WordPress.org

Make WordPress Core

Ticket #26253: 26253.diff

File 26253.diff, 8.1 KB (added by stevenkword, 8 years ago)
  • wp-includes/feed.php

     
    2727 */
    2828function get_bloginfo_rss($show = '') {
    2929        $info = strip_tags(get_bloginfo($show));
     30        /**
     31         * Filter the bloginfo for use in feeds.
     32         *
     33         * @since 2.2.0
     34         *
     35         * @param string $string Converted string value of the blog information.
     36         * @param string $show   Optional keyword naming the blog information you want.
     37         */
    3038        return apply_filters('get_bloginfo_rss', convert_chars($info), $show);
    3139}
    3240
     
    4654 * @param string $show See get_bloginfo() for possible values.
    4755 */
    4856function bloginfo_rss($show = '') {
     57        /**
     58         * Filter the RSS container for the bloginfo for use in feeds.
     59         *
     60         * @since 2.1.0
     61         *
     62         * @param string $string RSS container for the blog information.
     63         * @param string $show   Optional keyword naming the blog information you want.
     64         */
    4965        echo apply_filters('bloginfo_rss', get_bloginfo_rss($show), $show);
    5066}
    5167
     
    6379 * @return string Default feed, or for example 'rss2', 'atom', etc.
    6480 */
    6581function get_default_feed() {
     82        /**
     83         * Filter the default feed type.
     84         *
     85         * @since 2.5.0
     86         *
     87         * @param string $feed_type Default feed type, for example 'rss2', 'atom', etc.
     88         */
    6689        $default_feed = apply_filters('default_feed', 'rss2');
    6790        return 'rss' == $default_feed ? 'rss2' : $default_feed;
    6891}
     
    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 the feed title.
     111         *
     112         * @since 2.2.0
     113         *
     114         * @param string $title The current post title returned by wp_title().
     115         * @param string $sep   Optional separator.
     116         */
    86117        $title = apply_filters( 'get_wp_title_rss', $title, $sep );
    87118        return $title;
    88119}
     
    99130 * @param string $sep Optional.
    100131 */
    101132function wp_title_rss( $sep = '»' ) {
     133        /**
     134         * Filter the the blog title for display of the feed title.
     135         *
     136         * @since 2.2.0
     137         *
     138         * @param string $string The current post title returned by get_wp_title_rss().
     139         * @param string $sep    Optional separator.
     140         */
    102141        echo apply_filters( 'wp_title_rss', get_wp_title_rss( $sep ), $sep );
    103142}
    104143
     
    114153 */
    115154function get_the_title_rss() {
    116155        $title = get_the_title();
     156        /**
     157         * Filter the post title for the feed.
     158         *
     159         * @since 1.2.1
     160         *
     161         * @param string $title The current post title returned by get_the_title().
     162         */
    117163        $title = apply_filters('the_title_rss', $title);
    118164        return $title;
    119165}
     
    146192        if ( !$feed_type )
    147193                $feed_type = get_default_feed();
    148194
     195        /** This filter is documented in wp-admin/post-template.php */
    149196        $content = apply_filters('the_content', get_the_content());
    150197        $content = str_replace(']]>', ']]>', $content);
     198        /**
     199         * Filter the post content for use in feeds.
     200         *
     201         * @since 2.9.0
     202         *
     203         * @param string $content   The current post content.
     204         * @param string $feed_type Feed type returned by get_default_feed(), for example 'rss2', 'atom', etc.
     205         */
    151206        return apply_filters('the_content_feed', $content, $feed_type);
    152207}
    153208
     
    176231 */
    177232function the_excerpt_rss() {
    178233        $output = get_the_excerpt();
     234        /**
     235         * Filter the post excerpt for the feed.
     236         *
     237         * @since 1.2.1
     238         *
     239         * @param string $output The current post excerpt returned by get_the_excerpt().
     240         */
    179241        echo apply_filters('the_excerpt_rss', $output);
    180242}
    181243
     
    188250 * @uses apply_filters() Call 'the_permalink_rss' on the post permalink
    189251 */
    190252function the_permalink_rss() {
     253        /**
     254         * Filter the permalink to the post for use in feeds.
     255         *
     256         * @since 2.3.0
     257         *
     258         * @param string $string The current post permalink.
     259         */
    191260        echo esc_url( apply_filters('the_permalink_rss', get_permalink() ));
    192261}
    193262
     
    198267 * @return none
    199268 */
    200269function comments_link_feed() {
     270        /**
     271         * Filter the permalink to the comments for the current post.
     272         *
     273         * @since 3.6.0
     274         *
     275         * @param string $string The current comment permalink with '#comments' appended.
     276         */
    201277        echo esc_url( apply_filters( 'comments_link_feed', get_comments_link() ) );
    202278}
    203279
     
    239315 * @since 1.5.0
    240316 */
    241317function comment_link() {
     318        /**
     319         * Filter the permalink to the given comment.
     320         *
     321         * @since 1.5.2
     322         *
     323         * @param string $string The current comment permalink returned by get_comment_link().
     324         */
    242325        echo esc_url( apply_filters( 'comment_link', get_comment_link() ) );
    243326}
    244327
     
    254337 * @return string Comment Author
    255338 */
    256339function get_comment_author_rss() {
     340        /**
     341         * Filter the current comment author for use in the feeds.
     342         *
     343         * @since 1.5.2
     344         *
     345         * @param string $string The current comment author returned by get_comment_author().
     346         */
    257347        return apply_filters('comment_author_rss', get_comment_author() );
    258348}
    259349
     
    279369 */
    280370function comment_text_rss() {
    281371        $comment_text = get_comment_text();
     372        /**
     373         * Filter the current comment content for use in feeds.
     374         *
     375         * @since 1.5.2
     376         *
     377         * @param string $comment_text The comment content returned by get_comment_text().
     378         */
    282379        $comment_text = apply_filters('comment_text_rss', $comment_text);
    283380        echo $comment_text;
    284381}
     
    328425                else
    329426                        $the_list .= "\t\t<category><![CDATA[" . @html_entity_decode( $cat_name, ENT_COMPAT, get_option('blog_charset') ) . "]]></category>\n";
    330427        }
    331 
     428        /**
     429         * Filter all of the post categories for displaying in the feed.
     430         *
     431         * @since 2.2.0
     432         *
     433         * @param string $the_list All of the post categories for displaying in the feed.
     434         * @param string $type     Feed type returned by get_default_feed(), for example 'rss2', 'atom', etc.
     435         */
    332436        return apply_filters('the_category_rss', $the_list, $type);
    333437}
    334438
     
    394498                                // only get the first element, e.g. audio/mpeg from 'audio/mpeg mpga mp2 mp3'
    395499                                $t = preg_split('/[ \t]/', trim($enclosure[2]) );
    396500                                $type = $t[0];
    397 
     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                                 */
    398508                                echo apply_filters('rss_enclosure', '<enclosure url="' . trim(htmlspecialchars($enclosure[0])) . '" length="' . trim($enclosure[1]) . '" type="' . $type . '" />' . "\n");
    399509                        }
    400510                }
     
    426536                if ($key == 'enclosure') {
    427537                        foreach ( (array) $val as $enc ) {
    428538                                $enclosure = explode("\n", $enc);
     539                                /**
     540                                 * Filter the atom enclosure HTML link tag for the current post.
     541                                 *
     542                                 * @since 2.2.0
     543                                 *
     544                                 * @param string $string The link HTML tag with a URI and other attributes.
     545                                 */
    429546                                echo apply_filters('atom_enclosure', '<link href="' . trim(htmlspecialchars($enclosure[0])) . '" rel="enclosure" length="' . trim($enclosure[1]) . '" type="' . trim($enclosure[2]) . '" />' . "\n");
    430547                        }
    431548                }
     
    488605 */
    489606function self_link() {
    490607        $host = @parse_url(home_url());
     608        /**
     609         * Filter the feed URL.
     610         *
     611         * @since 3.6.0
     612         *
     613         * @param string $string The link for the feed with set scheme.
     614         */
    491615        echo esc_url( apply_filters( 'self_link', set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) );
    492616}
    493617
     
    511635        );
    512636
    513637        $content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream';
    514 
     638        /**
     639         * Filter the feed content type.
     640         *
     641         * @since 2.8.0
     642         *
     643         * @param string $content_type Media type indicating the type of data that a feed contains.
     644         * @param string $type         Feed type returned by get_default_feed(), for example 'rss2', 'atom', etc.
     645         */
    515646        return apply_filters( 'feed_content_type', $content_type, $type );
    516647}
    517648
     
    541672
    542673        $feed->set_feed_url( $url );
    543674        $feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) );
     675        /**
     676         * Fires just before processing the SimplePie feed object.
     677         *
     678         * @since 3.0.0
     679         *
     680         * @param object &$feed SimplePie feed object, passed by reference.
     681         * @param mixed  $url   URL of feed to retrieve. If an array of URLs, the feeds are merged.
     682         */
    544683        do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
    545684        $feed->init();
    546685        $feed->handle_content_type();