Changeset 34974 for trunk/src/wp-includes/embed-functions.php

Timestamp:

10/08/2015 11:21:49 PM (9 years ago)

Author:

DrewAPicture

Message:

Embeds: Rename the $return parameter in wp_filter_oembed_result() to $result to provide better context on what is being filtered.

See #32522.

File:

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

trunk/src/wp-includes/embed-functions.php

@@ -680 +680 @@
  * Filters the given oEmbed HTML.
  *
- * If the $url isn't on the trusted providers list,
+ * If the `$url` isn't on the trusted providers list,
  * we need to filter the HTML heavily for security.
  *
@@ -687 +687 @@
  * @since 4.4.0
  *
- * @param string $return The returned oEmbed HTML.
+ * @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.
  */
-function wp_filter_oembed_result( $return, $data, $url ) {
-    if ( false === $return || ! in_array( $data->type, array( 'rich', 'video' ) ) ) {
-        return $return;
+function wp_filter_oembed_result( $result, $data, $url ) {
+    if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ) ) ) {
+        return $result;
     }
 
@@ -702 +702 @@
     // Don't modify the HTML for trusted providers.
     if ( false !== $wp_oembed->get_provider( $url, array( 'discover' => false ) ) ) {
-        return $return;
+        return $result;
     }
 
@@ -719 +719 @@
     );
 
-    $html = wp_kses( $return, $allowed_html );
+    $html = wp_kses( $result, $allowed_html );
     preg_match( '|^.*(<iframe.*?></iframe>).*$|m', $html, $iframes );