Changeset 25532

Timestamp:

09/20/2013 11:01:01 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation of hooks for wp-includes/feed-rss2-comments.php.

Props dustyf.
See #25229.

File:

• trunk/src/wp-includes/feed-rss2-comments.php (modified) (3 diffs)

trunk/src/wp-includes/feed-rss2-comments.php

@@ -15 +15 @@
     xmlns:atom="http://www.w3.org/2005/Atom"
     xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
-    <?php do_action('rss2_ns'); do_action('rss2_comments_ns'); ?>
-    >
+    <?php 
+    //duplicate_hook 
+    do_action( 'rss2_ns' );
+    ?>
+
+    <?php 
+    /**
+     * Fires at the end of the RSS root to add namespaces.
+     *
+     * @since 2.8.0
+     */
+    do_action( 'rss2_comments_ns' );
+    ?>
+>
 <channel>
     <title><?php
@@ -30 +42 @@
     <description><?php bloginfo_rss("description") ?></description>
     <lastBuildDate><?php echo mysql2date('r', get_lastcommentmodified('GMT')); ?></lastBuildDate>
+    <?php //duplicate_hook ?>
     <sy:updatePeriod><?php echo apply_filters( 'rss_update_period', 'hourly' ); ?></sy:updatePeriod>
+    <?php //duplicate_hook ?>
     <sy:updateFrequency><?php echo apply_filters( 'rss_update_frequency', '1' ); ?></sy:updateFrequency>
-    <?php do_action('commentsrss2_head'); ?>
-<?php
-if ( have_comments() ) : while ( have_comments() ) : the_comment();
-    $comment_post = $GLOBALS['post'] = get_post( $comment->comment_post_ID );
-?>
+    <?php 
+    /**
+     * Fires at the end of the RSS2 comment feed header.
+     *
+     * @since 2.3.0
+     */
+    do_action( 'commentsrss2_head' );
+
+    if ( have_comments() ) : while ( have_comments() ) : the_comment();
+        $comment_post = $GLOBALS['post'] = get_post( $comment->comment_post_ID );
+    ?>
     <item>
         <title><?php
             if ( !is_singular() ) {
                 $title = get_the_title($comment_post->ID);
+                //duplicate_hook
                 $title = apply_filters('the_title_rss', $title);
                 printf(ent2ncr(__('Comment on %1$s by %2$s')), $title, get_comment_author_rss());
@@ -58 +79 @@
         <content:encoded><![CDATA[<?php comment_text() ?>]]></content:encoded>
 <?php endif; // post pass
-    do_action('commentrss2_item', $comment->comment_ID, $comment_post->ID);
+    /**
+     * Fires at the end of each RSS2 comment feed item.
+     *
+     * @since 2.1.0
+     *
+     * @param int $comment->comment_ID The ID of the comment being displayed.
+     * @param int $comment_post->ID    The ID of the post the comment is connected to.
+     */
+    do_action( 'commentrss2_item', $comment->comment_ID, $comment_post->ID );
 ?>
     </item>