Changeset 26863 for trunk/src/wp-includes/feed-atom-comments.php

Timestamp:

12/21/2013 08:21:20 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/feed-atom-comments.php.

Props dustyf, piontkowski, kpdesign.
Fixes #26532.

File:

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

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

@@ -13 +13 @@
     xml:lang="<?php bloginfo_rss( 'language' ); ?>"
     xmlns:thr="http://purl.org/syndication/thread/1.0"
-    <?php do_action('atom_ns'); do_action('atom_comments_ns'); ?>
+    <?php 
+        /** This action is documented in wp-includes/feed-atom.php */
+        do_action( 'atom_ns' ); 
+        
+        /**
+         * Fires inside the feed tag in the Atom comment feed.
+         *
+         * @since 2.8.0
+         */
+        do_action( 'atom_comments_ns' );
+    ?>
 >
     <title type="text"><?php
@@ -40 +50 @@
     <id><?php bloginfo_rss('comments_atom_url'); ?></id>
 <?php } ?>
-<?php do_action('comments_atom_head'); ?>
+<?php 
+    /**
+     * Fires at the end of the Atom comment feed header.
+     *
+     * @since 2.8.0
+     */
+    do_action( 'comments_atom_head' );
+?>
 <?php
 if ( have_comments() ) : while ( have_comments() ) : the_comment();
@@ -81 +98 @@
         <thr:in-reply-to ref="<?php comment_guid($parent_comment) ?>" href="<?php echo get_comment_link($parent_comment) ?>" type="<?php bloginfo_rss('html_type'); ?>" />
 <?php endif;
-    do_action('comment_atom_entry', $comment->comment_ID, $comment_post->ID);
+    /**
+     * Fires at the end of each Atom comment feed item.
+     *
+     * @since 2.2.0
+     *
+     * @param int $comment_id      ID of the current comment.
+     * @param int $comment_post_id ID of the post the current comment is connected to.
+     */
+    do_action( 'comment_atom_entry', $comment->comment_ID, $comment_post->ID );
 ?>
     </entry>