Docs: Standardize filter docs in wp-includes/feed.php to use third-person singular verbs per the inline documentation standards for PHP.
See #36913. git-svn-id: https://develop.svn.wordpress.org/trunk@37516 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
parent
0e34dac34a
commit
4fd2c46d89
@ -25,7 +25,7 @@
|
||||
function get_bloginfo_rss($show = '') {
|
||||
$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
|
||||
*
|
||||
@ -52,7 +52,7 @@ function get_bloginfo_rss($show = '') {
|
||||
*/
|
||||
function bloginfo_rss($show = '') {
|
||||
/**
|
||||
* Filter the bloginfo for display in RSS feeds.
|
||||
* Filters the bloginfo for display in RSS feeds.
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
@ -76,7 +76,7 @@ function bloginfo_rss($show = '') {
|
||||
*/
|
||||
function get_default_feed() {
|
||||
/**
|
||||
* Filter the default feed type.
|
||||
* Filters the default feed type.
|
||||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
@ -103,7 +103,7 @@ function get_wp_title_rss( $deprecated = '–' ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the blog title for use as the feed title.
|
||||
* Filters the blog title for use as the feed title.
|
||||
*
|
||||
* @since 2.2.0
|
||||
* @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.
|
||||
@ -129,7 +129,7 @@ function wp_title_rss( $deprecated = '–' ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the blog title for display of the feed title.
|
||||
* Filters the blog title for display of the feed title.
|
||||
*
|
||||
* @since 2.2.0
|
||||
* @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.
|
||||
@ -153,7 +153,7 @@ function get_the_title_rss() {
|
||||
$title = get_the_title();
|
||||
|
||||
/**
|
||||
* Filter the post title for use in a feed.
|
||||
* Filters the post title for use in a feed.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
@ -189,7 +189,7 @@ function get_the_content_feed($feed_type = null) {
|
||||
$content = apply_filters( 'the_content', get_the_content() );
|
||||
$content = str_replace(']]>', ']]>', $content);
|
||||
/**
|
||||
* Filter the post content for use in feeds.
|
||||
* Filters the post content for use in feeds.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
@ -219,7 +219,7 @@ function the_content_feed($feed_type = null) {
|
||||
function the_excerpt_rss() {
|
||||
$output = get_the_excerpt();
|
||||
/**
|
||||
* Filter the post excerpt for a feed.
|
||||
* Filters the post excerpt for a feed.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
@ -235,7 +235,7 @@ function the_excerpt_rss() {
|
||||
*/
|
||||
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
|
||||
*
|
||||
@ -252,7 +252,7 @@ function the_permalink_rss() {
|
||||
*/
|
||||
function comments_link_feed() {
|
||||
/**
|
||||
* Filter the comments permalink for the current post.
|
||||
* Filters the comments permalink for the current post.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
@ -300,7 +300,7 @@ function get_comment_guid($comment_id = null) {
|
||||
*/
|
||||
function comment_link( $comment = null ) {
|
||||
/**
|
||||
* Filter the current comment's permalink.
|
||||
* Filters the current comment's permalink.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
@ -320,7 +320,7 @@ function comment_link( $comment = null ) {
|
||||
*/
|
||||
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
|
||||
*
|
||||
@ -348,7 +348,7 @@ function comment_author_rss() {
|
||||
function comment_text_rss() {
|
||||
$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
|
||||
*
|
||||
@ -402,7 +402,7 @@ function get_the_category_rss($type = null) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
@ -469,7 +469,7 @@ function rss_enclosure() {
|
||||
$type = $t[0];
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
@ -503,7 +503,7 @@ function atom_enclosure() {
|
||||
foreach ( (array) $val as $enc ) {
|
||||
$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
|
||||
*
|
||||
@ -606,7 +606,7 @@ function rss2_site_icon() {
|
||||
function self_link() {
|
||||
$host = @parse_url(home_url());
|
||||
/**
|
||||
* Filter the current feed URL.
|
||||
* Filters the current feed URL.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
@ -640,7 +640,7 @@ function feed_content_type( $type = '' ) {
|
||||
$content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream';
|
||||
|
||||
/**
|
||||
* Filter the content type for a specific feed type.
|
||||
* Filters the content type for a specific feed type.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user