WordPress 4.1.4-scripts
[autoinstalls/wordpress.git] / wp-includes / class-wp-embed.php
index 6b5a51a715b4354dd6f23eb839c2d84538531364..a10024a789a74ae532401574dcd3e792ca8790c4 100644 (file)
@@ -43,9 +43,6 @@ class WP_Embed {
         * calls {@link do_shortcode()}, and then re-registers the old shortcodes.
         *
         * @uses $shortcode_tags
-        * @uses remove_all_shortcodes()
-        * @uses add_shortcode()
-        * @uses do_shortcode()
         *
         * @param string $content Content to parse
         * @return string Content with shortcode parsed
@@ -122,17 +119,6 @@ class WP_Embed {
         * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
         * If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
         *
-        * @uses wp_oembed_get()
-        * @uses wp_parse_args()
-        * @uses wp_embed_defaults()
-        * @uses WP_Embed::maybe_make_link()
-        * @uses get_option()
-        * @uses author_can()
-        * @uses wp_cache_get()
-        * @uses wp_cache_set()
-        * @uses get_post_meta()
-        * @uses update_post_meta()
-        *
         * @param array $attr {
         *     Shortcode attributes. Optional.
         *
@@ -156,7 +142,7 @@ class WP_Embed {
                $attr = wp_parse_args( $attr, wp_embed_defaults( $url ) );
 
                // kses converts & into & and we need to undo this
-               // See http://core.trac.wordpress.org/ticket/11311
+               // See https://core.trac.wordpress.org/ticket/11311
                $url = str_replace( '&', '&', $url );
 
                // Look for known internal handlers
@@ -237,13 +223,13 @@ class WP_Embed {
                        }
 
                        /**
-                        * Filter whether to inspect the given URL for discoverable <link> tags.
+                        * Filter whether to inspect the given URL for discoverable link tags.
                         *
                         * @since 2.9.0
                         *
                         * @see WP_oEmbed::discover()
                         *
-                        * @param bool $enable Whether to enable <link> tag discovery. Default false.
+                        * @param bool $enable Whether to enable `<link>` tag discovery. Default false.
                         */
                        $attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );
 
@@ -332,8 +318,6 @@ class WP_Embed {
        /**
         * Callback function for {@link WP_Embed::autoembed()}.
         *
-        * @uses WP_Embed::shortcode()
-        *
         * @param array $match A regex match array.
         * @return string The embed HTML on success, otherwise the original URL.
         */
@@ -350,7 +334,7 @@ class WP_Embed {
         * Conditionally makes a hyperlink based on an internal class variable.
         *
         * @param string $url URL to potentially be linked.
-        * @return string Linked URL or the original URL.
+        * @return false|string Linked URL or the original URL. False if 'return_false_on_fail' is true.
         */
        public function maybe_make_link( $url ) {
                if ( $this->return_false_on_fail ) {