Changeset 46661 for trunk/src/wp-includes/class-wp-embed.php

Timestamp:

11/05/2019 09:25:53 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Further improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-includes/class-wp-embed.php (modified) (3 diffs)

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

@@ -174 +174 @@
                     if ( false !== $return ) {
                         /**
-                         * Filters the returned embed handler.
+                         * Filters the returned embed HTML.
                          *
                          * @since 2.9.0
@@ -180 +180 @@
                          * @see WP_Embed::shortcode()
                          *
-                         * @param mixed  $return The shortcode callback function to call.
-                         * @param string $url    The attempted embed URL.
-                         * @param array  $attr   An array of shortcode attributes.
+                         * @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.
                          */
                         return apply_filters( 'embed_handler_html', $return, $url, $attr );
@@ -249 +249 @@
                  * @see WP_Embed::shortcode()
                  *
-                 * @param mixed  $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|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.
                  */
                 return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );