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

SergeyBiryukov · SergeyBiryukov · commit 17f8ee4efedb · 2025-04-10T13:45:39.000Z
The value cannot be `false` at this point, as the filter is only applied to non-empty embed HTML. Follow-up to [25726], [46661]. Props apermo, jasonsa19. Fixes #63248. git-svn-id: https://develop.svn.wordpress.org/trunk@60149 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/class-wp-embed.php b/src/wp-includes/class-wp-embed.php
@@ -163,9 +163,9 @@ public function get_embed_handler_html( $attr, $url ) {
 						 *
 						 * @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 );
 					}

Original file line number	Diff line number	Diff line change
`@@ -163,9 +163,9 @@ public function get_embed_handler_html( $attr, $url ) {`
`163`	`163`	`*`
`164`	`164`	`* @see WP_Embed::shortcode()`
`165`	`165`	`*`
`166`		`- * @param string\|false $return The HTML result of the shortcode, or false on failure.`
`167`		`- * @param string $url The embed URL.`
`168`		`- * @param array $attr An array of shortcode attributes.`
	`166`	`+ * @param string $return The HTML result of the shortcode.`
	`167`	`+ * @param string $url The embed URL.`
	`168`	`+ * @param array $attr An array of shortcode attributes.`
`169`	`169`	`*/`
`170`	`170`	`return apply_filters( 'embed_handler_html', $return, $url, $attr );`
`171`	`171`	`}`