Changeset 25726

Timestamp:

10/08/2013 04:42:20 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/class-wp-embed.php.

Props swissspidy, kpdesign.
Fixes #25515.

File:

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

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

@@ -154 +154 @@
                 if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
                     if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) )
+                        /**
+                         * Filter the returned embed handler.
+                         *
+                         * @since 2.9.0
+                         *
+                         * @param mixed  $return The shortcode callback function to call.
+                         * @param string $url    The attempted embed URL.
+                         * @param array  $attr   An array of shortcode attributes.
+                         */
                         return apply_filters( 'embed_handler_html', $return, $url, $attr );
                 }
@@ -176 +185 @@
 
                 if ( ! empty( $cache ) )
+                    /**
+                     * Filter the cached oEmbed HTML.
+                     *
+                     * @since 2.9.0
+                     *
+                     * @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.
+                     */
                     return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $post_ID );
             }
 
+            /**
+             * Filter whether to inspect the given URL for discoverable <link> tags.
+             *
+             * @see WP_oEmbed::discover()
+             *
+             * @param bool false Whether to enable <link> tag discovery. Default false.
+             */
+            $attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );
+
             // Use oEmbed to get the HTML
-            $attr['discover'] = ( apply_filters('embed_oembed_discover', false) && author_can( $post_ID, 'unfiltered_html' ) );
             $html = wp_oembed_get( $url, $attr );
 
@@ -188 +215 @@
 
             // If there was a result, return it
-            if ( $html )
+            if ( $html ) {
+                //duplicate_hook
                 return apply_filters( 'embed_oembed_html', $html, $url, $attr, $post_ID );
+            }
         }
 
@@ -220 +249 @@
         $post = get_post( $post_ID );
 
-        if ( empty($post->ID) || !in_array( $post->post_type, apply_filters( 'embed_cache_oembed_types', array( 'post', 'page' ) ) ) )
+        $post_types = array( 'post', 'page' );
+        /**
+         * Filter the array of post types to cache oEmbed results for.
+         *
+         * @since 2.9.0
+         *
+         * @param array $post_types Array of post types to cache oEmbed results for. Default 'post', 'page'.
+         */
+        if ( empty($post->ID) || !in_array( $post->post_type, apply_filters( 'embed_cache_oembed_types', $post_types ) ) )
             return;
 
@@ -272 +309 @@
     function maybe_make_link( $url ) {
         $output = ( $this->linkifunknown ) ? '<a href="' . esc_url($url) . '">' . esc_html($url) . '</a>' : $url;
+
+        /**
+         * Filter the returned, maybe-linked embed URL.
+         *
+         * @since 2.9.0
+         *
+         * @param string $output The linked or original URL.
+         * @param string $url    The original URL.
+         */
         return apply_filters( 'embed_maybe_make_link', $output, $url );
     }