Docs: Improve @return docblock section for get_category().
This changeset adds more details on the `WP_Term` returned by `get_category()` as it contains additional backwards compatible aliases for the era before WP 4.4 and 2.3. Props apermo, audrasjb. Fixes #62842. See #62281. Built from https://develop.svn.wordpress.org/trunk@59704 git-svn-id: http://core.svn.wordpress.org/trunk@59046 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
@@ -85,7 +85,8 @@ function get_categories( $args = '' ) {
|
|||||||
* correspond to a WP_Term object, an associative array, or a numeric array,
|
* correspond to a WP_Term object, an associative array, or a numeric array,
|
||||||
* respectively. Default OBJECT.
|
* respectively. Default OBJECT.
|
||||||
* @param string $filter Optional. How to sanitize category fields. Default 'raw'.
|
* @param string $filter Optional. How to sanitize category fields. Default 'raw'.
|
||||||
* @return object|array|WP_Error|null Category data in type defined by $output parameter.
|
* @return WP_Term|array|WP_Error|null Category data in type defined by $output parameter.
|
||||||
|
* Returns a WP_Term object with backwards compatible property aliases filled in.
|
||||||
* WP_Error if $category is empty, null if it does not exist.
|
* WP_Error if $category is empty, null if it does not exist.
|
||||||
*/
|
*/
|
||||||
function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
|
function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
|
||||||
|
|||||||
@@ -16,7 +16,7 @@
|
|||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '6.8-alpha-59703';
|
$wp_version = '6.8-alpha-59704';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|||||||
Reference in New Issue
Block a user