Changeset 25530

Timestamp:

09/20/2013 10:26:08 PM (11 years ago)

Author:

DrewAPicture

Message:

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

Props dustyf for the initial patch.
See #25229.

File:

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

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

@@ -18 +18 @@
     xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
     xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
-    <?php do_action('rss2_ns'); ?>
+    <?php
+    /**
+     * Fires at the end of the RSS root to add namespaces.
+     *
+     * @since 2.0.0
+     */
+    do_action( 'rss2_ns' );
+    ?>
 >
 
@@ -28 +35 @@
     <lastBuildDate><?php echo mysql2date('D, d M Y H:i:s +0000', get_lastpostmodified('GMT'), false); ?></lastBuildDate>
     <language><?php bloginfo_rss( 'language' ); ?></language>
-    <sy:updatePeriod><?php echo apply_filters( 'rss_update_period', 'hourly' ); ?></sy:updatePeriod>
-    <sy:updateFrequency><?php echo apply_filters( 'rss_update_frequency', '1' ); ?></sy:updateFrequency>
-    <?php do_action('rss2_head'); ?>
-    <?php while( have_posts()) : the_post(); ?>
+    <?php
+    $duration = 'hourly';
+    /**
+     * Filter how often to update the RSS feed.
+     *
+     * @since 2.1.0
+     *
+     * @param string $duration The update period.
+     *                         Default 'hourly'. Accepts 'hourly', 'daily', 'weekly', 'monthly', 'yearly'.
+     */
+    ?>
+    <sy:updatePeriod><?php echo apply_filters( 'rss_update_period', $duration ); ?></sy:updatePeriod>
+    <?php
+    $frequency = '1';
+    /**
+     * Filter the RSS update frequency.
+     *
+     * @since 2.1.0
+     *
+     * @param string $frequency An integer passed as a string representing the frequency
+     *                          of RSS updates within the update period. Default '1'.
+     */
+    ?>
+    <sy:updateFrequency><?php echo apply_filters( 'rss_update_frequency', $frequency ); ?></sy:updateFrequency>
+    <?php
+    /**
+     * Fires at the end of the RSS2 Feed Header.
+     *
+     * @since 2.0.0
+     */
+    do_action( 'rss2_head');
+
+    while( have_posts()) : the_post();
+    ?>
     <item>
         <title><?php the_title_rss() ?></title>
@@ -55 +92 @@
         <slash:comments><?php echo get_comments_number(); ?></slash:comments>
 <?php rss_enclosure(); ?>
-    <?php do_action('rss2_item'); ?>
+    <?php
+    /**
+     * Fires at the end of each RSS2 feed item.
+     *
+     * @since 2.0.0
+     */
+    do_action( 'rss2_item' );
+    ?>
     </item>
     <?php endwhile; ?>