Changeset 60140

Timestamp:

04/08/2025 02:10:35 AM (3 weeks ago)

Author:

jorbin

Message:

Docs: Correct the type of the $cache parameter in embed_oembed_html.

The value cannot be false at this point, as the filter is only applied to non-empty output.

Follow-up to [25726], [46661].

Reviewed By peterwilsoncc, jorbin.
Merges [60127] to the 6.8 branch.

Props apermo, xate, SergeyBiryukov.
Fixes #63220.

Location:

branches/6.8

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-embed.php (modified) (1 diff)

branches/6.8/src/wp-includes/class-wp-embed.php

@@ -284 +284 @@
                  * @see WP_Embed::shortcode()
                  *
-                 * @param string|false $cache   The cached HTML result, stored in post meta.
-                 * @param string       $url     The attempted embed URL.
-                 * @param array        $attr    An array of shortcode attributes.
-                 * @param int          $post_id Post ID.
+                 * @param string $cache   The cached HTML result, stored in post meta.
+                 * @param string $url     The attempted embed URL.
+                 * @param array  $attr    An array of shortcode attributes.
+                 * @param int    $post_id Post ID.
                  */
                 return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_id );