Docs: Correct parameter type for the oembed_dataparse filter.

This commit updates the filter documentation to indicate that it can both take and return a `string|false` value.

Documentation for functions attached to the filter has been similarly corrected:
* `WP_oEmbed::_strip_newlines()`
* `wp_filter_oembed_result()`
* `wp_filter_oembed_iframe_title_attribute()`

Follow-up to [12153], [25723], [34903], [34974], [44942].

Props justlevine.
See #63268.

git-svn-id: https://develop.svn.wordpress.org/trunk@60307 602fd350-edb4-49c9-b593-d223f7449a82

Author: SergeyBiryukov

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

@@ -739,9 +739,9 @@ public function data2html( $data, $url ) {
 		 *
 		 * @since 2.9.0
 		 *
-		 * @param string $return The returned oEmbed HTML.
-		 * @param object $data   A data object result from an oEmbed provider.
-		 * @param string $url    The URL of the content to be embedded.
+		 * @param string|false $return The returned oEmbed HTML, or false on failure.
+		 * @param object       $data   A data object result from an oEmbed provider.
+		 * @param string       $url    The URL of the content to be embedded.
 		 */
 		return apply_filters( 'oembed_dataparse', $return, $data, $url );
 	}
@@ -752,10 +752,10 @@ public function data2html( $data, $url ) {
 	 * @since 2.9.0 as strip_scribd_newlines()
 	 * @since 3.0.0
 	 *
-	 * @param string $html Existing HTML.
-	 * @param object $data Data object from WP_oEmbed::data2html()
-	 * @param string $url The original URL passed to oEmbed.
-	 * @return string Possibly modified $html
+	 * @param string|false $html Existing HTML.
+	 * @param object       $data Data object from WP_oEmbed::data2html()
+	 * @param string       $url The original URL passed to oEmbed.
+	 * @return string|false Possibly modified $html.
 	 */
 	public function _strip_newlines( $html, $data, $url ) {
 		if ( ! str_contains( $html, "\n" ) ) {

src/wp-includes/embed.php

@@ -843,10 +843,10 @@ function _oembed_create_xml( $data, $node = null ) {
  *
  * @since 5.2.0
  *
- * @param string $result The oEmbed HTML result.
- * @param object $data   A data object result from an oEmbed provider.
- * @param string $url    The URL of the content to be embedded.
- * @return string The filtered oEmbed result.
+ * @param string|false $result The oEmbed HTML result.
+ * @param object       $data   A data object result from an oEmbed provider.
+ * @param string       $url    The URL of the content to be embedded.
+ * @return string|false The filtered oEmbed result.
  */
 function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) {
 	if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ), true ) ) {
@@ -910,10 +910,10 @@ function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) {
  *
  * @since 4.4.0
  *
- * @param string $result The oEmbed HTML result.
- * @param object $data   A data object result from an oEmbed provider.
- * @param string $url    The URL of the content to be embedded.
- * @return string The filtered and sanitized oEmbed result.
+ * @param string|false $result The oEmbed HTML result.
+ * @param object       $data   A data object result from an oEmbed provider.
+ * @param string       $url    The URL of the content to be embedded.
+ * @return string|false The filtered and sanitized oEmbed result.
  */
 function wp_filter_oembed_result( $result, $data, $url ) {
 	if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ), true ) ) {