10 // Taxonomy Registration
14 * Creates the initial taxonomies.
16 * This function fires twice: in wp-settings.php before plugins are loaded (for
17 * backwards compatibility reasons), and again on the {@see 'init'} action. We must
18 * avoid registering rewrite rules before the {@see 'init'} action.
22 * @global WP_Rewrite $wp_rewrite The WordPress rewrite class.
24 function create_initial_taxonomies() {
27 if ( ! did_action( 'init' ) ) {
28 $rewrite = array( 'category' => false, 'post_tag' => false, 'post_format' => false );
32 * Filter the post formats rewrite base.
36 * @param string $context Context of the rewrite base. Default 'type'.
38 $post_format_base = apply_filters( 'post_format_rewrite_base', 'type' );
41 'hierarchical' => true,
42 'slug' => get_option('category_base') ? get_option('category_base') : 'category',
43 'with_front' => ! get_option('category_base') || $wp_rewrite->using_index_permalinks(),
44 'ep_mask' => EP_CATEGORIES,
47 'hierarchical' => false,
48 'slug' => get_option('tag_base') ? get_option('tag_base') : 'tag',
49 'with_front' => ! get_option('tag_base') || $wp_rewrite->using_index_permalinks(),
52 'post_format' => $post_format_base ? array( 'slug' => $post_format_base ) : false,
56 register_taxonomy( 'category', 'post', array(
57 'hierarchical' => true,
58 'query_var' => 'category_name',
59 'rewrite' => $rewrite['category'],
62 'show_admin_column' => true,
66 register_taxonomy( 'post_tag', 'post', array(
67 'hierarchical' => false,
69 'rewrite' => $rewrite['post_tag'],
72 'show_admin_column' => true,
76 register_taxonomy( 'nav_menu', 'nav_menu_item', array(
78 'hierarchical' => false,
80 'name' => __( 'Navigation Menus' ),
81 'singular_name' => __( 'Navigation Menu' ),
87 'show_in_nav_menus' => false,
90 register_taxonomy( 'link_category', 'link', array(
91 'hierarchical' => false,
93 'name' => __( 'Link Categories' ),
94 'singular_name' => __( 'Link Category' ),
95 'search_items' => __( 'Search Link Categories' ),
96 'popular_items' => null,
97 'all_items' => __( 'All Link Categories' ),
98 'edit_item' => __( 'Edit Link Category' ),
99 'update_item' => __( 'Update Link Category' ),
100 'add_new_item' => __( 'Add New Link Category' ),
101 'new_item_name' => __( 'New Link Category Name' ),
102 'separate_items_with_commas' => null,
103 'add_or_remove_items' => null,
104 'choose_from_most_used' => null,
106 'capabilities' => array(
107 'manage_terms' => 'manage_links',
108 'edit_terms' => 'manage_links',
109 'delete_terms' => 'manage_links',
110 'assign_terms' => 'manage_links',
112 'query_var' => false,
119 register_taxonomy( 'post_format', 'post', array(
121 'hierarchical' => false,
123 'name' => _x( 'Format', 'post format' ),
124 'singular_name' => _x( 'Format', 'post format' ),
127 'rewrite' => $rewrite['post_format'],
130 'show_in_nav_menus' => current_theme_supports( 'post-formats' ),
135 * Retrieves a list of registered taxonomy names or objects.
139 * @global array $wp_taxonomies The registered taxonomies.
141 * @param array $args Optional. An array of `key => value` arguments to match against the taxonomy objects.
142 * Default empty array.
143 * @param string $output Optional. The type of output to return in the array. Accepts either taxonomy 'names'
144 * or 'objects'. Default 'names'.
145 * @param string $operator Optional. The logical operation to perform. Accepts 'and' or 'or'. 'or' means only
146 * one element from the array needs to match; 'and' means all elements must match.
148 * @return array A list of taxonomy names or objects.
150 function get_taxonomies( $args = array(), $output = 'names', $operator = 'and' ) {
151 global $wp_taxonomies;
153 $field = ('names' == $output) ? 'name' : false;
155 return wp_filter_object_list($wp_taxonomies, $args, $operator, $field);
159 * Return the names or objects of the taxonomies which are registered for the requested object or object type, such as
160 * a post object or post type name.
164 * $taxonomies = get_object_taxonomies( 'post' );
168 * Array( 'category', 'post_tag' )
172 * @global array $wp_taxonomies The registered taxonomies.
174 * @param array|string|WP_Post $object Name of the type of taxonomy object, or an object (row from posts)
175 * @param string $output Optional. The type of output to return in the array. Accepts either
176 * taxonomy 'names' or 'objects'. Default 'names'.
177 * @return array The names of all taxonomy of $object_type.
179 function get_object_taxonomies( $object, $output = 'names' ) {
180 global $wp_taxonomies;
182 if ( is_object($object) ) {
183 if ( $object->post_type == 'attachment' )
184 return get_attachment_taxonomies($object);
185 $object = $object->post_type;
188 $object = (array) $object;
190 $taxonomies = array();
191 foreach ( (array) $wp_taxonomies as $tax_name => $tax_obj ) {
192 if ( array_intersect($object, (array) $tax_obj->object_type) ) {
193 if ( 'names' == $output )
194 $taxonomies[] = $tax_name;
196 $taxonomies[ $tax_name ] = $tax_obj;
204 * Retrieves the taxonomy object of $taxonomy.
206 * The get_taxonomy function will first check that the parameter string given
207 * is a taxonomy object and if it is, it will return it.
211 * @global array $wp_taxonomies The registered taxonomies.
213 * @param string $taxonomy Name of taxonomy object to return.
214 * @return object|false The Taxonomy Object or false if $taxonomy doesn't exist.
216 function get_taxonomy( $taxonomy ) {
217 global $wp_taxonomies;
219 if ( ! taxonomy_exists( $taxonomy ) )
222 return $wp_taxonomies[$taxonomy];
226 * Checks that the taxonomy name exists.
228 * Formerly is_taxonomy(), introduced in 2.3.0.
232 * @global array $wp_taxonomies The registered taxonomies.
234 * @param string $taxonomy Name of taxonomy object.
235 * @return bool Whether the taxonomy exists.
237 function taxonomy_exists( $taxonomy ) {
238 global $wp_taxonomies;
240 return isset( $wp_taxonomies[$taxonomy] );
244 * Whether the taxonomy object is hierarchical.
246 * Checks to make sure that the taxonomy is an object first. Then Gets the
247 * object, and finally returns the hierarchical value in the object.
249 * A false return value might also mean that the taxonomy does not exist.
253 * @param string $taxonomy Name of taxonomy object.
254 * @return bool Whether the taxonomy is hierarchical.
256 function is_taxonomy_hierarchical($taxonomy) {
257 if ( ! taxonomy_exists($taxonomy) )
260 $taxonomy = get_taxonomy($taxonomy);
261 return $taxonomy->hierarchical;
265 * Creates or modifies a taxonomy object.
267 * Note: Do not use before the {@see 'init'} hook.
269 * A simple function for creating or modifying a taxonomy object based on the
270 * parameters given. The function will accept an array (third optional
271 * parameter), along with strings for the taxonomy name and another string for
275 * @since 4.2.0 Introduced `show_in_quick_edit` argument.
276 * @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen.
277 * @since 4.4.0 The `public` argument now controls whether the taxonomy can be queried on the front end.
278 * @since 4.5.0 Introduced `publicly_queryable` argument.
280 * @global array $wp_taxonomies Registered taxonomies.
281 * @global WP $wp WP instance.
283 * @param string $taxonomy Taxonomy key, must not exceed 32 characters.
284 * @param array|string $object_type Name of the object type for the taxonomy object.
285 * @param array|string $args {
286 * Optional. Array or query string of arguments for registering a taxonomy.
288 * @type string $label Name of the taxonomy shown in the menu. Usually plural. If not set,
289 * `$labels['name']` will be used.
290 * @type array $labels An array of labels for this taxonomy. By default, Tag labels are used for
291 * non-hierarchical taxonmies, and Category labels are used for hierarchical
292 * taxonomies. See accepted values in get_taxonomy_labels().
293 * Default empty array.
294 * @type string $description A short descriptive summary of what the taxonomy is for. Default empty.
295 * @type bool $public Whether a taxonomy is intended for use publicly either via
296 * the admin interface or by front-end users. The default settings
297 * of `$publicly_queryable`, `$show_ui`, and `$show_in_nav_menus`
298 * are inherited from `$public`.
299 * @type bool $publicly_queryable Whether the taxonomy is publicly queryable.
300 * If not set, the default is inherited from `$public`
301 * @type bool $hierarchical Whether the taxonomy is hierarchical. Default false.
302 * @type bool $show_ui Whether to generate and allow a UI for managing terms in this taxonomy in
303 * the admin. If not set, the default is inherited from `$public`
305 * @type bool $show_in_menu Whether to show the taxonomy in the admin menu. If true, the taxonomy is
306 * shown as a submenu of the object type menu. If false, no menu is shown.
307 * `$show_ui` must be true. If not set, default is inherited from `$show_ui`
309 * @type bool $show_in_nav_menus Makes this taxonomy available for selection in navigation menus. If not
310 * set, the default is inherited from `$public` (default true).
311 * @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set,
312 * the default is inherited from `$show_ui` (default true).
313 * @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set,
314 * the default is inherited from `$show_ui` (default true).
315 * @type bool $show_admin_column Whether to display a column for the taxonomy on its post type listing
316 * screens. Default false.
317 * @type bool|callable $meta_box_cb Provide a callback function for the meta box display. If not set,
318 * post_categories_meta_box() is used for hierarchical taxonomies, and
319 * post_tags_meta_box() is used for non-hierarchical. If false, no meta
321 * @type array $capabilities {
322 * Array of capabilities for this taxonomy.
324 * @type string $manage_terms Default 'manage_categories'.
325 * @type string $edit_terms Default 'manage_categories'.
326 * @type string $delete_terms Default 'manage_categories'.
327 * @type string $assign_terms Default 'edit_posts'.
329 * @type bool|array $rewrite {
330 * Triggers the handling of rewrites for this taxonomy. Default true, using $taxonomy as slug. To prevent
331 * rewrite, set to false. To specify rewrite rules, an array can be passed with any of these keys:
333 * @type string $slug Customize the permastruct slug. Default `$taxonomy` key.
334 * @type bool $with_front Should the permastruct be prepended with WP_Rewrite::$front. Default true.
335 * @type bool $hierarchical Either hierarchical rewrite tag or not. Default false.
336 * @type int $ep_mask Assign an endpoint mask. Default `EP_NONE`.
338 * @type string $query_var Sets the query var key for this taxonomy. Default `$taxonomy` key. If
339 * false, a taxonomy cannot be loaded at `?{query_var}={term_slug}`. If a
340 * string, the query `?{query_var}={term_slug}` will be valid.
341 * @type callable $update_count_callback Works much like a hook, in that it will be called when the count is
342 * updated. Default _update_post_term_count() for taxonomies attached
343 * to post types, which confirms that the objects are published before
344 * counting them. Default _update_generic_term_count() for taxonomies
345 * attached to other object types, such as users.
346 * @type bool $_builtin This taxonomy is a "built-in" taxonomy. INTERNAL USE ONLY!
349 * @return WP_Error|void WP_Error, if errors.
351 function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
352 global $wp_taxonomies, $wp;
354 if ( ! is_array( $wp_taxonomies ) )
355 $wp_taxonomies = array();
357 $args = wp_parse_args( $args );
360 * Filter the arguments for registering a taxonomy.
364 * @param array $args Array of arguments for registering a taxonomy.
365 * @param string $taxonomy Taxonomy key.
366 * @param array $object_type Array of names of object types for the taxonomy.
368 $args = apply_filters( 'register_taxonomy_args', $args, $taxonomy, (array) $object_type );
374 'publicly_queryable' => null,
375 'hierarchical' => false,
377 'show_in_menu' => null,
378 'show_in_nav_menus' => null,
379 'show_tagcloud' => null,
380 'show_in_quick_edit' => null,
381 'show_admin_column' => false,
382 'meta_box_cb' => null,
383 'capabilities' => array(),
385 'query_var' => $taxonomy,
386 'update_count_callback' => '',
389 $args = array_merge( $defaults, $args );
391 if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) {
392 _doing_it_wrong( __FUNCTION__, __( 'Taxonomy names must be between 1 and 32 characters in length.' ), '4.2' );
393 return new WP_Error( 'taxonomy_length_invalid', __( 'Taxonomy names must be between 1 and 32 characters in length.' ) );
396 // If not set, default to the setting for public.
397 if ( null === $args['publicly_queryable'] ) {
398 $args['publicly_queryable'] = $args['public'];
401 // Non-publicly queryable taxonomies should not register query vars, except in the admin.
402 if ( false !== $args['query_var'] && ( is_admin() || false !== $args['publicly_queryable'] ) && ! empty( $wp ) ) {
403 if ( true === $args['query_var'] )
404 $args['query_var'] = $taxonomy;
406 $args['query_var'] = sanitize_title_with_dashes( $args['query_var'] );
407 $wp->add_query_var( $args['query_var'] );
409 // Force query_var to false for non-public taxonomies.
410 $args['query_var'] = false;
413 if ( false !== $args['rewrite'] && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
414 $args['rewrite'] = wp_parse_args( $args['rewrite'], array(
415 'with_front' => true,
416 'hierarchical' => false,
417 'ep_mask' => EP_NONE,
420 if ( empty( $args['rewrite']['slug'] ) )
421 $args['rewrite']['slug'] = sanitize_title_with_dashes( $taxonomy );
423 if ( $args['hierarchical'] && $args['rewrite']['hierarchical'] )
428 add_rewrite_tag( "%$taxonomy%", $tag, $args['query_var'] ? "{$args['query_var']}=" : "taxonomy=$taxonomy&term=" );
429 add_permastruct( $taxonomy, "{$args['rewrite']['slug']}/%$taxonomy%", $args['rewrite'] );
432 // If not set, default to the setting for public.
433 if ( null === $args['show_ui'] )
434 $args['show_ui'] = $args['public'];
436 // If not set, default to the setting for show_ui.
437 if ( null === $args['show_in_menu' ] || ! $args['show_ui'] )
438 $args['show_in_menu' ] = $args['show_ui'];
440 // If not set, default to the setting for public.
441 if ( null === $args['show_in_nav_menus'] )
442 $args['show_in_nav_menus'] = $args['public'];
444 // If not set, default to the setting for show_ui.
445 if ( null === $args['show_tagcloud'] )
446 $args['show_tagcloud'] = $args['show_ui'];
448 // If not set, default to the setting for show_ui.
449 if ( null === $args['show_in_quick_edit'] ) {
450 $args['show_in_quick_edit'] = $args['show_ui'];
453 $default_caps = array(
454 'manage_terms' => 'manage_categories',
455 'edit_terms' => 'manage_categories',
456 'delete_terms' => 'manage_categories',
457 'assign_terms' => 'edit_posts',
459 $args['cap'] = (object) array_merge( $default_caps, $args['capabilities'] );
460 unset( $args['capabilities'] );
462 $args['name'] = $taxonomy;
463 $args['object_type'] = array_unique( (array) $object_type );
465 $args['labels'] = get_taxonomy_labels( (object) $args );
466 $args['label'] = $args['labels']->name;
468 // If not set, use the default meta box
469 if ( null === $args['meta_box_cb'] ) {
470 if ( $args['hierarchical'] )
471 $args['meta_box_cb'] = 'post_categories_meta_box';
473 $args['meta_box_cb'] = 'post_tags_meta_box';
476 $wp_taxonomies[ $taxonomy ] = (object) $args;
478 // register callback handling for metabox
479 add_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
482 * Fires after a taxonomy is registered.
486 * @param string $taxonomy Taxonomy slug.
487 * @param array|string $object_type Object type or array of object types.
488 * @param array $args Array of taxonomy registration arguments.
490 do_action( 'registered_taxonomy', $taxonomy, $object_type, $args );
494 * Unregisters a taxonomy.
496 * Can not be used to unregister built-in taxonomies.
500 * @global WP $wp Current WordPress environment instance.
501 * @global array $wp_taxonomies List of taxonomies.
503 * @param string $taxonomy Taxonomy name.
504 * @return bool|WP_Error True on success, WP_Error on failure or if the taxonomy doesn't exist.
506 function unregister_taxonomy( $taxonomy ) {
507 if ( ! taxonomy_exists( $taxonomy ) ) {
508 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
511 $taxonomy_args = get_taxonomy( $taxonomy );
513 // Do not allow unregistering internal taxonomies.
514 if ( $taxonomy_args->_builtin ) {
515 return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed' ) );
518 global $wp, $wp_taxonomies;
521 if ( false !== $taxonomy_args->query_var ) {
522 $wp->remove_query_var( $taxonomy_args->query_var );
525 // Remove rewrite tags and permastructs.
526 if ( false !== $taxonomy_args->rewrite ) {
527 remove_rewrite_tag( "%$taxonomy%" );
528 remove_permastruct( $taxonomy );
531 // Unregister callback handling for metabox.
532 remove_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
534 // Remove the taxonomy.
535 unset( $wp_taxonomies[ $taxonomy ] );
538 * Fires after a taxonomy is unregistered.
542 * @param string $taxonomy Taxonomy name.
544 do_action( 'unregistered_taxonomy', $taxonomy );
550 * Builds an object with all taxonomy labels out of a taxonomy object
552 * Accepted keys of the label array in the taxonomy object:
554 * - name - general name for the taxonomy, usually plural. The same as and overridden by $tax->label. Default is Tags/Categories
555 * - singular_name - name for one object of this taxonomy. Default is Tag/Category
556 * - search_items - Default is Search Tags/Search Categories
557 * - popular_items - This string isn't used on hierarchical taxonomies. Default is Popular Tags
558 * - all_items - Default is All Tags/All Categories
559 * - parent_item - This string isn't used on non-hierarchical taxonomies. In hierarchical ones the default is Parent Category
560 * - parent_item_colon - The same as `parent_item`, but with colon `:` in the end
561 * - edit_item - Default is Edit Tag/Edit Category
562 * - view_item - Default is View Tag/View Category
563 * - update_item - Default is Update Tag/Update Category
564 * - add_new_item - Default is Add New Tag/Add New Category
565 * - new_item_name - Default is New Tag Name/New Category Name
566 * - separate_items_with_commas - This string isn't used on hierarchical taxonomies. Default is "Separate tags with commas", used in the meta box.
567 * - add_or_remove_items - This string isn't used on hierarchical taxonomies. Default is "Add or remove tags", used in the meta box when JavaScript is disabled.
568 * - choose_from_most_used - This string isn't used on hierarchical taxonomies. Default is "Choose from the most used tags", used in the meta box.
569 * - not_found - Default is "No tags found"/"No categories found", used in the meta box and taxonomy list table.
570 * - no_terms - Default is "No tags"/"No categories", used in the posts and media list tables.
571 * - items_list_navigation - String for the table pagination hidden heading.
572 * - items_list - String for the table hidden heading.
574 * Above, the first default value is for non-hierarchical taxonomies (like tags) and the second one is for hierarchical taxonomies (like categories).
576 * @todo Better documentation for the labels array.
579 * @since 4.3.0 Added the `no_terms` label.
580 * @since 4.4.0 Added the `items_list_navigation` and `items_list` labels.
582 * @param object $tax Taxonomy object.
583 * @return object object with all the labels as member variables.
585 function get_taxonomy_labels( $tax ) {
586 $tax->labels = (array) $tax->labels;
588 if ( isset( $tax->helps ) && empty( $tax->labels['separate_items_with_commas'] ) )
589 $tax->labels['separate_items_with_commas'] = $tax->helps;
591 if ( isset( $tax->no_tagcloud ) && empty( $tax->labels['not_found'] ) )
592 $tax->labels['not_found'] = $tax->no_tagcloud;
594 $nohier_vs_hier_defaults = array(
595 'name' => array( _x( 'Tags', 'taxonomy general name' ), _x( 'Categories', 'taxonomy general name' ) ),
596 'singular_name' => array( _x( 'Tag', 'taxonomy singular name' ), _x( 'Category', 'taxonomy singular name' ) ),
597 'search_items' => array( __( 'Search Tags' ), __( 'Search Categories' ) ),
598 'popular_items' => array( __( 'Popular Tags' ), null ),
599 'all_items' => array( __( 'All Tags' ), __( 'All Categories' ) ),
600 'parent_item' => array( null, __( 'Parent Category' ) ),
601 'parent_item_colon' => array( null, __( 'Parent Category:' ) ),
602 'edit_item' => array( __( 'Edit Tag' ), __( 'Edit Category' ) ),
603 'view_item' => array( __( 'View Tag' ), __( 'View Category' ) ),
604 'update_item' => array( __( 'Update Tag' ), __( 'Update Category' ) ),
605 'add_new_item' => array( __( 'Add New Tag' ), __( 'Add New Category' ) ),
606 'new_item_name' => array( __( 'New Tag Name' ), __( 'New Category Name' ) ),
607 'separate_items_with_commas' => array( __( 'Separate tags with commas' ), null ),
608 'add_or_remove_items' => array( __( 'Add or remove tags' ), null ),
609 'choose_from_most_used' => array( __( 'Choose from the most used tags' ), null ),
610 'not_found' => array( __( 'No tags found.' ), __( 'No categories found.' ) ),
611 'no_terms' => array( __( 'No tags' ), __( 'No categories' ) ),
612 'items_list_navigation' => array( __( 'Tags list navigation' ), __( 'Categories list navigation' ) ),
613 'items_list' => array( __( 'Tags list' ), __( 'Categories list' ) ),
615 $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
617 $labels = _get_custom_object_labels( $tax, $nohier_vs_hier_defaults );
619 $taxonomy = $tax->name;
621 $default_labels = clone $labels;
624 * Filter the labels of a specific taxonomy.
626 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
630 * @see get_taxonomy_labels() for the full list of taxonomy labels.
632 * @param object $labels Object with labels for the taxonomy as member variables.
634 $labels = apply_filters( "taxonomy_labels_{$taxonomy}", $labels );
636 // Ensure that the filtered labels contain all required default values.
637 $labels = (object) array_merge( (array) $default_labels, (array) $labels );
643 * Add an already registered taxonomy to an object type.
647 * @global array $wp_taxonomies The registered taxonomies.
649 * @param string $taxonomy Name of taxonomy object.
650 * @param string $object_type Name of the object type.
651 * @return bool True if successful, false if not.
653 function register_taxonomy_for_object_type( $taxonomy, $object_type) {
654 global $wp_taxonomies;
656 if ( !isset($wp_taxonomies[$taxonomy]) )
659 if ( ! get_post_type_object($object_type) )
662 if ( ! in_array( $object_type, $wp_taxonomies[$taxonomy]->object_type ) )
663 $wp_taxonomies[$taxonomy]->object_type[] = $object_type;
665 // Filter out empties.
666 $wp_taxonomies[ $taxonomy ]->object_type = array_filter( $wp_taxonomies[ $taxonomy ]->object_type );
672 * Remove an already registered taxonomy from an object type.
676 * @global array $wp_taxonomies The registered taxonomies.
678 * @param string $taxonomy Name of taxonomy object.
679 * @param string $object_type Name of the object type.
680 * @return bool True if successful, false if not.
682 function unregister_taxonomy_for_object_type( $taxonomy, $object_type ) {
683 global $wp_taxonomies;
685 if ( ! isset( $wp_taxonomies[ $taxonomy ] ) )
688 if ( ! get_post_type_object( $object_type ) )
691 $key = array_search( $object_type, $wp_taxonomies[ $taxonomy ]->object_type, true );
692 if ( false === $key )
695 unset( $wp_taxonomies[ $taxonomy ]->object_type[ $key ] );
704 * Retrieve object_ids of valid taxonomy and term.
706 * The strings of $taxonomies must exist before this function will continue. On
707 * failure of finding a valid taxonomy, it will return an WP_Error class, kind
708 * of like Exceptions in PHP 5, except you can't catch them. Even so, you can
709 * still test for the WP_Error class and get the error message.
711 * The $terms aren't checked the same as $taxonomies, but still need to exist
712 * for $object_ids to be returned.
714 * It is possible to change the order that object_ids is returned by either
715 * using PHP sort family functions or using the database by using $args with
716 * either ASC or DESC array. The value should be in the key named 'order'.
720 * @global wpdb $wpdb WordPress database abstraction object.
722 * @param int|array $term_ids Term id or array of term ids of terms that will be used.
723 * @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names.
724 * @param array|string $args Change the order of the object_ids, either ASC or DESC.
725 * @return WP_Error|array If the taxonomy does not exist, then WP_Error will be returned. On success.
726 * the array can be empty meaning that there are no $object_ids found or it will return the $object_ids found.
728 function get_objects_in_term( $term_ids, $taxonomies, $args = array() ) {
731 if ( ! is_array( $term_ids ) ) {
732 $term_ids = array( $term_ids );
734 if ( ! is_array( $taxonomies ) ) {
735 $taxonomies = array( $taxonomies );
737 foreach ( (array) $taxonomies as $taxonomy ) {
738 if ( ! taxonomy_exists( $taxonomy ) ) {
739 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
743 $defaults = array( 'order' => 'ASC' );
744 $args = wp_parse_args( $args, $defaults );
746 $order = ( 'desc' == strtolower( $args['order'] ) ) ? 'DESC' : 'ASC';
748 $term_ids = array_map('intval', $term_ids );
750 $taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'";
751 $term_ids = "'" . implode( "', '", $term_ids ) . "'";
753 $object_ids = $wpdb->get_col("SELECT tr.object_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tt.taxonomy IN ($taxonomies) AND tt.term_id IN ($term_ids) ORDER BY tr.object_id $order");
755 if ( ! $object_ids ){
762 * Given a taxonomy query, generates SQL to be appended to a main query.
768 * @param array $tax_query A compact tax query
769 * @param string $primary_table
770 * @param string $primary_id_column
773 function get_tax_sql( $tax_query, $primary_table, $primary_id_column ) {
774 $tax_query_obj = new WP_Tax_Query( $tax_query );
775 return $tax_query_obj->get_sql( $primary_table, $primary_id_column );
779 * Get all Term data from database by Term ID.
781 * The usage of the get_term function is to apply filters to a term object. It
782 * is possible to get a term object from the database before applying the
785 * $term ID must be part of $taxonomy, to get from the database. Failure, might
786 * be able to be captured by the hooks. Failure would be the same value as $wpdb
787 * returns for the get_row method.
789 * There are two hooks, one is specifically for each term, named 'get_term', and
790 * the second is for the taxonomy name, 'term_$taxonomy'. Both hooks gets the
791 * term object, and the taxonomy name as parameters. Both hooks are expected to
792 * return a Term object.
794 * {@see 'get_term'} hook - Takes two parameters the term Object and the taxonomy name.
795 * Must return term object. Used in get_term() as a catch-all filter for every
798 * {@see 'get_$taxonomy'} hook - Takes two parameters the term Object and the taxonomy
799 * name. Must return term object. $taxonomy will be the taxonomy name, so for
800 * example, if 'category', it would be 'get_category' as the filter name. Useful
801 * for custom taxonomies or plugging into default taxonomies.
803 * @todo Better formatting for DocBlock
806 * @since 4.4.0 Converted to return a WP_Term object if `$output` is `OBJECT`.
807 * The `$taxonomy` parameter was made optional.
809 * @global wpdb $wpdb WordPress database abstraction object.
810 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
812 * @param int|WP_Term|object $term If integer, term data will be fetched from the database, or from the cache if
813 * available. If stdClass object (as in the results of a database query), will apply
814 * filters and return a `WP_Term` object corresponding to the `$term` data. If `WP_Term`,
815 * will return `$term`.
816 * @param string $taxonomy Optional. Taxonomy name that $term is part of.
817 * @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
818 * @param string $filter Optional, default is raw or no WordPress defined filter will applied.
819 * @return array|WP_Term|WP_Error|null Object of the type specified by `$output` on success. When `$output` is 'OBJECT',
820 * a WP_Term instance is returned. If taxonomy does not exist, a WP_Error is
821 * returned. Returns null for miscellaneous failure.
823 function get_term( $term, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
824 if ( empty( $term ) ) {
825 return new WP_Error( 'invalid_term', __( 'Empty Term' ) );
828 if ( $taxonomy && ! taxonomy_exists( $taxonomy ) ) {
829 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
832 if ( $term instanceof WP_Term ) {
834 } elseif ( is_object( $term ) ) {
835 if ( empty( $term->filter ) || 'raw' === $term->filter ) {
836 $_term = sanitize_term( $term, $taxonomy, 'raw' );
837 $_term = new WP_Term( $_term );
839 $_term = WP_Term::get_instance( $term->term_id );
842 $_term = WP_Term::get_instance( $term, $taxonomy );
845 if ( is_wp_error( $_term ) ) {
847 } elseif ( ! $_term ) {
855 * @since 4.4.0 `$_term` can now also be a WP_Term object.
857 * @param int|WP_Term $_term Term object or ID.
858 * @param string $taxonomy The taxonomy slug.
860 $_term = apply_filters( 'get_term', $_term, $taxonomy );
865 * The dynamic portion of the filter name, `$taxonomy`, refers
866 * to the taxonomy slug.
869 * @since 4.4.0 `$_term` can now also be a WP_Term object.
871 * @param int|WP_Term $_term Term object or ID.
872 * @param string $taxonomy The taxonomy slug.
874 $_term = apply_filters( "get_$taxonomy", $_term, $taxonomy );
876 // Bail if a filter callback has changed the type of the `$_term` object.
877 if ( ! ( $_term instanceof WP_Term ) ) {
881 // Sanitize term, according to the specified filter.
882 $_term->filter( $filter );
884 if ( $output == ARRAY_A ) {
885 return $_term->to_array();
886 } elseif ( $output == ARRAY_N ) {
887 return array_values( $_term->to_array() );
894 * Get all Term data from database by Term field and data.
896 * Warning: $value is not escaped for 'name' $field. You must do it yourself, if
899 * The default $field is 'id', therefore it is possible to also use null for
900 * field, but not recommended that you do so.
902 * If $value does not exist, the return value will be false. If $taxonomy exists
903 * and $field and $value combinations exist, the Term will be returned.
905 * @todo Better formatting for DocBlock.
908 * @since 4.4.0 `$taxonomy` is optional if `$field` is 'term_taxonomy_id'. Converted to return
909 * a WP_Term object if `$output` is `OBJECT`.
911 * @global wpdb $wpdb WordPress database abstraction object.
912 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
914 * @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id'
915 * @param string|int $value Search for this term value
916 * @param string $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'.
917 * @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
918 * @param string $filter Optional, default is raw or no WordPress defined filter will applied.
919 * @return WP_Term|bool WP_Term instance on success. Will return false if `$taxonomy` does not exist
920 * or `$term` was not found.
922 function get_term_by( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
925 // 'term_taxonomy_id' lookups don't require taxonomy checks.
926 if ( 'term_taxonomy_id' !== $field && ! taxonomy_exists( $taxonomy ) ) {
930 $tax_clause = $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy );
932 if ( 'slug' == $field ) {
934 $value = sanitize_title($value);
937 } elseif ( 'name' == $field ) {
938 // Assume already escaped
939 $value = wp_unslash($value);
941 } elseif ( 'term_taxonomy_id' == $field ) {
942 $value = (int) $value;
943 $_field = 'tt.term_taxonomy_id';
945 // No `taxonomy` clause when searching by 'term_taxonomy_id'.
948 $term = get_term( (int) $value, $taxonomy, $output, $filter );
949 if ( is_wp_error( $term ) || is_null( $term ) ) {
955 $term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE $_field = %s", $value ) . " $tax_clause LIMIT 1" );
959 // In the case of 'term_taxonomy_id', override the provided `$taxonomy` with whatever we find in the db.
960 if ( 'term_taxonomy_id' === $field ) {
961 $taxonomy = $term->taxonomy;
964 wp_cache_add( $term->term_id, $term, 'terms' );
966 return get_term( $term, $taxonomy, $output, $filter );
970 * Merge all term children into a single array of their IDs.
972 * This recursive function will merge all of the children of $term into the same
973 * array of term IDs. Only useful for taxonomies which are hierarchical.
975 * Will return an empty array if $term does not exist in $taxonomy.
979 * @param string $term_id ID of Term to get children.
980 * @param string $taxonomy Taxonomy Name.
981 * @return array|WP_Error List of Term IDs. WP_Error returned if `$taxonomy` does not exist.
983 function get_term_children( $term_id, $taxonomy ) {
984 if ( ! taxonomy_exists($taxonomy) )
985 return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
987 $term_id = intval( $term_id );
989 $terms = _get_term_hierarchy($taxonomy);
991 if ( ! isset($terms[$term_id]) )
994 $children = $terms[$term_id];
996 foreach ( (array) $terms[$term_id] as $child ) {
997 if ( $term_id == $child ) {
1001 if ( isset($terms[$child]) )
1002 $children = array_merge($children, get_term_children($child, $taxonomy));
1009 * Get sanitized Term field.
1011 * The function is for contextual reasons and for simplicity of usage.
1014 * @since 4.4.0 The `$taxonomy` parameter was made optional. `$term` can also now accept a WP_Term object.
1016 * @see sanitize_term_field()
1018 * @param string $field Term field to fetch.
1019 * @param int|WP_Term $term Term ID or object.
1020 * @param string $taxonomy Optional. Taxonomy Name. Default empty.
1021 * @param string $context Optional, default is display. Look at sanitize_term_field() for available options.
1022 * @return string|int|null|WP_Error Will return an empty string if $term is not an object or if $field is not set in $term.
1024 function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) {
1025 $term = get_term( $term, $taxonomy );
1026 if ( is_wp_error($term) )
1029 if ( !is_object($term) )
1032 if ( !isset($term->$field) )
1035 return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context );
1039 * Sanitizes Term for editing.
1041 * Return value is sanitize_term() and usage is for sanitizing the term for
1042 * editing. Function is for contextual and simplicity.
1046 * @param int|object $id Term ID or object.
1047 * @param string $taxonomy Taxonomy name.
1048 * @return string|int|null|WP_Error Will return empty string if $term is not an object.
1050 function get_term_to_edit( $id, $taxonomy ) {
1051 $term = get_term( $id, $taxonomy );
1053 if ( is_wp_error($term) )
1056 if ( !is_object($term) )
1059 return sanitize_term($term, $taxonomy, 'edit');
1063 * Retrieve the terms in a given taxonomy or list of taxonomies.
1065 * You can fully inject any customizations to the query before it is sent, as
1066 * well as control the output with a filter.
1068 * The {@see 'get_terms'} filter will be called when the cache has the term and will
1069 * pass the found term along with the array of $taxonomies and array of $args.
1070 * This filter is also called before the array of terms is passed and will pass
1071 * the array of terms, along with the $taxonomies and $args.
1073 * The {@see 'list_terms_exclusions'} filter passes the compiled exclusions along with
1076 * The {@see 'get_terms_orderby'} filter passes the `ORDER BY` clause for the query
1077 * along with the $args array.
1079 * Prior to 4.5.0, the first parameter of `get_terms()` was a taxonomy or list of taxonomies:
1081 * $terms = get_terms( 'post_tag', array(
1082 * 'hide_empty' => false,
1085 * Since 4.5.0, taxonomies should be passed via the 'taxonomy' argument in the `$args` array:
1087 * $terms = get_terms( array(
1088 * 'taxonomy' => 'post_tag',
1089 * 'hide_empty' => false,
1093 * @since 4.2.0 Introduced 'name' and 'childless' parameters.
1094 * @since 4.4.0 Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter.
1095 * Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return
1096 * a list of WP_Term objects.
1097 * @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter.
1098 * Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
1100 * @internal The `$deprecated` parameter is parsed for backward compatibility only.
1102 * @global wpdb $wpdb WordPress database abstraction object.
1103 * @global array $wp_filter
1105 * @param array|string $args {
1106 * Optional. Array or string of arguments to get terms.
1108 * @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should
1110 * @type string $orderby Field(s) to order terms by. Accepts term fields ('name', 'slug',
1111 * 'term_group', 'term_id', 'id', 'description'), 'count' for term
1112 * taxonomy count, 'include' to match the 'order' of the $include param,
1113 * 'meta_value', 'meta_value_num', the value of `$meta_key`, the array
1114 * keys of `$meta_query`, or 'none' to omit the ORDER BY clause.
1115 * Defaults to 'name'.
1116 * @type string $order Whether to order terms in ascending or descending order.
1117 * Accepts 'ASC' (ascending) or 'DESC' (descending).
1119 * @type bool|int $hide_empty Whether to hide terms not assigned to any posts. Accepts
1120 * 1|true or 0|false. Default 1|true.
1121 * @type array|string $include Array or comma/space-separated string of term ids to include.
1122 * Default empty array.
1123 * @type array|string $exclude Array or comma/space-separated string of term ids to exclude.
1124 * If $include is non-empty, $exclude is ignored.
1125 * Default empty array.
1126 * @type array|string $exclude_tree Array or comma/space-separated string of term ids to exclude
1127 * along with all of their descendant terms. If $include is
1128 * non-empty, $exclude_tree is ignored. Default empty array.
1129 * @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any
1130 * positive number. Default ''|0 (all).
1131 * @type int $offset The number by which to offset the terms query. Default empty.
1132 * @type string $fields Term fields to query for. Accepts 'all' (returns an array of complete
1133 * term objects), 'ids' (returns an array of ids), 'id=>parent' (returns
1134 * an associative array with ids as keys, parent term IDs as values),
1135 * 'names' (returns an array of term names), 'count' (returns the number
1136 * of matching terms), 'id=>name' (returns an associative array with ids
1137 * as keys, term names as values), or 'id=>slug' (returns an associative
1138 * array with ids as keys, term slugs as values). Default 'all'.
1139 * @type string|array $name Optional. Name or array of names to return term(s) for. Default empty.
1140 * @type string|array $slug Optional. Slug or array of slugs to return term(s) for. Default empty.
1141 * @type bool $hierarchical Whether to include terms that have non-empty descendants (even
1142 * if $hide_empty is set to true). Default true.
1143 * @type string $search Search criteria to match terms. Will be SQL-formatted with
1144 * wildcards before and after. Default empty.
1145 * @type string $name__like Retrieve terms with criteria by which a term is LIKE $name__like.
1147 * @type string $description__like Retrieve terms where the description is LIKE $description__like.
1149 * @type bool $pad_counts Whether to pad the quantity of a term's children in the quantity
1150 * of each term's "count" object variable. Default false.
1151 * @type string $get Whether to return terms regardless of ancestry or whether the terms
1152 * are empty. Accepts 'all' or empty (disabled). Default empty.
1153 * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies
1154 * are passed, $child_of is ignored. Default 0.
1155 * @type int|string $parent Parent term ID to retrieve direct-child terms of. Default empty.
1156 * @type bool $childless True to limit results to terms that have no children. This parameter
1157 * has no effect on non-hierarchical taxonomies. Default false.
1158 * @type string $cache_domain Unique cache key to be produced when this query is stored in an
1159 * object cache. Default is 'core'.
1160 * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
1161 * @type array $meta_query Meta query clauses to limit retrieved terms by.
1162 * See `WP_Meta_Query`. Default empty.
1163 * @type string $meta_key Limit terms to those matching a specific metadata key. Can be used in
1164 * conjunction with `$meta_value`.
1165 * @type string $meta_value Limit terms to those matching a specific metadata value. Usually used
1166 * in conjunction with `$meta_key`.
1168 * @param array $deprecated Argument array, when using the legacy function parameter format. If present, this
1169 * parameter will be interpreted as `$args`, and the first function parameter will
1170 * be parsed as a taxonomy or array of taxonomies.
1171 * @return array|int|WP_Error List of WP_Term instances and their children. Will return WP_Error, if any of $taxonomies
1174 function get_terms( $args = array(), $deprecated = '' ) {
1179 'orderby' => 'name',
1181 'hide_empty' => true,
1182 'include' => array(),
1183 'exclude' => array(),
1184 'exclude_tree' => array(),
1190 'hierarchical' => true,
1193 'description__like' => '',
1194 'pad_counts' => false,
1198 'childless' => false,
1199 'cache_domain' => 'core',
1200 'update_term_meta_cache' => true,
1205 * Legacy argument format ($taxonomy, $args) takes precedence.
1207 * We detect legacy argument format by checking if
1208 * (a) a second non-empty parameter is passed, or
1209 * (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies)
1211 $key_intersect = array_intersect_key( $defaults, (array) $args );
1212 $do_legacy_args = $deprecated || empty( $key_intersect );
1215 if ( $do_legacy_args ) {
1216 $taxonomies = (array) $args;
1217 $args = $deprecated;
1218 } elseif ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
1219 $taxonomies = (array) $args['taxonomy'];
1220 unset( $args['taxonomy'] );
1223 $empty_array = array();
1225 if ( $taxonomies ) {
1226 foreach ( $taxonomies as $taxonomy ) {
1227 if ( ! taxonomy_exists($taxonomy) ) {
1228 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
1234 * Filter the terms query default arguments.
1236 * Use 'get_terms_args' to filter the passed arguments.
1240 * @param array $defaults An array of default get_terms() arguments.
1241 * @param array $taxonomies An array of taxonomies.
1243 $args = wp_parse_args( $args, apply_filters( 'get_terms_defaults', $defaults, $taxonomies ) );
1245 $args['number'] = absint( $args['number'] );
1246 $args['offset'] = absint( $args['offset'] );
1248 // Save queries by not crawling the tree in the case of multiple taxes or a flat tax.
1249 $has_hierarchical_tax = false;
1250 if ( $taxonomies ) {
1251 foreach ( $taxonomies as $_tax ) {
1252 if ( is_taxonomy_hierarchical( $_tax ) ) {
1253 $has_hierarchical_tax = true;
1258 if ( ! $has_hierarchical_tax ) {
1259 $args['hierarchical'] = false;
1260 $args['pad_counts'] = false;
1263 // 'parent' overrides 'child_of'.
1264 if ( 0 < intval( $args['parent'] ) ) {
1265 $args['child_of'] = false;
1268 if ( 'all' == $args['get'] ) {
1269 $args['childless'] = false;
1270 $args['child_of'] = 0;
1271 $args['hide_empty'] = 0;
1272 $args['hierarchical'] = false;
1273 $args['pad_counts'] = false;
1277 * Filter the terms query arguments.
1281 * @param array $args An array of get_terms() arguments.
1282 * @param array $taxonomies An array of taxonomies.
1284 $args = apply_filters( 'get_terms_args', $args, $taxonomies );
1286 // Avoid the query if the queried parent/child_of term has no descendants.
1287 $child_of = $args['child_of'];
1288 $parent = $args['parent'];
1291 $_parent = $child_of;
1292 } elseif ( $parent ) {
1299 $in_hierarchy = false;
1300 foreach ( $taxonomies as $_tax ) {
1301 $hierarchy = _get_term_hierarchy( $_tax );
1303 if ( isset( $hierarchy[ $_parent ] ) ) {
1304 $in_hierarchy = true;
1308 if ( ! $in_hierarchy ) {
1309 return $empty_array;
1313 $_orderby = strtolower( $args['orderby'] );
1314 if ( 'count' == $_orderby ) {
1315 $orderby = 'tt.count';
1316 } elseif ( 'name' == $_orderby ) {
1317 $orderby = 't.name';
1318 } elseif ( 'slug' == $_orderby ) {
1319 $orderby = 't.slug';
1320 } elseif ( 'include' == $_orderby && ! empty( $args['include'] ) ) {
1321 $include = implode( ',', array_map( 'absint', $args['include'] ) );
1322 $orderby = "FIELD( t.term_id, $include )";
1323 } elseif ( 'term_group' == $_orderby ) {
1324 $orderby = 't.term_group';
1325 } elseif ( 'description' == $_orderby ) {
1326 $orderby = 'tt.description';
1327 } elseif ( 'none' == $_orderby ) {
1329 } elseif ( empty( $_orderby ) || 'id' == $_orderby || 'term_id' === $_orderby ) {
1330 $orderby = 't.term_id';
1332 $orderby = 't.name';
1336 * Filter the ORDERBY clause of the terms query.
1340 * @param string $orderby `ORDERBY` clause of the terms query.
1341 * @param array $args An array of terms query arguments.
1342 * @param array $taxonomies An array of taxonomies.
1344 $orderby = apply_filters( 'get_terms_orderby', $orderby, $args, $taxonomies );
1346 $order = strtoupper( $args['order'] );
1347 if ( ! empty( $orderby ) ) {
1348 $orderby = "ORDER BY $orderby";
1353 if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) ) {
1357 $where_conditions = array();
1359 if ( $taxonomies ) {
1360 $where_conditions[] = "tt.taxonomy IN ('" . implode("', '", array_map( 'esc_sql', $taxonomies ) ) . "')";
1363 $exclude = $args['exclude'];
1364 $exclude_tree = $args['exclude_tree'];
1365 $include = $args['include'];
1368 if ( ! empty( $include ) ) {
1371 $inclusions = implode( ',', wp_parse_id_list( $include ) );
1374 if ( ! empty( $inclusions ) ) {
1375 $where_conditions[] = 't.term_id IN ( ' . $inclusions . ' )';
1378 $exclusions = array();
1379 if ( ! empty( $exclude_tree ) ) {
1380 $exclude_tree = wp_parse_id_list( $exclude_tree );
1381 $excluded_children = $exclude_tree;
1382 foreach ( $exclude_tree as $extrunk ) {
1383 $excluded_children = array_merge(
1385 (array) get_terms( $taxonomies[0], array( 'child_of' => intval( $extrunk ), 'fields' => 'ids', 'hide_empty' => 0 ) )
1388 $exclusions = array_merge( $excluded_children, $exclusions );
1391 if ( ! empty( $exclude ) ) {
1392 $exclusions = array_merge( wp_parse_id_list( $exclude ), $exclusions );
1395 // 'childless' terms are those without an entry in the flattened term hierarchy.
1396 $childless = (bool) $args['childless'];
1398 foreach ( $taxonomies as $_tax ) {
1399 $term_hierarchy = _get_term_hierarchy( $_tax );
1400 $exclusions = array_merge( array_keys( $term_hierarchy ), $exclusions );
1404 if ( ! empty( $exclusions ) ) {
1405 $exclusions = 't.term_id NOT IN (' . implode( ',', array_map( 'intval', $exclusions ) ) . ')';
1411 * Filter the terms to exclude from the terms query.
1415 * @param string $exclusions `NOT IN` clause of the terms query.
1416 * @param array $args An array of terms query arguments.
1417 * @param array $taxonomies An array of taxonomies.
1419 $exclusions = apply_filters( 'list_terms_exclusions', $exclusions, $args, $taxonomies );
1421 if ( ! empty( $exclusions ) ) {
1422 // Must do string manipulation here for backward compatibility with filter.
1423 $where_conditions[] = preg_replace( '/^\s*AND\s*/', '', $exclusions );
1426 if ( ! empty( $args['name'] ) ) {
1427 $names = (array) $args['name'];
1428 foreach ( $names as &$_name ) {
1429 // `sanitize_term_field()` returns slashed data.
1430 $_name = stripslashes( sanitize_term_field( 'name', $_name, 0, reset( $taxonomies ), 'db' ) );
1433 $where_conditions[] = "t.name IN ('" . implode( "', '", array_map( 'esc_sql', $names ) ) . "')";
1436 if ( ! empty( $args['slug'] ) ) {
1437 if ( is_array( $args['slug'] ) ) {
1438 $slug = array_map( 'sanitize_title', $args['slug'] );
1439 $where_conditions[] = "t.slug IN ('" . implode( "', '", $slug ) . "')";
1441 $slug = sanitize_title( $args['slug'] );
1442 $where_conditions[] = "t.slug = '$slug'";
1446 if ( ! empty( $args['name__like'] ) ) {
1447 $where_conditions[] = $wpdb->prepare( "t.name LIKE %s", '%' . $wpdb->esc_like( $args['name__like'] ) . '%' );
1450 if ( ! empty( $args['description__like'] ) ) {
1451 $where_conditions[] = $wpdb->prepare( "tt.description LIKE %s", '%' . $wpdb->esc_like( $args['description__like'] ) . '%' );
1454 if ( '' !== $parent ) {
1455 $parent = (int) $parent;
1456 $where_conditions[] = "tt.parent = '$parent'";
1459 $hierarchical = $args['hierarchical'];
1460 if ( 'count' == $args['fields'] ) {
1461 $hierarchical = false;
1463 if ( $args['hide_empty'] && !$hierarchical ) {
1464 $where_conditions[] = 'tt.count > 0';
1467 $number = $args['number'];
1468 $offset = $args['offset'];
1470 // Don't limit the query results when we have to descend the family tree.
1471 if ( $number && ! $hierarchical && ! $child_of && '' === $parent ) {
1473 $limits = 'LIMIT ' . $offset . ',' . $number;
1475 $limits = 'LIMIT ' . $number;
1481 if ( ! empty( $args['search'] ) ) {
1482 $like = '%' . $wpdb->esc_like( $args['search'] ) . '%';
1483 $where_conditions[] = $wpdb->prepare( '((t.name LIKE %s) OR (t.slug LIKE %s))', $like, $like );
1486 // Meta query support.
1490 $mquery = new WP_Meta_Query();
1491 $mquery->parse_query_vars( $args );
1492 $mq_sql = $mquery->get_sql( 'term', 't', 'term_id' );
1493 $meta_clauses = $mquery->get_clauses();
1495 if ( ! empty( $meta_clauses ) ) {
1496 $join .= $mq_sql['join'];
1497 $where_conditions[] = preg_replace( '/^\s*AND\s*/', '', $mq_sql['where'] );
1498 $distinct .= "DISTINCT";
1500 // 'orderby' support.
1501 $allowed_keys = array();
1502 $primary_meta_key = null;
1503 $primary_meta_query = reset( $meta_clauses );
1504 if ( ! empty( $primary_meta_query['key'] ) ) {
1505 $primary_meta_key = $primary_meta_query['key'];
1506 $allowed_keys[] = $primary_meta_key;
1508 $allowed_keys[] = 'meta_value';
1509 $allowed_keys[] = 'meta_value_num';
1510 $allowed_keys = array_merge( $allowed_keys, array_keys( $meta_clauses ) );
1512 if ( ! empty( $args['orderby'] ) && in_array( $args['orderby'], $allowed_keys ) ) {
1513 switch( $args['orderby'] ) {
1514 case $primary_meta_key:
1516 if ( ! empty( $primary_meta_query['type'] ) ) {
1517 $orderby = "ORDER BY CAST({$primary_meta_query['alias']}.meta_value AS {$primary_meta_query['cast']})";
1519 $orderby = "ORDER BY {$primary_meta_query['alias']}.meta_value";
1523 case 'meta_value_num':
1524 $orderby = "ORDER BY {$primary_meta_query['alias']}.meta_value+0";
1528 if ( array_key_exists( $args['orderby'], $meta_clauses ) ) {
1529 // $orderby corresponds to a meta_query clause.
1530 $meta_clause = $meta_clauses[ $args['orderby'] ];
1531 $orderby = "ORDER BY CAST({$meta_clause['alias']}.meta_value AS {$meta_clause['cast']})";
1539 switch ( $args['fields'] ) {
1541 $selects = array( 't.*', 'tt.*' );
1545 $selects = array( 't.term_id', 'tt.parent', 'tt.count', 'tt.taxonomy' );
1548 $selects = array( 't.term_id', 'tt.parent', 'tt.count', 't.name', 'tt.taxonomy' );
1553 $selects = array( 'COUNT(*)' );
1556 $selects = array( 't.term_id', 't.name', 'tt.count', 'tt.taxonomy' );
1559 $selects = array( 't.term_id', 't.slug', 'tt.count', 'tt.taxonomy' );
1563 $_fields = $args['fields'];
1566 * Filter the fields to select in the terms query.
1568 * Field lists modified using this filter will only modify the term fields returned
1569 * by the function when the `$fields` parameter set to 'count' or 'all'. In all other
1570 * cases, the term fields in the results array will be determined by the `$fields`
1573 * Use of this filter can result in unpredictable behavior, and is not recommended.
1577 * @param array $selects An array of fields to select for the terms query.
1578 * @param array $args An array of term query arguments.
1579 * @param array $taxonomies An array of taxonomies.
1581 $fields = implode( ', ', apply_filters( 'get_terms_fields', $selects, $args, $taxonomies ) );
1583 $join .= " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id";
1585 $where = implode( ' AND ', $where_conditions );
1587 $pieces = array( 'fields', 'join', 'where', 'distinct', 'orderby', 'order', 'limits' );
1590 * Filter the terms query SQL clauses.
1594 * @param array $pieces Terms query SQL clauses.
1595 * @param array $taxonomies An array of taxonomies.
1596 * @param array $args An array of terms query arguments.
1598 $clauses = apply_filters( 'terms_clauses', compact( $pieces ), $taxonomies, $args );
1600 $fields = isset( $clauses[ 'fields' ] ) ? $clauses[ 'fields' ] : '';
1601 $join = isset( $clauses[ 'join' ] ) ? $clauses[ 'join' ] : '';
1602 $where = isset( $clauses[ 'where' ] ) ? $clauses[ 'where' ] : '';
1603 $distinct = isset( $clauses[ 'distinct' ] ) ? $clauses[ 'distinct' ] : '';
1604 $orderby = isset( $clauses[ 'orderby' ] ) ? $clauses[ 'orderby' ] : '';
1605 $order = isset( $clauses[ 'order' ] ) ? $clauses[ 'order' ] : '';
1606 $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : '';
1609 $where = "WHERE $where";
1612 $query = "SELECT $distinct $fields FROM $wpdb->terms AS t $join $where $orderby $order $limits";
1614 // $args can be anything. Only use the args defined in defaults to compute the key.
1615 $key = md5( serialize( wp_array_slice_assoc( $args, array_keys( $defaults ) ) ) . serialize( $taxonomies ) . $query );
1616 $last_changed = wp_cache_get( 'last_changed', 'terms' );
1617 if ( ! $last_changed ) {
1618 $last_changed = microtime();
1619 wp_cache_set( 'last_changed', $last_changed, 'terms' );
1621 $cache_key = "get_terms:$key:$last_changed";
1622 $cache = wp_cache_get( $cache_key, 'terms' );
1623 if ( false !== $cache ) {
1624 if ( 'all' === $_fields ) {
1625 $cache = array_map( 'get_term', $cache );
1629 * Filter the given taxonomy's terms cache.
1633 * @param array $cache Cached array of terms for the given taxonomy.
1634 * @param array $taxonomies An array of taxonomies.
1635 * @param array $args An array of get_terms() arguments.
1637 return apply_filters( 'get_terms', $cache, $taxonomies, $args );
1640 if ( 'count' == $_fields ) {
1641 return $wpdb->get_var( $query );
1644 $terms = $wpdb->get_results($query);
1645 if ( 'all' == $_fields ) {
1646 update_term_cache( $terms );
1649 // Prime termmeta cache.
1650 if ( $args['update_term_meta_cache'] ) {
1651 $term_ids = wp_list_pluck( $terms, 'term_id' );
1652 update_termmeta_cache( $term_ids );
1655 if ( empty($terms) ) {
1656 wp_cache_add( $cache_key, array(), 'terms', DAY_IN_SECONDS );
1658 /** This filter is documented in wp-includes/taxonomy.php */
1659 return apply_filters( 'get_terms', array(), $taxonomies, $args );
1663 foreach ( $taxonomies as $_tax ) {
1664 $children = _get_term_hierarchy( $_tax );
1665 if ( ! empty( $children ) ) {
1666 $terms = _get_term_children( $child_of, $terms, $_tax );
1671 // Update term counts to include children.
1672 if ( $args['pad_counts'] && 'all' == $_fields ) {
1673 foreach ( $taxonomies as $_tax ) {
1674 _pad_term_counts( $terms, $_tax );
1678 // Make sure we show empty categories that have children.
1679 if ( $hierarchical && $args['hide_empty'] && is_array( $terms ) ) {
1680 foreach ( $terms as $k => $term ) {
1681 if ( ! $term->count ) {
1682 $children = get_term_children( $term->term_id, $term->taxonomy );
1683 if ( is_array( $children ) ) {
1684 foreach ( $children as $child_id ) {
1685 $child = get_term( $child_id, $term->taxonomy );
1686 if ( $child->count ) {
1692 // It really is empty.
1699 if ( 'id=>parent' == $_fields ) {
1700 foreach ( $terms as $term ) {
1701 $_terms[ $term->term_id ] = $term->parent;
1703 } elseif ( 'ids' == $_fields ) {
1704 foreach ( $terms as $term ) {
1705 $_terms[] = $term->term_id;
1707 } elseif ( 'names' == $_fields ) {
1708 foreach ( $terms as $term ) {
1709 $_terms[] = $term->name;
1711 } elseif ( 'id=>name' == $_fields ) {
1712 foreach ( $terms as $term ) {
1713 $_terms[ $term->term_id ] = $term->name;
1715 } elseif ( 'id=>slug' == $_fields ) {
1716 foreach ( $terms as $term ) {
1717 $_terms[ $term->term_id ] = $term->slug;
1721 if ( ! empty( $_terms ) ) {
1725 // Hierarchical queries are not limited, so 'offset' and 'number' must be handled now.
1726 if ( $hierarchical && $number && is_array( $terms ) ) {
1727 if ( $offset >= count( $terms ) ) {
1730 $terms = array_slice( $terms, $offset, $number, true );
1734 wp_cache_add( $cache_key, $terms, 'terms', DAY_IN_SECONDS );
1736 if ( 'all' === $_fields ) {
1737 $terms = array_map( 'get_term', $terms );
1740 /** This filter is documented in wp-includes/taxonomy.php */
1741 return apply_filters( 'get_terms', $terms, $taxonomies, $args );
1745 * Adds metadata to a term.
1749 * @param int $term_id Term ID.
1750 * @param string $meta_key Metadata name.
1751 * @param mixed $meta_value Metadata value.
1752 * @param bool $unique Optional. Whether to bail if an entry with the same key is found for the term.
1754 * @return int|WP_Error|bool Meta ID on success. WP_Error when term_id is ambiguous between taxonomies.
1757 function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
1758 // Bail if term meta table is not installed.
1759 if ( get_option( 'db_version' ) < 34370 ) {
1763 if ( wp_term_is_shared( $term_id ) ) {
1764 return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.'), $term_id );
1767 $added = add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
1769 // Bust term query cache.
1771 wp_cache_set( 'last_changed', microtime(), 'terms' );
1778 * Removes metadata matching criteria from a term.
1782 * @param int $term_id Term ID.
1783 * @param string $meta_key Metadata name.
1784 * @param mixed $meta_value Optional. Metadata value. If provided, rows will only be removed that match the value.
1785 * @return bool True on success, false on failure.
1787 function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
1788 // Bail if term meta table is not installed.
1789 if ( get_option( 'db_version' ) < 34370 ) {
1793 $deleted = delete_metadata( 'term', $term_id, $meta_key, $meta_value );
1795 // Bust term query cache.
1797 wp_cache_set( 'last_changed', microtime(), 'terms' );
1804 * Retrieves metadata for a term.
1808 * @param int $term_id Term ID.
1809 * @param string $key Optional. The meta key to retrieve. If no key is provided, fetches all metadata for the term.
1810 * @param bool $single Whether to return a single value. If false, an array of all values matching the
1811 * `$term_id`/`$key` pair will be returned. Default: false.
1812 * @return mixed If `$single` is false, an array of metadata values. If `$single` is true, a single metadata value.
1814 function get_term_meta( $term_id, $key = '', $single = false ) {
1815 // Bail if term meta table is not installed.
1816 if ( get_option( 'db_version' ) < 34370 ) {
1820 return get_metadata( 'term', $term_id, $key, $single );
1824 * Updates term metadata.
1826 * Use the `$prev_value` parameter to differentiate between meta fields with the same key and term ID.
1828 * If the meta field for the term does not exist, it will be added.
1832 * @param int $term_id Term ID.
1833 * @param string $meta_key Metadata key.
1834 * @param mixed $meta_value Metadata value.
1835 * @param mixed $prev_value Optional. Previous value to check before removing.
1836 * @return int|WP_Error|bool Meta ID if the key didn't previously exist. True on successful update.
1837 * WP_Error when term_id is ambiguous between taxonomies. False on failure.
1839 function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
1840 // Bail if term meta table is not installed.
1841 if ( get_option( 'db_version' ) < 34370 ) {
1845 if ( wp_term_is_shared( $term_id ) ) {
1846 return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.'), $term_id );
1849 $updated = update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
1851 // Bust term query cache.
1853 wp_cache_set( 'last_changed', microtime(), 'terms' );
1860 * Updates metadata cache for list of term IDs.
1862 * Performs SQL query to retrieve all metadata for the terms matching `$term_ids` and stores them in the cache.
1863 * Subsequent calls to `get_term_meta()` will not need to query the database.
1867 * @param array $term_ids List of term IDs.
1868 * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
1870 function update_termmeta_cache( $term_ids ) {
1871 // Bail if term meta table is not installed.
1872 if ( get_option( 'db_version' ) < 34370 ) {
1876 return update_meta_cache( 'term', $term_ids );
1880 * Check if Term exists.
1882 * Formerly is_term(), introduced in 2.3.0.
1886 * @global wpdb $wpdb WordPress database abstraction object.
1888 * @param int|string $term The term to check
1889 * @param string $taxonomy The taxonomy name to use
1890 * @param int $parent Optional. ID of parent term under which to confine the exists search.
1891 * @return mixed Returns null if the term does not exist. Returns the term ID
1892 * if no taxonomy is specified and the term ID exists. Returns
1893 * an array of the term ID and the term taxonomy ID the taxonomy
1894 * is specified and the pairing exists.
1896 function term_exists( $term, $taxonomy = '', $parent = null ) {
1899 $select = "SELECT term_id FROM $wpdb->terms as t WHERE ";
1900 $tax_select = "SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE ";
1902 if ( is_int($term) ) {
1905 $where = 't.term_id = %d';
1906 if ( !empty($taxonomy) )
1907 return $wpdb->get_row( $wpdb->prepare( $tax_select . $where . " AND tt.taxonomy = %s", $term, $taxonomy ), ARRAY_A );
1909 return $wpdb->get_var( $wpdb->prepare( $select . $where, $term ) );
1912 $term = trim( wp_unslash( $term ) );
1913 $slug = sanitize_title( $term );
1915 $where = 't.slug = %s';
1916 $else_where = 't.name = %s';
1917 $where_fields = array($slug);
1918 $else_where_fields = array($term);
1919 $orderby = 'ORDER BY t.term_id ASC';
1921 if ( !empty($taxonomy) ) {
1922 if ( is_numeric( $parent ) ) {
1923 $parent = (int) $parent;
1924 $where_fields[] = $parent;
1925 $else_where_fields[] = $parent;
1926 $where .= ' AND tt.parent = %d';
1927 $else_where .= ' AND tt.parent = %d';
1930 $where_fields[] = $taxonomy;
1931 $else_where_fields[] = $taxonomy;
1933 if ( $result = $wpdb->get_row( $wpdb->prepare("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $where AND tt.taxonomy = %s $orderby $limit", $where_fields), ARRAY_A) )
1936 return $wpdb->get_row( $wpdb->prepare("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $else_where AND tt.taxonomy = %s $orderby $limit", $else_where_fields), ARRAY_A);
1939 if ( $result = $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $where $orderby $limit", $where_fields) ) )
1942 return $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $else_where $orderby $limit", $else_where_fields) );
1946 * Check if a term is an ancestor of another term.
1948 * You can use either an id or the term object for both parameters.
1952 * @param int|object $term1 ID or object to check if this is the parent term.
1953 * @param int|object $term2 The child term.
1954 * @param string $taxonomy Taxonomy name that $term1 and `$term2` belong to.
1955 * @return bool Whether `$term2` is a child of `$term1`.
1957 function term_is_ancestor_of( $term1, $term2, $taxonomy ) {
1958 if ( ! isset( $term1->term_id ) )
1959 $term1 = get_term( $term1, $taxonomy );
1960 if ( ! isset( $term2->parent ) )
1961 $term2 = get_term( $term2, $taxonomy );
1963 if ( empty( $term1->term_id ) || empty( $term2->parent ) )
1965 if ( $term2->parent == $term1->term_id )
1968 return term_is_ancestor_of( $term1, get_term( $term2->parent, $taxonomy ), $taxonomy );
1972 * Sanitize Term all fields.
1974 * Relies on sanitize_term_field() to sanitize the term. The difference is that
1975 * this function will sanitize <strong>all</strong> fields. The context is based
1976 * on sanitize_term_field().
1978 * The $term is expected to be either an array or an object.
1982 * @param array|object $term The term to check.
1983 * @param string $taxonomy The taxonomy name to use.
1984 * @param string $context Optional. Context in which to sanitize the term. Accepts 'edit', 'db',
1985 * 'display', 'attribute', or 'js'. Default 'display'.
1986 * @return array|object Term with all fields sanitized.
1988 function sanitize_term($term, $taxonomy, $context = 'display') {
1989 $fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' );
1991 $do_object = is_object( $term );
1993 $term_id = $do_object ? $term->term_id : (isset($term['term_id']) ? $term['term_id'] : 0);
1995 foreach ( (array) $fields as $field ) {
1997 if ( isset($term->$field) )
1998 $term->$field = sanitize_term_field($field, $term->$field, $term_id, $taxonomy, $context);
2000 if ( isset($term[$field]) )
2001 $term[$field] = sanitize_term_field($field, $term[$field], $term_id, $taxonomy, $context);
2006 $term->filter = $context;
2008 $term['filter'] = $context;
2014 * Cleanse the field value in the term based on the context.
2016 * Passing a term field value through the function should be assumed to have
2017 * cleansed the value for whatever context the term field is going to be used.
2019 * If no context or an unsupported context is given, then default filters will
2022 * There are enough filters for each context to support a custom filtering
2023 * without creating your own filter function. Simply create a function that
2024 * hooks into the filter you need.
2028 * @param string $field Term field to sanitize.
2029 * @param string $value Search for this term value.
2030 * @param int $term_id Term ID.
2031 * @param string $taxonomy Taxonomy Name.
2032 * @param string $context Context in which to sanitize the term field. Accepts 'edit', 'db', 'display',
2033 * 'attribute', or 'js'.
2034 * @return mixed Sanitized field.
2036 function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) {
2037 $int_fields = array( 'parent', 'term_id', 'count', 'term_group', 'term_taxonomy_id', 'object_id' );
2038 if ( in_array( $field, $int_fields ) ) {
2039 $value = (int) $value;
2044 if ( 'raw' == $context )
2047 if ( 'edit' == $context ) {
2050 * Filter a term field to edit before it is sanitized.
2052 * The dynamic portion of the filter name, `$field`, refers to the term field.
2056 * @param mixed $value Value of the term field.
2057 * @param int $term_id Term ID.
2058 * @param string $taxonomy Taxonomy slug.
2060 $value = apply_filters( "edit_term_{$field}", $value, $term_id, $taxonomy );
2063 * Filter the taxonomy field to edit before it is sanitized.
2065 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
2066 * to the taxonomy slug and taxonomy field, respectively.
2070 * @param mixed $value Value of the taxonomy field to edit.
2071 * @param int $term_id Term ID.
2073 $value = apply_filters( "edit_{$taxonomy}_{$field}", $value, $term_id );
2075 if ( 'description' == $field )
2076 $value = esc_html($value); // textarea_escaped
2078 $value = esc_attr($value);
2079 } elseif ( 'db' == $context ) {
2082 * Filter a term field value before it is sanitized.
2084 * The dynamic portion of the filter name, `$field`, refers to the term field.
2088 * @param mixed $value Value of the term field.
2089 * @param string $taxonomy Taxonomy slug.
2091 $value = apply_filters( "pre_term_{$field}", $value, $taxonomy );
2094 * Filter a taxonomy field before it is sanitized.
2096 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
2097 * to the taxonomy slug and field name, respectively.
2101 * @param mixed $value Value of the taxonomy field.
2103 $value = apply_filters( "pre_{$taxonomy}_{$field}", $value );
2105 // Back compat filters
2106 if ( 'slug' == $field ) {
2108 * Filter the category nicename before it is sanitized.
2110 * Use the pre_{$taxonomy}_{$field} hook instead.
2114 * @param string $value The category nicename.
2116 $value = apply_filters( 'pre_category_nicename', $value );
2119 } elseif ( 'rss' == $context ) {
2122 * Filter the term field for use in RSS.
2124 * The dynamic portion of the filter name, `$field`, refers to the term field.
2128 * @param mixed $value Value of the term field.
2129 * @param string $taxonomy Taxonomy slug.
2131 $value = apply_filters( "term_{$field}_rss", $value, $taxonomy );
2134 * Filter the taxonomy field for use in RSS.
2136 * The dynamic portions of the hook name, `$taxonomy`, and `$field`, refer
2137 * to the taxonomy slug and field name, respectively.
2141 * @param mixed $value Value of the taxonomy field.
2143 $value = apply_filters( "{$taxonomy}_{$field}_rss", $value );
2145 // Use display filters by default.
2148 * Filter the term field sanitized for display.
2150 * The dynamic portion of the filter name, `$field`, refers to the term field name.
2154 * @param mixed $value Value of the term field.
2155 * @param int $term_id Term ID.
2156 * @param string $taxonomy Taxonomy slug.
2157 * @param string $context Context to retrieve the term field value.
2159 $value = apply_filters( "term_{$field}", $value, $term_id, $taxonomy, $context );
2162 * Filter the taxonomy field sanitized for display.
2164 * The dynamic portions of the filter name, `$taxonomy`, and `$field`, refer
2165 * to the taxonomy slug and taxonomy field, respectively.
2169 * @param mixed $value Value of the taxonomy field.
2170 * @param int $term_id Term ID.
2171 * @param string $context Context to retrieve the taxonomy field value.
2173 $value = apply_filters( "{$taxonomy}_{$field}", $value, $term_id, $context );
2176 if ( 'attribute' == $context ) {
2177 $value = esc_attr($value);
2178 } elseif ( 'js' == $context ) {
2179 $value = esc_js($value);
2185 * Count how many terms are in Taxonomy.
2187 * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true).
2191 * @param string $taxonomy Taxonomy name.
2192 * @param array|string $args Optional. Array of arguments that get passed to {@see get_terms()}.
2193 * Default empty array.
2194 * @return array|int|WP_Error Number of terms in that taxonomy or WP_Error if the taxonomy does not exist.
2196 function wp_count_terms( $taxonomy, $args = array() ) {
2197 $defaults = array('hide_empty' => false);
2198 $args = wp_parse_args($args, $defaults);
2200 // backwards compatibility
2201 if ( isset($args['ignore_empty']) ) {
2202 $args['hide_empty'] = $args['ignore_empty'];
2203 unset($args['ignore_empty']);
2206 $args['fields'] = 'count';
2208 return get_terms($taxonomy, $args);
2212 * Will unlink the object from the taxonomy or taxonomies.
2214 * Will remove all relationships between the object and any terms in
2215 * a particular taxonomy or taxonomies. Does not remove the term or
2220 * @param int $object_id The term Object Id that refers to the term.
2221 * @param string|array $taxonomies List of Taxonomy Names or single Taxonomy name.
2223 function wp_delete_object_term_relationships( $object_id, $taxonomies ) {
2224 $object_id = (int) $object_id;
2226 if ( !is_array($taxonomies) )
2227 $taxonomies = array($taxonomies);
2229 foreach ( (array) $taxonomies as $taxonomy ) {
2230 $term_ids = wp_get_object_terms( $object_id, $taxonomy, array( 'fields' => 'ids' ) );
2231 $term_ids = array_map( 'intval', $term_ids );
2232 wp_remove_object_terms( $object_id, $term_ids, $taxonomy );
2237 * Removes a term from the database.
2239 * If the term is a parent of other terms, then the children will be updated to
2240 * that term's parent.
2242 * Metadata associated with the term will be deleted.
2246 * @global wpdb $wpdb WordPress database abstraction object.
2248 * @param int $term Term ID.
2249 * @param string $taxonomy Taxonomy Name.
2250 * @param array|string $args {
2251 * Optional. Array of arguments to override the default term ID. Default empty array.
2253 * @type int $default The term ID to make the default term. This will only override
2254 * the terms found if there is only one term found. Any other and
2255 * the found terms are used.
2256 * @type bool $force_default Optional. Whether to force the supplied term as default to be
2257 * assigned even if the object was not going to be term-less.
2260 * @return bool|int|WP_Error True on success, false if term does not exist. Zero on attempted
2261 * deletion of default Category. WP_Error if the taxonomy does not exist.
2263 function wp_delete_term( $term, $taxonomy, $args = array() ) {
2266 $term = (int) $term;
2268 if ( ! $ids = term_exists($term, $taxonomy) )
2270 if ( is_wp_error( $ids ) )
2273 $tt_id = $ids['term_taxonomy_id'];
2275 $defaults = array();
2277 if ( 'category' == $taxonomy ) {
2278 $defaults['default'] = get_option( 'default_category' );
2279 if ( $defaults['default'] == $term )
2280 return 0; // Don't delete the default category
2283 $args = wp_parse_args($args, $defaults);
2285 if ( isset( $args['default'] ) ) {
2286 $default = (int) $args['default'];
2287 if ( ! term_exists( $default, $taxonomy ) ) {
2292 if ( isset( $args['force_default'] ) ) {
2293 $force_default = $args['force_default'];
2297 * Fires when deleting a term, before any modifications are made to posts or terms.
2301 * @param int $term Term ID.
2302 * @param string $taxonomy Taxonomy Name.
2304 do_action( 'pre_delete_term', $term, $taxonomy );
2306 // Update children to point to new parent
2307 if ( is_taxonomy_hierarchical($taxonomy) ) {
2308 $term_obj = get_term($term, $taxonomy);
2309 if ( is_wp_error( $term_obj ) )
2311 $parent = $term_obj->parent;
2313 $edit_ids = $wpdb->get_results( "SELECT term_id, term_taxonomy_id FROM $wpdb->term_taxonomy WHERE `parent` = " . (int)$term_obj->term_id );
2314 $edit_tt_ids = wp_list_pluck( $edit_ids, 'term_taxonomy_id' );
2317 * Fires immediately before a term to delete's children are reassigned a parent.
2321 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term.
2323 do_action( 'edit_term_taxonomies', $edit_tt_ids );
2325 $wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id) + compact( 'taxonomy' ) );
2327 // Clean the cache for all child terms.
2328 $edit_term_ids = wp_list_pluck( $edit_ids, 'term_id' );
2329 clean_term_cache( $edit_term_ids, $taxonomy );
2332 * Fires immediately after a term to delete's children are reassigned a parent.
2336 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term.
2338 do_action( 'edited_term_taxonomies', $edit_tt_ids );
2341 // Get the term before deleting it or its term relationships so we can pass to actions below.
2342 $deleted_term = get_term( $term, $taxonomy );
2344 $object_ids = (array) $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
2346 foreach ( $object_ids as $object_id ) {
2347 $terms = wp_get_object_terms( $object_id, $taxonomy, array( 'fields' => 'ids', 'orderby' => 'none' ) );
2348 if ( 1 == count($terms) && isset($default) ) {
2349 $terms = array($default);
2351 $terms = array_diff($terms, array($term));
2352 if (isset($default) && isset($force_default) && $force_default)
2353 $terms = array_merge($terms, array($default));
2355 $terms = array_map('intval', $terms);
2356 wp_set_object_terms( $object_id, $terms, $taxonomy );
2359 // Clean the relationship caches for all object types using this term.
2360 $tax_object = get_taxonomy( $taxonomy );
2361 foreach ( $tax_object->object_type as $object_type )
2362 clean_object_term_cache( $object_ids, $object_type );
2364 $term_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->termmeta WHERE term_id = %d ", $term ) );
2365 foreach ( $term_meta_ids as $mid ) {
2366 delete_metadata_by_mid( 'term', $mid );
2370 * Fires immediately before a term taxonomy ID is deleted.
2374 * @param int $tt_id Term taxonomy ID.
2376 do_action( 'delete_term_taxonomy', $tt_id );
2377 $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) );
2380 * Fires immediately after a term taxonomy ID is deleted.
2384 * @param int $tt_id Term taxonomy ID.
2386 do_action( 'deleted_term_taxonomy', $tt_id );
2388 // Delete the term if no taxonomies use it.
2389 if ( !$wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term) ) )
2390 $wpdb->delete( $wpdb->terms, array( 'term_id' => $term ) );
2392 clean_term_cache($term, $taxonomy);
2395 * Fires after a term is deleted from the database and the cache is cleaned.
2398 * @since 4.5.0 Introduced the `$object_ids` argument.
2400 * @param int $term Term ID.
2401 * @param int $tt_id Term taxonomy ID.
2402 * @param string $taxonomy Taxonomy slug.
2403 * @param mixed $deleted_term Copy of the already-deleted term, in the form specified
2404 * by the parent function. WP_Error otherwise.
2405 * @param array $object_ids List of term object IDs.
2407 do_action( 'delete_term', $term, $tt_id, $taxonomy, $deleted_term, $object_ids );
2410 * Fires after a term in a specific taxonomy is deleted.
2412 * The dynamic portion of the hook name, `$taxonomy`, refers to the specific
2413 * taxonomy the term belonged to.
2416 * @since 4.5.0 Introduced the `$object_ids` argument.
2418 * @param int $term Term ID.
2419 * @param int $tt_id Term taxonomy ID.
2420 * @param mixed $deleted_term Copy of the already-deleted term, in the form specified
2421 * by the parent function. WP_Error otherwise.
2422 * @param array $object_ids List of term object IDs.
2424 do_action( "delete_$taxonomy", $term, $tt_id, $deleted_term, $object_ids );
2430 * Deletes one existing category.
2434 * @param int $cat_ID
2435 * @return bool|int|WP_Error Returns true if completes delete action; false if term doesn't exist;
2436 * Zero on attempted deletion of default Category; WP_Error object is also a possibility.
2438 function wp_delete_category( $cat_ID ) {
2439 return wp_delete_term( $cat_ID, 'category' );
2443 * Retrieves the terms associated with the given object(s), in the supplied taxonomies.
2446 * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`.
2447 * Introduced `$parent` argument.
2448 * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or
2449 * 'all_with_object_id', an array of `WP_Term` objects will be returned.
2451 * @global wpdb $wpdb WordPress database abstraction object.
2453 * @param int|array $object_ids The ID(s) of the object(s) to retrieve.
2454 * @param string|array $taxonomies The taxonomies to retrieve terms from.
2455 * @param array|string $args {
2456 * Array of arguments.
2457 * @type string $orderby Field by which results should be sorted. Accepts 'name', 'count', 'slug',
2458 * 'term_group', 'term_order', 'taxonomy', 'parent', or 'term_taxonomy_id'.
2460 * @type string $order Sort order. Accepts 'ASC' or 'DESC'. Default 'ASC'.
2461 * @type string $fields Fields to return for matched terms. Accepts 'all', 'ids', 'names', and
2462 * 'all_with_object_id'. Note that 'all' or 'all_with_object_id' will result
2463 * in an array of term objects being returned, 'ids' will return an array of
2464 * integers, and 'names' an array of strings.
2465 * @type int $parent Optional. Limit results to the direct children of a given term ID.
2466 * @type bool $update_term_meta_cache Whether to prime termmeta cache for matched terms. Only applies when
2467 * `$fields` is 'all', 'all_with_object_id', or 'term_id'. Default true.
2468 * @type array $meta_query Meta query clauses to limit retrieved terms by. See `WP_Meta_Query`.
2471 * @return array|WP_Error The requested term data or empty array if no terms found.
2472 * WP_Error if any of the $taxonomies don't exist.
2474 function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
2477 if ( empty( $object_ids ) || empty( $taxonomies ) )
2480 if ( !is_array($taxonomies) )
2481 $taxonomies = array($taxonomies);
2483 foreach ( $taxonomies as $taxonomy ) {
2484 if ( ! taxonomy_exists($taxonomy) )
2485 return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
2488 if ( !is_array($object_ids) )
2489 $object_ids = array($object_ids);
2490 $object_ids = array_map('intval', $object_ids);
2493 'orderby' => 'name',
2497 'update_term_meta_cache' => true,
2500 $args = wp_parse_args( $args, $defaults );
2503 if ( count($taxonomies) > 1 ) {
2504 foreach ( $taxonomies as $index => $taxonomy ) {
2505 $t = get_taxonomy($taxonomy);
2506 if ( isset($t->args) && is_array($t->args) && $args != array_merge($args, $t->args) ) {
2507 unset($taxonomies[$index]);
2508 $terms = array_merge($terms, wp_get_object_terms($object_ids, $taxonomy, array_merge($args, $t->args)));
2512 $t = get_taxonomy($taxonomies[0]);
2513 if ( isset($t->args) && is_array($t->args) )
2514 $args = array_merge($args, $t->args);
2517 $orderby = $args['orderby'];
2518 $order = $args['order'];
2519 $fields = $args['fields'];
2521 if ( in_array( $orderby, array( 'term_id', 'name', 'slug', 'term_group' ) ) ) {
2522 $orderby = "t.$orderby";
2523 } elseif ( in_array( $orderby, array( 'count', 'parent', 'taxonomy', 'term_taxonomy_id' ) ) ) {
2524 $orderby = "tt.$orderby";
2525 } elseif ( 'term_order' === $orderby ) {
2526 $orderby = 'tr.term_order';
2527 } elseif ( 'none' === $orderby ) {
2531 $orderby = 't.term_id';
2534 // tt_ids queries can only be none or tr.term_taxonomy_id
2535 if ( ('tt_ids' == $fields) && !empty($orderby) )
2536 $orderby = 'tr.term_taxonomy_id';
2538 if ( !empty($orderby) )
2539 $orderby = "ORDER BY $orderby";
2541 $order = strtoupper( $order );
2542 if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) )
2545 $taxonomy_array = $taxonomies;
2546 $object_id_array = $object_ids;
2547 $taxonomies = "'" . implode("', '", array_map( 'esc_sql', $taxonomies ) ) . "'";
2548 $object_ids = implode(', ', $object_ids);
2551 if ( 'all' == $fields ) {
2552 $select_this = 't.*, tt.*';
2553 } elseif ( 'ids' == $fields ) {
2554 $select_this = 't.term_id';
2555 } elseif ( 'names' == $fields ) {
2556 $select_this = 't.name';
2557 } elseif ( 'slugs' == $fields ) {
2558 $select_this = 't.slug';
2559 } elseif ( 'all_with_object_id' == $fields ) {
2560 $select_this = 't.*, tt.*, tr.object_id';
2564 "tt.taxonomy IN ($taxonomies)",
2565 "tr.object_id IN ($object_ids)",
2568 if ( '' !== $args['parent'] ) {
2569 $where[] = $wpdb->prepare( 'tt.parent = %d', $args['parent'] );
2572 // Meta query support.
2573 $meta_query_join = '';
2574 if ( ! empty( $args['meta_query'] ) ) {
2575 $mquery = new WP_Meta_Query( $args['meta_query'] );
2576 $mq_sql = $mquery->get_sql( 'term', 't', 'term_id' );
2578 $meta_query_join .= $mq_sql['join'];
2580 // Strip leading AND.
2581 $where[] = preg_replace( '/^\s*AND/', '', $mq_sql['where'] );
2584 $where = implode( ' AND ', $where );
2586 $query = "SELECT $select_this FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON tt.term_id = t.term_id INNER JOIN $wpdb->term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id $meta_query_join WHERE $where $orderby $order";
2589 if ( 'all' == $fields || 'all_with_object_id' == $fields ) {
2590 $_terms = $wpdb->get_results( $query );
2591 $object_id_index = array();
2592 foreach ( $_terms as $key => $term ) {
2593 $term = sanitize_term( $term, $taxonomy, 'raw' );
2594 $_terms[ $key ] = $term;
2596 if ( isset( $term->object_id ) ) {
2597 $object_id_index[ $key ] = $term->object_id;
2601 update_term_cache( $_terms );
2602 $_terms = array_map( 'get_term', $_terms );
2604 // Re-add the object_id data, which is lost when fetching terms from cache.
2605 if ( 'all_with_object_id' === $fields ) {
2606 foreach ( $_terms as $key => $_term ) {
2607 if ( isset( $object_id_index[ $key ] ) ) {
2608 $_term->object_id = $object_id_index[ $key ];
2613 $terms = array_merge( $terms, $_terms );
2616 } elseif ( 'ids' == $fields || 'names' == $fields || 'slugs' == $fields ) {
2617 $_terms = $wpdb->get_col( $query );
2618 $_field = ( 'ids' == $fields ) ? 'term_id' : 'name';
2619 foreach ( $_terms as $key => $term ) {
2620 $_terms[$key] = sanitize_term_field( $_field, $term, $term, $taxonomy, 'raw' );
2622 $terms = array_merge( $terms, $_terms );
2623 } elseif ( 'tt_ids' == $fields ) {
2624 $terms = $wpdb->get_col("SELECT tr.term_taxonomy_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tr.object_id IN ($object_ids) AND tt.taxonomy IN ($taxonomies) $orderby $order");
2625 foreach ( $terms as $key => $tt_id ) {
2626 $terms[$key] = sanitize_term_field( 'term_taxonomy_id', $tt_id, 0, $taxonomy, 'raw' ); // 0 should be the term id, however is not needed when using raw context.
2630 // Update termmeta cache, if necessary.
2631 if ( $args['update_term_meta_cache'] && ( 'all' === $fields || 'all_with_object_ids' === $fields || 'term_id' === $fields ) ) {
2632 if ( 'term_id' === $fields ) {
2633 $term_ids = $fields;
2635 $term_ids = wp_list_pluck( $terms, 'term_id' );
2638 update_termmeta_cache( $term_ids );
2643 } elseif ( $objects && 'all_with_object_id' !== $fields ) {
2646 foreach ( $terms as $term ) {
2647 if ( in_array( $term->term_taxonomy_id, $_tt_ids ) ) {
2651 $_tt_ids[] = $term->term_taxonomy_id;
2655 } elseif ( ! $objects ) {
2656 $terms = array_values( array_unique( $terms ) );
2660 * Filter the terms for a given object or objects.
2664 * @param array $terms An array of terms for the given object or objects.
2665 * @param array $object_id_array Array of object IDs for which `$terms` were retrieved.
2666 * @param array $taxonomy_array Array of taxonomies from which `$terms` were retrieved.
2667 * @param array $args An array of arguments for retrieving terms for the given
2668 * object(s). See wp_get_object_terms() for details.
2670 $terms = apply_filters( 'get_object_terms', $terms, $object_id_array, $taxonomy_array, $args );
2673 * Filter the terms for a given object or objects.
2675 * The `$taxonomies` parameter passed to this filter is formatted as a SQL fragment. The
2676 * {@see 'get_object_terms'} filter is recommended as an alternative.
2680 * @param array $terms An array of terms for the given object or objects.
2681 * @param int|array $object_ids Object ID or array of IDs.
2682 * @param string $taxonomies SQL-formatted (comma-separated and quoted) list of taxonomy names.
2683 * @param array $args An array of arguments for retrieving terms for the given object(s).
2684 * See {@see wp_get_object_terms()} for details.
2686 return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );
2690 * Add a new term to the database.
2692 * A non-existent term is inserted in the following sequence:
2693 * 1. The term is added to the term table, then related to the taxonomy.
2694 * 2. If everything is correct, several actions are fired.
2695 * 3. The 'term_id_filter' is evaluated.
2696 * 4. The term cache is cleaned.
2697 * 5. Several more actions are fired.
2698 * 6. An array is returned containing the term_id and term_taxonomy_id.
2700 * If the 'slug' argument is not empty, then it is checked to see if the term
2701 * is invalid. If it is not a valid, existing term, it is added and the term_id
2704 * If the taxonomy is hierarchical, and the 'parent' argument is not empty,
2705 * the term is inserted and the term_id will be given.
2708 * If $taxonomy does not exist or $term is empty,
2709 * a WP_Error object will be returned.
2711 * If the term already exists on the same hierarchical level,
2712 * or the term slug and name are not unique, a WP_Error object will be returned.
2714 * @global wpdb $wpdb WordPress database abstraction object.
2718 * @param string $term The term to add or update.
2719 * @param string $taxonomy The taxonomy to which to add the term.
2720 * @param array|string $args {
2721 * Optional. Array or string of arguments for inserting a term.
2723 * @type string $alias_of Slug of the term to make this term an alias of.
2724 * Default empty string. Accepts a term slug.
2725 * @type string $description The term description. Default empty string.
2726 * @type int $parent The id of the parent term. Default 0.
2727 * @type string $slug The term slug to use. Default empty string.
2729 * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
2730 * {@see WP_Error} otherwise.
2732 function wp_insert_term( $term, $taxonomy, $args = array() ) {
2735 if ( ! taxonomy_exists($taxonomy) ) {
2736 return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
2739 * Filter a term before it is sanitized and inserted into the database.
2743 * @param string $term The term to add or update.
2744 * @param string $taxonomy Taxonomy slug.
2746 $term = apply_filters( 'pre_insert_term', $term, $taxonomy );
2747 if ( is_wp_error( $term ) ) {
2750 if ( is_int($term) && 0 == $term ) {
2751 return new WP_Error('invalid_term_id', __('Invalid term ID'));
2753 if ( '' == trim($term) ) {
2754 return new WP_Error('empty_term_name', __('A name is required for this term'));
2756 $defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => '');
2757 $args = wp_parse_args( $args, $defaults );
2759 if ( $args['parent'] > 0 && ! term_exists( (int) $args['parent'] ) ) {
2760 return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) );
2763 $args['name'] = $term;
2764 $args['taxonomy'] = $taxonomy;
2766 // Coerce null description to strings, to avoid database errors.
2767 $args['description'] = (string) $args['description'];
2769 $args = sanitize_term($args, $taxonomy, 'db');
2771 // expected_slashed ($name)
2772 $name = wp_unslash( $args['name'] );
2773 $description = wp_unslash( $args['description'] );
2774 $parent = (int) $args['parent'];
2776 $slug_provided = ! empty( $args['slug'] );
2777 if ( ! $slug_provided ) {
2778 $slug = sanitize_title( $name );
2780 $slug = $args['slug'];
2784 if ( $args['alias_of'] ) {
2785 $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy );
2786 if ( ! empty( $alias->term_group ) ) {
2787 // The alias we want is already in a group, so let's use that one.
2788 $term_group = $alias->term_group;
2789 } elseif ( ! empty( $alias->term_id ) ) {
2791 * The alias is not in a group, so we create a new one
2792 * and add the alias to it.
2794 $term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
2796 wp_update_term( $alias->term_id, $taxonomy, array(
2797 'term_group' => $term_group,
2803 * Prevent the creation of terms with duplicate names at the same level of a taxonomy hierarchy,
2804 * unless a unique slug has been explicitly provided.
2806 $name_matches = get_terms( $taxonomy, array(
2808 'hide_empty' => false,
2812 * The `name` match in `get_terms()` doesn't differentiate accented characters,
2813 * so we do a stricter comparison here.
2816 if ( $name_matches ) {
2817 foreach ( $name_matches as $_match ) {
2818 if ( strtolower( $name ) === strtolower( $_match->name ) ) {
2819 $name_match = $_match;
2825 if ( $name_match ) {
2826 $slug_match = get_term_by( 'slug', $slug, $taxonomy );
2827 if ( ! $slug_provided || $name_match->slug === $slug || $slug_match ) {
2828 if ( is_taxonomy_hierarchical( $taxonomy ) ) {
2829 $siblings = get_terms( $taxonomy, array( 'get' => 'all', 'parent' => $parent ) );
2831 $existing_term = null;
2832 if ( $name_match->slug === $slug && in_array( $name, wp_list_pluck( $siblings, 'name' ) ) ) {
2833 $existing_term = $name_match;
2834 } elseif ( $slug_match && in_array( $slug, wp_list_pluck( $siblings, 'slug' ) ) ) {
2835 $existing_term = $slug_match;
2838 if ( $existing_term ) {
2839 return new WP_Error( 'term_exists', __( 'A term with the name provided already exists with this parent.' ), $existing_term->term_id );
2842 return new WP_Error( 'term_exists', __( 'A term with the name provided already exists in this taxonomy.' ), $name_match->term_id );
2847 $slug = wp_unique_term_slug( $slug, (object) $args );
2849 if ( false === $wpdb->insert( $wpdb->terms, compact( 'name', 'slug', 'term_group' ) ) ) {
2850 return new WP_Error( 'db_insert_error', __( 'Could not insert term into the database' ), $wpdb->last_error );
2853 $term_id = (int) $wpdb->insert_id;
2855 // Seems unreachable, However, Is used in the case that a term name is provided, which sanitizes to an empty string.
2856 if ( empty($slug) ) {
2857 $slug = sanitize_title($slug, $term_id);
2859 /** This action is documented in wp-includes/taxonomy.php */
2860 do_action( 'edit_terms', $term_id, $taxonomy );
2861 $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
2863 /** This action is documented in wp-includes/taxonomy.php */
2864 do_action( 'edited_terms', $term_id, $taxonomy );
2867 $tt_id = $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id ) );
2869 if ( !empty($tt_id) ) {
2870 return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
2872 $wpdb->insert( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent') + array( 'count' => 0 ) );
2873 $tt_id = (int) $wpdb->insert_id;
2876 * Sanity check: if we just created a term with the same parent + taxonomy + slug but a higher term_id than
2877 * an existing term, then we have unwittingly created a duplicate term. Delete the dupe, and use the term_id
2878 * and term_taxonomy_id of the older term instead. Then return out of the function so that the "create" hooks
2881 $duplicate_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.term_id, tt.term_taxonomy_id FROM $wpdb->terms t INNER JOIN $wpdb->term_taxonomy tt ON ( tt.term_id = t.term_id ) WHERE t.slug = %s AND tt.parent = %d AND tt.taxonomy = %s AND t.term_id < %d AND tt.term_taxonomy_id != %d", $slug, $parent, $taxonomy, $term_id, $tt_id ) );
2882 if ( $duplicate_term ) {
2883 $wpdb->delete( $wpdb->terms, array( 'term_id' => $term_id ) );
2884 $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) );
2886 $term_id = (int) $duplicate_term->term_id;
2887 $tt_id = (int) $duplicate_term->term_taxonomy_id;
2889 clean_term_cache( $term_id, $taxonomy );
2890 return array( 'term_id' => $term_id, 'term_taxonomy_id' => $tt_id );
2894 * Fires immediately after a new term is created, before the term cache is cleaned.
2898 * @param int $term_id Term ID.
2899 * @param int $tt_id Term taxonomy ID.
2900 * @param string $taxonomy Taxonomy slug.
2902 do_action( "create_term", $term_id, $tt_id, $taxonomy );
2905 * Fires after a new term is created for a specific taxonomy.
2907 * The dynamic portion of the hook name, `$taxonomy`, refers
2908 * to the slug of the taxonomy the term was created for.
2912 * @param int $term_id Term ID.
2913 * @param int $tt_id Term taxonomy ID.
2915 do_action( "create_$taxonomy", $term_id, $tt_id );
2918 * Filter the term ID after a new term is created.
2922 * @param int $term_id Term ID.
2923 * @param int $tt_id Taxonomy term ID.
2925 $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id );
2927 clean_term_cache($term_id, $taxonomy);
2930 * Fires after a new term is created, and after the term cache has been cleaned.
2934 * @param int $term_id Term ID.
2935 * @param int $tt_id Term taxonomy ID.
2936 * @param string $taxonomy Taxonomy slug.
2938 do_action( 'created_term', $term_id, $tt_id, $taxonomy );
2941 * Fires after a new term in a specific taxonomy is created, and after the term
2942 * cache has been cleaned.
2944 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
2948 * @param int $term_id Term ID.
2949 * @param int $tt_id Term taxonomy ID.
2951 do_action( "created_$taxonomy", $term_id, $tt_id );
2953 return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
2957 * Create Term and Taxonomy Relationships.
2959 * Relates an object (post, link etc) to a term and taxonomy type. Creates the
2960 * term and taxonomy relationship if it doesn't already exist. Creates a term if
2961 * it doesn't exist (using the slug).
2963 * A relationship means that the term is grouped in or belongs to the taxonomy.
2964 * A term has no meaning until it is given context by defining which taxonomy it
2969 * @global wpdb $wpdb The WordPress database abstraction object.
2971 * @param int $object_id The object to relate to.
2972 * @param array|int|string $terms A single term slug, single term id, or array of either term slugs or ids.
2973 * Will replace all existing related terms in this taxonomy.
2974 * @param string $taxonomy The context in which to relate the term to the object.
2975 * @param bool $append Optional. If false will delete difference of terms. Default false.
2976 * @return array|WP_Error Term taxonomy IDs of the affected terms.
2978 function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
2981 $object_id = (int) $object_id;
2983 if ( ! taxonomy_exists($taxonomy) )
2984 return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
2986 if ( !is_array($terms) )
2987 $terms = array($terms);
2990 $old_tt_ids = wp_get_object_terms($object_id, $taxonomy, array('fields' => 'tt_ids', 'orderby' => 'none'));
2992 $old_tt_ids = array();
2995 $term_ids = array();
2996 $new_tt_ids = array();
2998 foreach ( (array) $terms as $term) {
2999 if ( !strlen(trim($term)) )
3002 if ( !$term_info = term_exists($term, $taxonomy) ) {
3003 // Skip if a non-existent term ID is passed.
3004 if ( is_int($term) )
3006 $term_info = wp_insert_term($term, $taxonomy);
3008 if ( is_wp_error($term_info) )
3010 $term_ids[] = $term_info['term_id'];
3011 $tt_id = $term_info['term_taxonomy_id'];
3014 if ( $wpdb->get_var( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id = %d", $object_id, $tt_id ) ) )
3018 * Fires immediately before an object-term relationship is added.
3022 * @param int $object_id Object ID.
3023 * @param int $tt_id Term taxonomy ID.
3025 do_action( 'add_term_relationship', $object_id, $tt_id );
3026 $wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $tt_id ) );
3029 * Fires immediately after an object-term relationship is added.
3033 * @param int $object_id Object ID.
3034 * @param int $tt_id Term taxonomy ID.
3036 do_action( 'added_term_relationship', $object_id, $tt_id );
3037 $new_tt_ids[] = $tt_id;
3041 wp_update_term_count( $new_tt_ids, $taxonomy );
3044 $delete_tt_ids = array_diff( $old_tt_ids, $tt_ids );
3046 if ( $delete_tt_ids ) {
3047 $in_delete_tt_ids = "'" . implode( "', '", $delete_tt_ids ) . "'";
3048 $delete_term_ids = $wpdb->get_col( $wpdb->prepare( "SELECT tt.term_id FROM $wpdb->term_taxonomy AS tt WHERE tt.taxonomy = %s AND tt.term_taxonomy_id IN ($in_delete_tt_ids)", $taxonomy ) );
3049 $delete_term_ids = array_map( 'intval', $delete_term_ids );
3051 $remove = wp_remove_object_terms( $object_id, $delete_term_ids, $taxonomy );
3052 if ( is_wp_error( $remove ) ) {
3058 $t = get_taxonomy($taxonomy);
3059 if ( ! $append && isset($t->sort) && $t->sort ) {
3062 $final_tt_ids = wp_get_object_terms($object_id, $taxonomy, array('fields' => 'tt_ids'));
3063 foreach ( $tt_ids as $tt_id )
3064 if ( in_array($tt_id, $final_tt_ids) )
3065 $values[] = $wpdb->prepare( "(%d, %d, %d)", $object_id, $tt_id, ++$term_order);
3067 if ( false === $wpdb->query( "INSERT INTO $wpdb->term_relationships (object_id, term_taxonomy_id, term_order) VALUES " . join( ',', $values ) . " ON DUPLICATE KEY UPDATE term_order = VALUES(term_order)" ) )
3068 return new WP_Error( 'db_insert_error', __( 'Could not insert term relationship into the database' ), $wpdb->last_error );
3071 wp_cache_delete( $object_id, $taxonomy . '_relationships' );
3074 * Fires after an object's terms have been set.
3078 * @param int $object_id Object ID.
3079 * @param array $terms An array of object terms.
3080 * @param array $tt_ids An array of term taxonomy IDs.
3081 * @param string $taxonomy Taxonomy slug.
3082 * @param bool $append Whether to append new terms to the old terms.
3083 * @param array $old_tt_ids Old array of term taxonomy IDs.
3085 do_action( 'set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids );
3090 * Add term(s) associated with a given object.
3094 * @param int $object_id The ID of the object to which the terms will be added.
3095 * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to add.
3096 * @param array|string $taxonomy Taxonomy name.
3097 * @return array|WP_Error Term taxonomy IDs of the affected terms.
3099 function wp_add_object_terms( $object_id, $terms, $taxonomy ) {
3100 return wp_set_object_terms( $object_id, $terms, $taxonomy, true );
3104 * Remove term(s) associated with a given object.
3108 * @global wpdb $wpdb WordPress database abstraction object.
3110 * @param int $object_id The ID of the object from which the terms will be removed.
3111 * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to remove.
3112 * @param array|string $taxonomy Taxonomy name.
3113 * @return bool|WP_Error True on success, false or WP_Error on failure.
3115 function wp_remove_object_terms( $object_id, $terms, $taxonomy ) {
3118 $object_id = (int) $object_id;
3120 if ( ! taxonomy_exists( $taxonomy ) ) {
3121 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
3124 if ( ! is_array( $terms ) ) {
3125 $terms = array( $terms );
3130 foreach ( (array) $terms as $term ) {
3131 if ( ! strlen( trim( $term ) ) ) {
3135 if ( ! $term_info = term_exists( $term, $taxonomy ) ) {
3136 // Skip if a non-existent term ID is passed.
3137 if ( is_int( $term ) ) {
3142 if ( is_wp_error( $term_info ) ) {
3146 $tt_ids[] = $term_info['term_taxonomy_id'];
3150 $in_tt_ids = "'" . implode( "', '", $tt_ids ) . "'";
3153 * Fires immediately before an object-term relationship is deleted.
3157 * @param int $object_id Object ID.
3158 * @param array $tt_ids An array of term taxonomy IDs.
3160 do_action( 'delete_term_relationships', $object_id, $tt_ids );
3161 $deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) );
3163 wp_cache_delete( $object_id, $taxonomy . '_relationships' );
3166 * Fires immediately after an object-term relationship is deleted.
3170 * @param int $object_id Object ID.
3171 * @param array $tt_ids An array of term taxonomy IDs.
3173 do_action( 'deleted_term_relationships', $object_id, $tt_ids );
3175 wp_update_term_count( $tt_ids, $taxonomy );
3177 return (bool) $deleted;
3184 * Will make slug unique, if it isn't already.
3186 * The `$slug` has to be unique global to every taxonomy, meaning that one
3187 * taxonomy term can't have a matching slug with another taxonomy term. Each
3188 * slug has to be globally unique for every taxonomy.
3190 * The way this works is that if the taxonomy that the term belongs to is
3191 * hierarchical and has a parent, it will append that parent to the $slug.
3193 * If that still doesn't return an unique slug, then it try to append a number
3194 * until it finds a number that is truly unique.
3196 * The only purpose for `$term` is for appending a parent, if one exists.
3200 * @global wpdb $wpdb WordPress database abstraction object.
3202 * @param string $slug The string that will be tried for a unique slug.
3203 * @param object $term The term object that the `$slug` will belong to.
3204 * @return string Will return a true unique slug.
3206 function wp_unique_term_slug( $slug, $term ) {
3209 $needs_suffix = true;
3210 $original_slug = $slug;
3212 // As of 4.1, duplicate slugs are allowed as long as they're in different taxonomies.
3213 if ( ! term_exists( $slug ) || get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) {
3214 $needs_suffix = false;
3218 * If the taxonomy supports hierarchy and the term has a parent, make the slug unique
3219 * by incorporating parent slugs.
3221 $parent_suffix = '';
3222 if ( $needs_suffix && is_taxonomy_hierarchical( $term->taxonomy ) && ! empty( $term->parent ) ) {
3223 $the_parent = $term->parent;
3224 while ( ! empty($the_parent) ) {
3225 $parent_term = get_term($the_parent, $term->taxonomy);
3226 if ( is_wp_error($parent_term) || empty($parent_term) )
3228 $parent_suffix .= '-' . $parent_term->slug;
3229 if ( ! term_exists( $slug . $parent_suffix ) ) {
3233 if ( empty($parent_term->parent) )
3235 $the_parent = $parent_term->parent;
3239 // If we didn't get a unique slug, try appending a number to make it unique.
3242 * Filter whether the proposed unique term slug is bad.
3246 * @param bool $needs_suffix Whether the slug needs to be made unique with a suffix.
3247 * @param string $slug The slug.
3248 * @param object $term Term object.
3250 if ( apply_filters( 'wp_unique_term_slug_is_bad_slug', $needs_suffix, $slug, $term ) ) {
3251 if ( $parent_suffix ) {
3252 $slug .= $parent_suffix;
3254 if ( ! empty( $term->term_id ) )
3255 $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id );
3257 $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );
3259 if ( $wpdb->get_var( $query ) ) {
3262 $alt_slug = $slug . "-$num";
3264 $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );
3265 } while ( $slug_check );
3272 * Filter the unique term slug.
3276 * @param string $slug Unique term slug.
3277 * @param object $term Term object.
3278 * @param string $original_slug Slug originally passed to the function for testing.
3280 return apply_filters( 'wp_unique_term_slug', $slug, $term, $original_slug );
3284 * Update term based on arguments provided.
3286 * The $args will indiscriminately override all values with the same field name.
3287 * Care must be taken to not override important information need to update or
3288 * update will fail (or perhaps create a new term, neither would be acceptable).
3290 * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not
3291 * defined in $args already.
3293 * 'alias_of' will create a term group, if it doesn't already exist, and update
3296 * If the 'slug' argument in $args is missing, then the 'name' in $args will be
3297 * used. It should also be noted that if you set 'slug' and it isn't unique then
3298 * a WP_Error will be passed back. If you don't pass any slug, then a unique one
3299 * will be created for you.
3301 * For what can be overrode in `$args`, check the term scheme can contain and stay
3302 * away from the term keys.
3306 * @global wpdb $wpdb WordPress database abstraction object.
3308 * @param int $term_id The ID of the term
3309 * @param string $taxonomy The context in which to relate the term to the object.
3310 * @param array|string $args Optional. Array of get_terms() arguments. Default empty array.
3311 * @return array|WP_Error Returns Term ID and Taxonomy Term ID
3313 function wp_update_term( $term_id, $taxonomy, $args = array() ) {
3316 if ( ! taxonomy_exists( $taxonomy ) ) {
3317 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
3320 $term_id = (int) $term_id;
3322 // First, get all of the original args
3323 $term = get_term( $term_id, $taxonomy );
3325 if ( is_wp_error( $term ) ) {
3330 return new WP_Error( 'invalid_term', __( 'Empty Term' ) );
3333 $term = (array) $term->data;
3335 // Escape data pulled from DB.
3336 $term = wp_slash( $term );
3338 // Merge old and new args with new args overwriting old ones.
3339 $args = array_merge($term, $args);
3341 $defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => '');
3342 $args = wp_parse_args($args, $defaults);
3343 $args = sanitize_term($args, $taxonomy, 'db');
3344 $parsed_args = $args;
3346 // expected_slashed ($name)
3347 $name = wp_unslash( $args['name'] );
3348 $description = wp_unslash( $args['description'] );
3350 $parsed_args['name'] = $name;
3351 $parsed_args['description'] = $description;
3353 if ( '' == trim($name) )
3354 return new WP_Error('empty_term_name', __('A name is required for this term'));
3356 if ( $parsed_args['parent'] > 0 && ! term_exists( (int) $parsed_args['parent'] ) ) {
3357 return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) );
3360 $empty_slug = false;
3361 if ( empty( $args['slug'] ) ) {
3363 $slug = sanitize_title($name);
3365 $slug = $args['slug'];
3368 $parsed_args['slug'] = $slug;
3370 $term_group = isset( $parsed_args['term_group'] ) ? $parsed_args['term_group'] : 0;
3371 if ( $args['alias_of'] ) {
3372 $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy );
3373 if ( ! empty( $alias->term_group ) ) {
3374 // The alias we want is already in a group, so let's use that one.
3375 $term_group = $alias->term_group;
3376 } elseif ( ! empty( $alias->term_id ) ) {
3378 * The alias is not in a group, so we create a new one
3379 * and add the alias to it.
3381 $term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
3383 wp_update_term( $alias->term_id, $taxonomy, array(
3384 'term_group' => $term_group,
3388 $parsed_args['term_group'] = $term_group;
3392 * Filter the term parent.
3394 * Hook to this filter to see if it will cause a hierarchy loop.
3398 * @param int $parent ID of the parent term.
3399 * @param int $term_id Term ID.
3400 * @param string $taxonomy Taxonomy slug.
3401 * @param array $parsed_args An array of potentially altered update arguments for the given term.
3402 * @param array $args An array of update arguments for the given term.
3404 $parent = apply_filters( 'wp_update_term_parent', $args['parent'], $term_id, $taxonomy, $parsed_args, $args );
3406 // Check for duplicate slug
3407 $duplicate = get_term_by( 'slug', $slug, $taxonomy );
3408 if ( $duplicate && $duplicate->term_id != $term_id ) {
3409 // If an empty slug was passed or the parent changed, reset the slug to something unique.
3411 if ( $empty_slug || ( $parent != $term['parent']) )
3412 $slug = wp_unique_term_slug($slug, (object) $args);
3414 return new WP_Error('duplicate_term_slug', sprintf(__('The slug “%s” is already in use by another term'), $slug));
3417 $tt_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id) );
3419 // Check whether this is a shared term that needs splitting.
3420 $_term_id = _split_shared_term( $term_id, $tt_id );
3421 if ( ! is_wp_error( $_term_id ) ) {
3422 $term_id = $_term_id;
3426 * Fires immediately before the given terms are edited.
3430 * @param int $term_id Term ID.
3431 * @param string $taxonomy Taxonomy slug.
3433 do_action( 'edit_terms', $term_id, $taxonomy );
3434 $wpdb->update($wpdb->terms, compact( 'name', 'slug', 'term_group' ), compact( 'term_id' ) );
3435 if ( empty($slug) ) {
3436 $slug = sanitize_title($name, $term_id);
3437 $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
3441 * Fires immediately after the given terms are edited.
3445 * @param int $term_id Term ID
3446 * @param string $taxonomy Taxonomy slug.
3448 do_action( 'edited_terms', $term_id, $taxonomy );
3451 * Fires immediate before a term-taxonomy relationship is updated.
3455 * @param int $tt_id Term taxonomy ID.
3456 * @param string $taxonomy Taxonomy slug.
3458 do_action( 'edit_term_taxonomy', $tt_id, $taxonomy );
3460 $wpdb->update( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ), array( 'term_taxonomy_id' => $tt_id ) );
3463 * Fires immediately after a term-taxonomy relationship is updated.
3467 * @param int $tt_id Term taxonomy ID.
3468 * @param string $taxonomy Taxonomy slug.
3470 do_action( 'edited_term_taxonomy', $tt_id, $taxonomy );
3472 // Clean the relationship caches for all object types using this term.
3473 $objects = $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
3474 $tax_object = get_taxonomy( $taxonomy );
3475 foreach ( $tax_object->object_type as $object_type ) {
3476 clean_object_term_cache( $objects, $object_type );
3480 * Fires after a term has been updated, but before the term cache has been cleaned.
3484 * @param int $term_id Term ID.
3485 * @param int $tt_id Term taxonomy ID.
3486 * @param string $taxonomy Taxonomy slug.
3488 do_action( "edit_term", $term_id, $tt_id, $taxonomy );
3491 * Fires after a term in a specific taxonomy has been updated, but before the term
3492 * cache has been cleaned.
3494 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
3498 * @param int $term_id Term ID.
3499 * @param int $tt_id Term taxonomy ID.
3501 do_action( "edit_$taxonomy", $term_id, $tt_id );
3503 /** This filter is documented in wp-includes/taxonomy.php */
3504 $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id );
3506 clean_term_cache($term_id, $taxonomy);
3509 * Fires after a term has been updated, and the term cache has been cleaned.
3513 * @param int $term_id Term ID.
3514 * @param int $tt_id Term taxonomy ID.
3515 * @param string $taxonomy Taxonomy slug.