Changeset 60157

Timestamp:

04/14/2025 02:29:56 PM (2 weeks ago)

Author:

audrasjb

Message:

Docs: Correct the type of the $return parameter in embed_handler_html filter.

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

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

Reviewed by SergeyBiryukov, audrasjb.
Merges [60149] to 6.8 branch.
Props apermo, jasonsa19.
Fixes #63248.

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

@@ -164 +164 @@
                          * @see WP_Embed::shortcode()
                          *
-                         * @param string|false $return The HTML result of the shortcode, or false on failure.
-                         * @param string       $url    The embed URL.
-                         * @param array        $attr   An array of shortcode attributes.
+                         * @param string $return The HTML result of the shortcode.
+                         * @param string $url    The embed URL.
+                         * @param array  $attr   An array of shortcode attributes.
                          */
                         return apply_filters( 'embed_handler_html', $return, $url, $attr );