PHP Class Twitter\WordPress\Shortcodes\PeriscopeOnAir

Since: 1.3.0
Inheritance: implements Twitter\WordPress\Shortcodes\ShortcodeInterface
ファイルを表示 Open project: twitter/wordpress Class Usage Examples

Public Properties

Property Type Description
$SHORTCODE_DEFAULTS Accepted shortcode attributes and their default values

Public Methods

Method Description
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

Method Details

getUsername() public static method

Get the Periscope username of the author of the current post
Since: 1.3.0
public static getUsername ( ) : string
return string Periscope username or empty if no screen name stored

init() public static method

Register shortcode macro and handler
Since: 1.3.0
public static init ( ) : void
return void

linkHandler() public static method

Handle a URL matched by an embed handler
Since: 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.
return string HTML markup for the Periscope On Air button or an empty string if requirements not met

sanitizeShortcodeParameters() public static method

Clean up provided shortcode values
Since: 1.3.0
public static sanitizeShortcodeParameters ( array $attributes = [] ) : array
$attributes array provided shortcode attributes { @type string shortcode attribute name @type mixed shortcode attribute value }
return array simplified shortcode values with defaults removed { @type string shortcode attribute name @type bool|string shortcode attribute value }

shortcodeHandler() public static method

Handle shortcode macro
Since: 1.3.0
public static shortcodeHandler ( array $attributes, string $content = '' ) : string
$attributes array shortcode attributes
$content string shortcode content. no effect
return string Periscope On Air button HTML or empty string

shortcodeUI() public static method

Describe shortcode for Shortcake UI
Since: 1.3.0
public static shortcodeUI ( ) : void
return void

Property Details

$SHORTCODE_DEFAULTS public_oe static_oe property

Accepted shortcode attributes and their default values
Since: 1.3.0
public static $SHORTCODE_DEFAULTS