Taxonomy: Declare and document the sort and args properties of the WP_Taxonomy class.

These properties have been in use since 2.5 and 2.6 but were never added as actual properties on the class. This fixes that.

Props gunnard, SergeyBiryukov

Fixes #52142


git-svn-id: https://develop.svn.wordpress.org/trunk@50116 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2021-01-31 23:13:50 +00:00
parent 15d786e91a
commit 66567d3191
2 changed files with 24 additions and 0 deletions

View File

@ -228,6 +228,24 @@ final class WP_Taxonomy {
*/
public $rest_controller;
/**
* Whether terms in this taxonomy should be sorted in the order they are provided to `wp_set_object_terms()`.
*
* Use this in combination with `'orderby' => 'term_order'` when fetching terms.
*
* @since 2.5.0
* @var bool|null
*/
public $sort = null;
/**
* Array of arguments to automatically use inside `wp_get_object_terms()` for this taxonomy.
*
* @since 2.6.0
* @var array|null
*/
public $args = null;
/**
* Whether it is a built-in taxonomy.
*
@ -304,6 +322,8 @@ final class WP_Taxonomy {
'rest_controller_class' => false,
'default_term' => null,
'_builtin' => false,
'sort' => null,
'args' => null,
);
$args = array_merge( $defaults, $args );

View File

@ -414,6 +414,10 @@ function is_taxonomy_hierarchical( $taxonomy ) {
* @type string $slug Slug for default term. Default empty.
* @type string $description Description for default term. Default empty.
* }
* @type bool $sort Whether terms in this taxonomy should be sorted in the order they are
* provided to `wp_set_object_terms()`. Default null which equates to false.
* @type array $args Array of arguments to automatically use inside `wp_get_object_terms()`
* for this taxonomy.
* @type bool $_builtin This taxonomy is a "built-in" taxonomy. INTERNAL USE ONLY!
* Default false.
* }