WordPress.org

Make WordPress Core

Ticket #26253: 26253.4.diff

File 26253.4.diff, 12.2 KB (added by DrewAPicture, 8 years ago)

Complete pass

  • src/wp-includes/feed.php

     
    1919 * @package WordPress
    2020 * @subpackage Feed
    2121 * @since 1.5.1
    22  * @uses apply_filters() Calls 'get_bloginfo_rss' hook with two parameters.
    2322 * @see get_bloginfo() For the list of possible values to display.
    2423 *
    2524 * @param string $show See get_bloginfo() for possible values.
     
    2726 */
    2827function get_bloginfo_rss($show = '') {
    2928        $info = strip_tags(get_bloginfo($show));
    30         return apply_filters('get_bloginfo_rss', convert_chars($info), $show);
     29        /**
     30         * Filter the bloginfo for use in RSS feeds.
     31         *
     32         * @since 2.2.0
     33         *
     34         * @see convert_chars()
     35         *
     36         * @param string $string Converted string value of the blog information.
     37         * @param string $show   The type of blog information to retrieve. @see get_bloginfo()
     38         */
     39        return apply_filters( 'get_bloginfo_rss', convert_chars( $info ), $show );
    3140}
    3241
    3342/**
     
    4049 * @package WordPress
    4150 * @subpackage Feed
    4251 * @since 0.71
    43  * @uses apply_filters() Calls 'bloginfo_rss' hook with two parameters.
    4452 * @see get_bloginfo() For the list of possible values to display.
    4553 *
    4654 * @param string $show See get_bloginfo() for possible values.
    4755 */
    4856function bloginfo_rss($show = '') {
     57        /**
     58         * Filter the retrieved RSS bloginfo for use in feeds.
     59         *
     60         * @since 2.1.0
     61         *
     62         * @see get_bloginfo()
     63         *
     64         * @param string $string RSS container for the blog information.
     65         * @param string $show   The type of blog information to retrieve.
     66         */
    4967        echo apply_filters('bloginfo_rss', get_bloginfo_rss($show), $show);
    5068}
    5169
     
    5876 * @package WordPress
    5977 * @subpackage Feed
    6078 * @since 2.5
    61  * @uses apply_filters() Calls 'default_feed' hook on the default feed string.
    6279 *
    6380 * @return string Default feed, or for example 'rss2', 'atom', etc.
    6481 */
    6582function get_default_feed() {
    66         $default_feed = apply_filters('default_feed', 'rss2');
     83        /**
     84         * Filter the default feed type.
     85         *
     86         * @since 2.5.0
     87         *
     88         * @param string $feed_type Type of default feed. Possible values include 'rss2', 'atom'.
     89         *                          Default 'rss2'.
     90         */
     91        $default_feed = apply_filters( 'default_feed', 'rss2' );
    6792        return 'rss' == $default_feed ? 'rss2' : $default_feed;
    6893}
    6994
     
    7398 * @package WordPress
    7499 * @subpackage Feed
    75100 * @since 2.2.0
    76  * @uses apply_filters() Calls 'get_wp_title_rss' hook on title.
    77  * @uses wp_title() See function for $sep parameter usage.
    78101 *
    79102 * @param string $sep Optional.How to separate the title. See wp_title() for more info.
    80103 * @return string Error message on failure or blog title on success.
     
    83106        $title = wp_title($sep, false);
    84107        if ( is_wp_error( $title ) )
    85108                return $title->get_error_message();
     109        /**
     110         * Filter the blog title for a feed title.
     111         *
     112         * @since 2.2.0
     113         *
     114         * @param string $title The current RSS post title.
     115         * @param string $sep   Separator used by wp_title().
     116         */
    86117        $title = apply_filters( 'get_wp_title_rss', $title, $sep );
    87118        return $title;
    88119}
     
    93124 * @package WordPress
    94125 * @subpackage Feed
    95126 * @since 2.2.0
    96  * @uses apply_filters() Calls 'wp_title_rss' on the blog title.
    97127 * @see wp_title() $sep parameter usage.
    98128 *
    99129 * @param string $sep Optional.
    100130 */
    101131function wp_title_rss( $sep = '»' ) {
     132        /**
     133         * Filter the the blog title for display of a feed title.
     134         *
     135         * @since 2.2.0
     136         *
     137         * @see get_wp_title_rss()
     138         *
     139         * @param string $string The current retrieved post title.
     140         * @param string $sep    Separator used by wp_title().
     141         */
    102142        echo apply_filters( 'wp_title_rss', get_wp_title_rss( $sep ), $sep );
    103143}
    104144
     
    108148 * @package WordPress
    109149 * @subpackage Feed
    110150 * @since 2.0.0
    111  * @uses apply_filters() Calls 'the_title_rss' on the post title.
    112151 *
    113152 * @return string Current post title.
    114153 */
    115154function get_the_title_rss() {
    116155        $title = get_the_title();
    117         $title = apply_filters('the_title_rss', $title);
     156        /**
     157         * Filter the post title for a feed.
     158         *
     159         * @since 1.2.1
     160         *
     161         * @param string $title The current post title.
     162         */
     163        $title = apply_filters( 'the_title_rss', $title );
    118164        return $title;
    119165}
    120166
     
    136182 * @package WordPress
    137183 * @subpackage Feed
    138184 * @since 2.9.0
    139  * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
    140185 * @see get_the_content()
    141186 *
    142187 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
     
    146191        if ( !$feed_type )
    147192                $feed_type = get_default_feed();
    148193
    149         $content = apply_filters('the_content', get_the_content());
     194        /** This filter is documented in wp-admin/post-template.php */
     195        $content = apply_filters( 'the_content', get_the_content() );
    150196        $content = str_replace(']]>', ']]>', $content);
    151         return apply_filters('the_content_feed', $content, $feed_type);
     197        /**
     198         * Filter the post content for use in feeds.
     199         *
     200         * @since 2.9.0
     201         *
     202         * @param string $content   The current post content.
     203         * @param string $feed_type Type of feed. Possible values include 'rss2', 'atom'.
     204         *                          Default 'rss2'.
     205         */
     206        return apply_filters( 'the_content_feed', $content, $feed_type );
    152207}
    153208
    154209/**
     
    157212 * @package WordPress
    158213 * @subpackage Feed
    159214 * @since 2.9.0
    160  * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
    161215 * @see get_the_content()
    162216 *
    163217 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
     
    172226 * @package WordPress
    173227 * @subpackage Feed
    174228 * @since 0.71
    175  * @uses apply_filters() Calls 'the_excerpt_rss' hook on the excerpt.
    176229 */
    177230function the_excerpt_rss() {
    178231        $output = get_the_excerpt();
     232        /**
     233         * Filter the post excerpt for a feed.
     234         *
     235         * @since 1.2.1
     236         *
     237         * @param string $output The current post excerpt returned by get_the_excerpt().
     238         */
    179239        echo apply_filters('the_excerpt_rss', $output);
    180240}
    181241
     
    185245 * @package WordPress
    186246 * @subpackage Feed
    187247 * @since 2.3.0
    188  * @uses apply_filters() Call 'the_permalink_rss' on the post permalink
    189248 */
    190249function the_permalink_rss() {
     250        /**
     251         * Filter the permalink to the post for use in feeds.
     252         *
     253         * @since 2.3.0
     254         *
     255         * @param string $string The current post permalink.
     256         */
    191257        echo esc_url( apply_filters('the_permalink_rss', get_permalink() ));
    192258}
    193259
     
    198264 * @return none
    199265 */
    200266function comments_link_feed() {
     267        /**
     268         * Filter the permalink to the comments for the current post.
     269         *
     270         * @since 3.6.0
     271         *
     272         * @param string $string The current comment permalink with '#comments' appended.
     273         */
    201274        echo esc_url( apply_filters( 'comments_link_feed', get_comments_link() ) );
    202275}
    203276
     
    239312 * @since 1.5.0
    240313 */
    241314function comment_link() {
     315        /**
     316         * Filter the current comment's permalink.
     317         *
     318         * @since 1.5.2
     319         *
     320         * @see get_comment_link()
     321         *
     322         * @param string $string The current comment permalink.
     323         */
    242324        echo esc_url( apply_filters( 'comment_link', get_comment_link() ) );
    243325}
    244326
     
    248330 * @package WordPress
    249331 * @subpackage Feed
    250332 * @since 2.0.0
    251  * @uses apply_filters() Calls 'comment_author_rss' hook on comment author.
    252333 * @uses get_comment_author()
    253334 *
    254335 * @return string Comment Author
    255336 */
    256337function get_comment_author_rss() {
    257         return apply_filters('comment_author_rss', get_comment_author() );
     338        /**
     339         * Filter the current comment author for use in a feed.
     340         *
     341         * @since 1.5.2
     342         *
     343         * @see get_comment_author()
     344         *
     345         * @param string $string The current comment author.
     346         */
     347        return apply_filters( 'comment_author_rss', get_comment_author() );
    258348}
    259349
    260350/**
     
    274364 * @package WordPress
    275365 * @subpackage Feed
    276366 * @since 1.0.0
    277  * @uses apply_filters() Calls 'comment_text_rss' filter on comment content.
    278367 * @uses get_comment_text()
    279368 */
    280369function comment_text_rss() {
    281370        $comment_text = get_comment_text();
    282         $comment_text = apply_filters('comment_text_rss', $comment_text);
     371        /**
     372         * Filter the current comment content for use in a feed.
     373         *
     374         * @since 1.5.2
     375         *
     376         * @param string $comment_text The comment content.
     377         */
     378        $comment_text = apply_filters( 'comment_text_rss', $comment_text );
    283379        echo $comment_text;
    284380}
    285381
     
    293389 * @package WordPress
    294390 * @subpackage Feed
    295391 * @since 2.1.0
    296  * @uses apply_filters()
    297392 *
    298393 * @param string $type Optional, default is the type returned by get_default_feed().
    299394 * @return string All of the post categories for displaying in the feed.
     
    329424                        $the_list .= "\t\t<category><![CDATA[" . @html_entity_decode( $cat_name, ENT_COMPAT, get_option('blog_charset') ) . "]]></category>\n";
    330425        }
    331426
    332         return apply_filters('the_category_rss', $the_list, $type);
     427        /**
     428         * Filter all of the post categories for display in a feed.
     429         *
     430         * @since 2.2.0
     431         *
     432         * @param string $the_list All of the RSS post categories.
     433         * @param string $type     Type of feed. Possible values include 'rss2', 'atom'.
     434         *                         Default 'rss2'.
     435         */
     436        return apply_filters( 'the_category_rss', $the_list, $type );
    333437}
    334438
    335439/**
     
    379483 * @package WordPress
    380484 * @subpackage Template
    381485 * @since 1.5.0
    382  * @uses apply_filters() Calls 'rss_enclosure' hook on rss enclosure.
    383486 * @uses get_post_custom() To get the current post enclosure metadata.
    384487 */
    385488function rss_enclosure() {
     
    395498                                $t = preg_split('/[ \t]/', trim($enclosure[2]) );
    396499                                $type = $t[0];
    397500
    398                                 echo apply_filters('rss_enclosure', '<enclosure url="' . trim(htmlspecialchars($enclosure[0])) . '" length="' . trim($enclosure[1]) . '" type="' . $type . '" />' . "\n");
     501                                /**
     502                                 * Filter the RSS enclosure HTML enclosure tag for the current post.
     503                                 *
     504                                 * @since 2.2.0
     505                                 *
     506                                 * @param string $string The link HTML tag with a URI and other attributes.
     507                                 */
     508                                echo apply_filters( 'rss_enclosure', '<enclosure url="' . trim(htmlspecialchars($enclosure[0])) . '" length="' . trim($enclosure[1]) . '" type="' . $type . '" />' . "\n" );
    399509                        }
    400510                }
    401511        }
     
    415525 * @package WordPress
    416526 * @subpackage Template
    417527 * @since 2.2.0
    418  * @uses apply_filters() Calls 'atom_enclosure' hook on atom enclosure.
    419528 * @uses get_post_custom() To get the current post enclosure metadata.
    420529 */
    421530function atom_enclosure() {
     
    426535                if ($key == 'enclosure') {
    427536                        foreach ( (array) $val as $enc ) {
    428537                                $enclosure = explode("\n", $enc);
    429                                 echo apply_filters('atom_enclosure', '<link href="' . trim(htmlspecialchars($enclosure[0])) . '" rel="enclosure" length="' . trim($enclosure[1]) . '" type="' . trim($enclosure[2]) . '" />' . "\n");
     538                                /**
     539                                 * Filter the atom enclosure HTML link tag for the current post.
     540                                 *
     541                                 * @since 2.2.0
     542                                 *
     543                                 * @param string $string The link HTML tag with a URI and other attributes.
     544                                 */
     545                                echo apply_filters( 'atom_enclosure', '<link href="' . trim(htmlspecialchars($enclosure[0])) . '" rel="enclosure" length="' . trim($enclosure[1]) . '" type="' . trim($enclosure[2]) . '" />' . "\n" );
    430546                        }
    431547                }
    432548        }
     
    488604 */
    489605function self_link() {
    490606        $host = @parse_url(home_url());
     607        /**
     608         * Filter a feed URL.
     609         *
     610         * @since 3.6.0
     611         *
     612         * @see set_url_scheme()
     613         * @see wp_unslash()
     614         *
     615         * @param string $string The link for the feed with set scheme.
     616         */
    491617        echo esc_url( apply_filters( 'self_link', set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) );
    492618}
    493619
     
    512638
    513639        $content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream';
    514640
     641        /**
     642         * Filter a feed content type.
     643         *
     644         * @since 2.8.0
     645         *
     646         * @param string $content_type Media type indicating the type of data that a feed contains.
     647         * @param string $type         Type of feed. Possible values include 'rss2', 'atom'.
     648         *                             Default 'rss2'.
     649         */
    515650        return apply_filters( 'feed_content_type', $content_type, $type );
    516651}
    517652
     
    541676
    542677        $feed->set_feed_url( $url );
    543678        $feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) );
     679        /**
     680         * Fires just before processing the SimplePie feed object.
     681         *
     682         * @since 3.0.0
     683         *
     684         * @param object &$feed SimplePie feed object, passed by reference.
     685         * @param mixed  $url   URL of feed to retrieve. If an array of URLs, the feeds are merged.
     686         */
    544687        do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
    545688        $feed->init();
    546689        $feed->handle_content_type();