<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WP_oEmbed_Controller class, used to provide an oEmbed endpoint.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Embeds

[5] Fix | Delete

* @since 4.4.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* oEmbed API endpoint controller.

[10] Fix | Delete

*

[11] Fix | Delete

* Registers the REST API route and delivers the response data.

[12] Fix | Delete

* The output format (XML or JSON) is handled by the REST API.

[13] Fix | Delete

*

[14] Fix | Delete

* @since 4.4.0

[15] Fix | Delete

*/

[16] Fix | Delete

#[AllowDynamicProperties]

[17] Fix | Delete

final class WP_oEmbed_Controller {

[18] Fix | Delete

/**

[19] Fix | Delete

* Register the oEmbed REST API route.

[20] Fix | Delete

*

[21] Fix | Delete

* @since 4.4.0

[22] Fix | Delete

*/

[23] Fix | Delete

public function register_routes() {

[24] Fix | Delete

/**

[25] Fix | Delete

* Filters the maxwidth oEmbed parameter.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 4.4.0

[28] Fix | Delete

*

[29] Fix | Delete

* @param int $maxwidth Maximum allowed width. Default 600.

[30] Fix | Delete

*/

[31] Fix | Delete

$maxwidth = apply_filters( 'oembed_default_width', 600 );

[32] Fix | Delete

[33] Fix | Delete

register_rest_route(

[34] Fix | Delete

'oembed/1.0',

[35] Fix | Delete

'/embed',

[36] Fix | Delete

array(

[37] Fix | Delete

array(

[38] Fix | Delete

'methods' => WP_REST_Server::READABLE,

[39] Fix | Delete

'callback' => array( $this, 'get_item' ),

[40] Fix | Delete

'permission_callback' => '__return_true',

[41] Fix | Delete

'args' => array(

[42] Fix | Delete

'url' => array(

[43] Fix | Delete

'description' => __( 'The URL of the resource for which to fetch oEmbed data.' ),

[44] Fix | Delete

'required' => true,

[45] Fix | Delete

'type' => 'string',

[46] Fix | Delete

'format' => 'uri',

[47] Fix | Delete

),

[48] Fix | Delete

'format' => array(

[49] Fix | Delete

'default' => 'json',

[50] Fix | Delete

'sanitize_callback' => 'wp_oembed_ensure_format',

[51] Fix | Delete

),

[52] Fix | Delete

'maxwidth' => array(

[53] Fix | Delete

'default' => $maxwidth,

[54] Fix | Delete

'sanitize_callback' => 'absint',

[55] Fix | Delete

),

[56] Fix | Delete

),

[57] Fix | Delete

),

[58] Fix | Delete

)

[59] Fix | Delete

);

[60] Fix | Delete

[61] Fix | Delete

register_rest_route(

[62] Fix | Delete

'oembed/1.0',

[63] Fix | Delete

'/proxy',

[64] Fix | Delete

array(

[65] Fix | Delete

array(

[66] Fix | Delete

'methods' => WP_REST_Server::READABLE,

[67] Fix | Delete

'callback' => array( $this, 'get_proxy_item' ),

[68] Fix | Delete

'permission_callback' => array( $this, 'get_proxy_item_permissions_check' ),

[69] Fix | Delete

'args' => array(

[70] Fix | Delete

'url' => array(

[71] Fix | Delete

'description' => __( 'The URL of the resource for which to fetch oEmbed data.' ),

[72] Fix | Delete

'required' => true,

[73] Fix | Delete

'type' => 'string',

[74] Fix | Delete

'format' => 'uri',

[75] Fix | Delete

),

[76] Fix | Delete

'format' => array(

[77] Fix | Delete

'description' => __( 'The oEmbed format to use.' ),

[78] Fix | Delete

'type' => 'string',

[79] Fix | Delete

'default' => 'json',

[80] Fix | Delete

'enum' => array(

[81] Fix | Delete

'json',

[82] Fix | Delete

'xml',

[83] Fix | Delete

),

[84] Fix | Delete

),

[85] Fix | Delete

'maxwidth' => array(

[86] Fix | Delete

'description' => __( 'The maximum width of the embed frame in pixels.' ),

[87] Fix | Delete

'type' => 'integer',

[88] Fix | Delete

'default' => $maxwidth,

[89] Fix | Delete

'sanitize_callback' => 'absint',

[90] Fix | Delete

),

[91] Fix | Delete

'maxheight' => array(

[92] Fix | Delete

'description' => __( 'The maximum height of the embed frame in pixels.' ),

[93] Fix | Delete

'type' => 'integer',

[94] Fix | Delete

'sanitize_callback' => 'absint',

[95] Fix | Delete

),

[96] Fix | Delete

'discover' => array(

[97] Fix | Delete

'description' => __( 'Whether to perform an oEmbed discovery request for unsanctioned providers.' ),

[98] Fix | Delete

'type' => 'boolean',

[99] Fix | Delete

'default' => true,

[100] Fix | Delete

),

[101] Fix | Delete

),

[102] Fix | Delete

),

[103] Fix | Delete

)

[104] Fix | Delete

);

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Callback for the embed API endpoint.

[109] Fix | Delete

*

[110] Fix | Delete

* Returns the JSON object for the post.

[111] Fix | Delete

*

[112] Fix | Delete

* @since 4.4.0

[113] Fix | Delete

*

[114] Fix | Delete

* @param WP_REST_Request $request Full data about the request.

[115] Fix | Delete

* @return array|WP_Error oEmbed response data or WP_Error on failure.

[116] Fix | Delete

*/

[117] Fix | Delete

public function get_item( $request ) {

[118] Fix | Delete

$post_id = url_to_postid( $request['url'] );

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Filters the determined post ID.

[122] Fix | Delete

*

[123] Fix | Delete

* @since 4.4.0

[124] Fix | Delete

*

[125] Fix | Delete

* @param int $post_id The post ID.

[126] Fix | Delete

* @param string $url The requested URL.

[127] Fix | Delete

*/

[128] Fix | Delete

$post_id = apply_filters( 'oembed_request_post_id', $post_id, $request['url'] );

[129] Fix | Delete

[130] Fix | Delete

$data = get_oembed_response_data( $post_id, $request['maxwidth'] );

[131] Fix | Delete

[132] Fix | Delete

if ( ! $data ) {

[133] Fix | Delete

return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

return $data;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Checks if current user can make a proxy oEmbed request.

[141] Fix | Delete

*

[142] Fix | Delete

* @since 4.8.0

[143] Fix | Delete

*

[144] Fix | Delete

* @return true|WP_Error True if the request has read access, WP_Error object otherwise.

[145] Fix | Delete

*/

[146] Fix | Delete

public function get_proxy_item_permissions_check() {

[147] Fix | Delete

if ( ! current_user_can( 'edit_posts' ) ) {

[148] Fix | Delete

return new WP_Error( 'rest_forbidden', __( 'Sorry, you are not allowed to make proxied oEmbed requests.' ), array( 'status' => rest_authorization_required_code() ) );

[149] Fix | Delete

}

[150] Fix | Delete

return true;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Callback for the proxy API endpoint.

[155] Fix | Delete

*

[156] Fix | Delete

* Returns the JSON object for the proxied item.

[157] Fix | Delete

*

[158] Fix | Delete

* @since 4.8.0

[159] Fix | Delete

*

[160] Fix | Delete

* @see WP_oEmbed::get_html()

[161] Fix | Delete

* @global WP_Embed $wp_embed WordPress Embed object.

[162] Fix | Delete

* @global WP_Scripts $wp_scripts

[163] Fix | Delete

*

[164] Fix | Delete

* @param WP_REST_Request $request Full data about the request.

[165] Fix | Delete

* @return object|WP_Error oEmbed response data or WP_Error on failure.

[166] Fix | Delete

*/

[167] Fix | Delete

public function get_proxy_item( $request ) {

[168] Fix | Delete

global $wp_embed, $wp_scripts;

[169] Fix | Delete

[170] Fix | Delete

$args = $request->get_params();

[171] Fix | Delete

[172] Fix | Delete

// Serve oEmbed data from cache if set.

[173] Fix | Delete

unset( $args['_wpnonce'] );

[174] Fix | Delete

$cache_key = 'oembed_' . md5( serialize( $args ) );

[175] Fix | Delete

$data = get_transient( $cache_key );

[176] Fix | Delete

if ( ! empty( $data ) ) {

[177] Fix | Delete

return $data;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

$url = $request['url'];

[181] Fix | Delete

unset( $args['url'] );

[182] Fix | Delete

[183] Fix | Delete

// Copy maxwidth/maxheight to width/height since WP_oEmbed::fetch() uses these arg names.

[184] Fix | Delete

if ( isset( $args['maxwidth'] ) ) {

[185] Fix | Delete

$args['width'] = $args['maxwidth'];

[186] Fix | Delete

}

[187] Fix | Delete

if ( isset( $args['maxheight'] ) ) {

[188] Fix | Delete

$args['height'] = $args['maxheight'];

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

// Short-circuit process for URLs belonging to the current site.

[192] Fix | Delete

$data = get_oembed_response_data_for_url( $url, $args );

[193] Fix | Delete

[194] Fix | Delete

if ( $data ) {

[195] Fix | Delete

return $data;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

$data = _wp_oembed_get_object()->get_data( $url, $args );

[199] Fix | Delete

[200] Fix | Delete

if ( false === $data ) {

[201] Fix | Delete

// Try using a classic embed, instead.

[202] Fix | Delete

/* @var WP_Embed $wp_embed */

[203] Fix | Delete

$html = $wp_embed->get_embed_handler_html( $args, $url );

[204] Fix | Delete

[205] Fix | Delete

if ( $html ) {

[206] Fix | Delete

// Check if any scripts were enqueued by the shortcode, and include them in the response.

[207] Fix | Delete

$enqueued_scripts = array();

[208] Fix | Delete

[209] Fix | Delete

foreach ( $wp_scripts->queue as $script ) {

[210] Fix | Delete

$enqueued_scripts[] = $wp_scripts->registered[ $script ]->src;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

return (object) array(

[214] Fix | Delete

'provider_name' => __( 'Embed Handler' ),

[215] Fix | Delete

'html' => $html,

[216] Fix | Delete

'scripts' => $enqueued_scripts,

[217] Fix | Delete

);

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/** This filter is documented in wp-includes/class-wp-oembed.php */

[224] Fix | Delete

$data->html = apply_filters( 'oembed_result', _wp_oembed_get_object()->data2html( (object) $data, $url ), $url, $args );

[225] Fix | Delete

[226] Fix | Delete

/**

[227] Fix | Delete

* Filters the oEmbed TTL value (time to live).

[228] Fix | Delete

*

[229] Fix | Delete

* Similar to the {@see 'oembed_ttl'} filter, but for the REST API

[230] Fix | Delete

* oEmbed proxy endpoint.

[231] Fix | Delete

*

[232] Fix | Delete

* @since 4.8.0

[233] Fix | Delete

*

[234] Fix | Delete

* @param int $time Time to live (in seconds).

[235] Fix | Delete

* @param string $url The attempted embed URL.

[236] Fix | Delete

* @param array $args An array of embed request arguments.

[237] Fix | Delete

*/

[238] Fix | Delete

$ttl = apply_filters( 'rest_oembed_ttl', DAY_IN_SECONDS, $url, $args );

[239] Fix | Delete

[240] Fix | Delete

set_transient( $cache_key, $data, $ttl );

[241] Fix | Delete

[242] Fix | Delete

return $data;

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete