Changeset 37516

Timestamp:

05/22/2016 06:46:29 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Standardize filter docs in wp-includes/feed.php to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

File:

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

trunk/src/wp-includes/feed.php

@@ -26 +26 @@
     $info = strip_tags(get_bloginfo($show));
     /**
-     * Filter the bloginfo for use in RSS feeds.
+     * Filters the bloginfo for use in RSS feeds.
      *
      * @since 2.2.0
@@ -53 +53 @@
 function bloginfo_rss($show = '') {
     /**
-     * Filter the bloginfo for display in RSS feeds.
+     * Filters the bloginfo for display in RSS feeds.
      *
      * @since 2.1.0
@@ -77 +77 @@
 function get_default_feed() {
     /**
-     * Filter the default feed type.
+     * Filters the default feed type.
      *
      * @since 2.5.0
@@ -104 +104 @@
 
     /**
-     * Filter the blog title for use as the feed title.
+     * Filters the blog title for use as the feed title.
      *
      * @since 2.2.0
@@ -130 +130 @@
 
     /**
-     * Filter the blog title for display of the feed title.
+     * Filters the blog title for display of the feed title.
      *
      * @since 2.2.0
@@ -154 +154 @@
 
     /**
-     * Filter the post title for use in a feed.
+     * Filters the post title for use in a feed.
      *
      * @since 1.2.0
@@ -190 +190 @@
     $content = str_replace(']]>', ']]>', $content);
     /**
-     * Filter the post content for use in feeds.
+     * Filters the post content for use in feeds.
      *
      * @since 2.9.0
@@ -220 +220 @@
     $output = get_the_excerpt();
     /**
-     * Filter the post excerpt for a feed.
+     * Filters the post excerpt for a feed.
      *
      * @since 1.2.0
@@ -236 +236 @@
 function the_permalink_rss() {
     /**
-     * Filter the permalink to the post for use in feeds.
+     * Filters the permalink to the post for use in feeds.
      *
      * @since 2.3.0
@@ -253 +253 @@
 function comments_link_feed() {
     /**
-     * Filter the comments permalink for the current post.
+     * Filters the comments permalink for the current post.
      *
      * @since 3.6.0
@@ -301 +301 @@
 function comment_link( $comment = null ) {
     /**
-     * Filter the current comment's permalink.
+     * Filters the current comment's permalink.
      *
      * @since 3.6.0
@@ -321 +321 @@
 function get_comment_author_rss() {
     /**
-     * Filter the current comment author for use in a feed.
+     * Filters the current comment author for use in a feed.
      *
      * @since 1.5.0
@@ -349 +349 @@
     $comment_text = get_comment_text();
     /**
-     * Filter the current comment content for use in a feed.
+     * Filters the current comment content for use in a feed.
      *
      * @since 1.5.0
@@ -403 +403 @@
 
     /**
-     * Filter all of the post categories for display in a feed.
+     * Filters all of the post categories for display in a feed.
      *
      * @since 1.2.0
@@ -470 +470 @@
 
                 /**
-                 * Filter the RSS enclosure HTML link tag for the current post.
+                 * Filters the RSS enclosure HTML link tag for the current post.
                  *
                  * @since 2.2.0
@@ -504 +504 @@
                 $enclosure = explode("\n", $enc);
                 /**
-                 * Filter the atom enclosure HTML link tag for the current post.
+                 * Filters the atom enclosure HTML link tag for the current post.
                  *
                  * @since 2.2.0
@@ -607 +607 @@
     $host = @parse_url(home_url());
     /**
-     * Filter the current feed URL.
+     * Filters the current feed URL.
      *
      * @since 3.6.0
@@ -641 +641 @@
 
     /**
-     * Filter the content type for a specific feed type.
+     * Filters the content type for a specific feed type.
      *
      * @since 2.8.0