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

Docs: Improve return descriptions for `get_the_category()` and `get_the_term()` to specifically notate that an array of `WP_Term` objects is returned on success. 

See #32246. 


git-svn-id: https://develop.svn.wordpress.org/trunk@37615 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-06-01 22:45:19 +00:00
parent b3dcb1ad05
commit 23aa6afccb
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -74,7 +74,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
* @since 0.71 * @since 0.71
* *
* @param int $id Optional, default to current post ID. The post ID. * @param int $id Optional, default to current post ID. The post ID.
* @return array Array of objects, one for each category assigned to the post. * @return array Array of WP_Term objects, one for each category assigned to the post.
*/ */
function get_the_category( $id = false ) { function get_the_category( $id = false ) {
$categories = get_the_terms( $id, 'category' ); $categories = get_the_terms( $id, 'category' );
@ -1185,7 +1185,7 @@ function term_description( $term = 0, $taxonomy = 'post_tag' ) {
* *
* @param int|object $post Post ID or object. * @param int|object $post Post ID or object.
* @param string $taxonomy Taxonomy name. * @param string $taxonomy Taxonomy name.
* @return array|false|WP_Error Array of term objects on success, false if there are no terms * @return array|false|WP_Error Array of WP_Term objects on success, false if there are no terms
* or the post does not exist, WP_Error on failure. * or the post does not exist, WP_Error on failure.
*/ */
function get_the_terms( $post, $taxonomy ) { function get_the_terms( $post, $taxonomy ) {