sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Use third-person singular verbs for function descriptions in wp-includes/category-template.php, per the documentation standards.

Browse Source 
See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@47545 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-04-02 15:49:53 +00:00
parent 561842636f
commit dfa959bbd5
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/wp-includes/category-template.php
View File

@ -8,7 +8,7 @@
*/
/**
* Retrieve category link URL.
* Retrieves category link URL.
*
* @since 1.0.0
* @see get_term_link()
@ -31,7 +31,7 @@ function get_category_link( $category ) {
}
/**
* Retrieve category parents with separator.
* Retrieves category parents with separator.
*
* @since 1.2.0
* @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
@ -61,7 +61,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
}
/**
* Retrieve post categories.
* Retrieves post categories.
*
* This tag may be used outside The Loop by passing a post id as the parameter.
*
@ -98,7 +98,7 @@ function get_the_category( $id = false ) {
}
/**
* Retrieve category name based on category ID.
* Retrieves category name based on category ID.
*
* @since 0.71
*
@ -117,7 +117,7 @@ function get_the_category_by_ID( $cat_ID ) { // phpcs:ignore WordPress.NamingCon
}
/**
* Retrieve category list for a post in either HTML list or custom format.
* Retrieves category list for a post in either HTML list or custom format.
*
* @since 1.5.1
*
@ -251,7 +251,7 @@ function in_category( $category, $post = null ) {
}
/**
* Display category list for a post in either HTML list or custom format.
* Displays category list for a post in either HTML list or custom format.
*
* @since 0.71
*
@ -265,7 +265,7 @@ function the_category( $separator = '', $parents = '', $post_id = false ) {
}
/**
* Retrieve category description.
* Retrieves category description.
*
* @since 1.0.0
*
@ -277,7 +277,7 @@ function category_description( $category = 0 ) {
}
/**
* Display or retrieve the HTML dropdown list of categories.
* Displays or retrieves the HTML dropdown list of categories.
*
* The 'hierarchical' argument, which is disabled by default, will override the
* depth argument, unless it is true. When the argument is false, it will
@ -465,7 +465,7 @@ function wp_dropdown_categories( $args = '' ) {
}
/**
* Display or retrieve the HTML list of categories.
* Displays or retrieves the HTML list of categories.
*
* @since 2.1.0
* @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments.
@ -1058,7 +1058,7 @@ function _wp_object_count_sort_cb( $a, $b ) {
//
/**
* Retrieve HTML list content for category list.
* Retrieves HTML list content for category list.
*
* @since 2.1.0
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
@ -1081,7 +1081,7 @@ function walk_category_tree( ...$args ) {
}
/**
* Retrieve HTML dropdown (select) content for category list.
* Retrieves HTML dropdown (select) content for category list.
*
* @since 2.1.0
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
@ -1108,7 +1108,7 @@ function walk_category_dropdown_tree( ...$args ) {
//
/**
* Retrieve the link to the tag.
* Retrieves the link to the tag.
*
* @since 2.3.0
* @see get_term_link()
@ -1121,7 +1121,7 @@ function get_tag_link( $tag ) {
}
/**
* Retrieve the tags for a post.
* Retrieves the tags for a post.
*
* @since 2.3.0
*
@ -1143,7 +1143,7 @@ function get_the_tags( $id = 0 ) {
}
/**
* Retrieve the tags for a post formatted as a string.
* Retrieves the tags for a post formatted as a string.
*
* @since 2.3.0
*
@ -1170,7 +1170,7 @@ function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
}
/**
* Retrieve the tags for a post.
* Retrieves the tags for a post.
*
* @since 2.3.0
*
@ -1191,7 +1191,7 @@ function the_tags( $before = null, $sep = ', ', $after = '' ) {
}
/**
* Retrieve tag description.
* Retrieves tag description.
*
* @since 2.8.0
*
@ -1203,7 +1203,7 @@ function tag_description( $tag = 0 ) {
}
/**
* Retrieve term description.
* Retrieves term description.
*
* @since 2.8.0
* @since 4.9.2 The `$taxonomy` parameter was deprecated.
@ -1224,7 +1224,7 @@ function term_description( $term = 0, $deprecated = null ) {
}
/**
* Retrieve the terms of the taxonomy that are attached to the post.
* Retrieves the terms of the taxonomy that are attached to the post.
*
* @since 2.5.0
*
@ -1267,7 +1267,7 @@ function get_the_terms( $post, $taxonomy ) {
}
/**
* Retrieve a post's terms as a list with specified format.
* Retrieves a post's terms as a list with specified format.
*
* @since 2.5.0
*
@ -1315,7 +1315,7 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
}
/**
* Retrieve term parents with separator.
* Retrieves term parents with separator.
*
* @since 4.8.0
*
@ -1380,7 +1380,7 @@ function get_term_parents_list( $term_id, $taxonomy, $args = array() ) {
}
/**
* Display the terms in a list.
* Displays the terms in a list.
*
* @since 2.5.0
*
@ -1413,7 +1413,7 @@ function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
}
/**
* Check if the current post has any of given category.
* Checks if the current post has any of given category.
*
* @since 3.1.0
*
@ -1451,7 +1451,7 @@ function has_tag( $tag = '', $post = null ) {
}
/**
* Check if the current post has any of given terms.
* Checks if the current post has any of given terms.
*
* The given terms are checked against the post's terms' term_ids, names and slugs.
* Terms given as integers will only be checked against the post's terms' term_ids.