| Property | Type | Description | |
|---|---|---|---|
| $SHORTCODE_DEFAULTS | Accepted shortcode attributes and their default values |
| 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 |
| public static getUsername ( ) : string | ||
| return | string | Periscope username or empty if no screen name stored |
| 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 |
| 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 } |
| public static shortcodeUI ( ) : void | ||
| return | void | |