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

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

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

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

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

Метод Описание
getOEmbedCacheKeyCustomParameters ( array $query_parameters ) : string Generate a unique string representing oEmbed result customizations set by shortcode parameters
init ( ) : void Attach handlers for embedded Tweets
linkHandler ( array $matches, array $attr, string $url, array $rawattr ) : string Handle a URL matched by an embed handler
oEmbedCacheKey ( array $query_parameters ) : string Construct a cache key for the oEmbed response. Account for query parameters needing to bust cache
sanitizeShortcodeParameters ( array $attributes = [] ) : array Convert shortcode parameters, attributes, and defaults into a clean set of Tweet parameters
sanitizeTweetID ( string $tweet_id ) : string Convert a Tweet ID in ID or URL form into a trimmed ID
shortcodeHandler ( array $attributes, string $content = '' ) : string Handle shortcode macro
shortcodeParamsToOEmbedParams ( string $tweet_id, array $shortcode_options = [] ) : array Convert shortcode parameters into query parameters supported by the Twitter oEmbed endpoint
shortcodeUI ( ) : void Describe shortcode for Shortcake UI

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

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

Generate a unique string representing oEmbed result customizations set by shortcode parameters
С версии: 1.0.0
public static getOEmbedCacheKeyCustomParameters ( array $query_parameters ) : string
$query_parameters array associative array of query parameters sent to the oEmbed endpoint { @type string query parameter name @type string|bool query parameter value }
Результат string cache key component

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

Attach handlers for embedded Tweets
С версии: 1.0.0
public static init ( ) : void
Результат void

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

Handle a URL matched by an embed handler
С версии: 1.0.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 Tweet or an empty string if requirements not met

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

Construct a cache key for the oEmbed response. Account for query parameters needing to bust cache
С версии: 1.0.0
public static oEmbedCacheKey ( array $query_parameters ) : string
$query_parameters array oEmbed API query parameters
Результат string cache key

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

Convert shortcode parameters, attributes, and defaults into a clean set of Tweet parameters
С версии: 1.0.0
public static sanitizeShortcodeParameters ( array $attributes = [] ) : array
$attributes array set of shortcode attribute-value pairs or positional content matching the WordPress shortcode regex { @type string|int attribute name or positional int @type mixed shortcode value }
Результат array cleaned up options ready for comparison { @type string option name @type string|bool option value }

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

Convert a Tweet ID in ID or URL form into a trimmed ID
С версии: 1.0.0
public static sanitizeTweetID ( string $tweet_id ) : string
$tweet_id string Tweet identifier
Результат string $tweet_id Tweet identifier or empty string if minimum requirements not met

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

Handle shortcode macro
С версии: 1.0.0
public static shortcodeHandler ( array $attributes, string $content = '' ) : string
$attributes array set of shortcode attribute-value pairs or positional content matching the WordPress shortcode regex { @type string|int attribute name or positional int @type mixed shortcode value }
$content string content inside a shortcode macro. no effect on this shortcode
Результат string HTML markup. empty string if parameter requirement not met or no Tweet info found

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

Convert shortcode parameters into query parameters supported by the Twitter oEmbed endpoint
С версии: 1.0.0
public static shortcodeParamsToOEmbedParams ( string $tweet_id, array $shortcode_options = [] ) : array
$tweet_id string Tweet identifier
$shortcode_options array customizations specified in the shortcode
Результат array associative array of query parameters ready for http_build_query { @type string query parameter name @type string|bool query parameter value }

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

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

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

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

Accepted values for the align parameter
С версии: 1.0.0
public static $ALIGN_OPTIONS

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

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