Property | Type | Description | |
---|---|---|---|
$age_rating | integer | Recommended minimum age of the viewer. | |
$blog_id | integer | WordPress.com blog identifier | |
$calculated_height | integer | Video height calculated based on original video dimensions and the requested maxwidth | |
$calculated_width | integer | Video width calculated based on original video dimensions and the requested maxwidth | |
$captions | array | Closed captions if available for the given video. Associative array of ISO 639-2 language code and a WebVTT URI | |
$description | string | Video description | |
$duration | integer | Video duration in whole seconds | |
$expires | integer | Expiration of the video expressed in Unix time | |
$guid | string | VideoPress unique identifier | |
$language | string | Text and audio language as ISO 639-2 language code | |
$maxwidth | integer | Maximum desired width. | |
$players | stdClass | Video player information | |
$post_id | integer | Remote blog attachment identifier | |
$poster_frame_uri | string | Poster frame image URI for the given video guid and calculated dimensions. | |
$restricted_embed | boolean | Video author has restricted video embedding or sharing | |
$skin | array | Video player skinning preferences including background color and watermark | |
$text_direction | string | Directionality of title text. ltr or rtl | |
$title | string | Video title | |
$version | |||
$videos | stdClass | Video files associated with the given guid for the calculated dimensions. |
Method | Description | |
---|---|---|
__construct ( $guid, $maxwidth = 640 ) | Setup the object. | |
calculate_expiration ( $expires_header ) : integer | boolean | Convert an Expires HTTP header value into Unix time for use in WP Cache | |
hostname ( string $url ) : boolean | string | Extract the site's host domain for statistics and comparison against an allowed site list in the case of restricted embeds. |
Method | Description | |
---|---|---|
get_data ( ) : stdClass | WP_Error | Request data from WordPress.com for the given guid, maxwidth, and calculated blog hostname. |
public __construct ( $guid, $maxwidth = 640 ) |
public static calculate_expiration ( $expires_header ) : integer | boolean | ||
return | integer | boolean | Unix time or false |
public int $age_rating | ||
return | integer |
public int $calculated_height | ||
return | integer |
public int $calculated_width | ||
return | integer |
public int $expires | ||
return | integer |
public string $language | ||
return | string |
public string $poster_frame_uri | ||
return | string |
public bool $restricted_embed | ||
return | boolean |
public array $skin | ||
return | array |
public string $text_direction | ||
return | string |