Changeset 52437 for trunk/src/wp-includes/embed.php

Timestamp:

01/04/2022 03:22:40 PM (3 years ago)

Author:

audrasjb

Message:

Embeds: Fix oEmbed host script enqueueing on block-based themes.

This change fixes oEmbed host script enqueueing on front-end when using block themes.

It deprecates wp_oembed_add_host_js in favor of wp_maybe_enqueue_oembed_host_js. The action is still triggered in default-filters.php to ensure backward compatibility for websites that are removing the action. There is now a has_action() check in wp_maybe_enqueue_oembed_host_js() to see if wp_oembed_add_host_js() has not been unhooked from running at the wp_head action.

Follow-up to [52132], [52151], [52153], [52325].

Props swissspidy, westonruter, flixos90, kafleg.
Fixes #44632.

File:

• trunk/src/wp-includes/embed.php (modified) (2 diffs)

trunk/src/wp-includes/embed.php

@@ -357 +357 @@
  * Adds the necessary JavaScript to communicate with the embedded iframes.
  *
- * @since 4.4.0
- */
-function wp_oembed_add_host_js() {
-    add_filter( 'embed_oembed_html', 'wp_maybe_enqueue_oembed_host_js' );
-}
+ * This function is no longer used directly. For back-compat it exists exclusively as a way to indicate that the oEmbed
+ * host JS _should_ be added. In `default-filters.php` there remains this code:
+ *
+ *     add_action( 'wp_head', 'wp_oembed_add_host_js' )
+ *
+ * Historically a site has been able to disable adding the oEmbed host script by doing:
+ *
+ *     remove_action( 'wp_head', 'wp_oembed_add_host_js' )
+ *
+ * In order to ensure that such code still works as expected, this function remains. There is now a `has_action()` check
+ * in `wp_maybe_enqueue_oembed_host_js()` to see if `wp_oembed_add_host_js()` has not been unhooked from running at the
+ * `wp_head` action.
+ *
+ * @since 4.4.0
+ * @deprecated 5.9.0 Use {@see wp_maybe_enqueue_oembed_host_js()} instead.
+ */
+function wp_oembed_add_host_js() {}
 
 /**
@@ -375 +387 @@
  */
 function wp_maybe_enqueue_oembed_host_js( $html ) {
-    if ( preg_match( '/<blockquote\s[^>]*?wp-embedded-content/', $html ) ) {
+    if (
+        has_action( 'wp_head', 'wp_oembed_add_host_js' )
+        &&
+        preg_match( '/<blockquote\s[^>]*?wp-embedded-content/', $html )
+    ) {
         wp_enqueue_script( 'wp-embed' );
     }