PHP Класс Twitter\WordPress\Shortcodes\PeriscopeOnAir

С версии: 1.3.0
Наследование: implements Twitter\WordPress\Shortcodes\ShortcodeInterface
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$SHORTCODE_DEFAULTS Accepted shortcode attributes and their default values

Открытые методы

Метод Описание
getUsername ( ) : string Get the Periscope username of the author of the current post
init ( ) : void Register shortcode macro and handler
linkHandler ( array $matches, array $attr, string $url, array $rawattr ) : string Handle a URL matched by an embed handler
sanitizeShortcodeParameters ( array $attributes = [] ) : array Clean up provided shortcode values
shortcodeHandler ( array $attributes, string $content = '' ) : string Handle shortcode macro
shortcodeUI ( ) : void Describe shortcode for Shortcake UI

Описание методов

getUsername() публичный статический Метод

Get the Periscope username of the author of the current post
С версии: 1.3.0
public static getUsername ( ) : string
Результат string Periscope username or empty if no screen name stored

init() публичный статический Метод

Register shortcode macro and handler
С версии: 1.3.0
public static init ( ) : void
Результат void

linkHandler() публичный статический Метод

Handle a URL matched by an embed handler
С версии: 1.3.0
public static linkHandler ( array $matches, array $attr, string $url, array $rawattr ) : string
$matches array The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
$attr array Embed attributes. Not used.
$url string The original URL that was matched by the regex. Not used.
$rawattr array The original unmodified attributes. Not used.
Результат string HTML markup for the Periscope On Air button or an empty string if requirements not met

sanitizeShortcodeParameters() публичный статический Метод

Clean up provided shortcode values
С версии: 1.3.0
public static sanitizeShortcodeParameters ( array $attributes = [] ) : array
$attributes array provided shortcode attributes { @type string shortcode attribute name @type mixed shortcode attribute value }
Результат array simplified shortcode values with defaults removed { @type string shortcode attribute name @type bool|string shortcode attribute value }

shortcodeHandler() публичный статический Метод

Handle shortcode macro
С версии: 1.3.0
public static shortcodeHandler ( array $attributes, string $content = '' ) : string
$attributes array shortcode attributes
$content string shortcode content. no effect
Результат string Periscope On Air button HTML or empty string

shortcodeUI() публичный статический Метод

Describe shortcode for Shortcake UI
С версии: 1.3.0
public static shortcodeUI ( ) : void
Результат void

Описание свойств

$SHORTCODE_DEFAULTS публичное статическое свойство

Accepted shortcode attributes and their default values
С версии: 1.3.0
public static $SHORTCODE_DEFAULTS