WP_Taxonomy

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 2

Every hook that fires from inside WP_Taxonomy, in the order it appears in the class, grouped by the method that fires it.

Properties · 30

$namestringpublic

Taxonomy key.

$labelstringpublic

Name of the taxonomy shown in the menu. Usually plural.

$labelsstdClasspublic

Labels object for this taxonomy.

$default_labels(string|null)[][]protected static

Default labels.

$descriptionstringpublic

A short descriptive summary of what the taxonomy is for.

$publicboolpublic

Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.

$publicly_queryableboolpublic

Whether the taxonomy is publicly queryable.

$hierarchicalboolpublic

Whether the taxonomy is hierarchical.

$show_uiboolpublic

Whether to generate and allow a UI for managing terms in this taxonomy in the admin.

$show_in_menuboolpublic

Whether to show the taxonomy in the admin menu.

$show_in_nav_menusboolpublic

Whether the taxonomy is available for selection in navigation menus.

$show_tagcloudboolpublic

Whether to list the taxonomy in the tag cloud widget controls.

$show_in_quick_editboolpublic

Whether to show the taxonomy in the quick/bulk edit panel.

$show_admin_columnboolpublic

Whether to display a column for the taxonomy on its post type listing screens.

$meta_box_cbbool|callablepublic

The callback function for the meta box display.

$meta_box_sanitize_cbcallablepublic

The callback function for sanitizing taxonomy data saved from a meta box.

$object_typestring[]public

An array of object types this taxonomy is registered for.

$capstdClasspublic

Capabilities for this taxonomy.

$rewritearray|falsepublic

Rewrites information for this taxonomy.

$query_varstring|falsepublic

Query var string for this taxonomy.

$update_count_callbackcallablepublic

Function that will be called when the count is updated.

$show_in_restboolpublic

Whether this taxonomy should appear in the REST API.

$rest_basestring|boolpublic

The base path for this taxonomy's REST API endpoints.

$rest_namespacestring|boolpublic

The namespace for this taxonomy's REST API endpoints.

$rest_controller_classstring|boolpublic

The controller for this taxonomy's REST API endpoints.

$rest_controllerWP_REST_Controllerpublic

The controller instance for this taxonomy's REST API endpoints.

$default_termarray|stringpublic

The default term name for this taxonomy. If you pass an array you have to set 'name' and optionally 'slug' and 'description'.

$sortbool|nullpublic

Whether terms in this taxonomy should be sorted in the order they are provided to wp_set_object_terms().

$argsarray|nullpublic

Array of arguments to automatically use inside wp_get_object_terms() for this taxonomy.

$_builtinboolpublic

Whether it is a built-in taxonomy.

Methods · 9

• __construct()Constructor.
• set_props()Sets taxonomy properties.
• add_rewrite_rules()Adds the necessary rewrite rules for the taxonomy.
• remove_rewrite_rules()Removes any rewrite rules, permastructs, and rules for the taxonomy.
• add_hooks()Registers the ajax callback for the meta box.
• remove_hooks()Removes the ajax callback for the meta box.
• get_rest_controller()Gets the REST API controller for this taxonomy.
• get_default_labels()Returns the default labels for taxonomies.
• reset_default_labels()Resets the cache for the default labels.

Source code

View on Trac ↗View on GitHub ↗

15#[AllowDynamicProperties]16final class WP_Taxonomy {17	/**18	 * Taxonomy key.19	 *20	 * @since 4.7.021	 * @var string22	 */23	public $name;24 25	/**26	 * Name of the taxonomy shown in the menu. Usually plural.27	 *28	 * @since 4.7.029	 * @var string30	 */31	public $label;32 33	/**34	 * Labels object for this taxonomy.35	 *36	 * If not set, tag labels are inherited for non-hierarchical types37	 * and category labels for hierarchical ones.38	 *39	 * @see get_taxonomy_labels()40	 *41	 * @since 4.7.042	 * @var stdClass43	 */44	public $labels;45 46	/**47	 * Default labels.48	 *49	 * @since 6.0.050	 * @var (string|null)[][] $default_labels51	 */52	protected static $default_labels = array();53 54	/**55	 * A short descriptive summary of what the taxonomy is for.56	 *57	 * @since 4.7.058	 * @var string59	 */60	public $description = '';61 62	/**63	 * Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.64	 *65	 * @since 4.7.066	 * @var bool67	 */68	public $public = true;69 70	/**71	 * Whether the taxonomy is publicly queryable.72	 *73	 * @since 4.7.074	 * @var bool75	 */76	public $publicly_queryable = true;77 78	/**79	 * Whether the taxonomy is hierarchical.80	 *81	 * @since 4.7.082	 * @var bool83	 */84	public $hierarchical = false;85 86	/**87	 * Whether to generate and allow a UI for managing terms in this taxonomy in the admin.88	 *89	 * @since 4.7.090	 * @var bool91	 */92	public $show_ui = true;93 94	/**

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.