Changeset 48135

Timestamp:

06/23/2020 06:06:11 AM (6 years ago)

Author:

whyisjake

Message:

Embeds: Ensure that classic embed support works in the block editor.

See ​https://github.com/WordPress/gutenberg/pull/6345

Fixes #45447.

Props swisspidy, pento, audrasjb, aduth, jrchamp, thrijith, TimothyBlynJacobs, whyisjake.

Location:

trunk

Files:

• src/wp-includes/class-wp-embed.php (modified) (3 diffs)
• src/wp-includes/class-wp-oembed-controller.php (modified) (1 diff)
• tests/phpunit/tests/oembed/controller.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-embed.php

@@ -127 +127 @@
 
         /**
-         * The do_shortcode() callback function.
-         *
-         * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of
-         * the registered embed handlers. If none of the regex matches and it's enabled, then the URL
-         * will be given to the WP_oEmbed class.
+         * Returns embed HTML for a given URL from embed handlers.
+         *
+         * Attempts to convert a URL into embed HTML by checking the URL
+         * against the regex of the registered embed handlers.
+         *
+         * @since 5.5.0
          *
          * @param array $attr {
@@ -140 +141 @@
          * }
          * @param string $url The URL attempting to be embedded.
-         * @return string|false The embed HTML on success, otherwise the original URL.
-         *                      `->maybe_make_link()` can return false on failure.
-         */
-        public function shortcode( $attr, $url = '' ) {
-                $post = get_post();
-
-                if ( empty( $url ) && ! empty( $attr['src'] ) ) {
-                        $url = $attr['src'];
-                }
-
-                $this->last_url = $url;
-
-                if ( empty( $url ) ) {
-                        $this->last_attr = $attr;
-                        return '';
-                }
-
+         * @return string|false The embed HTML on success, false otherwise.
+         */
+        public function get_embed_handler_html( $attr, $url ) {
                 $rawattr = $attr;
                 $attr    = wp_parse_args( $attr, wp_embed_defaults( $url ) );
 
-                $this->last_attr = $attr;
-
-                // KSES converts & into & and we need to undo this.
-                // See https://core.trac.wordpress.org/ticket/11311
-                $url = str_replace( '&', '&', $url );
-
-                // Look for known internal handlers.
                 ksort( $this->handlers );
                 foreach ( $this->handlers as $priority => $handlers ) {
@@ -188 +168 @@
                                 }
                         }
+                }
+
+                return false;
+        }
+
+        /**
+         * The do_shortcode() callback function.
+         *
+         * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of
+         * the registered embed handlers. If none of the regex matches and it's enabled, then the URL
+         * will be given to the WP_oEmbed class.
+         *
+         * @param array $attr {
+         *     Shortcode attributes. Optional.
+         *
+         *     @type int $width  Width of the embed in pixels.
+         *     @type int $height Height of the embed in pixels.
+         * }
+         * @param string $url The URL attempting to be embedded.
+         * @return string|false The embed HTML on success, otherwise the original URL.
+         *                      `->maybe_make_link()` can return false on failure.
+         */
+        public function shortcode( $attr, $url = '' ) {
+                $post = get_post();
+
+                if ( empty( $url ) && ! empty( $attr['src'] ) ) {
+                        $url = $attr['src'];
+                }
+
+                $this->last_url = $url;
+
+                if ( empty( $url ) ) {
+                        $this->last_attr = $attr;
+                        return '';
+                }
+
+                $rawattr = $attr;
+                $attr    = wp_parse_args( $attr, wp_embed_defaults( $url ) );
+
+                $this->last_attr = $attr;
+
+                // KSES converts & into & and we need to undo this.
+                // See https://core.trac.wordpress.org/ticket/11311
+                $url = str_replace( '&', '&', $url );
+
+                // Look for known internal handlers.
+                $embed_handler_html = $this->get_embed_handler_html( $rawattr, $url );
+                if ( false !== $embed_handler_html ) {
+                        return $embed_handler_html;
                 }
 

trunk/src/wp-includes/class-wp-oembed-controller.php

@@ -194 +194 @@
 
                 if ( false === $data ) {
+                        // Try using a classic embed, instead.
+                        global $wp_embed;
+
+                        /* @var WP_Embed $wp_embed */
+                        $html = $wp_embed->get_embed_handler_html( $args, $url );
+
+                        if ( $html ) {
+                                global $wp_scripts;
+                                // Check if any scripts were enqueued by the shortcode, and include them in the response.
+                                $enqueued_scripts = array();
+
+                                foreach ( $wp_scripts->queue as $script ) {
+                                        $enqueued_scripts[] = $wp_scripts->registered[ $script ]->src;
+                                }
+
+                                return (object) array(
+                                        'provider_name' => __( 'Embed Handler' ),
+                                        'html'          => $html,
+                                        'scripts'       => $enqueued_scripts,
+                                );
+                        }
+
                         return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );
                 }

trunk/tests/phpunit/tests/oembed/controller.php

@@ -98 +98 @@
 
                 // Mock request to YouTube Embed.
-                if ( ! empty( $query_params['url'] ) && false !== strpos( $query_params['url'], self::YOUTUBE_VIDEO_ID ) ) {
+                if ( ! empty( $query_params['url'] ) && false !== strpos( $query_params['url'], '?v=' . self::YOUTUBE_VIDEO_ID ) ) {
                         return array(
                                 'response' => array(
@@ -610 +610 @@
         }
 
+        /**
+         * @ticket 45447
+         *
+         * @see wp_maybe_load_embeds()
+         */
+        public function test_proxy_with_classic_embed_provider() {
+                wp_set_current_user( self::$editor );
+                $request = new WP_REST_Request( 'GET', '/oembed/1.0/proxy' );
+                $request->set_param( 'url', 'https://www.youtube.com/embed/' . self::YOUTUBE_VIDEO_ID );
+                $request->set_param( 'maxwidth', 456 );
+                $request->set_param( 'maxheight', 789 );
+                $request->set_param( '_wpnonce', wp_create_nonce( 'wp_rest' ) );
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEquals( 2, $this->request_count );
+
+                // Test data object.
+                $data = $response->get_data();
+
+                $this->assertNotEmpty( $data );
+                $this->assertInternalType( 'object', $data );
+                $this->assertInternalType( 'string', $data->html );
+                $this->assertInternalType( 'array', $data->scripts );
+        }
+
         public function test_proxy_with_invalid_oembed_provider_no_discovery() {
                 wp_set_current_user( self::$editor );
 
-                // If discover is false for an unkown provider, no discovery request should take place.
+                // If discover is false for an unknown provider, no discovery request should take place.
                 $request = new WP_REST_Request( 'GET', '/oembed/1.0/proxy' );
                 $request->set_param( 'url', self::INVALID_OEMBED_URL );
-                $request->set_param( 'discover', 0 );
+                $request->set_param( 'discover', false );
                 $response = rest_get_server()->dispatch( $request );
                 $this->assertEquals( 404, $response->get_status() );
@@ -625 +650 @@
                 wp_set_current_user( self::$editor );
 
-                // For an unkown provider, a discovery request should happen.
+                // For an unknown provider, a discovery request should happen.
                 $request = new WP_REST_Request( 'GET', '/oembed/1.0/proxy' );
                 $request->set_param( 'url', self::INVALID_OEMBED_URL );