Docs: Standardize filter docs in wp-includes/link-template.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@37499 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-22 18:26:44 +00:00
parent 14ca371c1c
commit 64ac60b8d3
1 changed files with 15 additions and 15 deletions

View File

@ -172,7 +172,7 @@ function get_permalink( $post = 0, $leavename = false ) {
usort($cats, '_usort_terms_by_ID'); // order by ID usort($cats, '_usort_terms_by_ID'); // order by ID
/** /**
* Filter the category that gets used in the %category% permalink token. * Filters the category that gets used in the %category% permalink token.
* *
* @since 3.5.0 * @since 3.5.0
* *
@ -316,7 +316,7 @@ function get_page_link( $post = false, $leavename = false, $sample = false ) {
$link = _get_page_link( $post, $leavename, $sample ); $link = _get_page_link( $post, $leavename, $sample );
/** /**
* Filter the permalink for a page. * Filters the permalink for a page.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -364,7 +364,7 @@ function _get_page_link( $post = false, $leavename = false, $sample = false ) {
} }
/** /**
* Filter the permalink for a non-page_on_front page. * Filters the permalink for a non-page_on_front page.
* *
* @since 2.1.0 * @since 2.1.0
* *
@ -535,7 +535,7 @@ function get_day_link($year, $month, $day) {
} }
/** /**
* Filter the day archive permalink. * Filters the day archive permalink.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -816,7 +816,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
if ( 'category' == $taxonomy ) { if ( 'category' == $taxonomy ) {
/** /**
* Filter the category feed link. * Filters the category feed link.
* *
* @since 1.5.1 * @since 1.5.1
* *
@ -826,7 +826,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
$link = apply_filters( 'category_feed_link', $link, $feed ); $link = apply_filters( 'category_feed_link', $link, $feed );
} elseif ( 'post_tag' == $taxonomy ) { } elseif ( 'post_tag' == $taxonomy ) {
/** /**
* Filter the post tag feed link. * Filters the post tag feed link.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -836,7 +836,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
$link = apply_filters( 'tag_feed_link', $link, $feed ); $link = apply_filters( 'tag_feed_link', $link, $feed );
} else { } else {
/** /**
* Filter the feed link for a taxonomy other than 'category' or 'post_tag'. * Filters the feed link for a taxonomy other than 'category' or 'post_tag'.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -874,7 +874,7 @@ function get_tag_feed_link( $tag_id, $feed = '' ) {
*/ */
function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) { function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
/** /**
* Filter the edit link for a tag (or term in another taxonomy). * Filters the edit link for a tag (or term in another taxonomy).
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -1397,7 +1397,7 @@ function get_edit_comment_link( $comment_id = 0 ) {
$location = admin_url('comment.php?action=editcomment&c=') . $comment->comment_ID; $location = admin_url('comment.php?action=editcomment&c=') . $comment->comment_ID;
/** /**
* Filter the comment edit link. * Filters the comment edit link.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -1457,7 +1457,7 @@ function get_edit_bookmark_link( $link = 0 ) {
$location = admin_url('link.php?action=edit&link_id=') . $link->link_id; $location = admin_url('link.php?action=edit&link_id=') . $link->link_id;
/** /**
* Filter the bookmark edit link. * Filters the bookmark edit link.
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -1525,7 +1525,7 @@ function get_edit_user_link( $user_id = null ) {
$link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) ); $link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) );
/** /**
* Filter the user edit link. * Filters the user edit link.
* *
* @since 3.5.0 * @since 3.5.0
* *
@ -2213,7 +2213,7 @@ function get_next_posts_link( $label = null, $max_page = 0 ) {
if ( !is_single() && ( $nextpage <= $max_page ) ) { if ( !is_single() && ( $nextpage <= $max_page ) ) {
/** /**
* Filter the anchor tag attributes for the next posts page link. * Filters the anchor tag attributes for the next posts page link.
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -2296,7 +2296,7 @@ function get_previous_posts_link( $label = null ) {
if ( !is_single() && $paged > 1 ) { if ( !is_single() && $paged > 1 ) {
/** /**
* Filter the anchor tag attributes for the previous posts page link. * Filters the anchor tag attributes for the previous posts page link.
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -2730,7 +2730,7 @@ function get_previous_comments_link( $label = '' ) {
$label = __('&laquo; Older Comments'); $label = __('&laquo; Older Comments');
/** /**
* Filter the anchor tag attributes for the previous comments page link. * Filters the anchor tag attributes for the previous comments page link.
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -3900,7 +3900,7 @@ function get_avatar_data( $id_or_email, $args = null ) {
$user = get_user_by( 'id', (int) $id_or_email->post_author ); $user = get_user_by( 'id', (int) $id_or_email->post_author );
} elseif ( $id_or_email instanceof WP_Comment ) { } elseif ( $id_or_email instanceof WP_Comment ) {
/** /**
* Filter the list of allowed comment types for retrieving avatars. * Filters the list of allowed comment types for retrieving avatars.
* *
* @since 3.0.0 * @since 3.0.0
* *