| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Core Taxonomy API 4 * 5 * @package WordPress 6 * @subpackage Taxonomy 7 */ 8 9 // 10 // Taxonomy registration. 11 // 12 13 /** 14 * Creates the initial taxonomies. 15 * 16 * This function fires twice: in wp-settings.php before plugins are loaded (for 17 * backward compatibility reasons), and again on the {@see 'init'} action. We must 18 * avoid registering rewrite rules before the {@see 'init'} action. 19 * 20 * @since 2.8.0 21 * @since 5.9.0 Added `'wp_template_part_area'` taxonomy. 22 * 23 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 24 */ 25 function create_initial_taxonomies() { 26 global $wp_rewrite; 27 28 WP_Taxonomy::reset_default_labels(); 29 30 if ( ! did_action( 'init' ) ) { 31 $rewrite = array( 32 'category' => false, 33 'post_tag' => false, 34 'post_format' => false, 35 ); 36 } else { 37 38 /** 39 * Filters the post formats rewrite base. 40 * 41 * @since 3.1.0 42 * 43 * @param string $context Context of the rewrite base. Default 'type'. 44 */ 45 $post_format_base = apply_filters( 'post_format_rewrite_base', 'type' ); 46 $rewrite = array( 47 'category' => array( 48 'hierarchical' => true, 49 'slug' => get_option( 'category_base' ) ? get_option( 'category_base' ) : 'category', 50 'with_front' => ! get_option( 'category_base' ) || $wp_rewrite->using_index_permalinks(), 51 'ep_mask' => EP_CATEGORIES, 52 ), 53 'post_tag' => array( 54 'hierarchical' => false, 55 'slug' => get_option( 'tag_base' ) ? get_option( 'tag_base' ) : 'tag', 56 'with_front' => ! get_option( 'tag_base' ) || $wp_rewrite->using_index_permalinks(), 57 'ep_mask' => EP_TAGS, 58 ), 59 'post_format' => $post_format_base ? array( 'slug' => $post_format_base ) : false, 60 ); 61 } 62 63 register_taxonomy( 64 'category', 65 'post', 66 array( 67 'hierarchical' => true, 68 'query_var' => 'category_name', 69 'rewrite' => $rewrite['category'], 70 'public' => true, 71 'show_ui' => true, 72 'show_admin_column' => true, 73 '_builtin' => true, 74 'capabilities' => array( 75 'manage_terms' => 'manage_categories', 76 'edit_terms' => 'edit_categories', 77 'delete_terms' => 'delete_categories', 78 'assign_terms' => 'assign_categories', 79 ), 80 'show_in_rest' => true, 81 'rest_base' => 'categories', 82 'rest_controller_class' => 'WP_REST_Terms_Controller', 83 ) 84 ); 85 86 register_taxonomy( 87 'post_tag', 88 'post', 89 array( 90 'hierarchical' => false, 91 'query_var' => 'tag', 92 'rewrite' => $rewrite['post_tag'], 93 'public' => true, 94 'show_ui' => true, 95 'show_admin_column' => true, 96 '_builtin' => true, 97 'capabilities' => array( 98 'manage_terms' => 'manage_post_tags', 99 'edit_terms' => 'edit_post_tags', 100 'delete_terms' => 'delete_post_tags', 101 'assign_terms' => 'assign_post_tags', 102 ), 103 'show_in_rest' => true, 104 'rest_base' => 'tags', 105 'rest_controller_class' => 'WP_REST_Terms_Controller', 106 ) 107 ); 108 109 register_taxonomy( 110 'nav_menu', 111 'nav_menu_item', 112 array( 113 'public' => false, 114 'hierarchical' => false, 115 'labels' => array( 116 'name' => __( 'Navigation Menus' ), 117 'singular_name' => __( 'Navigation Menu' ), 118 ), 119 'query_var' => false, 120 'rewrite' => false, 121 'show_ui' => false, 122 '_builtin' => true, 123 'show_in_nav_menus' => false, 124 'capabilities' => array( 125 'manage_terms' => 'edit_theme_options', 126 'edit_terms' => 'edit_theme_options', 127 'delete_terms' => 'edit_theme_options', 128 'assign_terms' => 'edit_theme_options', 129 ), 130 'show_in_rest' => true, 131 'rest_base' => 'menus', 132 'rest_controller_class' => 'WP_REST_Menus_Controller', 133 ) 134 ); 135 136 register_taxonomy( 137 'link_category', 138 'link', 139 array( 140 'hierarchical' => false, 141 'labels' => array( 142 'name' => __( 'Link Categories' ), 143 'singular_name' => __( 'Link Category' ), 144 'search_items' => __( 'Search Link Categories' ), 145 'popular_items' => null, 146 'all_items' => __( 'All Link Categories' ), 147 'edit_item' => __( 'Edit Link Category' ), 148 'update_item' => __( 'Update Link Category' ), 149 'add_new_item' => __( 'Add New Link Category' ), 150 'new_item_name' => __( 'New Link Category Name' ), 151 'separate_items_with_commas' => null, 152 'add_or_remove_items' => null, 153 'choose_from_most_used' => null, 154 'back_to_items' => __( '← Go to Link Categories' ), 155 ), 156 'capabilities' => array( 157 'manage_terms' => 'manage_links', 158 'edit_terms' => 'manage_links', 159 'delete_terms' => 'manage_links', 160 'assign_terms' => 'manage_links', 161 ), 162 'query_var' => false, 163 'rewrite' => false, 164 'public' => false, 165 'show_ui' => true, 166 '_builtin' => true, 167 ) 168 ); 169 170 register_taxonomy( 171 'post_format', 172 'post', 173 array( 174 'public' => true, 175 'hierarchical' => false, 176 'labels' => array( 177 'name' => _x( 'Formats', 'post format' ), 178 'singular_name' => _x( 'Format', 'post format' ), 179 ), 180 'query_var' => true, 181 'rewrite' => $rewrite['post_format'], 182 'show_ui' => false, 183 '_builtin' => true, 184 'show_in_nav_menus' => current_theme_supports( 'post-formats' ), 185 ) 186 ); 187 188 register_taxonomy( 189 'wp_theme', 190 array( 'wp_template', 'wp_template_part', 'wp_global_styles' ), 191 array( 192 'public' => false, 193 'hierarchical' => false, 194 'labels' => array( 195 'name' => __( 'Themes' ), 196 'singular_name' => __( 'Theme' ), 197 ), 198 'query_var' => false, 199 'rewrite' => false, 200 'show_ui' => false, 201 '_builtin' => true, 202 'show_in_nav_menus' => false, 203 'show_in_rest' => false, 204 ) 205 ); 206 207 register_taxonomy( 208 'wp_template_part_area', 209 array( 'wp_template_part' ), 210 array( 211 'public' => false, 212 'hierarchical' => false, 213 'labels' => array( 214 'name' => __( 'Template Part Areas' ), 215 'singular_name' => __( 'Template Part Area' ), 216 ), 217 'query_var' => false, 218 'rewrite' => false, 219 'show_ui' => false, 220 '_builtin' => true, 221 'show_in_nav_menus' => false, 222 'show_in_rest' => false, 223 ) 224 ); 225 226 register_taxonomy( 227 'wp_pattern_category', 228 array( 'wp_block' ), 229 array( 230 'public' => false, 231 'publicly_queryable' => false, 232 'hierarchical' => false, 233 'labels' => array( 234 'name' => _x( 'Pattern Categories', 'taxonomy general name' ), 235 'singular_name' => _x( 'Pattern Category', 'taxonomy singular name' ), 236 'add_new_item' => __( 'Add New Category' ), 237 'add_or_remove_items' => __( 'Add or remove pattern categories' ), 238 'back_to_items' => __( '← Go to Pattern Categories' ), 239 'choose_from_most_used' => __( 'Choose from the most used pattern categories' ), 240 'edit_item' => __( 'Edit Pattern Category' ), 241 'item_link' => __( 'Pattern Category Link' ), 242 'item_link_description' => __( 'A link to a pattern category.' ), 243 'items_list' => __( 'Pattern Categories list' ), 244 'items_list_navigation' => __( 'Pattern Categories list navigation' ), 245 'new_item_name' => __( 'New Pattern Category Name' ), 246 'no_terms' => __( 'No pattern categories' ), 247 'not_found' => __( 'No pattern categories found.' ), 248 'popular_items' => __( 'Popular Pattern Categories' ), 249 'search_items' => __( 'Search Pattern Categories' ), 250 'separate_items_with_commas' => __( 'Separate pattern categories with commas' ), 251 'update_item' => __( 'Update Pattern Category' ), 252 'view_item' => __( 'View Pattern Category' ), 253 ), 254 'query_var' => false, 255 'rewrite' => false, 256 'show_ui' => true, 257 '_builtin' => true, 258 'show_in_nav_menus' => false, 259 'show_in_rest' => true, 260 'show_admin_column' => true, 261 'show_tagcloud' => false, 262 ) 263 ); 264 } 265 266 /** 267 * Retrieves a list of registered taxonomy names or objects. 268 * 269 * @since 3.0.0 270 * 271 * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. 272 * 273 * @param array $args Optional. An array of `key => value` arguments to match against the taxonomy objects. 274 * Default empty array. 275 * @param string $output Optional. The type of output to return in the array. Either 'names' 276 * or 'objects'. Default 'names'. 277 * @param string $operator Optional. The logical operation to perform. Accepts 'and' or 'or'. 'or' means only 278 * one element from the array needs to match; 'and' means all elements must match. 279 * Default 'and'. 280 * @return string[]|WP_Taxonomy[] An array of taxonomy names or objects. 281 */ 282 function get_taxonomies( $args = array(), $output = 'names', $operator = 'and' ) { 283 global $wp_taxonomies; 284 285 $field = ( 'names' === $output ) ? 'name' : false; 286 287 return wp_filter_object_list( $wp_taxonomies, $args, $operator, $field ); 288 } 289 290 /** 291 * Returns the names or objects of the taxonomies which are registered for the requested object or object type, 292 * such as a post object or post type name. 293 * 294 * Example: 295 * 296 * $taxonomies = get_object_taxonomies( 'post' ); 297 * 298 * This results in: 299 * 300 * Array( 'category', 'post_tag' ) 301 * 302 * @since 2.3.0 303 * 304 * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. 305 * 306 * @param string|string[]|WP_Post $object_type Name of the type of taxonomy object, or an object (row from posts). 307 * @param string $output Optional. The type of output to return in the array. Accepts either 308 * 'names' or 'objects'. Default 'names'. 309 * @return string[]|WP_Taxonomy[] The names or objects of all taxonomies of `$object_type`. 310 */ 311 function get_object_taxonomies( $object_type, $output = 'names' ) { 312 global $wp_taxonomies; 313 314 if ( is_object( $object_type ) ) { 315 if ( 'attachment' === $object_type->post_type ) { 316 return get_attachment_taxonomies( $object_type, $output ); 317 } 318 $object_type = $object_type->post_type; 319 } 320 321 $object_type = (array) $object_type; 322 323 $taxonomies = array(); 324 foreach ( (array) $wp_taxonomies as $tax_name => $tax_obj ) { 325 if ( array_intersect( $object_type, (array) $tax_obj->object_type ) ) { 326 if ( 'names' === $output ) { 327 $taxonomies[] = $tax_name; 328 } else { 329 $taxonomies[ $tax_name ] = $tax_obj; 330 } 331 } 332 } 333 334 return $taxonomies; 335 } 336 337 /** 338 * Retrieves the taxonomy object of $taxonomy. 339 * 340 * The get_taxonomy function will first check that the parameter string given 341 * is a taxonomy object and if it is, it will return it. 342 * 343 * @since 2.3.0 344 * 345 * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. 346 * 347 * @param string $taxonomy Name of taxonomy object to return. 348 * @return WP_Taxonomy|false The taxonomy object or false if $taxonomy doesn't exist. 349 */ 350 function get_taxonomy( $taxonomy ) { 351 global $wp_taxonomies; 352 353 if ( ! taxonomy_exists( $taxonomy ) ) { 354 return false; 355 } 356 357 return $wp_taxonomies[ $taxonomy ]; 358 } 359 360 /** 361 * Determines whether the taxonomy name exists. 362 * 363 * Formerly is_taxonomy(), introduced in 2.3.0. 364 * 365 * For more information on this and similar theme functions, check out 366 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 367 * Conditional Tags} article in the Theme Developer Handbook. 368 * 369 * @since 3.0.0 370 * 371 * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. 372 * 373 * @param string $taxonomy Name of taxonomy object. 374 * @return bool Whether the taxonomy exists. 375 */ 376 function taxonomy_exists( $taxonomy ) { 377 global $wp_taxonomies; 378 379 return is_string( $taxonomy ) && isset( $wp_taxonomies[ $taxonomy ] ); 380 } 381 382 /** 383 * Determines whether the taxonomy object is hierarchical. 384 * 385 * Checks to make sure that the taxonomy is an object first. Then Gets the 386 * object, and finally returns the hierarchical value in the object. 387 * 388 * A false return value might also mean that the taxonomy does not exist. 389 * 390 * For more information on this and similar theme functions, check out 391 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 392 * Conditional Tags} article in the Theme Developer Handbook. 393 * 394 * @since 2.3.0 395 * 396 * @param string $taxonomy Name of taxonomy object. 397 * @return bool Whether the taxonomy is hierarchical. 398 */ 399 function is_taxonomy_hierarchical( $taxonomy ) { 400 if ( ! taxonomy_exists( $taxonomy ) ) { 401 return false; 402 } 403 404 $taxonomy = get_taxonomy( $taxonomy ); 405 return $taxonomy->hierarchical; 406 } 407 408 /** 409 * Creates or modifies a taxonomy object. 410 * 411 * Note: Do not use before the {@see 'init'} hook. 412 * 413 * A simple function for creating or modifying a taxonomy object based on 414 * the parameters given. If modifying an existing taxonomy object, note 415 * that the `$object_type` value from the original registration will be 416 * overwritten. 417 * 418 * @since 2.3.0 419 * @since 4.2.0 Introduced `show_in_quick_edit` argument. 420 * @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen. 421 * @since 4.4.0 The `public` argument now controls whether the taxonomy can be queried on the front end. 422 * @since 4.5.0 Introduced `publicly_queryable` argument. 423 * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class' 424 * arguments to register the taxonomy in REST API. 425 * @since 5.1.0 Introduced `meta_box_sanitize_cb` argument. 426 * @since 5.4.0 Added the registered taxonomy object as a return value. 427 * @since 5.5.0 Introduced `default_term` argument. 428 * @since 5.9.0 Introduced `rest_namespace` argument. 429 * 430 * @global WP_Taxonomy[] $wp_taxonomies Registered taxonomies. 431 * 432 * @param string $taxonomy Taxonomy key. Must not exceed 32 characters and may only contain 433 * lowercase alphanumeric characters, dashes, and underscores. See sanitize_key(). 434 * @param array|string $object_type Object type or array of object types with which the taxonomy should be associated. 435 * @param array|string $args { 436 * Optional. Array or query string of arguments for registering a taxonomy. 437 * 438 * @type string[] $labels An array of labels for this taxonomy. By default, Tag labels are 439 * used for non-hierarchical taxonomies, and Category labels are used 440 * for hierarchical taxonomies. See accepted values in 441 * get_taxonomy_labels(). Default empty array. 442 * @type string $description A short descriptive summary of what the taxonomy is for. Default empty. 443 * @type bool $public Whether a taxonomy is intended for use publicly either via 444 * the admin interface or by front-end users. The default settings 445 * of `$publicly_queryable`, `$show_ui`, and `$show_in_nav_menus` 446 * are inherited from `$public`. 447 * @type bool $publicly_queryable Whether the taxonomy is publicly queryable. 448 * If not set, the default is inherited from `$public` 449 * @type bool $hierarchical Whether the taxonomy is hierarchical. Default false. 450 * @type bool $show_ui Whether to generate and allow a UI for managing terms in this taxonomy in 451 * the admin. If not set, the default is inherited from `$public` 452 * (default true). 453 * @type bool $show_in_menu Whether to show the taxonomy in the admin menu. If true, the taxonomy is 454 * shown as a submenu of the object type menu. If false, no menu is shown. 455 * `$show_ui` must be true. If not set, default is inherited from `$show_ui` 456 * (default true). 457 * @type bool $show_in_nav_menus Makes this taxonomy available for selection in navigation menus. If not 458 * set, the default is inherited from `$public` (default true). 459 * @type bool $show_in_rest Whether to include the taxonomy in the REST API. Set this to true 460 * for the taxonomy to be available in the block editor. 461 * @type string $rest_base To change the base url of REST API route. Default is $taxonomy. 462 * @type string $rest_namespace To change the namespace URL of REST API route. Default is wp/v2. 463 * @type string $rest_controller_class REST API Controller class name. Default is 'WP_REST_Terms_Controller'. 464 * @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set, 465 * the default is inherited from `$show_ui` (default true). 466 * @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set, 467 * the default is inherited from `$show_ui` (default true). 468 * @type bool $show_admin_column Whether to display a column for the taxonomy on its post type listing 469 * screens. Default false. 470 * @type bool|callable $meta_box_cb Provide a callback function for the meta box display. If not set, 471 * post_categories_meta_box() is used for hierarchical taxonomies, and 472 * post_tags_meta_box() is used for non-hierarchical. If false, no meta 473 * box is shown. 474 * @type callable $meta_box_sanitize_cb Callback function for sanitizing taxonomy data saved from a meta 475 * box. If no callback is defined, an appropriate one is determined 476 * based on the value of `$meta_box_cb`. 477 * @type string[] $capabilities { 478 * Array of capabilities for this taxonomy. 479 * 480 * @type string $manage_terms Default 'manage_categories'. 481 * @type string $edit_terms Default 'manage_categories'. 482 * @type string $delete_terms Default 'manage_categories'. 483 * @type string $assign_terms Default 'edit_posts'. 484 * } 485 * @type bool|array $rewrite { 486 * Triggers the handling of rewrites for this taxonomy. Default true, using $taxonomy as slug. To prevent 487 * rewrite, set to false. To specify rewrite rules, an array can be passed with any of these keys: 488 * 489 * @type string $slug Customize the permastruct slug. Default `$taxonomy` key. 490 * @type bool $with_front Should the permastruct be prepended with WP_Rewrite::$front. Default true. 491 * @type bool $hierarchical Either hierarchical rewrite tag or not. Default false. 492 * @type int $ep_mask Assign an endpoint mask. Default `EP_NONE`. 493 * } 494 * @type string|bool $query_var Sets the query var key for this taxonomy. Default `$taxonomy` key. If 495 * false, a taxonomy cannot be loaded at `?{query_var}={term_slug}`. If a 496 * string, the query `?{query_var}={term_slug}` will be valid. 497 * @type callable $update_count_callback Works much like a hook, in that it will be called when the count is 498 * updated. Default _update_post_term_count() for taxonomies attached 499 * to post types, which confirms that the objects are published before 500 * counting them. Default _update_generic_term_count() for taxonomies 501 * attached to other object types, such as users. 502 * @type string|array $default_term { 503 * Default term to be used for the taxonomy. 504 * 505 * @type string $name Name of default term. 506 * @type string $slug Slug for default term. Default empty. 507 * @type string $description Description for default term. Default empty. 508 * } 509 * @type bool $sort Whether terms in this taxonomy should be sorted in the order they are 510 * provided to `wp_set_object_terms()`. Default null which equates to false. 511 * @type array $args Array of arguments to automatically use inside `wp_get_object_terms()` 512 * for this taxonomy. 513 * @type bool $_builtin This taxonomy is a "built-in" taxonomy. INTERNAL USE ONLY! 514 * Default false. 515 * } 516 * @return WP_Taxonomy|WP_Error The registered taxonomy object on success, WP_Error object on failure. 517 */ 518 function register_taxonomy( $taxonomy, $object_type, $args = array() ) { 519 global $wp_taxonomies; 520 521 if ( ! is_array( $wp_taxonomies ) ) { 522 $wp_taxonomies = array(); 523 } 524 525 $args = wp_parse_args( $args ); 526 527 if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) { 528 _doing_it_wrong( __FUNCTION__, __( 'Taxonomy names must be between 1 and 32 characters in length.' ), '4.2.0' ); 529 return new WP_Error( 'taxonomy_length_invalid', __( 'Taxonomy names must be between 1 and 32 characters in length.' ) ); 530 } 531 532 $taxonomy_object = new WP_Taxonomy( $taxonomy, $object_type, $args ); 533 $taxonomy_object->add_rewrite_rules(); 534 535 $wp_taxonomies[ $taxonomy ] = $taxonomy_object; 536 537 $taxonomy_object->add_hooks(); 538 539 // Add default term. 540 if ( ! empty( $taxonomy_object->default_term ) ) { 541 $term = term_exists( $taxonomy_object->default_term['name'], $taxonomy ); 542 if ( $term ) { 543 update_option( 'default_term_' . $taxonomy_object->name, $term['term_id'] ); 544 } else { 545 $term = wp_insert_term( 546 $taxonomy_object->default_term['name'], 547 $taxonomy, 548 array( 549 'slug' => sanitize_title( $taxonomy_object->default_term['slug'] ), 550 'description' => $taxonomy_object->default_term['description'], 551 ) 552 ); 553 554 // Update `term_id` in options. 555 if ( ! is_wp_error( $term ) ) { 556 update_option( 'default_term_' . $taxonomy_object->name, $term['term_id'] ); 557 } 558 } 559 } 560 561 /** 562 * Fires after a taxonomy is registered. 563 * 564 * @since 3.3.0 565 * 566 * @param string $taxonomy Taxonomy slug. 567 * @param array|string $object_type Object type or array of object types. 568 * @param array $args Array of taxonomy registration arguments. 569 */ 570 do_action( 'registered_taxonomy', $taxonomy, $object_type, (array) $taxonomy_object ); 571 572 /** 573 * Fires after a specific taxonomy is registered. 574 * 575 * The dynamic portion of the filter name, `$taxonomy`, refers to the taxonomy key. 576 * 577 * Possible hook names include: 578 * 579 * - `registered_taxonomy_category` 580 * - `registered_taxonomy_post_tag` 581 * 582 * @since 6.0.0 583 * 584 * @param string $taxonomy Taxonomy slug. 585 * @param array|string $object_type Object type or array of object types. 586 * @param array $args Array of taxonomy registration arguments. 587 */ 588 do_action( "registered_taxonomy_{$taxonomy}", $taxonomy, $object_type, (array) $taxonomy_object ); 589 590 return $taxonomy_object; 591 } 592 593 /** 594 * Unregisters a taxonomy. 595 * 596 * Can not be used to unregister built-in taxonomies. 597 * 598 * @since 4.5.0 599 * 600 * @global WP_Taxonomy[] $wp_taxonomies List of taxonomies. 601 * 602 * @param string $taxonomy Taxonomy name. 603 * @return true|WP_Error True on success, WP_Error on failure or if the taxonomy doesn't exist. 604 */ 605 function unregister_taxonomy( $taxonomy ) { 606 global $wp_taxonomies; 607 608 if ( ! taxonomy_exists( $taxonomy ) ) { 609 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 610 } 611 612 $taxonomy_object = get_taxonomy( $taxonomy ); 613 614 // Do not allow unregistering internal taxonomies. 615 if ( $taxonomy_object->_builtin ) { 616 return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed.' ) ); 617 } 618 619 $taxonomy_object->remove_rewrite_rules(); 620 $taxonomy_object->remove_hooks(); 621 622 // Remove the taxonomy. 623 unset( $wp_taxonomies[ $taxonomy ] ); 624 625 /** 626 * Fires after a taxonomy is unregistered. 627 * 628 * @since 4.5.0 629 * 630 * @param string $taxonomy Taxonomy name. 631 */ 632 do_action( 'unregistered_taxonomy', $taxonomy ); 633 634 return true; 635 } 636 637 /** 638 * Builds an object with all taxonomy labels out of a taxonomy object. 639 * 640 * @since 3.0.0 641 * @since 4.3.0 Added the `no_terms` label. 642 * @since 4.4.0 Added the `items_list_navigation` and `items_list` labels. 643 * @since 4.9.0 Added the `most_used` and `back_to_items` labels. 644 * @since 5.7.0 Added the `filter_by_item` label. 645 * @since 5.8.0 Added the `item_link` and `item_link_description` labels. 646 * @since 5.9.0 Added the `name_field_description`, `slug_field_description`, 647 * `parent_field_description`, and `desc_field_description` labels. 648 * @since 6.6.0 Added the `template_name` label. 649 * 650 * @param WP_Taxonomy $tax Taxonomy object. 651 * @return object { 652 * Taxonomy labels object. The first default value is for non-hierarchical taxonomies 653 * (like tags) and the second one is for hierarchical taxonomies (like categories). 654 * 655 * @type string $name General name for the taxonomy, usually plural. The same 656 * as and overridden by `$tax->label`. Default 'Tags'/'Categories'. 657 * @type string $singular_name Name for one object of this taxonomy. Default 'Tag'/'Category'. 658 * @type string $search_items Default 'Search Tags'/'Search Categories'. 659 * @type string $popular_items This label is only used for non-hierarchical taxonomies. 660 * Default 'Popular Tags'. 661 * @type string $all_items Default 'All Tags'/'All Categories'. 662 * @type string $parent_item This label is only used for hierarchical taxonomies. Default 663 * 'Parent Category'. 664 * @type string $parent_item_colon The same as `parent_item`, but with colon `:` in the end. 665 * @type string $name_field_description Description for the Name field on Edit Tags screen. 666 * Default 'The name is how it appears on your site'. 667 * @type string $slug_field_description Description for the Slug field on Edit Tags screen. 668 * Default 'The “slug” is the URL-friendly version 669 * of the name. It is usually all lowercase and contains 670 * only letters, numbers, and hyphens'. 671 * @type string $parent_field_description Description for the Parent field on Edit Tags screen. 672 * Default 'Assign a parent term to create a hierarchy. 673 * The term Jazz, for example, would be the parent 674 * of Bebop and Big Band'. 675 * @type string $desc_field_description Description for the Description field on Edit Tags screen. 676 * Default 'The description is not prominent by default; 677 * however, some themes may show it'. 678 * @type string $edit_item Default 'Edit Tag'/'Edit Category'. 679 * @type string $view_item Default 'View Tag'/'View Category'. 680 * @type string $update_item Default 'Update Tag'/'Update Category'. 681 * @type string $add_new_item Default 'Add New Tag'/'Add New Category'. 682 * @type string $new_item_name Default 'New Tag Name'/'New Category Name'. 683 * @type string $template_name Default 'Tag Archives'/'Category Archives'. 684 * @type string $separate_items_with_commas This label is only used for non-hierarchical taxonomies. Default 685 * 'Separate tags with commas', used in the meta box. 686 * @type string $add_or_remove_items This label is only used for non-hierarchical taxonomies. Default 687 * 'Add or remove tags', used in the meta box when JavaScript 688 * is disabled. 689 * @type string $choose_from_most_used This label is only used on non-hierarchical taxonomies. Default 690 * 'Choose from the most used tags', used in the meta box. 691 * @type string $not_found Default 'No tags found'/'No categories found', used in 692 * the meta box and taxonomy list table. 693 * @type string $no_terms Default 'No tags'/'No categories', used in the posts and media 694 * list tables. 695 * @type string $filter_by_item This label is only used for hierarchical taxonomies. Default 696 * 'Filter by category', used in the posts list table. 697 * @type string $items_list_navigation Label for the table pagination hidden heading. 698 * @type string $items_list Label for the table hidden heading. 699 * @type string $most_used Title for the Most Used tab. Default 'Most Used'. 700 * @type string $back_to_items Label displayed after a term has been updated. 701 * @type string $item_link Used in the block editor. Title for a navigation link block variation. 702 * Default 'Tag Link'/'Category Link'. 703 * @type string $item_link_description Used in the block editor. Description for a navigation link block 704 * variation. Default 'A link to a tag'/'A link to a category'. 705 * } 706 */ 707 function get_taxonomy_labels( $tax ) { 708 $tax->labels = (array) $tax->labels; 709 710 if ( isset( $tax->helps ) && empty( $tax->labels['separate_items_with_commas'] ) ) { 711 $tax->labels['separate_items_with_commas'] = $tax->helps; 712 } 713 714 if ( isset( $tax->no_tagcloud ) && empty( $tax->labels['not_found'] ) ) { 715 $tax->labels['not_found'] = $tax->no_tagcloud; 716 } 717 718 $nohier_vs_hier_defaults = WP_Taxonomy::get_default_labels(); 719 720 $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name']; 721 722 $labels = _get_custom_object_labels( $tax, $nohier_vs_hier_defaults ); 723 724 if ( ! isset( $tax->labels->template_name ) && isset( $labels->singular_name ) ) { 725 /* translators: %s: Taxonomy name. */ 726 $labels->template_name = sprintf( _x( '%s Archives', 'taxonomy template name' ), $labels->singular_name ); 727 } 728 729 $taxonomy = $tax->name; 730 731 $default_labels = clone $labels; 732 733 /** 734 * Filters the labels of a specific taxonomy. 735 * 736 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 737 * 738 * Possible hook names include: 739 * 740 * - `taxonomy_labels_category` 741 * - `taxonomy_labels_post_tag` 742 * 743 * @since 4.4.0 744 * 745 * @see get_taxonomy_labels() for the full list of taxonomy labels. 746 * 747 * @param object $labels Object with labels for the taxonomy as member variables. 748 */ 749 $labels = apply_filters( "taxonomy_labels_{$taxonomy}", $labels ); 750 751 // Ensure that the filtered labels contain all required default values. 752 $labels = (object) array_merge( (array) $default_labels, (array) $labels ); 753 754 return $labels; 755 } 756 757 /** 758 * Adds an already registered taxonomy to an object type. 759 * 760 * @since 3.0.0 761 * 762 * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. 763 * 764 * @param string $taxonomy Name of taxonomy object. 765 * @param string $object_type Name of the object type. 766 * @return bool True if successful, false if not. 767 */ 768 function register_taxonomy_for_object_type( $taxonomy, $object_type ) { 769 global $wp_taxonomies; 770 771 if ( ! isset( $wp_taxonomies[ $taxonomy ] ) ) { 772 return false; 773 } 774 775 if ( ! get_post_type_object( $object_type ) ) { 776 return false; 777 } 778 779 if ( ! in_array( $object_type, $wp_taxonomies[ $taxonomy ]->object_type, true ) ) { 780 $wp_taxonomies[ $taxonomy ]->object_type[] = $object_type; 781 } 782 783 // Filter out empties. 784 $wp_taxonomies[ $taxonomy ]->object_type = array_filter( $wp_taxonomies[ $taxonomy ]->object_type ); 785 786 /** 787 * Fires after a taxonomy is registered for an object type. 788 * 789 * @since 5.1.0 790 * 791 * @param string $taxonomy Taxonomy name. 792 * @param string $object_type Name of the object type. 793 */ 794 do_action( 'registered_taxonomy_for_object_type', $taxonomy, $object_type ); 795 796 return true; 797 } 798 799 /** 800 * Removes an already registered taxonomy from an object type. 801 * 802 * @since 3.7.0 803 * 804 * @global WP_Taxonomy[] $wp_taxonomies The registered taxonomies. 805 * 806 * @param string $taxonomy Name of taxonomy object. 807 * @param string $object_type Name of the object type. 808 * @return bool True if successful, false if not. 809 */ 810 function unregister_taxonomy_for_object_type( $taxonomy, $object_type ) { 811 global $wp_taxonomies; 812 813 if ( ! isset( $wp_taxonomies[ $taxonomy ] ) ) { 814 return false; 815 } 816 817 if ( ! get_post_type_object( $object_type ) ) { 818 return false; 819 } 820 821 $key = array_search( $object_type, $wp_taxonomies[ $taxonomy ]->object_type, true ); 822 if ( false === $key ) { 823 return false; 824 } 825 826 unset( $wp_taxonomies[ $taxonomy ]->object_type[ $key ] ); 827 828 /** 829 * Fires after a taxonomy is unregistered for an object type. 830 * 831 * @since 5.1.0 832 * 833 * @param string $taxonomy Taxonomy name. 834 * @param string $object_type Name of the object type. 835 */ 836 do_action( 'unregistered_taxonomy_for_object_type', $taxonomy, $object_type ); 837 838 return true; 839 } 840 841 // 842 // Term API. 843 // 844 845 /** 846 * Retrieves object IDs of valid taxonomy and term. 847 * 848 * The strings of `$taxonomies` must exist before this function will continue. 849 * On failure of finding a valid taxonomy, it will return a WP_Error. 850 * 851 * The `$terms` aren't checked the same as `$taxonomies`, but still need to exist 852 * for object IDs to be returned. 853 * 854 * It is possible to change the order that object IDs are returned by using `$args` 855 * with either ASC or DESC array. The value should be in the key named 'order'. 856 * 857 * @since 2.3.0 858 * 859 * @global wpdb $wpdb WordPress database abstraction object. 860 * 861 * @param int|int[] $term_ids Term ID or array of term IDs of terms that will be used. 862 * @param string|string[] $taxonomies String of taxonomy name or Array of string values of taxonomy names. 863 * @param array|string $args { 864 * Change the order of the object IDs. 865 * 866 * @type string $order Order to retrieve terms. Accepts 'ASC' or 'DESC'. Default 'ASC'. 867 * } 868 * @return string[]|WP_Error An array of object IDs as numeric strings on success, 869 * WP_Error if the taxonomy does not exist. 870 */ 871 function get_objects_in_term( $term_ids, $taxonomies, $args = array() ) { 872 global $wpdb; 873 874 if ( ! is_array( $term_ids ) ) { 875 $term_ids = array( $term_ids ); 876 } 877 if ( ! is_array( $taxonomies ) ) { 878 $taxonomies = array( $taxonomies ); 879 } 880 foreach ( (array) $taxonomies as $taxonomy ) { 881 if ( ! taxonomy_exists( $taxonomy ) ) { 882 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 883 } 884 } 885 886 $defaults = array( 'order' => 'ASC' ); 887 $args = wp_parse_args( $args, $defaults ); 888 889 $order = ( 'desc' === strtolower( $args['order'] ) ) ? 'DESC' : 'ASC'; 890 891 $term_ids = array_map( 'intval', $term_ids ); 892 893 $taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'"; 894 $term_ids = "'" . implode( "', '", $term_ids ) . "'"; 895 896 $sql = "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"; 897 898 $last_changed = wp_cache_get_last_changed( 'terms' ); 899 $cache_key = 'get_objects_in_term:' . md5( $sql ) . ":$last_changed"; 900 $cache = wp_cache_get( $cache_key, 'term-queries' ); 901 if ( false === $cache ) { 902 $object_ids = $wpdb->get_col( $sql ); 903 wp_cache_set( $cache_key, $object_ids, 'term-queries' ); 904 } else { 905 $object_ids = (array) $cache; 906 } 907 908 if ( ! $object_ids ) { 909 return array(); 910 } 911 return $object_ids; 912 } 913 914 /** 915 * Given a taxonomy query, generates SQL to be appended to a main query. 916 * 917 * @since 3.1.0 918 * 919 * @see WP_Tax_Query 920 * 921 * @param array $tax_query A compact tax query 922 * @param string $primary_table 923 * @param string $primary_id_column 924 * @return string[] 925 */ 926 function get_tax_sql( $tax_query, $primary_table, $primary_id_column ) { 927 $tax_query_obj = new WP_Tax_Query( $tax_query ); 928 return $tax_query_obj->get_sql( $primary_table, $primary_id_column ); 929 } 930 931 /** 932 * Gets all term data from database by term ID. 933 * 934 * The usage of the get_term function is to apply filters to a term object. It 935 * is possible to get a term object from the database before applying the 936 * filters. 937 * 938 * $term ID must be part of $taxonomy, to get from the database. Failure, might 939 * be able to be captured by the hooks. Failure would be the same value as $wpdb 940 * returns for the get_row method. 941 * 942 * There are two hooks, one is specifically for each term, named 'get_term', and 943 * the second is for the taxonomy name, 'term_$taxonomy'. Both hooks gets the 944 * term object, and the taxonomy name as parameters. Both hooks are expected to 945 * return a term object. 946 * 947 * {@see 'get_term'} hook - Takes two parameters the term Object and the taxonomy name. 948 * Must return term object. Used in get_term() as a catch-all filter for every 949 * $term. 950 * 951 * {@see 'get_$taxonomy'} hook - Takes two parameters the term Object and the taxonomy 952 * name. Must return term object. $taxonomy will be the taxonomy name, so for 953 * example, if 'category', it would be 'get_category' as the filter name. Useful 954 * for custom taxonomies or plugging into default taxonomies. 955 * 956 * @todo Better formatting for DocBlock 957 * 958 * @since 2.3.0 959 * @since 4.4.0 Converted to return a WP_Term object if `$output` is `OBJECT`. 960 * The `$taxonomy` parameter was made optional. 961 * 962 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param. 963 * 964 * @param int|WP_Term|object $term If integer, term data will be fetched from the database, 965 * or from the cache if available. 966 * If stdClass object (as in the results of a database query), 967 * will apply filters and return a `WP_Term` object with the `$term` data. 968 * If `WP_Term`, will return `$term`. 969 * @param string $taxonomy Optional. Taxonomy name that `$term` is part of. 970 * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which 971 * correspond to a WP_Term object, an associative array, or a numeric array, 972 * respectively. Default OBJECT. 973 * @param string $filter Optional. How to sanitize term fields. Default 'raw'. 974 * @return WP_Term|array|WP_Error|null WP_Term instance (or array) on success, depending on the `$output` value. 975 * WP_Error if `$taxonomy` does not exist. Null for miscellaneous failure. 976 */ 977 function get_term( $term, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) { 978 if ( empty( $term ) ) { 979 return new WP_Error( 'invalid_term', __( 'Empty Term.' ) ); 980 } 981 982 if ( $taxonomy && ! taxonomy_exists( $taxonomy ) ) { 983 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 984 } 985 986 if ( $term instanceof WP_Term ) { 987 $_term = $term; 988 } elseif ( is_object( $term ) ) { 989 if ( empty( $term->filter ) || 'raw' === $term->filter ) { 990 $_term = sanitize_term( $term, $taxonomy, 'raw' ); 991 $_term = new WP_Term( $_term ); 992 } else { 993 $_term = WP_Term::get_instance( $term->term_id ); 994 } 995 } else { 996 $_term = WP_Term::get_instance( $term, $taxonomy ); 997 } 998 999 if ( is_wp_error( $_term ) ) { 1000 return $_term; 1001 } elseif ( ! $_term ) { 1002 return null; 1003 } 1004 1005 // Ensure for filters that this is not empty. 1006 $taxonomy = $_term->taxonomy; 1007 1008 $old_term = $_term; 1009 /** 1010 * Filters a taxonomy term object. 1011 * 1012 * The {@see 'get_$taxonomy'} hook is also available for targeting a specific 1013 * taxonomy. 1014 * 1015 * @since 2.3.0 1016 * @since 4.4.0 `$_term` is now a `WP_Term` object. 1017 * 1018 * @param WP_Term $_term Term object. 1019 * @param string $taxonomy The taxonomy slug. 1020 */ 1021 $_term = apply_filters( 'get_term', $_term, $taxonomy ); 1022 1023 /** 1024 * Filters a taxonomy term object. 1025 * 1026 * The dynamic portion of the hook name, `$taxonomy`, refers 1027 * to the slug of the term's taxonomy. 1028 * 1029 * Possible hook names include: 1030 * 1031 * - `get_category` 1032 * - `get_post_tag` 1033 * 1034 * @since 2.3.0 1035 * @since 4.4.0 `$_term` is now a `WP_Term` object. 1036 * 1037 * @param WP_Term $_term Term object. 1038 * @param string $taxonomy The taxonomy slug. 1039 */ 1040 $_term = apply_filters( "get_{$taxonomy}", $_term, $taxonomy ); 1041 1042 // Bail if a filter callback has changed the type of the `$_term` object. 1043 if ( ! ( $_term instanceof WP_Term ) ) { 1044 return $_term; 1045 } 1046 1047 // Sanitize term, according to the specified filter. 1048 if ( $_term !== $old_term || $_term->filter !== $filter ) { 1049 $_term->filter( $filter ); 1050 } 1051 1052 if ( ARRAY_A === $output ) { 1053 return $_term->to_array(); 1054 } elseif ( ARRAY_N === $output ) { 1055 return array_values( $_term->to_array() ); 1056 } 1057 1058 return $_term; 1059 } 1060 1061 /** 1062 * Gets all term data from database by term field and data. 1063 * 1064 * Warning: $value is not escaped for 'name' $field. You must do it yourself, if 1065 * required. 1066 * 1067 * The default $field is 'id', therefore it is possible to also use null for 1068 * field, but not recommended that you do so. 1069 * 1070 * If $value does not exist, the return value will be false. If $taxonomy exists 1071 * and $field and $value combinations exist, the term will be returned. 1072 * 1073 * This function will always return the first term that matches the `$field`- 1074 * `$value`-`$taxonomy` combination specified in the parameters. If your query 1075 * is likely to match more than one term (as is likely to be the case when 1076 * `$field` is 'name', for example), consider using get_terms() instead; that 1077 * way, you will get all matching terms, and can provide your own logic for 1078 * deciding which one was intended. 1079 * 1080 * @todo Better formatting for DocBlock. 1081 * 1082 * @since 2.3.0 1083 * @since 4.4.0 `$taxonomy` is optional if `$field` is 'term_taxonomy_id'. Converted to return 1084 * a WP_Term object if `$output` is `OBJECT`. 1085 * @since 5.5.0 Added 'ID' as an alias of 'id' for the `$field` parameter. 1086 * 1087 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param. 1088 * 1089 * @param string $field Either 'slug', 'name', 'term_id' (or 'id', 'ID'), or 'term_taxonomy_id'. 1090 * @param string|int $value Search for this term value. 1091 * @param string $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'. 1092 * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which 1093 * correspond to a WP_Term object, an associative array, or a numeric array, 1094 * respectively. Default OBJECT. 1095 * @param string $filter Optional. How to sanitize term fields. Default 'raw'. 1096 * @return WP_Term|array|false WP_Term instance (or array) on success, depending on the `$output` value. 1097 * False if `$taxonomy` does not exist or `$term` was not found. 1098 */ 1099 function get_term_by( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) { 1100 1101 // 'term_taxonomy_id' lookups don't require taxonomy checks. 1102 if ( 'term_taxonomy_id' !== $field && ! taxonomy_exists( $taxonomy ) ) { 1103 return false; 1104 } 1105 1106 // No need to perform a query for empty 'slug' or 'name'. 1107 if ( 'slug' === $field || 'name' === $field ) { 1108 $value = (string) $value; 1109 1110 if ( 0 === strlen( $value ) ) { 1111 return false; 1112 } 1113 } 1114 1115 if ( 'id' === $field || 'ID' === $field || 'term_id' === $field ) { 1116 $term = get_term( (int) $value, $taxonomy, $output, $filter ); 1117 if ( is_wp_error( $term ) || null === $term ) { 1118 $term = false; 1119 } 1120 return $term; 1121 } 1122 1123 $args = array( 1124 'get' => 'all', 1125 'number' => 1, 1126 'taxonomy' => $taxonomy, 1127 'update_term_meta_cache' => false, 1128 'orderby' => 'none', 1129 'suppress_filter' => true, 1130 ); 1131 1132 switch ( $field ) { 1133 case 'slug': 1134 $args['slug'] = $value; 1135 break; 1136 case 'name': 1137 $args['name'] = $value; 1138 break; 1139 case 'term_taxonomy_id': 1140 $args['term_taxonomy_id'] = $value; 1141 unset( $args['taxonomy'] ); 1142 break; 1143 default: 1144 return false; 1145 } 1146 1147 $terms = get_terms( $args ); 1148 if ( is_wp_error( $terms ) || empty( $terms ) ) { 1149 return false; 1150 } 1151 1152 $term = array_shift( $terms ); 1153 1154 // In the case of 'term_taxonomy_id', override the provided `$taxonomy` with whatever we find in the DB. 1155 if ( 'term_taxonomy_id' === $field ) { 1156 $taxonomy = $term->taxonomy; 1157 } 1158 1159 return get_term( $term, $taxonomy, $output, $filter ); 1160 } 1161 1162 /** 1163 * Merges all term children into a single array of their IDs. 1164 * 1165 * This recursive function will merge all of the children of $term into the same 1166 * array of term IDs. Only useful for taxonomies which are hierarchical. 1167 * 1168 * Will return an empty array if $term does not exist in $taxonomy. 1169 * 1170 * @since 2.3.0 1171 * 1172 * @param int $term_id ID of term to get children. 1173 * @param string $taxonomy Taxonomy name. 1174 * @return array|WP_Error List of term IDs. WP_Error returned if `$taxonomy` does not exist. 1175 */ 1176 function get_term_children( $term_id, $taxonomy ) { 1177 if ( ! taxonomy_exists( $taxonomy ) ) { 1178 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 1179 } 1180 1181 $term_id = (int) $term_id; 1182 1183 $terms = _get_term_hierarchy( $taxonomy ); 1184 1185 if ( ! isset( $terms[ $term_id ] ) ) { 1186 return array(); 1187 } 1188 1189 $children = $terms[ $term_id ]; 1190 1191 foreach ( (array) $terms[ $term_id ] as $child ) { 1192 if ( $term_id === $child ) { 1193 continue; 1194 } 1195 1196 if ( isset( $terms[ $child ] ) ) { 1197 $children = array_merge( $children, get_term_children( $child, $taxonomy ) ); 1198 } 1199 } 1200 1201 return $children; 1202 } 1203 1204 /** 1205 * Gets sanitized term field. 1206 * 1207 * The function is for contextual reasons and for simplicity of usage. 1208 * 1209 * @since 2.3.0 1210 * @since 4.4.0 The `$taxonomy` parameter was made optional. `$term` can also now accept a WP_Term object. 1211 * 1212 * @see sanitize_term_field() 1213 * 1214 * @param string $field Term field to fetch. 1215 * @param int|WP_Term $term Term ID or object. 1216 * @param string $taxonomy Optional. Taxonomy name. Default empty. 1217 * @param string $context Optional. How to sanitize term fields. Look at sanitize_term_field() for available options. 1218 * Default 'display'. 1219 * @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. 1220 */ 1221 function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) { 1222 $term = get_term( $term, $taxonomy ); 1223 if ( is_wp_error( $term ) ) { 1224 return $term; 1225 } 1226 1227 if ( ! is_object( $term ) ) { 1228 return ''; 1229 } 1230 1231 if ( ! isset( $term->$field ) ) { 1232 return ''; 1233 } 1234 1235 return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context ); 1236 } 1237 1238 /** 1239 * Sanitizes term for editing. 1240 * 1241 * Return value is sanitize_term() and usage is for sanitizing the term for 1242 * editing. Function is for contextual and simplicity. 1243 * 1244 * @since 2.3.0 1245 * 1246 * @param int|object $id Term ID or object. 1247 * @param string $taxonomy Taxonomy name. 1248 * @return string|int|null|WP_Error Will return empty string if $term is not an object. 1249 */ 1250 function get_term_to_edit( $id, $taxonomy ) { 1251 $term = get_term( $id, $taxonomy ); 1252 1253 if ( is_wp_error( $term ) ) { 1254 return $term; 1255 } 1256 1257 if ( ! is_object( $term ) ) { 1258 return ''; 1259 } 1260 1261 return sanitize_term( $term, $taxonomy, 'edit' ); 1262 } 1263 1264 /** 1265 * Retrieves the terms in a given taxonomy or list of taxonomies. 1266 * 1267 * You can fully inject any customizations to the query before it is sent, as 1268 * well as control the output with a filter. 1269 * 1270 * The return type varies depending on the value passed to `$args['fields']`. See 1271 * WP_Term_Query::get_terms() for details. In all cases, a `WP_Error` object will 1272 * be returned if an invalid taxonomy is requested. 1273 * 1274 * The {@see 'get_terms'} filter will be called when the cache has the term and will 1275 * pass the found term along with the array of $taxonomies and array of $args. 1276 * This filter is also called before the array of terms is passed and will pass 1277 * the array of terms, along with the $taxonomies and $args. 1278 * 1279 * The {@see 'list_terms_exclusions'} filter passes the compiled exclusions along with 1280 * the $args. 1281 * 1282 * The {@see 'get_terms_orderby'} filter passes the `ORDER BY` clause for the query 1283 * along with the $args array. 1284 * 1285 * Taxonomy or an array of taxonomies should be passed via the 'taxonomy' argument 1286 * in the `$args` array: 1287 * 1288 * $terms = get_terms( array( 1289 * 'taxonomy' => 'post_tag', 1290 * 'hide_empty' => false, 1291 * ) ); 1292 * 1293 * Prior to 4.5.0, taxonomy was passed as the first parameter of `get_terms()`. 1294 * 1295 * @since 2.3.0 1296 * @since 4.2.0 Introduced 'name' and 'childless' parameters. 1297 * @since 4.4.0 Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter. 1298 * Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return 1299 * a list of WP_Term objects. 1300 * @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter. 1301 * Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata. 1302 * @since 4.8.0 Introduced 'suppress_filter' parameter. 1303 * 1304 * @internal The `$deprecated` parameter is parsed for backward compatibility only. 1305 * 1306 * @param array|string $args Optional. Array or string of arguments. See WP_Term_Query::__construct() 1307 * for information on accepted arguments. Default empty array. 1308 * @param array|string $deprecated Optional. Argument array, when using the legacy function parameter format. 1309 * If present, this parameter will be interpreted as `$args`, and the first 1310 * function parameter will be parsed as a taxonomy or array of taxonomies. 1311 * Default empty. 1312 * @return WP_Term[]|int[]|string[]|string|WP_Error Array of terms, a count thereof as a numeric string, 1313 * or WP_Error if any of the taxonomies do not exist. 1314 * See the function description for more information. 1315 */ 1316 function get_terms( $args = array(), $deprecated = '' ) { 1317 $term_query = new WP_Term_Query(); 1318 1319 $defaults = array( 1320 'suppress_filter' => false, 1321 ); 1322 1323 /* 1324 * Legacy argument format ($taxonomy, $args) takes precedence. 1325 * 1326 * We detect legacy argument format by checking if 1327 * (a) a second non-empty parameter is passed, or 1328 * (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies) 1329 */ 1330 $_args = wp_parse_args( $args ); 1331 $key_intersect = array_intersect_key( $term_query->query_var_defaults, (array) $_args ); 1332 $do_legacy_args = $deprecated || empty( $key_intersect ); 1333 1334 if ( $do_legacy_args ) { 1335 $taxonomies = (array) $args; 1336 $args = wp_parse_args( $deprecated, $defaults ); 1337 $args['taxonomy'] = $taxonomies; 1338 } else { 1339 $args = wp_parse_args( $args, $defaults ); 1340 if ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) { 1341 $args['taxonomy'] = (array) $args['taxonomy']; 1342 } 1343 } 1344 1345 if ( ! empty( $args['taxonomy'] ) ) { 1346 foreach ( $args['taxonomy'] as $taxonomy ) { 1347 if ( ! taxonomy_exists( $taxonomy ) ) { 1348 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 1349 } 1350 } 1351 } 1352 1353 // Don't pass suppress_filter to WP_Term_Query. 1354 $suppress_filter = $args['suppress_filter']; 1355 unset( $args['suppress_filter'] ); 1356 1357 $terms = $term_query->query( $args ); 1358 1359 // Count queries are not filtered, for legacy reasons. 1360 if ( ! is_array( $terms ) ) { 1361 return $terms; 1362 } 1363 1364 if ( $suppress_filter ) { 1365 return $terms; 1366 } 1367 1368 /** 1369 * Filters the found terms. 1370 * 1371 * @since 2.3.0 1372 * @since 4.6.0 Added the `$term_query` parameter. 1373 * 1374 * @param array $terms Array of found terms. 1375 * @param array|null $taxonomies An array of taxonomies if known. 1376 * @param array $args An array of get_terms() arguments. 1377 * @param WP_Term_Query $term_query The WP_Term_Query object. 1378 */ 1379 return apply_filters( 'get_terms', $terms, $term_query->query_vars['taxonomy'], $term_query->query_vars, $term_query ); 1380 } 1381 1382 /** 1383 * Adds metadata to a term. 1384 * 1385 * @since 4.4.0 1386 * 1387 * @param int $term_id Term ID. 1388 * @param string $meta_key Metadata name. 1389 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1390 * @param bool $unique Optional. Whether the same key should not be added. 1391 * Default false. 1392 * @return int|false|WP_Error Meta ID on success, false on failure. 1393 * WP_Error when term_id is ambiguous between taxonomies. 1394 */ 1395 function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) { 1396 if ( wp_term_is_shared( $term_id ) ) { 1397 return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id ); 1398 } 1399 1400 return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique ); 1401 } 1402 1403 /** 1404 * Removes metadata matching criteria from a term. 1405 * 1406 * @since 4.4.0 1407 * 1408 * @param int $term_id Term ID. 1409 * @param string $meta_key Metadata name. 1410 * @param mixed $meta_value Optional. Metadata value. If provided, 1411 * rows will only be removed that match the value. 1412 * Must be serializable if non-scalar. Default empty. 1413 * @return bool True on success, false on failure. 1414 */ 1415 function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) { 1416 return delete_metadata( 'term', $term_id, $meta_key, $meta_value ); 1417 } 1418 1419 /** 1420 * Retrieves metadata for a term. 1421 * 1422 * @since 4.4.0 1423 * 1424 * @param int $term_id Term ID. 1425 * @param string $key Optional. The meta key to retrieve. By default, 1426 * returns data for all keys. Default empty. 1427 * @param bool $single Optional. Whether to return a single value. 1428 * This parameter has no effect if `$key` is not specified. 1429 * Default false. 1430 * @return mixed An array of values if `$single` is false. 1431 * The value of the meta field if `$single` is true. 1432 * False for an invalid `$term_id` (non-numeric, zero, or negative value). 1433 * An empty array if a valid but non-existing term ID is passed and `$single` is false. 1434 * An empty string if a valid but non-existing term ID is passed and `$single` is true. 1435 */ 1436 function get_term_meta( $term_id, $key = '', $single = false ) { 1437 return get_metadata( 'term', $term_id, $key, $single ); 1438 } 1439 1440 /** 1441 * Updates term metadata. 1442 * 1443 * Use the `$prev_value` parameter to differentiate between meta fields with the same key and term ID. 1444 * 1445 * If the meta field for the term does not exist, it will be added. 1446 * 1447 * @since 4.4.0 1448 * 1449 * @param int $term_id Term ID. 1450 * @param string $meta_key Metadata key. 1451 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1452 * @param mixed $prev_value Optional. Previous value to check before updating. 1453 * If specified, only update existing metadata entries with 1454 * this value. Otherwise, update all entries. Default empty. 1455 * @return int|bool|WP_Error Meta ID if the key didn't exist. true on successful update, 1456 * false on failure or if the value passed to the function 1457 * is the same as the one that is already in the database. 1458 * WP_Error when term_id is ambiguous between taxonomies. 1459 */ 1460 function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) { 1461 if ( wp_term_is_shared( $term_id ) ) { 1462 return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id ); 1463 } 1464 1465 return update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value ); 1466 } 1467 1468 /** 1469 * Updates metadata cache for list of term IDs. 1470 * 1471 * Performs SQL query to retrieve all metadata for the terms matching `$term_ids` and stores them in the cache. 1472 * Subsequent calls to `get_term_meta()` will not need to query the database. 1473 * 1474 * @since 4.4.0 1475 * 1476 * @param array $term_ids List of term IDs. 1477 * @return array|false An array of metadata on success, false if there is nothing to update. 1478 */ 1479 function update_termmeta_cache( $term_ids ) { 1480 return update_meta_cache( 'term', $term_ids ); 1481 } 1482 1483 1484 /** 1485 * Queue term meta for lazy-loading. 1486 * 1487 * @since 6.3.0 1488 * 1489 * @param array $term_ids List of term IDs. 1490 */ 1491 function wp_lazyload_term_meta( array $term_ids ) { 1492 if ( empty( $term_ids ) ) { 1493 return; 1494 } 1495 $lazyloader = wp_metadata_lazyloader(); 1496 $lazyloader->queue_objects( 'term', $term_ids ); 1497 } 1498 1499 /** 1500 * Gets all meta data, including meta IDs, for the given term ID. 1501 * 1502 * @since 4.9.0 1503 * 1504 * @global wpdb $wpdb WordPress database abstraction object. 1505 * 1506 * @param int $term_id Term ID. 1507 * @return array|false Array with meta data, or false when the meta table is not installed. 1508 */ 1509 function has_term_meta( $term_id ) { 1510 $check = wp_check_term_meta_support_prefilter( null ); 1511 if ( null !== $check ) { 1512 return $check; 1513 } 1514 1515 global $wpdb; 1516 1517 return $wpdb->get_results( $wpdb->prepare( "SELECT meta_key, meta_value, meta_id, term_id FROM $wpdb->termmeta WHERE term_id = %d ORDER BY meta_key,meta_id", $term_id ), ARRAY_A ); 1518 } 1519 1520 /** 1521 * Registers a meta key for terms. 1522 * 1523 * @since 4.9.8 1524 * 1525 * @param string $taxonomy Taxonomy to register a meta key for. Pass an empty string 1526 * to register the meta key across all existing taxonomies. 1527 * @param string $meta_key The meta key to register. 1528 * @param array $args Data used to describe the meta key when registered. See 1529 * {@see register_meta()} for a list of supported arguments. 1530 * @return bool True if the meta key was successfully registered, false if not. 1531 */ 1532 function register_term_meta( $taxonomy, $meta_key, array $args ) { 1533 $args['object_subtype'] = $taxonomy; 1534 1535 return register_meta( 'term', $meta_key, $args ); 1536 } 1537 1538 /** 1539 * Unregisters a meta key for terms. 1540 * 1541 * @since 4.9.8 1542 * 1543 * @param string $taxonomy Taxonomy the meta key is currently registered for. Pass 1544 * an empty string if the meta key is registered across all 1545 * existing taxonomies. 1546 * @param string $meta_key The meta key to unregister. 1547 * @return bool True on success, false if the meta key was not previously registered. 1548 */ 1549 function unregister_term_meta( $taxonomy, $meta_key ) { 1550 return unregister_meta_key( 'term', $meta_key, $taxonomy ); 1551 } 1552 1553 /** 1554 * Determines whether a taxonomy term exists. 1555 * 1556 * Formerly is_term(), introduced in 2.3.0. 1557 * 1558 * For more information on this and similar theme functions, check out 1559 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1560 * Conditional Tags} article in the Theme Developer Handbook. 1561 * 1562 * @since 3.0.0 1563 * @since 6.0.0 Converted to use `get_terms()`. 1564 * 1565 * @global bool $_wp_suspend_cache_invalidation 1566 * 1567 * @param int|string $term The term to check. Accepts term ID, slug, or name. 1568 * @param string $taxonomy Optional. The taxonomy name to use. 1569 * @param int $parent_term Optional. ID of parent term under which to confine the exists search. 1570 * @return mixed Returns null if the term does not exist. 1571 * Returns the term ID if no taxonomy is specified and the term ID exists. 1572 * Returns an array of the term ID and the term taxonomy ID if the taxonomy is specified and the pairing exists. 1573 * Returns 0 if term ID 0 is passed to the function. 1574 */ 1575 function term_exists( $term, $taxonomy = '', $parent_term = null ) { 1576 global $_wp_suspend_cache_invalidation; 1577 1578 if ( null === $term ) { 1579 return null; 1580 } 1581 1582 $defaults = array( 1583 'get' => 'all', 1584 'fields' => 'ids', 1585 'number' => 1, 1586 'update_term_meta_cache' => false, 1587 'order' => 'ASC', 1588 'orderby' => 'term_id', 1589 'suppress_filter' => true, 1590 ); 1591 1592 // Ensure that while importing, queries are not cached. 1593 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 1594 $defaults['cache_results'] = false; 1595 } 1596 1597 if ( ! empty( $taxonomy ) ) { 1598 $defaults['taxonomy'] = $taxonomy; 1599 $defaults['fields'] = 'all'; 1600 } 1601 1602 /** 1603 * Filters default query arguments for checking if a term exists. 1604 * 1605 * @since 6.0.0 1606 * 1607 * @param array $defaults An array of arguments passed to get_terms(). 1608 * @param int|string $term The term to check. Accepts term ID, slug, or name. 1609 * @param string $taxonomy The taxonomy name to use. An empty string indicates 1610 * the search is against all taxonomies. 1611 * @param int|null $parent_term ID of parent term under which to confine the exists search. 1612 * Null indicates the search is unconfined. 1613 */ 1614 $defaults = apply_filters( 'term_exists_default_query_args', $defaults, $term, $taxonomy, $parent_term ); 1615 1616 if ( is_int( $term ) ) { 1617 if ( 0 === $term ) { 1618 return 0; 1619 } 1620 $args = wp_parse_args( array( 'include' => array( $term ) ), $defaults ); 1621 $terms = get_terms( $args ); 1622 } else { 1623 $term = trim( wp_unslash( $term ) ); 1624 if ( '' === $term ) { 1625 return null; 1626 } 1627 1628 if ( ! empty( $taxonomy ) && is_numeric( $parent_term ) ) { 1629 $defaults['parent'] = (int) $parent_term; 1630 } 1631 1632 $args = wp_parse_args( array( 'slug' => sanitize_title( $term ) ), $defaults ); 1633 $terms = get_terms( $args ); 1634 if ( empty( $terms ) || is_wp_error( $terms ) ) { 1635 $args = wp_parse_args( array( 'name' => $term ), $defaults ); 1636 $terms = get_terms( $args ); 1637 } 1638 } 1639 1640 if ( empty( $terms ) || is_wp_error( $terms ) ) { 1641 return null; 1642 } 1643 1644 $_term = array_shift( $terms ); 1645 1646 if ( ! empty( $taxonomy ) ) { 1647 return array( 1648 'term_id' => (string) $_term->term_id, 1649 'term_taxonomy_id' => (string) $_term->term_taxonomy_id, 1650 ); 1651 } 1652 1653 return (string) $_term; 1654 } 1655 1656 /** 1657 * Checks if a term is an ancestor of another term. 1658 * 1659 * You can use either an ID or the term object for both parameters. 1660 * 1661 * @since 3.4.0 1662 * 1663 * @param int|object $term1 ID or object to check if this is the parent term. 1664 * @param int|object $term2 The child term. 1665 * @param string $taxonomy Taxonomy name that $term1 and `$term2` belong to. 1666 * @return bool Whether `$term2` is a child of `$term1`. 1667 */ 1668 function term_is_ancestor_of( $term1, $term2, $taxonomy ) { 1669 if ( ! isset( $term1->term_id ) ) { 1670 $term1 = get_term( $term1, $taxonomy ); 1671 } 1672 if ( ! isset( $term2->parent ) ) { 1673 $term2 = get_term( $term2, $taxonomy ); 1674 } 1675 1676 if ( empty( $term1->term_id ) || empty( $term2->parent ) ) { 1677 return false; 1678 } 1679 if ( $term2->parent === $term1->term_id ) { 1680 return true; 1681 } 1682 1683 return term_is_ancestor_of( $term1, get_term( $term2->parent, $taxonomy ), $taxonomy ); 1684 } 1685 1686 /** 1687 * Sanitizes all term fields. 1688 * 1689 * Relies on sanitize_term_field() to sanitize the term. The difference is that 1690 * this function will sanitize **all** fields. The context is based 1691 * on sanitize_term_field(). 1692 * 1693 * The `$term` is expected to be either an array or an object. 1694 * 1695 * @since 2.3.0 1696 * 1697 * @param array|object $term The term to check. 1698 * @param string $taxonomy The taxonomy name to use. 1699 * @param string $context Optional. Context in which to sanitize the term. 1700 * Accepts 'raw', 'edit', 'db', 'display', 'rss', 1701 * 'attribute', or 'js'. Default 'display'. 1702 * @return array|object Term with all fields sanitized. 1703 */ 1704 function sanitize_term( $term, $taxonomy, $context = 'display' ) { 1705 $fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' ); 1706 1707 $do_object = is_object( $term ); 1708 1709 $term_id = $do_object ? $term->term_id : ( isset( $term['term_id'] ) ? $term['term_id'] : 0 ); 1710 1711 foreach ( (array) $fields as $field ) { 1712 if ( $do_object ) { 1713 if ( isset( $term->$field ) ) { 1714 $term->$field = sanitize_term_field( $field, $term->$field, $term_id, $taxonomy, $context ); 1715 } 1716 } else { 1717 if ( isset( $term[ $field ] ) ) { 1718 $term[ $field ] = sanitize_term_field( $field, $term[ $field ], $term_id, $taxonomy, $context ); 1719 } 1720 } 1721 } 1722 1723 if ( $do_object ) { 1724 $term->filter = $context; 1725 } else { 1726 $term['filter'] = $context; 1727 } 1728 1729 return $term; 1730 } 1731 1732 /** 1733 * Sanitizes the field value in the term based on the context. 1734 * 1735 * Passing a term field value through the function should be assumed to have 1736 * cleansed the value for whatever context the term field is going to be used. 1737 * 1738 * If no context or an unsupported context is given, then default filters will 1739 * be applied. 1740 * 1741 * There are enough filters for each context to support a custom filtering 1742 * without creating your own filter function. Simply create a function that 1743 * hooks into the filter you need. 1744 * 1745 * @since 2.3.0 1746 * 1747 * @param string $field Term field to sanitize. 1748 * @param string $value Search for this term value. 1749 * @param int $term_id Term ID. 1750 * @param string $taxonomy Taxonomy name. 1751 * @param string $context Context in which to sanitize the term field. 1752 * Accepts 'raw', 'edit', 'db', 'display', 'rss', 1753 * 'attribute', or 'js'. Default 'display'. 1754 * @return mixed Sanitized field. 1755 */ 1756 function sanitize_term_field( $field, $value, $term_id, $taxonomy, $context ) { 1757 $int_fields = array( 'parent', 'term_id', 'count', 'term_group', 'term_taxonomy_id', 'object_id' ); 1758 if ( in_array( $field, $int_fields, true ) ) { 1759 $value = (int) $value; 1760 if ( $value < 0 ) { 1761 $value = 0; 1762 } 1763 } 1764 1765 $context = strtolower( $context ); 1766 1767 if ( 'raw' === $context ) { 1768 return $value; 1769 } 1770 1771 if ( 'edit' === $context ) { 1772 1773 /** 1774 * Filters a term field to edit before it is sanitized. 1775 * 1776 * The dynamic portion of the hook name, `$field`, refers to the term field. 1777 * 1778 * @since 2.3.0 1779 * 1780 * @param mixed $value Value of the term field. 1781 * @param int $term_id Term ID. 1782 * @param string $taxonomy Taxonomy slug. 1783 */ 1784 $value = apply_filters( "edit_term_{$field}", $value, $term_id, $taxonomy ); 1785 1786 /** 1787 * Filters the taxonomy field to edit before it is sanitized. 1788 * 1789 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer 1790 * to the taxonomy slug and taxonomy field, respectively. 1791 * 1792 * @since 2.3.0 1793 * 1794 * @param mixed $value Value of the taxonomy field to edit. 1795 * @param int $term_id Term ID. 1796 */ 1797 $value = apply_filters( "edit_{$taxonomy}_{$field}", $value, $term_id ); 1798 1799 if ( 'description' === $field ) { 1800 $value = esc_html( $value ); // textarea_escaped 1801 } else { 1802 $value = esc_attr( $value ); 1803 } 1804 } elseif ( 'db' === $context ) { 1805 1806 /** 1807 * Filters a term field value before it is sanitized. 1808 * 1809 * The dynamic portion of the hook name, `$field`, refers to the term field. 1810 * 1811 * @since 2.3.0 1812 * 1813 * @param mixed $value Value of the term field. 1814 * @param string $taxonomy Taxonomy slug. 1815 */ 1816 $value = apply_filters( "pre_term_{$field}", $value, $taxonomy ); 1817 1818 /** 1819 * Filters a taxonomy field before it is sanitized. 1820 * 1821 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer 1822 * to the taxonomy slug and field name, respectively. 1823 * 1824 * @since 2.3.0 1825 * 1826 * @param mixed $value Value of the taxonomy field. 1827 */ 1828 $value = apply_filters( "pre_{$taxonomy}_{$field}", $value ); 1829 1830 // Back compat filters. 1831 if ( 'slug' === $field ) { 1832 /** 1833 * Filters the category nicename before it is sanitized. 1834 * 1835 * Use the {@see 'pre_$taxonomy_$field'} hook instead. 1836 * 1837 * @since 2.0.3 1838 * 1839 * @param string $value The category nicename. 1840 */ 1841 $value = apply_filters( 'pre_category_nicename', $value ); 1842 } 1843 } elseif ( 'rss' === $context ) { 1844 1845 /** 1846 * Filters the term field for use in RSS. 1847 * 1848 * The dynamic portion of the hook name, `$field`, refers to the term field. 1849 * 1850 * @since 2.3.0 1851 * 1852 * @param mixed $value Value of the term field. 1853 * @param string $taxonomy Taxonomy slug. 1854 */ 1855 $value = apply_filters( "term_{$field}_rss", $value, $taxonomy ); 1856 1857 /** 1858 * Filters the taxonomy field for use in RSS. 1859 * 1860 * The dynamic portions of the hook name, `$taxonomy`, and `$field`, refer 1861 * to the taxonomy slug and field name, respectively. 1862 * 1863 * @since 2.3.0 1864 * 1865 * @param mixed $value Value of the taxonomy field. 1866 */ 1867 $value = apply_filters( "{$taxonomy}_{$field}_rss", $value ); 1868 } else { 1869 // Use display filters by default. 1870 1871 /** 1872 * Filters the term field sanitized for display. 1873 * 1874 * The dynamic portion of the hook name, `$field`, refers to the term field name. 1875 * 1876 * @since 2.3.0 1877 * 1878 * @param mixed $value Value of the term field. 1879 * @param int $term_id Term ID. 1880 * @param string $taxonomy Taxonomy slug. 1881 * @param string $context Context to retrieve the term field value. 1882 */ 1883 $value = apply_filters( "term_{$field}", $value, $term_id, $taxonomy, $context ); 1884 1885 /** 1886 * Filters the taxonomy field sanitized for display. 1887 * 1888 * The dynamic portions of the filter name, `$taxonomy`, and `$field`, refer 1889 * to the taxonomy slug and taxonomy field, respectively. 1890 * 1891 * @since 2.3.0 1892 * 1893 * @param mixed $value Value of the taxonomy field. 1894 * @param int $term_id Term ID. 1895 * @param string $context Context to retrieve the taxonomy field value. 1896 */ 1897 $value = apply_filters( "{$taxonomy}_{$field}", $value, $term_id, $context ); 1898 } 1899 1900 if ( 'attribute' === $context ) { 1901 $value = esc_attr( $value ); 1902 } elseif ( 'js' === $context ) { 1903 $value = esc_js( $value ); 1904 } 1905 1906 // Restore the type for integer fields after esc_attr(). 1907 if ( in_array( $field, $int_fields, true ) ) { 1908 $value = (int) $value; 1909 } 1910 1911 return $value; 1912 } 1913 1914 /** 1915 * Counts how many terms are in taxonomy. 1916 * 1917 * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true). 1918 * 1919 * @since 2.3.0 1920 * @since 5.6.0 Changed the function signature so that the `$args` array can be provided as the first parameter. 1921 * 1922 * @internal The `$deprecated` parameter is parsed for backward compatibility only. 1923 * 1924 * @param array|string $args Optional. Array or string of arguments. See WP_Term_Query::__construct() 1925 * for information on accepted arguments. Default empty array. 1926 * @param array|string $deprecated Optional. Argument array, when using the legacy function parameter format. 1927 * If present, this parameter will be interpreted as `$args`, and the first 1928 * function parameter will be parsed as a taxonomy or array of taxonomies. 1929 * Default empty. 1930 * @return string|WP_Error Numeric string containing the number of terms in that 1931 * taxonomy or WP_Error if the taxonomy does not exist. 1932 */ 1933 function wp_count_terms( $args = array(), $deprecated = '' ) { 1934 $use_legacy_args = false; 1935 1936 // Check whether function is used with legacy signature: `$taxonomy` and `$args`. 1937 if ( $args 1938 && ( is_string( $args ) && taxonomy_exists( $args ) 1939 || is_array( $args ) && wp_is_numeric_array( $args ) ) 1940 ) { 1941 $use_legacy_args = true; 1942 } 1943 1944 $defaults = array( 'hide_empty' => false ); 1945 1946 if ( $use_legacy_args ) { 1947 $defaults['taxonomy'] = $args; 1948 $args = $deprecated; 1949 } 1950 1951 $args = wp_parse_args( $args, $defaults ); 1952 1953 // Backward compatibility. 1954 if ( isset( $args['ignore_empty'] ) ) { 1955 $args['hide_empty'] = $args['ignore_empty']; 1956 unset( $args['ignore_empty'] ); 1957 } 1958 1959 $args['fields'] = 'count'; 1960 1961 return get_terms( $args ); 1962 } 1963 1964 /** 1965 * Unlinks the object from the taxonomy or taxonomies. 1966 * 1967 * Will remove all relationships between the object and any terms in 1968 * a particular taxonomy or taxonomies. Does not remove the term or 1969 * taxonomy itself. 1970 * 1971 * @since 2.3.0 1972 * 1973 * @param int $object_id The term object ID that refers to the term. 1974 * @param string|array $taxonomies List of taxonomy names or single taxonomy name. 1975 */ 1976 function wp_delete_object_term_relationships( $object_id, $taxonomies ) { 1977 $object_id = (int) $object_id; 1978 1979 if ( ! is_array( $taxonomies ) ) { 1980 $taxonomies = array( $taxonomies ); 1981 } 1982 1983 foreach ( (array) $taxonomies as $taxonomy ) { 1984 $term_ids = wp_get_object_terms( $object_id, $taxonomy, array( 'fields' => 'ids' ) ); 1985 $term_ids = array_map( 'intval', $term_ids ); 1986 wp_remove_object_terms( $object_id, $term_ids, $taxonomy ); 1987 } 1988 } 1989 1990 /** 1991 * Removes a term from the database. 1992 * 1993 * If the term is a parent of other terms, then the children will be updated to 1994 * that term's parent. 1995 * 1996 * Metadata associated with the term will be deleted. 1997 * 1998 * @since 2.3.0 1999 * 2000 * @global wpdb $wpdb WordPress database abstraction object. 2001 * 2002 * @param int $term Term ID. 2003 * @param string $taxonomy Taxonomy name. 2004 * @param array|string $args { 2005 * Optional. Array of arguments to override the default term ID. Default empty array. 2006 * 2007 * @type int $default The term ID to make the default term. This will only override 2008 * the terms found if there is only one term found. Any other and 2009 * the found terms are used. 2010 * @type bool $force_default Optional. Whether to force the supplied term as default to be 2011 * assigned even if the object was not going to be term-less. 2012 * Default false. 2013 * } 2014 * @return bool|int|WP_Error True on success, false if term does not exist. Zero on attempted 2015 * deletion of default Category. WP_Error if the taxonomy does not exist. 2016 */ 2017 function wp_delete_term( $term, $taxonomy, $args = array() ) { 2018 global $wpdb; 2019 2020 $term = (int) $term; 2021 2022 $ids = term_exists( $term, $taxonomy ); 2023 if ( ! $ids ) { 2024 return false; 2025 } 2026 if ( is_wp_error( $ids ) ) { 2027 return $ids; 2028 } 2029 2030 $tt_id = $ids['term_taxonomy_id']; 2031 2032 $defaults = array(); 2033 2034 if ( 'category' === $taxonomy ) { 2035 $defaults['default'] = (int) get_option( 'default_category' ); 2036 if ( $defaults['default'] === $term ) { 2037 return 0; // Don't delete the default category. 2038 } 2039 } 2040 2041 // Don't delete the default custom taxonomy term. 2042 $taxonomy_object = get_taxonomy( $taxonomy ); 2043 if ( ! empty( $taxonomy_object->default_term ) ) { 2044 $defaults['default'] = (int) get_option( 'default_term_' . $taxonomy ); 2045 if ( $defaults['default'] === $term ) { 2046 return 0; 2047 } 2048 } 2049 2050 $args = wp_parse_args( $args, $defaults ); 2051 2052 if ( isset( $args['default'] ) ) { 2053 $default = (int) $args['default']; 2054 if ( ! term_exists( $default, $taxonomy ) ) { 2055 unset( $default ); 2056 } 2057 } 2058 2059 if ( isset( $args['force_default'] ) ) { 2060 $force_default = $args['force_default']; 2061 } 2062 2063 /** 2064 * Fires when deleting a term, before any modifications are made to posts or terms. 2065 * 2066 * @since 4.1.0 2067 * 2068 * @param int $term Term ID. 2069 * @param string $taxonomy Taxonomy name. 2070 */ 2071 do_action( 'pre_delete_term', $term, $taxonomy ); 2072 2073 // Update children to point to new parent. 2074 if ( is_taxonomy_hierarchical( $taxonomy ) ) { 2075 $term_obj = get_term( $term, $taxonomy ); 2076 if ( is_wp_error( $term_obj ) ) { 2077 return $term_obj; 2078 } 2079 $parent = $term_obj->parent; 2080 2081 $edit_ids = $wpdb->get_results( "SELECT term_id, term_taxonomy_id FROM $wpdb->term_taxonomy WHERE `parent` = " . (int) $term_obj->term_id ); 2082 $edit_tt_ids = wp_list_pluck( $edit_ids, 'term_taxonomy_id' ); 2083 2084 /** 2085 * Fires immediately before a term to delete's children are reassigned a parent. 2086 * 2087 * @since 2.9.0 2088 * 2089 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term. 2090 */ 2091 do_action( 'edit_term_taxonomies', $edit_tt_ids ); 2092 2093 $wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id ) + compact( 'taxonomy' ) ); 2094 2095 // Clean the cache for all child terms. 2096 $edit_term_ids = wp_list_pluck( $edit_ids, 'term_id' ); 2097 clean_term_cache( $edit_term_ids, $taxonomy ); 2098 2099 /** 2100 * Fires immediately after a term to delete's children are reassigned a parent. 2101 * 2102 * @since 2.9.0 2103 * 2104 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term. 2105 */ 2106 do_action( 'edited_term_taxonomies', $edit_tt_ids ); 2107 } 2108 2109 // Get the term before deleting it or its term relationships so we can pass to actions below. 2110 $deleted_term = get_term( $term, $taxonomy ); 2111 2112 $object_ids = (array) $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) ); 2113 2114 foreach ( $object_ids as $object_id ) { 2115 if ( ! isset( $default ) ) { 2116 wp_remove_object_terms( $object_id, $term, $taxonomy ); 2117 continue; 2118 } 2119 2120 $terms = wp_get_object_terms( 2121 $object_id, 2122 $taxonomy, 2123 array( 2124 'fields' => 'ids', 2125 'orderby' => 'none', 2126 ) 2127 ); 2128 2129 if ( 1 === count( $terms ) && isset( $default ) ) { 2130 $terms = array( $default ); 2131 } else { 2132 $terms = array_diff( $terms, array( $term ) ); 2133 if ( isset( $default ) && isset( $force_default ) && $force_default ) { 2134 $terms = array_merge( $terms, array( $default ) ); 2135 } 2136 } 2137 2138 $terms = array_map( 'intval', $terms ); 2139 wp_set_object_terms( $object_id, $terms, $taxonomy ); 2140 } 2141 2142 // Clean the relationship caches for all object types using this term. 2143 $tax_object = get_taxonomy( $taxonomy ); 2144 foreach ( $tax_object->object_type as $object_type ) { 2145 clean_object_term_cache( $object_ids, $object_type ); 2146 } 2147 2148 $term_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->termmeta WHERE term_id = %d ", $term ) ); 2149 foreach ( $term_meta_ids as $mid ) { 2150 delete_metadata_by_mid( 'term', $mid ); 2151 } 2152 2153 /** 2154 * Fires immediately before a term taxonomy ID is deleted. 2155 * 2156 * @since 2.9.0 2157 * 2158 * @param int $tt_id Term taxonomy ID. 2159 */ 2160 do_action( 'delete_term_taxonomy', $tt_id ); 2161 2162 $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) ); 2163 2164 /** 2165 * Fires immediately after a term taxonomy ID is deleted. 2166 * 2167 * @since 2.9.0 2168 * 2169 * @param int $tt_id Term taxonomy ID. 2170 */ 2171 do_action( 'deleted_term_taxonomy', $tt_id ); 2172 2173 // Delete the term if no taxonomies use it. 2174 if ( ! $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term ) ) ) { 2175 $wpdb->delete( $wpdb->terms, array( 'term_id' => $term ) ); 2176 } 2177 2178 clean_term_cache( $term, $taxonomy ); 2179 2180 /** 2181 * Fires after a term is deleted from the database and the cache is cleaned. 2182 * 2183 * The {@see 'delete_$taxonomy'} hook is also available for targeting a specific 2184 * taxonomy. 2185 * 2186 * @since 2.5.0 2187 * @since 4.5.0 Introduced the `$object_ids` argument. 2188 * 2189 * @param int $term Term ID. 2190 * @param int $tt_id Term taxonomy ID. 2191 * @param string $taxonomy Taxonomy slug. 2192 * @param WP_Term $deleted_term Copy of the already-deleted term. 2193 * @param array $object_ids List of term object IDs. 2194 */ 2195 do_action( 'delete_term', $term, $tt_id, $taxonomy, $deleted_term, $object_ids ); 2196 2197 /** 2198 * Fires after a term in a specific taxonomy is deleted. 2199 * 2200 * The dynamic portion of the hook name, `$taxonomy`, refers to the specific 2201 * taxonomy the term belonged to. 2202 * 2203 * Possible hook names include: 2204 * 2205 * - `delete_category` 2206 * - `delete_post_tag` 2207 * 2208 * @since 2.3.0 2209 * @since 4.5.0 Introduced the `$object_ids` argument. 2210 * 2211 * @param int $term Term ID. 2212 * @param int $tt_id Term taxonomy ID. 2213 * @param WP_Term $deleted_term Copy of the already-deleted term. 2214 * @param array $object_ids List of term object IDs. 2215 */ 2216 do_action( "delete_{$taxonomy}", $term, $tt_id, $deleted_term, $object_ids ); 2217 2218 return true; 2219 } 2220 2221 /** 2222 * Deletes one existing category. 2223 * 2224 * @since 2.0.0 2225 * 2226 * @param int $cat_id Category term ID. 2227 * @return bool|int|WP_Error Returns true if completes delete action; false if term doesn't exist; 2228 * Zero on attempted deletion of default Category; WP_Error object is 2229 * also a possibility. 2230 */ 2231 function wp_delete_category( $cat_id ) { 2232 return wp_delete_term( $cat_id, 'category' ); 2233 } 2234 2235 /** 2236 * Retrieves the terms associated with the given object(s), in the supplied taxonomies. 2237 * 2238 * @since 2.3.0 2239 * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`. 2240 * Introduced `$parent` argument. 2241 * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or 2242 * 'all_with_object_id', an array of `WP_Term` objects will be returned. 2243 * @since 4.7.0 Refactored to use WP_Term_Query, and to support any WP_Term_Query arguments. 2244 * @since 6.3.0 Passing `update_term_meta_cache` argument value false by default resulting in get_terms() to not 2245 * prime the term meta cache. 2246 * 2247 * @param int|int[] $object_ids The ID(s) of the object(s) to retrieve. 2248 * @param string|string[] $taxonomies The taxonomy names to retrieve terms from. 2249 * @param array|string $args See WP_Term_Query::__construct() for supported arguments. 2250 * @return WP_Term[]|int[]|string[]|string|WP_Error Array of terms, a count thereof as a numeric string, 2251 * or WP_Error if any of the taxonomies do not exist. 2252 * See WP_Term_Query::get_terms() for more information. 2253 */ 2254 function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) { 2255 if ( empty( $object_ids ) || empty( $taxonomies ) ) { 2256 return array(); 2257 } 2258 2259 if ( ! is_array( $taxonomies ) ) { 2260 $taxonomies = array( $taxonomies ); 2261 } 2262 2263 foreach ( $taxonomies as $taxonomy ) { 2264 if ( ! taxonomy_exists( $taxonomy ) ) { 2265 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2266 } 2267 } 2268 2269 if ( ! is_array( $object_ids ) ) { 2270 $object_ids = array( $object_ids ); 2271 } 2272 $object_ids = array_map( 'intval', $object_ids ); 2273 2274 $defaults = array( 2275 'update_term_meta_cache' => false, 2276 ); 2277 2278 $args = wp_parse_args( $args, $defaults ); 2279 2280 /** 2281 * Filters arguments for retrieving object terms. 2282 * 2283 * @since 4.9.0 2284 * 2285 * @param array $args An array of arguments for retrieving terms for the given object(s). 2286 * See {@see wp_get_object_terms()} for details. 2287 * @param int[] $object_ids Array of object IDs. 2288 * @param string[] $taxonomies Array of taxonomy names to retrieve terms from. 2289 */ 2290 $args = apply_filters( 'wp_get_object_terms_args', $args, $object_ids, $taxonomies ); 2291 2292 /* 2293 * When one or more queried taxonomies is registered with an 'args' array, 2294 * those params override the `$args` passed to this function. 2295 */ 2296 $terms = array(); 2297 if ( count( $taxonomies ) > 1 ) { 2298 foreach ( $taxonomies as $index => $taxonomy ) { 2299 $t = get_taxonomy( $taxonomy ); 2300 if ( isset( $t->args ) && is_array( $t->args ) && array_merge( $args, $t->args ) != $args ) { 2301 unset( $taxonomies[ $index ] ); 2302 $terms = array_merge( $terms, wp_get_object_terms( $object_ids, $taxonomy, array_merge( $args, $t->args ) ) ); 2303 } 2304 } 2305 } else { 2306 $t = get_taxonomy( $taxonomies[0] ); 2307 if ( isset( $t->args ) && is_array( $t->args ) ) { 2308 $args = array_merge( $args, $t->args ); 2309 } 2310 } 2311 2312 $args['taxonomy'] = $taxonomies; 2313 $args['object_ids'] = $object_ids; 2314 2315 // Taxonomies registered without an 'args' param are handled here. 2316 if ( ! empty( $taxonomies ) ) { 2317 $terms_from_remaining_taxonomies = get_terms( $args ); 2318 2319 // Array keys should be preserved for values of $fields that use term_id for keys. 2320 if ( ! empty( $args['fields'] ) && str_starts_with( $args['fields'], 'id=>' ) ) { 2321 $terms = $terms + $terms_from_remaining_taxonomies; 2322 } else { 2323 $terms = array_merge( $terms, $terms_from_remaining_taxonomies ); 2324 } 2325 } 2326 2327 /** 2328 * Filters the terms for a given object or objects. 2329 * 2330 * @since 4.2.0 2331 * 2332 * @param WP_Term[]|int[]|string[]|string $terms Array of terms or a count thereof as a numeric string. 2333 * @param int[] $object_ids Array of object IDs for which terms were retrieved. 2334 * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved. 2335 * @param array $args Array of arguments for retrieving terms for the given 2336 * object(s). See wp_get_object_terms() for details. 2337 */ 2338 $terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomies, $args ); 2339 2340 $object_ids = implode( ',', $object_ids ); 2341 $taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'"; 2342 2343 /** 2344 * Filters the terms for a given object or objects. 2345 * 2346 * The `$taxonomies` parameter passed to this filter is formatted as a SQL fragment. The 2347 * {@see 'get_object_terms'} filter is recommended as an alternative. 2348 * 2349 * @since 2.8.0 2350 * 2351 * @param WP_Term[]|int[]|string[]|string $terms Array of terms or a count thereof as a numeric string. 2352 * @param string $object_ids Comma separated list of object IDs for which terms were retrieved. 2353 * @param string $taxonomies SQL fragment of taxonomy names from which terms were retrieved. 2354 * @param array $args Array of arguments for retrieving terms for the given 2355 * object(s). See wp_get_object_terms() for details. 2356 */ 2357 return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args ); 2358 } 2359 2360 /** 2361 * Adds a new term to the database. 2362 * 2363 * A non-existent term is inserted in the following sequence: 2364 * 1. The term is added to the term table, then related to the taxonomy. 2365 * 2. If everything is correct, several actions are fired. 2366 * 3. The 'term_id_filter' is evaluated. 2367 * 4. The term cache is cleaned. 2368 * 5. Several more actions are fired. 2369 * 6. An array is returned containing the `term_id` and `term_taxonomy_id`. 2370 * 2371 * If the 'slug' argument is not empty, then it is checked to see if the term 2372 * is invalid. If it is not a valid, existing term, it is added and the term_id 2373 * is given. 2374 * 2375 * If the taxonomy is hierarchical, and the 'parent' argument is not empty, 2376 * the term is inserted and the term_id will be given. 2377 * 2378 * Error handling: 2379 * If `$taxonomy` does not exist or `$term` is empty, 2380 * a WP_Error object will be returned. 2381 * 2382 * If the term already exists on the same hierarchical level, 2383 * or the term slug and name are not unique, a WP_Error object will be returned. 2384 * 2385 * @global wpdb $wpdb WordPress database abstraction object. 2386 * 2387 * @since 2.3.0 2388 * 2389 * @param string $term The term name to add. 2390 * @param string $taxonomy The taxonomy to which to add the term. 2391 * @param array|string $args { 2392 * Optional. Array or query string of arguments for inserting a term. 2393 * 2394 * @type string $alias_of Slug of the term to make this term an alias of. 2395 * Default empty string. Accepts a term slug. 2396 * @type string $description The term description. Default empty string. 2397 * @type int $parent The id of the parent term. Default 0. 2398 * @type string $slug The term slug to use. Default empty string. 2399 * } 2400 * @return array|WP_Error { 2401 * An array of the new term data, WP_Error otherwise. 2402 * 2403 * @type int $term_id The new term ID. 2404 * @type int|string $term_taxonomy_id The new term taxonomy ID. Can be a numeric string. 2405 * } 2406 */ 2407 function wp_insert_term( $term, $taxonomy, $args = array() ) { 2408 global $wpdb; 2409 2410 if ( ! taxonomy_exists( $taxonomy ) ) { 2411 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2412 } 2413 2414 /** 2415 * Filters a term before it is sanitized and inserted into the database. 2416 * 2417 * @since 3.0.0 2418 * @since 6.1.0 The `$args` parameter was added. 2419 * 2420 * @param string|WP_Error $term The term name to add, or a WP_Error object if there's an error. 2421 * @param string $taxonomy Taxonomy slug. 2422 * @param array|string $args Array or query string of arguments passed to wp_insert_term(). 2423 */ 2424 $term = apply_filters( 'pre_insert_term', $term, $taxonomy, $args ); 2425 2426 if ( is_wp_error( $term ) ) { 2427 return $term; 2428 } 2429 2430 if ( is_int( $term ) && 0 === $term ) { 2431 return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) ); 2432 } 2433 2434 if ( '' === trim( $term ) ) { 2435 return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) ); 2436 } 2437 2438 $defaults = array( 2439 'alias_of' => '', 2440 'description' => '', 2441 'parent' => 0, 2442 'slug' => '', 2443 ); 2444 $args = wp_parse_args( $args, $defaults ); 2445 2446 if ( (int) $args['parent'] > 0 && ! term_exists( (int) $args['parent'] ) ) { 2447 return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) ); 2448 } 2449 2450 $args['name'] = $term; 2451 $args['taxonomy'] = $taxonomy; 2452 2453 // Coerce null description to strings, to avoid database errors. 2454 $args['description'] = (string) $args['description']; 2455 2456 $args = sanitize_term( $args, $taxonomy, 'db' ); 2457 2458 // expected_slashed ($name) 2459 $name = wp_unslash( $args['name'] ); 2460 $description = wp_unslash( $args['description'] ); 2461 $parent = (int) $args['parent']; 2462 2463 // Sanitization could clean the name to an empty string that must be checked again. 2464 if ( '' === $name ) { 2465 return new WP_Error( 'invalid_term_name', __( 'Invalid term name.' ) ); 2466 } 2467 2468 $slug_provided = ! empty( $args['slug'] ); 2469 if ( ! $slug_provided ) { 2470 $slug = sanitize_title( $name ); 2471 } else { 2472 $slug = $args['slug']; 2473 } 2474 2475 $term_group = 0; 2476 if ( $args['alias_of'] ) { 2477 $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy ); 2478 if ( ! empty( $alias->term_group ) ) { 2479 // The alias we want is already in a group, so let's use that one. 2480 $term_group = $alias->term_group; 2481 } elseif ( ! empty( $alias->term_id ) ) { 2482 /* 2483 * The alias is not in a group, so we create a new one 2484 * and add the alias to it. 2485 */ 2486 $term_group = $wpdb->get_var( "SELECT MAX(term_group) FROM $wpdb->terms" ) + 1; 2487 2488 wp_update_term( 2489 $alias->term_id, 2490 $taxonomy, 2491 array( 2492 'term_group' => $term_group, 2493 ) 2494 ); 2495 } 2496 } 2497 2498 /* 2499 * Prevent the creation of terms with duplicate names at the same level of a taxonomy hierarchy, 2500 * unless a unique slug has been explicitly provided. 2501 */ 2502 $name_matches = get_terms( 2503 array( 2504 'taxonomy' => $taxonomy, 2505 'name' => $name, 2506 'hide_empty' => false, 2507 'parent' => $args['parent'], 2508 'update_term_meta_cache' => false, 2509 ) 2510 ); 2511 2512 /* 2513 * The `name` match in `get_terms()` doesn't differentiate accented characters, 2514 * so we do a stricter comparison here. 2515 */ 2516 $name_match = null; 2517 if ( $name_matches ) { 2518 foreach ( $name_matches as $_match ) { 2519 if ( strtolower( $name ) === strtolower( $_match->name ) ) { 2520 $name_match = $_match; 2521 break; 2522 } 2523 } 2524 } 2525 2526 if ( $name_match ) { 2527 $slug_match = get_term_by( 'slug', $slug, $taxonomy ); 2528 if ( ! $slug_provided || $name_match->slug === $slug || $slug_match ) { 2529 if ( is_taxonomy_hierarchical( $taxonomy ) ) { 2530 $siblings = get_terms( 2531 array( 2532 'taxonomy' => $taxonomy, 2533 'get' => 'all', 2534 'parent' => $parent, 2535 'update_term_meta_cache' => false, 2536 ) 2537 ); 2538 2539 $existing_term = null; 2540 $sibling_names = wp_list_pluck( $siblings, 'name' ); 2541 $sibling_slugs = wp_list_pluck( $siblings, 'slug' ); 2542 2543 if ( ( ! $slug_provided || $name_match->slug === $slug ) && in_array( $name, $sibling_names, true ) ) { 2544 $existing_term = $name_match; 2545 } elseif ( $slug_match && in_array( $slug, $sibling_slugs, true ) ) { 2546 $existing_term = $slug_match; 2547 } 2548 2549 if ( $existing_term ) { 2550 return new WP_Error( 'term_exists', __( 'A term with the name provided already exists with this parent.' ), $existing_term->term_id ); 2551 } 2552 } else { 2553 return new WP_Error( 'term_exists', __( 'A term with the name provided already exists in this taxonomy.' ), $name_match->term_id ); 2554 } 2555 } 2556 } 2557 2558 $slug = wp_unique_term_slug( $slug, (object) $args ); 2559 2560 $data = compact( 'name', 'slug', 'term_group' ); 2561 2562 /** 2563 * Filters term data before it is inserted into the database. 2564 * 2565 * @since 4.7.0 2566 * 2567 * @param array $data Term data to be inserted. 2568 * @param string $taxonomy Taxonomy slug. 2569 * @param array $args Arguments passed to wp_insert_term(). 2570 */ 2571 $data = apply_filters( 'wp_insert_term_data', $data, $taxonomy, $args ); 2572 2573 if ( false === $wpdb->insert( $wpdb->terms, $data ) ) { 2574 return new WP_Error( 'db_insert_error', __( 'Could not insert term into the database.' ), $wpdb->last_error ); 2575 } 2576 2577 $term_id = (int) $wpdb->insert_id; 2578 2579 // Seems unreachable. However, is used in the case that a term name is provided, which sanitizes to an empty string. 2580 if ( empty( $slug ) ) { 2581 $slug = sanitize_title( $slug, $term_id ); 2582 2583 /** This action is documented in wp-includes/taxonomy.php */ 2584 do_action( 'edit_terms', $term_id, $taxonomy ); 2585 $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) ); 2586 2587 /** This action is documented in wp-includes/taxonomy.php */ 2588 do_action( 'edited_terms', $term_id, $taxonomy ); 2589 } 2590 2591 $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 ) ); 2592 2593 if ( ! empty( $tt_id ) ) { 2594 return array( 2595 'term_id' => $term_id, 2596 'term_taxonomy_id' => $tt_id, 2597 ); 2598 } 2599 2600 if ( false === $wpdb->insert( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ) + array( 'count' => 0 ) ) ) { 2601 return new WP_Error( 'db_insert_error', __( 'Could not insert term taxonomy into the database.' ), $wpdb->last_error ); 2602 } 2603 2604 $tt_id = (int) $wpdb->insert_id; 2605 2606 /* 2607 * Confidence check: if we just created a term with the same parent + taxonomy + slug but a higher term_id than 2608 * an existing term, then we have unwittingly created a duplicate term. Delete the dupe, and use the term_id 2609 * and term_taxonomy_id of the older term instead. Then return out of the function so that the "create" hooks 2610 * are not fired. 2611 */ 2612 $duplicate_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.term_id, t.slug, tt.term_taxonomy_id, tt.taxonomy FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS 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 ) ); 2613 2614 /** 2615 * Filters the duplicate term check that takes place during term creation. 2616 * 2617 * Term parent + taxonomy + slug combinations are meant to be unique, and wp_insert_term() 2618 * performs a last-minute confirmation of this uniqueness before allowing a new term 2619 * to be created. Plugins with different uniqueness requirements may use this filter 2620 * to bypass or modify the duplicate-term check. 2621 * 2622 * @since 5.1.0 2623 * 2624 * @param object $duplicate_term Duplicate term row from terms table, if found. 2625 * @param string $term Term being inserted. 2626 * @param string $taxonomy Taxonomy name. 2627 * @param array $args Arguments passed to wp_insert_term(). 2628 * @param int $tt_id term_taxonomy_id for the newly created term. 2629 */ 2630 $duplicate_term = apply_filters( 'wp_insert_term_duplicate_term_check', $duplicate_term, $term, $taxonomy, $args, $tt_id ); 2631 2632 if ( $duplicate_term ) { 2633 $wpdb->delete( $wpdb->terms, array( 'term_id' => $term_id ) ); 2634 $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) ); 2635 2636 $term_id = (int) $duplicate_term->term_id; 2637 $tt_id = (int) $duplicate_term->term_taxonomy_id; 2638 2639 clean_term_cache( $term_id, $taxonomy ); 2640 return array( 2641 'term_id' => $term_id, 2642 'term_taxonomy_id' => $tt_id, 2643 ); 2644 } 2645 2646 /** 2647 * Fires immediately after a new term is created, before the term cache is cleaned. 2648 * 2649 * The {@see 'create_$taxonomy'} hook is also available for targeting a specific 2650 * taxonomy. 2651 * 2652 * @since 2.3.0 2653 * @since 6.1.0 The `$args` parameter was added. 2654 * 2655 * @param int $term_id Term ID. 2656 * @param int $tt_id Term taxonomy ID. 2657 * @param string $taxonomy Taxonomy slug. 2658 * @param array $args Arguments passed to wp_insert_term(). 2659 */ 2660 do_action( 'create_term', $term_id, $tt_id, $taxonomy, $args ); 2661 2662 /** 2663 * Fires after a new term is created for a specific taxonomy. 2664 * 2665 * The dynamic portion of the hook name, `$taxonomy`, refers 2666 * to the slug of the taxonomy the term was created for. 2667 * 2668 * Possible hook names include: 2669 * 2670 * - `create_category` 2671 * - `create_post_tag` 2672 * 2673 * @since 2.3.0 2674 * @since 6.1.0 The `$args` parameter was added. 2675 * 2676 * @param int $term_id Term ID. 2677 * @param int $tt_id Term taxonomy ID. 2678 * @param array $args Arguments passed to wp_insert_term(). 2679 */ 2680 do_action( "create_{$taxonomy}", $term_id, $tt_id, $args ); 2681 2682 /** 2683 * Filters the term ID after a new term is created. 2684 * 2685 * @since 2.3.0 2686 * @since 6.1.0 The `$args` parameter was added. 2687 * 2688 * @param int $term_id Term ID. 2689 * @param int $tt_id Term taxonomy ID. 2690 * @param array $args Arguments passed to wp_insert_term(). 2691 */ 2692 $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id, $args ); 2693 2694 clean_term_cache( $term_id, $taxonomy ); 2695 2696 /** 2697 * Fires after a new term is created, and after the term cache has been cleaned. 2698 * 2699 * The {@see 'created_$taxonomy'} hook is also available for targeting a specific 2700 * taxonomy. 2701 * 2702 * @since 2.3.0 2703 * @since 6.1.0 The `$args` parameter was added. 2704 * 2705 * @param int $term_id Term ID. 2706 * @param int $tt_id Term taxonomy ID. 2707 * @param string $taxonomy Taxonomy slug. 2708 * @param array $args Arguments passed to wp_insert_term(). 2709 */ 2710 do_action( 'created_term', $term_id, $tt_id, $taxonomy, $args ); 2711 2712 /** 2713 * Fires after a new term in a specific taxonomy is created, and after the term 2714 * cache has been cleaned. 2715 * 2716 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 2717 * 2718 * Possible hook names include: 2719 * 2720 * - `created_category` 2721 * - `created_post_tag` 2722 * 2723 * @since 2.3.0 2724 * @since 6.1.0 The `$args` parameter was added. 2725 * 2726 * @param int $term_id Term ID. 2727 * @param int $tt_id Term taxonomy ID. 2728 * @param array $args Arguments passed to wp_insert_term(). 2729 */ 2730 do_action( "created_{$taxonomy}", $term_id, $tt_id, $args ); 2731 2732 /** 2733 * Fires after a term has been saved, and the term cache has been cleared. 2734 * 2735 * The {@see 'saved_$taxonomy'} hook is also available for targeting a specific 2736 * taxonomy. 2737 * 2738 * @since 5.5.0 2739 * @since 6.1.0 The `$args` parameter was added. 2740 * 2741 * @param int $term_id Term ID. 2742 * @param int $tt_id Term taxonomy ID. 2743 * @param string $taxonomy Taxonomy slug. 2744 * @param bool $update Whether this is an existing term being updated. 2745 * @param array $args Arguments passed to wp_insert_term(). 2746 */ 2747 do_action( 'saved_term', $term_id, $tt_id, $taxonomy, false, $args ); 2748 2749 /** 2750 * Fires after a term in a specific taxonomy has been saved, and the term 2751 * cache has been cleared. 2752 * 2753 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 2754 * 2755 * Possible hook names include: 2756 * 2757 * - `saved_category` 2758 * - `saved_post_tag` 2759 * 2760 * @since 5.5.0 2761 * @since 6.1.0 The `$args` parameter was added. 2762 * 2763 * @param int $term_id Term ID. 2764 * @param int $tt_id Term taxonomy ID. 2765 * @param bool $update Whether this is an existing term being updated. 2766 * @param array $args Arguments passed to wp_insert_term(). 2767 */ 2768 do_action( "saved_{$taxonomy}", $term_id, $tt_id, false, $args ); 2769 2770 return array( 2771 'term_id' => $term_id, 2772 'term_taxonomy_id' => $tt_id, 2773 ); 2774 } 2775 2776 /** 2777 * Creates term and taxonomy relationships. 2778 * 2779 * Relates an object (post, link, etc.) to a term and taxonomy type. Creates the 2780 * term and taxonomy relationship if it doesn't already exist. Creates a term if 2781 * it doesn't exist (using the slug). 2782 * 2783 * A relationship means that the term is grouped in or belongs to the taxonomy. 2784 * A term has no meaning until it is given context by defining which taxonomy it 2785 * exists under. 2786 * 2787 * @since 2.3.0 2788 * 2789 * @global wpdb $wpdb WordPress database abstraction object. 2790 * 2791 * @param int $object_id The object to relate to. 2792 * @param string|int|array $terms A single term slug, single term ID, or array of either term slugs or IDs. 2793 * Will replace all existing related terms in this taxonomy. Passing an 2794 * empty array will remove all related terms. 2795 * @param string $taxonomy The context in which to relate the term to the object. 2796 * @param bool $append Optional. If false will delete difference of terms. Default false. 2797 * @return array|WP_Error Term taxonomy IDs of the affected terms or WP_Error on failure. 2798 */ 2799 function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) { 2800 global $wpdb; 2801 2802 $object_id = (int) $object_id; 2803 2804 if ( ! taxonomy_exists( $taxonomy ) ) { 2805 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2806 } 2807 2808 if ( empty( $terms ) ) { 2809 $terms = array(); 2810 } elseif ( ! is_array( $terms ) ) { 2811 $terms = array( $terms ); 2812 } 2813 2814 if ( ! $append ) { 2815 $old_tt_ids = wp_get_object_terms( 2816 $object_id, 2817 $taxonomy, 2818 array( 2819 'fields' => 'tt_ids', 2820 'orderby' => 'none', 2821 'update_term_meta_cache' => false, 2822 ) 2823 ); 2824 } else { 2825 $old_tt_ids = array(); 2826 } 2827 2828 $tt_ids = array(); 2829 $new_tt_ids = array(); 2830 2831 foreach ( (array) $terms as $term ) { 2832 if ( '' === trim( $term ) ) { 2833 continue; 2834 } 2835 2836 $term_info = term_exists( $term, $taxonomy ); 2837 2838 if ( ! $term_info ) { 2839 // Skip if a non-existent term ID is passed. 2840 if ( is_int( $term ) ) { 2841 continue; 2842 } 2843 2844 $term_info = wp_insert_term( $term, $taxonomy ); 2845 } 2846 2847 if ( is_wp_error( $term_info ) ) { 2848 return $term_info; 2849 } 2850 2851 $tt_id = $term_info['term_taxonomy_id']; 2852 $tt_ids[] = $tt_id; 2853 2854 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 ) ) ) { 2855 continue; 2856 } 2857 2858 /** 2859 * Fires immediately before an object-term relationship is added. 2860 * 2861 * @since 2.9.0 2862 * @since 4.7.0 Added the `$taxonomy` parameter. 2863 * 2864 * @param int $object_id Object ID. 2865 * @param int $tt_id Term taxonomy ID. 2866 * @param string $taxonomy Taxonomy slug. 2867 */ 2868 do_action( 'add_term_relationship', $object_id, $tt_id, $taxonomy ); 2869 2870 $wpdb->insert( 2871 $wpdb->term_relationships, 2872 array( 2873 'object_id' => $object_id, 2874 'term_taxonomy_id' => $tt_id, 2875 ) 2876 ); 2877 2878 /** 2879 * Fires immediately after an object-term relationship is added. 2880 * 2881 * @since 2.9.0 2882 * @since 4.7.0 Added the `$taxonomy` parameter. 2883 * 2884 * @param int $object_id Object ID. 2885 * @param int $tt_id Term taxonomy ID. 2886 * @param string $taxonomy Taxonomy slug. 2887 */ 2888 do_action( 'added_term_relationship', $object_id, $tt_id, $taxonomy ); 2889 2890 $new_tt_ids[] = $tt_id; 2891 } 2892 2893 if ( $new_tt_ids ) { 2894 wp_update_term_count( $new_tt_ids, $taxonomy ); 2895 } 2896 2897 if ( ! $append ) { 2898 $delete_tt_ids = array_diff( $old_tt_ids, $tt_ids ); 2899 2900 if ( $delete_tt_ids ) { 2901 $in_delete_tt_ids = "'" . implode( "', '", $delete_tt_ids ) . "'"; 2902 $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 ) ); 2903 $delete_term_ids = array_map( 'intval', $delete_term_ids ); 2904 2905 $remove = wp_remove_object_terms( $object_id, $delete_term_ids, $taxonomy ); 2906 if ( is_wp_error( $remove ) ) { 2907 return $remove; 2908 } 2909 } 2910 } 2911 2912 $t = get_taxonomy( $taxonomy ); 2913 2914 if ( ! $append && isset( $t->sort ) && $t->sort ) { 2915 $values = array(); 2916 $term_order = 0; 2917 2918 $final_tt_ids = wp_get_object_terms( 2919 $object_id, 2920 $taxonomy, 2921 array( 2922 'fields' => 'tt_ids', 2923 'update_term_meta_cache' => false, 2924 ) 2925 ); 2926 2927 foreach ( $tt_ids as $tt_id ) { 2928 if ( in_array( (int) $tt_id, $final_tt_ids, true ) ) { 2929 $values[] = $wpdb->prepare( '(%d, %d, %d)', $object_id, $tt_id, ++$term_order ); 2930 } 2931 } 2932 2933 if ( $values ) { 2934 if ( false === $wpdb->query( "INSERT INTO $wpdb->term_relationships (object_id, term_taxonomy_id, term_order) VALUES " . implode( ',', $values ) . ' ON DUPLICATE KEY UPDATE term_order = VALUES(term_order)' ) ) { 2935 return new WP_Error( 'db_insert_error', __( 'Could not insert term relationship into the database.' ), $wpdb->last_error ); 2936 } 2937 } 2938 } 2939 2940 wp_cache_delete( $object_id, $taxonomy . '_relationships' ); 2941 wp_cache_set_terms_last_changed(); 2942 2943 /** 2944 * Fires after an object's terms have been set. 2945 * 2946 * @since 2.8.0 2947 * 2948 * @param int $object_id Object ID. 2949 * @param array $terms An array of object term IDs or slugs. 2950 * @param array $tt_ids An array of term taxonomy IDs. 2951 * @param string $taxonomy Taxonomy slug. 2952 * @param bool $append Whether to append new terms to the old terms. 2953 * @param array $old_tt_ids Old array of term taxonomy IDs. 2954 */ 2955 do_action( 'set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids ); 2956 2957 return $tt_ids; 2958 } 2959 2960 /** 2961 * Adds term(s) associated with a given object. 2962 * 2963 * @since 3.6.0 2964 * 2965 * @param int $object_id The ID of the object to which the terms will be added. 2966 * @param string|int|array $terms The slug(s) or ID(s) of the term(s) to add. 2967 * @param array|string $taxonomy Taxonomy name. 2968 * @return array|WP_Error Term taxonomy IDs of the affected terms. 2969 */ 2970 function wp_add_object_terms( $object_id, $terms, $taxonomy ) { 2971 return wp_set_object_terms( $object_id, $terms, $taxonomy, true ); 2972 } 2973 2974 /** 2975 * Removes term(s) associated with a given object. 2976 * 2977 * @since 3.6.0 2978 * 2979 * @global wpdb $wpdb WordPress database abstraction object. 2980 * 2981 * @param int $object_id The ID of the object from which the terms will be removed. 2982 * @param string|int|array $terms The slug(s) or ID(s) of the term(s) to remove. 2983 * @param string $taxonomy Taxonomy name. 2984 * @return bool|WP_Error True on success, false or WP_Error on failure. 2985 */ 2986 function wp_remove_object_terms( $object_id, $terms, $taxonomy ) { 2987 global $wpdb; 2988 2989 $object_id = (int) $object_id; 2990 2991 if ( ! taxonomy_exists( $taxonomy ) ) { 2992 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2993 } 2994 2995 if ( ! is_array( $terms ) ) { 2996 $terms = array( $terms ); 2997 } 2998 2999 $tt_ids = array(); 3000 3001 foreach ( (array) $terms as $term ) { 3002 if ( '' === trim( $term ) ) { 3003 continue; 3004 } 3005 3006 $term_info = term_exists( $term, $taxonomy ); 3007 if ( ! $term_info ) { 3008 // Skip if a non-existent term ID is passed. 3009 if ( is_int( $term ) ) { 3010 continue; 3011 } 3012 } 3013 3014 if ( is_wp_error( $term_info ) ) { 3015 return $term_info; 3016 } 3017 3018 $tt_ids[] = $term_info['term_taxonomy_id']; 3019 } 3020 3021 if ( $tt_ids ) { 3022 $in_tt_ids = "'" . implode( "', '", $tt_ids ) . "'"; 3023 3024 /** 3025 * Fires immediately before an object-term relationship is deleted. 3026 * 3027 * @since 2.9.0 3028 * @since 4.7.0 Added the `$taxonomy` parameter. 3029 * 3030 * @param int $object_id Object ID. 3031 * @param array $tt_ids An array of term taxonomy IDs. 3032 * @param string $taxonomy Taxonomy slug. 3033 */ 3034 do_action( 'delete_term_relationships', $object_id, $tt_ids, $taxonomy ); 3035 3036 $deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) ); 3037 3038 wp_cache_delete( $object_id, $taxonomy . '_relationships' ); 3039 wp_cache_set_terms_last_changed(); 3040 3041 /** 3042 * Fires immediately after an object-term relationship is deleted. 3043 * 3044 * @since 2.9.0 3045 * @since 4.7.0 Added the `$taxonomy` parameter. 3046 * 3047 * @param int $object_id Object ID. 3048 * @param array $tt_ids An array of term taxonomy IDs. 3049 * @param string $taxonomy Taxonomy slug. 3050 */ 3051 do_action( 'deleted_term_relationships', $object_id, $tt_ids, $taxonomy ); 3052 3053 wp_update_term_count( $tt_ids, $taxonomy ); 3054 3055 return (bool) $deleted; 3056 } 3057 3058 return false; 3059 } 3060 3061 /** 3062 * Makes term slug unique, if it isn't already. 3063 * 3064 * The `$slug` has to be unique global to every taxonomy, meaning that one 3065 * taxonomy term can't have a matching slug with another taxonomy term. Each 3066 * slug has to be globally unique for every taxonomy. 3067 * 3068 * The way this works is that if the taxonomy that the term belongs to is 3069 * hierarchical and has a parent, it will append that parent to the $slug. 3070 * 3071 * If that still doesn't return a unique slug, then it tries to append a number 3072 * until it finds a number that is truly unique. 3073 * 3074 * The only purpose for `$term` is for appending a parent, if one exists. 3075 * 3076 * @since 2.3.0 3077 * 3078 * @global wpdb $wpdb WordPress database abstraction object. 3079 * 3080 * @param string $slug The string that will be tried for a unique slug. 3081 * @param object $term The term object that the `$slug` will belong to. 3082 * @return string Will return a true unique slug. 3083 */ 3084 function wp_unique_term_slug( $slug, $term ) { 3085 global $wpdb; 3086 3087 $needs_suffix = true; 3088 $original_slug = $slug; 3089 3090 // As of 4.1, duplicate slugs are allowed as long as they're in different taxonomies. 3091 if ( ! term_exists( $slug ) || get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) { 3092 $needs_suffix = false; 3093 } 3094 3095 /* 3096 * If the taxonomy supports hierarchy and the term has a parent, make the slug unique 3097 * by incorporating parent slugs. 3098 */ 3099 $parent_suffix = ''; 3100 if ( $needs_suffix && is_taxonomy_hierarchical( $term->taxonomy ) && ! empty( $term->parent ) ) { 3101 $the_parent = $term->parent; 3102 while ( ! empty( $the_parent ) ) { 3103 $parent_term = get_term( $the_parent, $term->taxonomy ); 3104 if ( is_wp_error( $parent_term ) || empty( $parent_term ) ) { 3105 break; 3106 } 3107 $parent_suffix .= '-' . $parent_term->slug; 3108 if ( ! term_exists( $slug . $parent_suffix ) ) { 3109 break; 3110 } 3111 3112 if ( empty( $parent_term->parent ) ) { 3113 break; 3114 } 3115 $the_parent = $parent_term->parent; 3116 } 3117 } 3118 3119 // If we didn't get a unique slug, try appending a number to make it unique. 3120 3121 /** 3122 * Filters whether the proposed unique term slug is bad. 3123 * 3124 * @since 4.3.0 3125 * 3126 * @param bool $needs_suffix Whether the slug needs to be made unique with a suffix. 3127 * @param string $slug The slug. 3128 * @param object $term Term object. 3129 */ 3130 if ( apply_filters( 'wp_unique_term_slug_is_bad_slug', $needs_suffix, $slug, $term ) ) { 3131 if ( $parent_suffix ) { 3132 $slug .= $parent_suffix; 3133 } 3134 3135 if ( ! empty( $term->term_id ) ) { 3136 $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id ); 3137 } else { 3138 $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug ); 3139 } 3140 3141 if ( $wpdb->get_var( $query ) ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared 3142 $num = 2; 3143 do { 3144 $alt_slug = $slug . "-$num"; 3145 ++$num; 3146 $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) ); 3147 } while ( $slug_check ); 3148 $slug = $alt_slug; 3149 } 3150 } 3151 3152 /** 3153 * Filters the unique term slug. 3154 * 3155 * @since 4.3.0 3156 * 3157 * @param string $slug Unique term slug. 3158 * @param object $term Term object. 3159 * @param string $original_slug Slug originally passed to the function for testing. 3160 */ 3161 return apply_filters( 'wp_unique_term_slug', $slug, $term, $original_slug ); 3162 } 3163 3164 /** 3165 * Updates term based on arguments provided. 3166 * 3167 * The `$args` will indiscriminately override all values with the same field name. 3168 * Care must be taken to not override important information need to update or 3169 * update will fail (or perhaps create a new term, neither would be acceptable). 3170 * 3171 * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not 3172 * defined in `$args` already. 3173 * 3174 * 'alias_of' will create a term group, if it doesn't already exist, and 3175 * update it for the `$term`. 3176 * 3177 * If the 'slug' argument in `$args` is missing, then the 'name' will be used. 3178 * If you set 'slug' and it isn't unique, then a WP_Error is returned. 3179 * If you don't pass any slug, then a unique one will be created. 3180 * 3181 * @since 2.3.0 3182 * 3183 * @global wpdb $wpdb WordPress database abstraction object. 3184 * 3185 * @param int $term_id The ID of the term. 3186 * @param string $taxonomy The taxonomy of the term. 3187 * @param array $args { 3188 * Optional. Array of arguments for updating a term. 3189 * 3190 * @type string $alias_of Slug of the term to make this term an alias of. 3191 * Default empty string. Accepts a term slug. 3192 * @type string $description The term description. Default empty string. 3193 * @type int $parent The id of the parent term. Default 0. 3194 * @type string $slug The term slug to use. Default empty string. 3195 * } 3196 * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`, 3197 * WP_Error otherwise. 3198 */ 3199 function wp_update_term( $term_id, $taxonomy, $args = array() ) { 3200 global $wpdb; 3201 3202 if ( ! taxonomy_exists( $taxonomy ) ) { 3203 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 3204 } 3205 3206 $term_id = (int) $term_id; 3207 3208 // First, get all of the original args. 3209 $term = get_term( $term_id, $taxonomy ); 3210 3211 if ( is_wp_error( $term ) ) { 3212 return $term; 3213 } 3214 3215 if ( ! $term ) { 3216 return new WP_Error( 'invalid_term', __( 'Empty Term.' ) ); 3217 } 3218 3219 $term = (array) $term->data; 3220 3221 // Escape data pulled from DB. 3222 $term = wp_slash( $term ); 3223 3224 // Merge old and new args with new args overwriting old ones. 3225 $args = array_merge( $term, $args ); 3226 3227 $defaults = array( 3228 'alias_of' => '', 3229 'description' => '', 3230 'parent' => 0, 3231 'slug' => '', 3232 ); 3233 $args = wp_parse_args( $args, $defaults ); 3234 $args = sanitize_term( $args, $taxonomy, 'db' ); 3235 $parsed_args = $args; 3236 3237 // expected_slashed ($name) 3238 $name = wp_unslash( $args['name'] ); 3239 $description = wp_unslash( $args['description'] ); 3240 3241 $parsed_args['name'] = $name; 3242 $parsed_args['description'] = $description; 3243 3244 if ( '' === trim( $name ) ) { 3245 return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) ); 3246 } 3247 3248 if ( (int) $parsed_args['parent'] > 0 && ! term_exists( (int) $parsed_args['parent'] ) ) { 3249 return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) ); 3250 } 3251 3252 $empty_slug = false; 3253 if ( empty( $args['slug'] ) ) { 3254 $empty_slug = true; 3255 $slug = sanitize_title( $name ); 3256 } else { 3257 $slug = $args['slug']; 3258 } 3259 3260 $parsed_args['slug'] = $slug; 3261 3262 $term_group = isset( $parsed_args['term_group'] ) ? $parsed_args['term_group'] : 0; 3263 if ( $args['alias_of'] ) { 3264 $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy ); 3265 if ( ! empty( $alias->term_group ) ) { 3266 // The alias we want is already in a group, so let's use that one. 3267 $term_group = $alias->term_group; 3268 } elseif ( ! empty( $alias->term_id ) ) { 3269 /* 3270 * The alias is not in a group, so we create a new one 3271 * and add the alias to it. 3272 */ 3273 $term_group = $wpdb->get_var( "SELECT MAX(term_group) FROM $wpdb->terms" ) + 1; 3274 3275 wp_update_term( 3276 $alias->term_id, 3277 $taxonomy, 3278 array( 3279 'term_group' => $term_group, 3280 ) 3281 ); 3282 } 3283 3284 $parsed_args['term_group'] = $term_group; 3285 } 3286 3287 /** 3288 * Filters the term parent. 3289 * 3290 * Hook to this filter to see if it will cause a hierarchy loop. 3291 * 3292 * @since 3.1.0 3293 * 3294 * @param int $parent_term ID of the parent term. 3295 * @param int $term_id Term ID. 3296 * @param string $taxonomy Taxonomy slug. 3297 * @param array $parsed_args An array of potentially altered update arguments for the given term. 3298 * @param array $args Arguments passed to wp_update_term(). 3299 */ 3300 $parent = (int) apply_filters( 'wp_update_term_parent', $args['parent'], $term_id, $taxonomy, $parsed_args, $args ); 3301 3302 // Check for duplicate slug. 3303 $duplicate = get_term_by( 'slug', $slug, $taxonomy ); 3304 if ( $duplicate && $duplicate->term_id !== $term_id ) { 3305 /* 3306 * If an empty slug was passed or the parent changed, reset the slug to something unique. 3307 * Otherwise, bail. 3308 */ 3309 if ( $empty_slug || ( $parent !== (int) $term['parent'] ) ) { 3310 $slug = wp_unique_term_slug( $slug, (object) $args ); 3311 } else { 3312 /* translators: %s: Taxonomy term slug. */ 3313 return new WP_Error( 'duplicate_term_slug', sprintf( __( 'The slug “%s” is already in use by another term.' ), $slug ) ); 3314 } 3315 } 3316 3317 $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 ) ); 3318 3319 // Check whether this is a shared term that needs splitting. 3320 $_term_id = _split_shared_term( $term_id, $tt_id ); 3321 if ( ! is_wp_error( $_term_id ) ) { 3322 $term_id = $_term_id; 3323 } 3324 3325 /** 3326 * Fires immediately before the given terms are edited. 3327 * 3328 * @since 2.9.0 3329 * @since 6.1.0 The `$args` parameter was added. 3330 * 3331 * @param int $term_id Term ID. 3332 * @param string $taxonomy Taxonomy slug. 3333 * @param array $args Arguments passed to wp_update_term(). 3334 */ 3335 do_action( 'edit_terms', $term_id, $taxonomy, $args ); 3336 3337 $data = compact( 'name', 'slug', 'term_group' ); 3338 3339 /** 3340 * Filters term data before it is updated in the database. 3341 * 3342 * @since 4.7.0 3343 * 3344 * @param array $data Term data to be updated. 3345 * @param int $term_id Term ID. 3346 * @param string $taxonomy Taxonomy slug. 3347 * @param array $args Arguments passed to wp_update_term(). 3348 */ 3349 $data = apply_filters( 'wp_update_term_data', $data, $term_id, $taxonomy, $args ); 3350 3351 $wpdb->update( $wpdb->terms, $data, compact( 'term_id' ) ); 3352 3353 if ( empty( $slug ) ) { 3354 $slug = sanitize_title( $name, $term_id ); 3355 $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) ); 3356 } 3357 3358 /** 3359 * Fires immediately after a term is updated in the database, but before its 3360 * term-taxonomy relationship is updated. 3361 * 3362 * @since 2.9.0 3363 * @since 6.1.0 The `$args` parameter was added. 3364 * 3365 * @param int $term_id Term ID. 3366 * @param string $taxonomy Taxonomy slug. 3367 * @param array $args Arguments passed to wp_update_term(). 3368 */ 3369 do_action( 'edited_terms', $term_id, $taxonomy, $args ); 3370 3371 /** 3372 * Fires immediate before a term-taxonomy relationship is updated. 3373 * 3374 * @since 2.9.0 3375 * @since 6.1.0 The `$args` parameter was added. 3376 * 3377 * @param int $tt_id Term taxonomy ID. 3378 * @param string $taxonomy Taxonomy slug. 3379 * @param array $args Arguments passed to wp_update_term(). 3380 */ 3381 do_action( 'edit_term_taxonomy', $tt_id, $taxonomy, $args ); 3382 3383 $wpdb->update( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ), array( 'term_taxonomy_id' => $tt_id ) ); 3384 3385 /** 3386 * Fires immediately after a term-taxonomy relationship is updated. 3387 * 3388 * @since 2.9.0 3389 * @since 6.1.0 The `$args` parameter was added. 3390 * 3391 * @param int $tt_id Term taxonomy ID. 3392 * @param string $taxonomy Taxonomy slug. 3393 * @param array $args Arguments passed to wp_update_term(). 3394 */ 3395 do_action( 'edited_term_taxonomy', $tt_id, $taxonomy, $args ); 3396 3397 /** 3398 * Fires after a term has been updated, but before the term cache has been cleaned. 3399 * 3400 * The {@see 'edit_$taxonomy'} hook is also available for targeting a specific 3401 * taxonomy. 3402 * 3403 * @since 2.3.0 3404 * @since 6.1.0 The `$args` parameter was added. 3405 * 3406 * @param int $term_id Term ID. 3407 * @param int $tt_id Term taxonomy ID. 3408 * @param string $taxonomy Taxonomy slug. 3409 * @param array $args Arguments passed to wp_update_term(). 3410 */ 3411 do_action( 'edit_term', $term_id, $tt_id, $taxonomy, $args ); 3412 3413 /** 3414 * Fires after a term in a specific taxonomy has been updated, but before the term 3415 * cache has been cleaned. 3416 * 3417 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 3418 * 3419 * Possible hook names include: 3420 * 3421 * - `edit_category` 3422 * - `edit_post_tag` 3423 * 3424 * @since 2.3.0 3425 * @since 6.1.0 The `$args` parameter was added. 3426 * 3427 * @param int $term_id Term ID. 3428 * @param int $tt_id Term taxonomy ID. 3429 * @param array $args Arguments passed to wp_update_term(). 3430 */ 3431 do_action( "edit_{$taxonomy}", $term_id, $tt_id, $args ); 3432 3433 /** This filter is documented in wp-includes/taxonomy.php */ 3434 $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id ); 3435 3436 clean_term_cache( $term_id, $taxonomy ); 3437 3438 /** 3439 * Fires after a term has been updated, and the term cache has been cleaned. 3440 * 3441 * The {@see 'edited_$taxonomy'} hook is also available for targeting a specific 3442 * taxonomy. 3443 * 3444 * @since 2.3.0 3445 * @since 6.1.0 The `$args` parameter was added. 3446 * 3447 * @param int $term_id Term ID. 3448 * @param int $tt_id Term taxonomy ID. 3449 * @param string $taxonomy Taxonomy slug. 3450 * @param array $args Arguments passed to wp_update_term(). 3451 */ 3452 do_action( 'edited_term', $term_id, $tt_id, $taxonomy, $args ); 3453 3454 /** 3455 * Fires after a term for a specific taxonomy has been updated, and the term 3456 * cache has been cleaned. 3457 * 3458 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 3459 * 3460 * Possible hook names include: 3461 * 3462 * - `edited_category` 3463 * - `edited_post_tag` 3464 * 3465 * @since 2.3.0 3466 * @since 6.1.0 The `$args` parameter was added. 3467 * 3468 * @param int $term_id Term ID. 3469 * @param int $tt_id Term taxonomy ID. 3470 * @param array $args Arguments passed to wp_update_term(). 3471 */ 3472 do_action( "edited_{$taxonomy}", $term_id, $tt_id, $args ); 3473 3474 /** This action is documented in wp-includes/taxonomy.php */ 3475 do_action( 'saved_term', $term_id, $tt_id, $taxonomy, true, $args ); 3476 3477 /** This action is documented in wp-includes/taxonomy.php */ 3478 do_action( "saved_{$taxonomy}", $term_id, $tt_id, true, $args ); 3479 3480 return array( 3481 'term_id' => $term_id, 3482 'term_taxonomy_id' => $tt_id, 3483 ); 3484 } 3485 3486 /** 3487 * Enables or disables term counting. 3488 * 3489 * @since 2.5.0 3490 * 3491 * @param bool $defer Optional. Enable if true, disable if false. 3492 * @return bool Whether term counting is enabled or disabled. 3493 */ 3494 function wp_defer_term_counting( $defer = null ) { 3495 static $_defer = false; 3496 3497 if ( is_bool( $defer ) ) { 3498 $_defer = $defer; 3499 // Flush any deferred counts. 3500 if ( ! $defer ) { 3501 wp_update_term_count( null, null, true ); 3502 } 3503 } 3504 3505 return $_defer; 3506 } 3507 3508 /** 3509 * Updates the amount of terms in taxonomy. 3510 * 3511 * If there is a taxonomy callback applied, then it will be called for updating 3512 * the count. 3513 * 3514 * The default action is to count what the amount of terms have the relationship 3515 * of term ID. Once that is done, then update the database. 3516 * 3517 * @since 2.3.0 3518 * 3519 * @param int|array $terms The term_taxonomy_id of the terms. 3520 * @param string $taxonomy The context of the term. 3521 * @param bool $do_deferred Whether to flush the deferred term counts too. Default false. 3522 * @return bool If no terms will return false, and if successful will return true. 3523 */ 3524 function wp_update_term_count( $terms, $taxonomy, $do_deferred = false ) { 3525 static $_deferred = array(); 3526 3527 if ( $do_deferred ) { 3528 foreach ( (array) array_keys( $_deferred ) as $tax ) { 3529 wp_update_term_count_now( $_deferred[ $tax ], $tax ); 3530 unset( $_deferred[ $tax ] ); 3531 } 3532 } 3533 3534 if ( empty( $terms ) ) { 3535 return false; 3536 } 3537 3538 if ( ! is_array( $terms ) ) { 3539 $terms = array( $terms ); 3540 } 3541 3542 if ( wp_defer_term_counting() ) { 3543 if ( ! isset( $_deferred[ $taxonomy ] ) ) { 3544 $_deferred[ $taxonomy ] = array(); 3545 } 3546 $_deferred[ $taxonomy ] = array_unique( array_merge( $_deferred[ $taxonomy ], $terms ) ); 3547 return true; 3548 } 3549 3550 return wp_update_term_count_now( $terms, $taxonomy ); 3551 } 3552 3553 /** 3554 * Performs term count update immediately. 3555 * 3556 * @since 2.5.0 3557 * 3558 * @param array $terms The term_taxonomy_id of terms to update. 3559 * @param string $taxonomy The context of the term. 3560 * @return true Always true when complete. 3561 */ 3562 function wp_update_term_count_now( $terms, $taxonomy ) { 3563 $terms = array_map( 'intval', $terms ); 3564 3565 $taxonomy = get_taxonomy( $taxonomy ); 3566 if ( ! empty( $taxonomy->update_count_callback ) ) { 3567 call_user_func( $taxonomy->update_count_callback, $terms, $taxonomy ); 3568 } else { 3569 $object_types = (array) $taxonomy->object_type; 3570 foreach ( $object_types as &$object_type ) { 3571 if ( str_starts_with( $object_type, 'attachment:' ) ) { 3572 list( $object_type ) = explode( ':', $object_type ); 3573 } 3574 } 3575 3576 if ( array_filter( $object_types, 'post_type_exists' ) == $object_types ) { 3577 // Only post types are attached to this taxonomy. 3578 _update_post_term_count( $terms, $taxonomy ); 3579 } else { 3580 // Default count updater. 3581 _update_generic_term_count( $terms, $taxonomy ); 3582 } 3583 } 3584 3585 clean_term_cache( $terms, '', false ); 3586 3587 return true; 3588 } 3589 3590 // 3591 // Cache. 3592 // 3593 3594 /** 3595 * Removes the taxonomy relationship to terms from the cache. 3596 * 3597 * Will remove the entire taxonomy relationship containing term `$object_id`. The 3598 * term IDs have to exist within the taxonomy `$object_type` for the deletion to 3599 * take place. 3600 * 3601 * @since 2.3.0 3602 * 3603 * @global bool $_wp_suspend_cache_invalidation 3604 * 3605 * @see get_object_taxonomies() for more on $object_type. 3606 * 3607 * @param int|array $object_ids Single or list of term object ID(s). 3608 * @param array|string $object_type The taxonomy object type. 3609 */ 3610 function clean_object_term_cache( $object_ids, $object_type ) { 3611 global $_wp_suspend_cache_invalidation; 3612 3613 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 3614 return; 3615 } 3616 3617 if ( ! is_array( $object_ids ) ) { 3618 $object_ids = array( $object_ids ); 3619 } 3620 3621 $taxonomies = get_object_taxonomies( $object_type ); 3622 3623 foreach ( $taxonomies as $taxonomy ) { 3624 wp_cache_delete_multiple( $object_ids, "{$taxonomy}_relationships" ); 3625 } 3626 3627 wp_cache_set_terms_last_changed(); 3628 3629 /** 3630 * Fires after the object term cache has been cleaned. 3631 * 3632 * @since 2.5.0 3633 * 3634 * @param array $object_ids An array of object IDs. 3635 * @param string $object_type Object type. 3636 */ 3637 do_action( 'clean_object_term_cache', $object_ids, $object_type ); 3638 } 3639 3640 /** 3641 * Removes all of the term IDs from the cache. 3642 * 3643 * @since 2.3.0 3644 * 3645 * @global wpdb $wpdb WordPress database abstraction object. 3646 * @global bool $_wp_suspend_cache_invalidation 3647 * 3648 * @param int|int[] $ids Single or array of term IDs. 3649 * @param string $taxonomy Optional. Taxonomy slug. Can be empty, in which case the taxonomies of the passed 3650 * term IDs will be used. Default empty. 3651 * @param bool $clean_taxonomy Optional. Whether to clean taxonomy wide caches (true), or just individual 3652 * term object caches (false). Default true. 3653 */ 3654 function clean_term_cache( $ids, $taxonomy = '', $clean_taxonomy = true ) { 3655 global $wpdb, $_wp_suspend_cache_invalidation; 3656 3657 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 3658 return; 3659 } 3660 3661 if ( ! is_array( $ids ) ) { 3662 $ids = array( $ids ); 3663 } 3664 3665 $taxonomies = array(); 3666 // If no taxonomy, assume tt_ids. 3667 if ( empty( $taxonomy ) ) { 3668 $tt_ids = array_map( 'intval', $ids ); 3669 $tt_ids = implode( ', ', $tt_ids ); 3670 $terms = $wpdb->get_results( "SELECT term_id, taxonomy FROM $wpdb->term_taxonomy WHERE term_taxonomy_id IN ($tt_ids)" ); 3671 $ids = array(); 3672 3673 foreach ( (array) $terms as $term ) { 3674 $taxonomies[] = $term->taxonomy; 3675 $ids[] = $term->term_id; 3676 } 3677 wp_cache_delete_multiple( $ids, 'terms' ); 3678 $taxonomies = array_unique( $taxonomies ); 3679 } else { 3680 wp_cache_delete_multiple( $ids, 'terms' ); 3681 $taxonomies = array( $taxonomy ); 3682 } 3683 3684 foreach ( $taxonomies as $taxonomy ) { 3685 if ( $clean_taxonomy ) { 3686 clean_taxonomy_cache( $taxonomy ); 3687 } 3688 3689 /** 3690 * Fires once after each taxonomy's term cache has been cleaned. 3691 * 3692 * @since 2.5.0 3693 * @since 4.5.0 Added the `$clean_taxonomy` parameter. 3694 * 3695 * @param array $ids An array of term IDs. 3696 * @param string $taxonomy Taxonomy slug. 3697 * @param bool $clean_taxonomy Whether or not to clean taxonomy-wide caches 3698 */ 3699 do_action( 'clean_term_cache', $ids, $taxonomy, $clean_taxonomy ); 3700 } 3701 3702 wp_cache_set_terms_last_changed(); 3703 } 3704 3705 /** 3706 * Cleans the caches for a taxonomy. 3707 * 3708 * @since 4.9.0 3709 * 3710 * @param string $taxonomy Taxonomy slug. 3711 */ 3712 function clean_taxonomy_cache( $taxonomy ) { 3713 wp_cache_delete( 'all_ids', $taxonomy ); 3714 wp_cache_delete( 'get', $taxonomy ); 3715 wp_cache_set_terms_last_changed(); 3716 3717 // Regenerate cached hierarchy. 3718 delete_option( "{$taxonomy}_children" ); 3719 _get_term_hierarchy( $taxonomy ); 3720 3721 /** 3722 * Fires after a taxonomy's caches have been cleaned. 3723 * 3724 * @since 4.9.0 3725 * 3726 * @param string $taxonomy Taxonomy slug. 3727 */ 3728 do_action( 'clean_taxonomy_cache', $taxonomy ); 3729 } 3730 3731 /** 3732 * Retrieves the cached term objects for the given object ID. 3733 * 3734 * Upstream functions (like get_the_terms() and is_object_in_term()) are 3735 * responsible for populating the object-term relationship cache. The current 3736 * function only fetches relationship data that is already in the cache. 3737 * 3738 * @since 2.3.0 3739 * @since 4.7.0 Returns a `WP_Error` object if there's an error with 3740 * any of the matched terms. 3741 * 3742 * @param int $id Term object ID, for example a post, comment, or user ID. 3743 * @param string $taxonomy Taxonomy name. 3744 * @return bool|WP_Term[]|WP_Error Array of `WP_Term` objects, if cached. 3745 * False if cache is empty for `$taxonomy` and `$id`. 3746 * WP_Error if get_term() returns an error object for any term. 3747 */ 3748 function get_object_term_cache( $id, $taxonomy ) { 3749 $_term_ids = wp_cache_get( $id, "{$taxonomy}_relationships" ); 3750 3751 // We leave the priming of relationship caches to upstream functions. 3752 if ( false === $_term_ids ) { 3753 return false; 3754 } 3755 3756 // Backward compatibility for if a plugin is putting objects into the cache, rather than IDs. 3757 $term_ids = array(); 3758 foreach ( $_term_ids as $term_id ) { 3759 if ( is_numeric( $term_id ) ) { 3760 $term_ids[] = (int) $term_id; 3761 } elseif ( isset( $term_id->term_id ) ) { 3762 $term_ids[] = (int) $term_id->term_id; 3763 } 3764 } 3765 3766 // Fill the term objects. 3767 _prime_term_caches( $term_ids ); 3768 3769 $terms = array(); 3770 foreach ( $term_ids as $term_id ) { 3771 $term = get_term( $term_id, $taxonomy ); 3772 if ( is_wp_error( $term ) ) { 3773 return $term; 3774 } 3775 3776 $terms[] = $term; 3777 } 3778 3779 return $terms; 3780 } 3781 3782 /** 3783 * Updates the cache for the given term object ID(s). 3784 * 3785 * Note: Due to performance concerns, great care should be taken to only update 3786 * term caches when necessary. Processing time can increase exponentially depending 3787 * on both the number of passed term IDs and the number of taxonomies those terms 3788 * belong to. 3789 * 3790 * Caches will only be updated for terms not already cached. 3791 * 3792 * @since 2.3.0 3793 * 3794 * @param string|int[] $object_ids Comma-separated list or array of term object IDs. 3795 * @param string|string[] $object_type The taxonomy object type or array of the same. 3796 * @return void|false Void on success or if the `$object_ids` parameter is empty, 3797 * false if all of the terms in `$object_ids` are already cached. 3798 */ 3799 function update_object_term_cache( $object_ids, $object_type ) { 3800 if ( empty( $object_ids ) ) { 3801 return; 3802 } 3803 3804 if ( ! is_array( $object_ids ) ) { 3805 $object_ids = explode( ',', $object_ids ); 3806 } 3807 3808 $object_ids = array_map( 'intval', $object_ids ); 3809 $non_cached_ids = array(); 3810 3811 $taxonomies = get_object_taxonomies( $object_type ); 3812 3813 foreach ( $taxonomies as $taxonomy ) { 3814 $cache_values = wp_cache_get_multiple( (array) $object_ids, "{$taxonomy}_relationships" ); 3815 3816 foreach ( $cache_values as $id => $value ) { 3817 if ( false === $value ) { 3818 $non_cached_ids[] = $id; 3819 } 3820 } 3821 } 3822 3823 if ( empty( $non_cached_ids ) ) { 3824 return false; 3825 } 3826 3827 $non_cached_ids = array_unique( $non_cached_ids ); 3828 3829 $terms = wp_get_object_terms( 3830 $non_cached_ids, 3831 $taxonomies, 3832 array( 3833 'fields' => 'all_with_object_id', 3834 'orderby' => 'name', 3835 'update_term_meta_cache' => false, 3836 ) 3837 ); 3838 3839 $object_terms = array(); 3840 foreach ( (array) $terms as $term ) { 3841 $object_terms[ $term->object_id ][ $term->taxonomy ][] = $term->term_id; 3842 } 3843 3844 foreach ( $non_cached_ids as $id ) { 3845 foreach ( $taxonomies as $taxonomy ) { 3846 if ( ! isset( $object_terms[ $id ][ $taxonomy ] ) ) { 3847 if ( ! isset( $object_terms[ $id ] ) ) { 3848 $object_terms[ $id ] = array(); 3849 } 3850 $object_terms[ $id ][ $taxonomy ] = array(); 3851 } 3852 } 3853 } 3854 3855 $cache_values = array(); 3856 foreach ( $object_terms as $id => $value ) { 3857 foreach ( $value as $taxonomy => $terms ) { 3858 $cache_values[ $taxonomy ][ $id ] = $terms; 3859 } 3860 } 3861 foreach ( $cache_values as $taxonomy => $data ) { 3862 wp_cache_add_multiple( $data, "{$taxonomy}_relationships" ); 3863 } 3864 } 3865 3866 /** 3867 * Updates terms in cache. 3868 * 3869 * @since 2.3.0 3870 * 3871 * @param WP_Term[] $terms Array of term objects to change. 3872 * @param string $taxonomy Not used. 3873 */ 3874 function update_term_cache( $terms, $taxonomy = '' ) { 3875 $data = array(); 3876 foreach ( (array) $terms as $term ) { 3877 // Create a copy in case the array was passed by reference. 3878 $_term = clone $term; 3879 3880 // Object ID should not be cached. 3881 unset( $_term->object_id ); 3882 3883 $data[ $term->term_id ] = $_term; 3884 } 3885 wp_cache_add_multiple( $data, 'terms' ); 3886 } 3887 3888 // 3889 // Private. 3890 // 3891 3892 /** 3893 * Retrieves children of taxonomy as term IDs. 3894 * 3895 * @access private 3896 * @since 2.3.0 3897 * 3898 * @param string $taxonomy Taxonomy name. 3899 * @return array Empty if $taxonomy isn't hierarchical or returns children as term IDs. 3900 */ 3901 function _get_term_hierarchy( $taxonomy ) { 3902 if ( ! is_taxonomy_hierarchical( $taxonomy ) ) { 3903 return array(); 3904 } 3905 $children = get_option( "{$taxonomy}_children" ); 3906 3907 if ( is_array( $children ) ) { 3908 return $children; 3909 } 3910 $children = array(); 3911 $terms = get_terms( 3912 array( 3913 'taxonomy' => $taxonomy, 3914 'get' => 'all', 3915 'orderby' => 'id', 3916 'fields' => 'id=>parent', 3917 'update_term_meta_cache' => false, 3918 ) 3919 ); 3920 foreach ( $terms as $term_id => $parent ) { 3921 if ( $parent > 0 ) { 3922 $children[ $parent ][] = $term_id; 3923 } 3924 } 3925 update_option( "{$taxonomy}_children", $children ); 3926 3927 return $children; 3928 } 3929 3930 /** 3931 * Gets the subset of $terms that are descendants of $term_id. 3932 * 3933 * If `$terms` is an array of objects, then _get_term_children() returns an array of objects. 3934 * If `$terms` is an array of IDs, then _get_term_children() returns an array of IDs. 3935 * 3936 * @access private 3937 * @since 2.3.0 3938 * 3939 * @param int $term_id The ancestor term: all returned terms should be descendants of `$term_id`. 3940 * @param array $terms The set of terms - either an array of term objects or term IDs - from which those that 3941 * are descendants of $term_id will be chosen. 3942 * @param string $taxonomy The taxonomy which determines the hierarchy of the terms. 3943 * @param array $ancestors Optional. Term ancestors that have already been identified. Passed by reference, to keep 3944 * track of found terms when recursing the hierarchy. The array of located ancestors is used 3945 * to prevent infinite recursion loops. For performance, `term_ids` are used as array keys, 3946 * with 1 as value. Default empty array. 3947 * @return array|WP_Error The subset of $terms that are descendants of $term_id. 3948 */ 3949 function _get_term_children( $term_id, $terms, $taxonomy, &$ancestors = array() ) { 3950 $empty_array = array(); 3951 if ( empty( $terms ) ) { 3952 return $empty_array; 3953 } 3954 3955 $term_id = (int) $term_id; 3956 $term_list = array(); 3957 $has_children = _get_term_hierarchy( $taxonomy ); 3958 3959 if ( $term_id && ! isset( $has_children[ $term_id ] ) ) { 3960 return $empty_array; 3961 } 3962 3963 // Include the term itself in the ancestors array, so we can properly detect when a loop has occurred. 3964 if ( empty( $ancestors ) ) { 3965 $ancestors[ $term_id ] = 1; 3966 } 3967 3968 foreach ( (array) $terms as $term ) { 3969 $use_id = false; 3970 if ( ! is_object( $term ) ) { 3971 $term = get_term( $term, $taxonomy ); 3972 if ( is_wp_error( $term ) ) { 3973 return $term; 3974 } 3975 $use_id = true; 3976 } 3977 3978 // Don't recurse if we've already identified the term as a child - this indicates a loop. 3979 if ( isset( $ancestors[ $term->term_id ] ) ) { 3980 continue; 3981 } 3982 3983 if ( (int) $term->parent === $term_id ) { 3984 if ( $use_id ) { 3985 $term_list[] = $term->term_id; 3986 } else { 3987 $term_list[] = $term; 3988 } 3989 3990 if ( ! isset( $has_children[ $term->term_id ] ) ) { 3991 continue; 3992 } 3993 3994 $ancestors[ $term->term_id ] = 1; 3995 3996 $children = _get_term_children( $term->term_id, $terms, $taxonomy, $ancestors ); 3997 if ( $children ) { 3998 $term_list = array_merge( $term_list, $children ); 3999 } 4000 } 4001 } 4002 4003 return $term_list; 4004 } 4005 4006 /** 4007 * Adds count of children to parent count. 4008 * 4009 * Recalculates term counts by including items from child terms. Assumes all 4010 * relevant children are already in the $terms argument. 4011 * 4012 * @access private 4013 * @since 2.3.0 4014 * 4015 * @global wpdb $wpdb WordPress database abstraction object. 4016 * 4017 * @param object[]|WP_Term[] $terms List of term objects (passed by reference). 4018 * @param string $taxonomy Term context. 4019 */ 4020 function _pad_term_counts( &$terms, $taxonomy ) { 4021 global $wpdb; 4022 4023 // This function only works for hierarchical taxonomies like post categories. 4024 if ( ! is_taxonomy_hierarchical( $taxonomy ) ) { 4025 return; 4026 } 4027 4028 $term_hier = _get_term_hierarchy( $taxonomy ); 4029 4030 if ( empty( $term_hier ) ) { 4031 return; 4032 } 4033 4034 $term_items = array(); 4035 $terms_by_id = array(); 4036 $term_ids = array(); 4037 4038 foreach ( (array) $terms as $key => $term ) { 4039 $terms_by_id[ $term->term_id ] = & $terms[ $key ]; 4040 $term_ids[ $term->term_taxonomy_id ] = $term->term_id; 4041 } 4042 4043 // Get the object and term IDs and stick them in a lookup table. 4044 $tax_obj = get_taxonomy( $taxonomy ); 4045 $object_types = esc_sql( $tax_obj->object_type ); 4046 $results = $wpdb->get_results( "SELECT object_id, term_taxonomy_id FROM $wpdb->term_relationships INNER JOIN $wpdb->posts ON object_id = ID WHERE term_taxonomy_id IN (" . implode( ',', array_keys( $term_ids ) ) . ") AND post_type IN ('" . implode( "', '", $object_types ) . "') AND post_status = 'publish'" ); 4047 4048 foreach ( $results as $row ) { 4049 $id = $term_ids[ $row->term_taxonomy_id ]; 4050 4051 $term_items[ $id ][ $row->object_id ] = isset( $term_items[ $id ][ $row->object_id ] ) ? ++$term_items[ $id ][ $row->object_id ] : 1; 4052 } 4053 4054 // Touch every ancestor's lookup row for each post in each term. 4055 foreach ( $term_ids as $term_id ) { 4056 $child = $term_id; 4057 $ancestors = array(); 4058 while ( ! empty( $terms_by_id[ $child ] ) && $parent = $terms_by_id[ $child ]->parent ) { 4059 $ancestors[] = $child; 4060 4061 if ( ! empty( $term_items[ $term_id ] ) ) { 4062 foreach ( $term_items[ $term_id ] as $item_id => $touches ) { 4063 $term_items[ $parent ][ $item_id ] = isset( $term_items[ $parent ][ $item_id ] ) ? ++$term_items[ $parent ][ $item_id ] : 1; 4064 } 4065 } 4066 4067 $child = $parent; 4068 4069 if ( in_array( $parent, $ancestors, true ) ) { 4070 break; 4071 } 4072 } 4073 } 4074 4075 // Transfer the touched cells. 4076 foreach ( (array) $term_items as $id => $items ) { 4077 if ( isset( $terms_by_id[ $id ] ) ) { 4078 $terms_by_id[ $id ]->count = count( $items ); 4079 } 4080 } 4081 } 4082 4083 /** 4084 * Adds any terms from the given IDs to the cache that do not already exist in cache. 4085 * 4086 * @since 4.6.0 4087 * @since 6.1.0 This function is no longer marked as "private". 4088 * @since 6.3.0 Use wp_lazyload_term_meta() for lazy-loading of term meta. 4089 * 4090 * @global wpdb $wpdb WordPress database abstraction object. 4091 * 4092 * @param array $term_ids Array of term IDs. 4093 * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true. 4094 */ 4095 function _prime_term_caches( $term_ids, $update_meta_cache = true ) { 4096 global $wpdb; 4097 4098 $non_cached_ids = _get_non_cached_ids( $term_ids, 'terms' ); 4099 if ( ! empty( $non_cached_ids ) ) { 4100 $fresh_terms = $wpdb->get_results( sprintf( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); 4101 4102 update_term_cache( $fresh_terms ); 4103 } 4104 4105 if ( $update_meta_cache ) { 4106 wp_lazyload_term_meta( $term_ids ); 4107 } 4108 } 4109 4110 // 4111 // Default callbacks. 4112 // 4113 4114 /** 4115 * Updates term count based on object types of the current taxonomy. 4116 * 4117 * Private function for the default callback for post_tag and category 4118 * taxonomies. 4119 * 4120 * @access private 4121 * @since 2.3.0 4122 * 4123 * @global wpdb $wpdb WordPress database abstraction object. 4124 * 4125 * @param int[] $terms List of term taxonomy IDs. 4126 * @param WP_Taxonomy $taxonomy Current taxonomy object of terms. 4127 */ 4128 function _update_post_term_count( $terms, $taxonomy ) { 4129 global $wpdb; 4130 4131 $object_types = (array) $taxonomy->object_type; 4132 4133 foreach ( $object_types as &$object_type ) { 4134 list( $object_type ) = explode( ':', $object_type ); 4135 } 4136 4137 $object_types = array_unique( $object_types ); 4138 4139 $check_attachments = array_search( 'attachment', $object_types, true ); 4140 if ( false !== $check_attachments ) { 4141 unset( $object_types[ $check_attachments ] ); 4142 $check_attachments = true; 4143 } 4144 4145 if ( $object_types ) { 4146 $object_types = esc_sql( array_filter( $object_types, 'post_type_exists' ) ); 4147 } 4148 4149 $post_statuses = array( 'publish' ); 4150 4151 /** 4152 * Filters the post statuses for updating the term count. 4153 * 4154 * @since 5.7.0 4155 * 4156 * @param string[] $post_statuses List of post statuses to include in the count. Default is 'publish'. 4157 * @param WP_Taxonomy $taxonomy Current taxonomy object. 4158 */ 4159 $post_statuses = esc_sql( apply_filters( 'update_post_term_count_statuses', $post_statuses, $taxonomy ) ); 4160 4161 foreach ( (array) $terms as $term ) { 4162 $count = 0; 4163 4164 // Attachments can be 'inherit' status, we need to base count off the parent's status if so. 4165 if ( $check_attachments ) { 4166 // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration 4167 $count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts p1 WHERE p1.ID = $wpdb->term_relationships.object_id AND ( post_status IN ('" . implode( "', '", $post_statuses ) . "') OR ( post_status = 'inherit' AND post_parent > 0 AND ( SELECT post_status FROM $wpdb->posts WHERE ID = p1.post_parent ) IN ('" . implode( "', '", $post_statuses ) . "') ) ) AND post_type = 'attachment' AND term_taxonomy_id = %d", $term ) ); 4168 } 4169 4170 if ( $object_types ) { 4171 // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration 4172 $count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts WHERE $wpdb->posts.ID = $wpdb->term_relationships.object_id AND post_status IN ('" . implode( "', '", $post_statuses ) . "') AND post_type IN ('" . implode( "', '", $object_types ) . "') AND term_taxonomy_id = %d", $term ) ); 4173 } 4174 4175 /** This action is documented in wp-includes/taxonomy.php */ 4176 do_action( 'edit_term_taxonomy', $term, $taxonomy->name ); 4177 $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) ); 4178 4179 /** This action is documented in wp-includes/taxonomy.php */ 4180 do_action( 'edited_term_taxonomy', $term, $taxonomy->name ); 4181 } 4182 } 4183 4184 /** 4185 * Updates term count based on number of objects. 4186 * 4187 * Default callback for the 'link_category' taxonomy. 4188 * 4189 * @since 3.3.0 4190 * 4191 * @global wpdb $wpdb WordPress database abstraction object. 4192 * 4193 * @param int[] $terms List of term taxonomy IDs. 4194 * @param WP_Taxonomy $taxonomy Current taxonomy object of terms. 4195 */ 4196 function _update_generic_term_count( $terms, $taxonomy ) { 4197 global $wpdb; 4198 4199 foreach ( (array) $terms as $term ) { 4200 $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term ) ); 4201 4202 /** This action is documented in wp-includes/taxonomy.php */ 4203 do_action( 'edit_term_taxonomy', $term, $taxonomy->name ); 4204 $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) ); 4205 4206 /** This action is documented in wp-includes/taxonomy.php */ 4207 do_action( 'edited_term_taxonomy', $term, $taxonomy->name ); 4208 } 4209 } 4210 4211 /** 4212 * Creates a new term for a term_taxonomy item that currently shares its term 4213 * with another term_taxonomy. 4214 * 4215 * @ignore 4216 * @since 4.2.0 4217 * @since 4.3.0 Introduced `$record` parameter. Also, `$term_id` and 4218 * `$term_taxonomy_id` can now accept objects. 4219 * 4220 * @global wpdb $wpdb WordPress database abstraction object. 4221 * 4222 * @param int|object $term_id ID of the shared term, or the shared term object. 4223 * @param int|object $term_taxonomy_id ID of the term_taxonomy item to receive a new term, or the term_taxonomy object 4224 * (corresponding to a row from the term_taxonomy table). 4225 * @param bool $record Whether to record data about the split term in the options table. The recording 4226 * process has the potential to be resource-intensive, so during batch operations 4227 * it can be beneficial to skip inline recording and do it just once, after the 4228 * batch is processed. Only set this to `false` if you know what you are doing. 4229 * Default: true. 4230 * @return int|WP_Error When the current term does not need to be split (or cannot be split on the current 4231 * database schema), `$term_id` is returned. When the term is successfully split, the 4232 * new term_id is returned. A WP_Error is returned for miscellaneous errors. 4233 */ 4234 function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) { 4235 global $wpdb; 4236 4237 if ( is_object( $term_id ) ) { 4238 $shared_term = $term_id; 4239 $term_id = (int) $shared_term->term_id; 4240 } 4241 4242 if ( is_object( $term_taxonomy_id ) ) { 4243 $term_taxonomy = $term_taxonomy_id; 4244 $term_taxonomy_id = (int) $term_taxonomy->term_taxonomy_id; 4245 } 4246 4247 // If there are no shared term_taxonomy rows, there's nothing to do here. 4248 $shared_tt_count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy tt WHERE tt.term_id = %d AND tt.term_taxonomy_id != %d", $term_id, $term_taxonomy_id ) ); 4249 4250 if ( ! $shared_tt_count ) { 4251 return $term_id; 4252 } 4253 4254 /* 4255 * Verify that the term_taxonomy_id passed to the function is actually associated with the term_id. 4256 * If there's a mismatch, it may mean that the term is already split. Return the actual term_id from the db. 4257 */ 4258 $check_term_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) ); 4259 if ( $check_term_id !== $term_id ) { 4260 return $check_term_id; 4261 } 4262 4263 // Pull up data about the currently shared slug, which we'll use to populate the new one. 4264 if ( empty( $shared_term ) ) { 4265 $shared_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.* FROM $wpdb->terms t WHERE t.term_id = %d", $term_id ) ); 4266 } 4267 4268 $new_term_data = array( 4269 'name' => $shared_term->name, 4270 'slug' => $shared_term->slug, 4271 'term_group' => $shared_term->term_group, 4272 ); 4273 4274 if ( false === $wpdb->insert( $wpdb->terms, $new_term_data ) ) { 4275 return new WP_Error( 'db_insert_error', __( 'Could not split shared term.' ), $wpdb->last_error ); 4276 } 4277 4278 $new_term_id = (int) $wpdb->insert_id; 4279 4280 // Update the existing term_taxonomy to point to the newly created term. 4281 $wpdb->update( 4282 $wpdb->term_taxonomy, 4283 array( 'term_id' => $new_term_id ), 4284 array( 'term_taxonomy_id' => $term_taxonomy_id ) 4285 ); 4286 4287 // Reassign child terms to the new parent. 4288 if ( empty( $term_taxonomy ) ) { 4289 $term_taxonomy = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) ); 4290 } 4291 4292 $children_tt_ids = $wpdb->get_col( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_taxonomy WHERE parent = %d AND taxonomy = %s", $term_id, $term_taxonomy->taxonomy ) ); 4293 if ( ! empty( $children_tt_ids ) ) { 4294 foreach ( $children_tt_ids as $child_tt_id ) { 4295 $wpdb->update( 4296 $wpdb->term_taxonomy, 4297 array( 'parent' => $new_term_id ), 4298 array( 'term_taxonomy_id' => $child_tt_id ) 4299 ); 4300 clean_term_cache( (int) $child_tt_id, '', false ); 4301 } 4302 } else { 4303 // If the term has no children, we must force its taxonomy cache to be rebuilt separately. 4304 clean_term_cache( $new_term_id, $term_taxonomy->taxonomy, false ); 4305 } 4306 4307 clean_term_cache( $term_id, $term_taxonomy->taxonomy, false ); 4308 4309 /* 4310 * Taxonomy cache clearing is delayed to avoid race conditions that may occur when 4311 * regenerating the taxonomy's hierarchy tree. 4312 */ 4313 $taxonomies_to_clean = array( $term_taxonomy->taxonomy ); 4314 4315 // Clean the cache for term taxonomies formerly shared with the current term. 4316 $shared_term_taxonomies = $wpdb->get_col( $wpdb->prepare( "SELECT taxonomy FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) ); 4317 $taxonomies_to_clean = array_merge( $taxonomies_to_clean, $shared_term_taxonomies ); 4318 4319 foreach ( $taxonomies_to_clean as $taxonomy_to_clean ) { 4320 clean_taxonomy_cache( $taxonomy_to_clean ); 4321 } 4322 4323 // Keep a record of term_ids that have been split, keyed by old term_id. See wp_get_split_term(). 4324 if ( $record ) { 4325 $split_term_data = get_option( '_split_terms', array() ); 4326 if ( ! isset( $split_term_data[ $term_id ] ) ) { 4327 $split_term_data[ $term_id ] = array(); 4328 } 4329 4330 $split_term_data[ $term_id ][ $term_taxonomy->taxonomy ] = $new_term_id; 4331 update_option( '_split_terms', $split_term_data ); 4332 } 4333 4334 // If we've just split the final shared term, set the "finished" flag. 4335 $shared_terms_exist = $wpdb->get_results( 4336 "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt 4337 LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id 4338 GROUP BY t.term_id 4339 HAVING term_tt_count > 1 4340 LIMIT 1" 4341 ); 4342 if ( ! $shared_terms_exist ) { 4343 update_option( 'finished_splitting_shared_terms', true ); 4344 } 4345 4346 /** 4347 * Fires after a previously shared taxonomy term is split into two separate terms. 4348 * 4349 * @since 4.2.0 4350 * 4351 * @param int $term_id ID of the formerly shared term. 4352 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4353 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4354 * @param string $taxonomy Taxonomy for the split term. 4355 */ 4356 do_action( 'split_shared_term', $term_id, $new_term_id, $term_taxonomy_id, $term_taxonomy->taxonomy ); 4357 4358 return $new_term_id; 4359 } 4360 4361 /** 4362 * Splits a batch of shared taxonomy terms. 4363 * 4364 * @since 4.3.0 4365 * 4366 * @global wpdb $wpdb WordPress database abstraction object. 4367 */ 4368 function _wp_batch_split_terms() { 4369 global $wpdb; 4370 4371 $lock_name = 'term_split.lock'; 4372 4373 // Try to lock. 4374 $lock_result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'off') /* LOCK */", $lock_name, time() ) ); 4375 4376 if ( ! $lock_result ) { 4377 $lock_result = get_option( $lock_name ); 4378 4379 // Bail if we were unable to create a lock, or if the existing lock is still valid. 4380 if ( ! $lock_result || ( $lock_result > ( time() - HOUR_IN_SECONDS ) ) ) { 4381 wp_schedule_single_event( time() + ( 5 * MINUTE_IN_SECONDS ), 'wp_split_shared_term_batch' ); 4382 return; 4383 } 4384 } 4385 4386 // Update the lock, as by this point we've definitely got a lock, just need to fire the actions. 4387 update_option( $lock_name, time() ); 4388 4389 // Get a list of shared terms (those with more than one associated row in term_taxonomy). 4390 $shared_terms = $wpdb->get_results( 4391 "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt 4392 LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id 4393 GROUP BY t.term_id 4394 HAVING term_tt_count > 1 4395 LIMIT 10" 4396 ); 4397 4398 // No more terms, we're done here. 4399 if ( ! $shared_terms ) { 4400 update_option( 'finished_splitting_shared_terms', true ); 4401 delete_option( $lock_name ); 4402 return; 4403 } 4404 4405 // Shared terms found? We'll need to run this script again. 4406 wp_schedule_single_event( time() + ( 2 * MINUTE_IN_SECONDS ), 'wp_split_shared_term_batch' ); 4407 4408 // Rekey shared term array for faster lookups. 4409 $_shared_terms = array(); 4410 foreach ( $shared_terms as $shared_term ) { 4411 $term_id = (int) $shared_term->term_id; 4412 $_shared_terms[ $term_id ] = $shared_term; 4413 } 4414 $shared_terms = $_shared_terms; 4415 4416 // Get term taxonomy data for all shared terms. 4417 $shared_term_ids = implode( ',', array_keys( $shared_terms ) ); 4418 $shared_tts = $wpdb->get_results( "SELECT * FROM {$wpdb->term_taxonomy} WHERE `term_id` IN ({$shared_term_ids})" ); 4419 4420 // Split term data recording is slow, so we do it just once, outside the loop. 4421 $split_term_data = get_option( '_split_terms', array() ); 4422 $skipped_first_term = array(); 4423 $taxonomies = array(); 4424 foreach ( $shared_tts as $shared_tt ) { 4425 $term_id = (int) $shared_tt->term_id; 4426 4427 // Don't split the first tt belonging to a given term_id. 4428 if ( ! isset( $skipped_first_term[ $term_id ] ) ) { 4429 $skipped_first_term[ $term_id ] = 1; 4430 continue; 4431 } 4432 4433 if ( ! isset( $split_term_data[ $term_id ] ) ) { 4434 $split_term_data[ $term_id ] = array(); 4435 } 4436 4437 // Keep track of taxonomies whose hierarchies need flushing. 4438 if ( ! isset( $taxonomies[ $shared_tt->taxonomy ] ) ) { 4439 $taxonomies[ $shared_tt->taxonomy ] = 1; 4440 } 4441 4442 // Split the term. 4443 $split_term_data[ $term_id ][ $shared_tt->taxonomy ] = _split_shared_term( $shared_terms[ $term_id ], $shared_tt, false ); 4444 } 4445 4446 // Rebuild the cached hierarchy for each affected taxonomy. 4447 foreach ( array_keys( $taxonomies ) as $tax ) { 4448 delete_option( "{$tax}_children" ); 4449 _get_term_hierarchy( $tax ); 4450 } 4451 4452 update_option( '_split_terms', $split_term_data ); 4453 4454 delete_option( $lock_name ); 4455 } 4456 4457 /** 4458 * In order to avoid the _wp_batch_split_terms() job being accidentally removed, 4459 * checks that it's still scheduled while we haven't finished splitting terms. 4460 * 4461 * @ignore 4462 * @since 4.3.0 4463 */ 4464 function _wp_check_for_scheduled_split_terms() { 4465 if ( ! get_option( 'finished_splitting_shared_terms' ) && ! wp_next_scheduled( 'wp_split_shared_term_batch' ) ) { 4466 wp_schedule_single_event( time() + MINUTE_IN_SECONDS, 'wp_split_shared_term_batch' ); 4467 } 4468 } 4469 4470 /** 4471 * Checks default categories when a term gets split to see if any of them need to be updated. 4472 * 4473 * @ignore 4474 * @since 4.2.0 4475 * 4476 * @param int $term_id ID of the formerly shared term. 4477 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4478 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4479 * @param string $taxonomy Taxonomy for the split term. 4480 */ 4481 function _wp_check_split_default_terms( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { 4482 if ( 'category' !== $taxonomy ) { 4483 return; 4484 } 4485 4486 foreach ( array( 'default_category', 'default_link_category', 'default_email_category' ) as $option ) { 4487 if ( (int) get_option( $option, -1 ) === $term_id ) { 4488 update_option( $option, $new_term_id ); 4489 } 4490 } 4491 } 4492 4493 /** 4494 * Checks menu items when a term gets split to see if any of them need to be updated. 4495 * 4496 * @ignore 4497 * @since 4.2.0 4498 * 4499 * @global wpdb $wpdb WordPress database abstraction object. 4500 * 4501 * @param int $term_id ID of the formerly shared term. 4502 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4503 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4504 * @param string $taxonomy Taxonomy for the split term. 4505 */ 4506 function _wp_check_split_terms_in_menus( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { 4507 global $wpdb; 4508 $post_ids = $wpdb->get_col( 4509 $wpdb->prepare( 4510 "SELECT m1.post_id 4511 FROM {$wpdb->postmeta} AS m1 4512 INNER JOIN {$wpdb->postmeta} AS m2 ON ( m2.post_id = m1.post_id ) 4513 INNER JOIN {$wpdb->postmeta} AS m3 ON ( m3.post_id = m1.post_id ) 4514 WHERE ( m1.meta_key = '_menu_item_type' AND m1.meta_value = 'taxonomy' ) 4515 AND ( m2.meta_key = '_menu_item_object' AND m2.meta_value = %s ) 4516 AND ( m3.meta_key = '_menu_item_object_id' AND m3.meta_value = %d )", 4517 $taxonomy, 4518 $term_id 4519 ) 4520 ); 4521 4522 if ( $post_ids ) { 4523 foreach ( $post_ids as $post_id ) { 4524 update_post_meta( $post_id, '_menu_item_object_id', $new_term_id, $term_id ); 4525 } 4526 } 4527 } 4528 4529 /** 4530 * If the term being split is a nav_menu, changes associations. 4531 * 4532 * @ignore 4533 * @since 4.3.0 4534 * 4535 * @param int $term_id ID of the formerly shared term. 4536 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4537 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4538 * @param string $taxonomy Taxonomy for the split term. 4539 */ 4540 function _wp_check_split_nav_menu_terms( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { 4541 if ( 'nav_menu' !== $taxonomy ) { 4542 return; 4543 } 4544 4545 // Update menu locations. 4546 $locations = get_nav_menu_locations(); 4547 foreach ( $locations as $location => $menu_id ) { 4548 if ( $term_id === $menu_id ) { 4549 $locations[ $location ] = $new_term_id; 4550 } 4551 } 4552 set_theme_mod( 'nav_menu_locations', $locations ); 4553 } 4554 4555 /** 4556 * Gets data about terms that previously shared a single term_id, but have since been split. 4557 * 4558 * @since 4.2.0 4559 * 4560 * @param int $old_term_id Term ID. This is the old, pre-split term ID. 4561 * @return array Array of new term IDs, keyed by taxonomy. 4562 */ 4563 function wp_get_split_terms( $old_term_id ) { 4564 $split_terms = get_option( '_split_terms', array() ); 4565 4566 $terms = array(); 4567 if ( isset( $split_terms[ $old_term_id ] ) ) { 4568 $terms = $split_terms[ $old_term_id ]; 4569 } 4570 4571 return $terms; 4572 } 4573 4574 /** 4575 * Gets the new term ID corresponding to a previously split term. 4576 * 4577 * @since 4.2.0 4578 * 4579 * @param int $old_term_id Term ID. This is the old, pre-split term ID. 4580 * @param string $taxonomy Taxonomy that the term belongs to. 4581 * @return int|false If a previously split term is found corresponding to the old term_id and taxonomy, 4582 * the new term_id will be returned. If no previously split term is found matching 4583 * the parameters, returns false. 4584 */ 4585 function wp_get_split_term( $old_term_id, $taxonomy ) { 4586 $split_terms = wp_get_split_terms( $old_term_id ); 4587 4588 $term_id = false; 4589 if ( isset( $split_terms[ $taxonomy ] ) ) { 4590 $term_id = (int) $split_terms[ $taxonomy ]; 4591 } 4592 4593 return $term_id; 4594 } 4595 4596 /** 4597 * Determines whether a term is shared between multiple taxonomies. 4598 * 4599 * Shared taxonomy terms began to be split in 4.3, but failed cron tasks or 4600 * other delays in upgrade routines may cause shared terms to remain. 4601 * 4602 * @since 4.4.0 4603 * 4604 * @global wpdb $wpdb WordPress database abstraction object. 4605 * 4606 * @param int $term_id Term ID. 4607 * @return bool Returns false if a term is not shared between multiple taxonomies or 4608 * if splitting shared taxonomy terms is finished. 4609 */ 4610 function wp_term_is_shared( $term_id ) { 4611 global $wpdb; 4612 4613 if ( get_option( 'finished_splitting_shared_terms' ) ) { 4614 return false; 4615 } 4616 4617 $tt_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) ); 4618 4619 return $tt_count > 1; 4620 } 4621 4622 /** 4623 * Generates a permalink for a taxonomy term archive. 4624 * 4625 * @since 2.5.0 4626 * 4627 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 4628 * 4629 * @param WP_Term|int|string $term The term object, ID, or slug whose link will be retrieved. 4630 * @param string $taxonomy Optional. Taxonomy. Default empty. 4631 * @return string|WP_Error URL of the taxonomy term archive on success, WP_Error if term does not exist. 4632 */ 4633 function get_term_link( $term, $taxonomy = '' ) { 4634 global $wp_rewrite; 4635 4636 if ( ! is_object( $term ) ) { 4637 if ( is_int( $term ) ) { 4638 $term = get_term( $term, $taxonomy ); 4639 } else { 4640 $term = get_term_by( 'slug', $term, $taxonomy ); 4641 } 4642 } 4643 4644 if ( ! is_object( $term ) ) { 4645 $term = new WP_Error( 'invalid_term', __( 'Empty Term.' ) ); 4646 } 4647 4648 if ( is_wp_error( $term ) ) { 4649 return $term; 4650 } 4651 4652 $taxonomy = $term->taxonomy; 4653 4654 $termlink = $wp_rewrite->get_extra_permastruct( $taxonomy ); 4655 4656 /** 4657 * Filters the permalink structure for a term before token replacement occurs. 4658 * 4659 * @since 4.9.0 4660 * 4661 * @param string $termlink The permalink structure for the term's taxonomy. 4662 * @param WP_Term $term The term object. 4663 */ 4664 $termlink = apply_filters( 'pre_term_link', $termlink, $term ); 4665 4666 $slug = $term->slug; 4667 $t = get_taxonomy( $taxonomy ); 4668 4669 if ( empty( $termlink ) ) { 4670 if ( 'category' === $taxonomy ) { 4671 $termlink = '?cat=' . $term->term_id; 4672 } elseif ( $t->query_var ) { 4673 $termlink = "?$t->query_var=$slug"; 4674 } else { 4675 $termlink = "?taxonomy=$taxonomy&term=$slug"; 4676 } 4677 $termlink = home_url( $termlink ); 4678 } else { 4679 if ( ! empty( $t->rewrite['hierarchical'] ) ) { 4680 $hierarchical_slugs = array(); 4681 $ancestors = get_ancestors( $term->term_id, $taxonomy, 'taxonomy' ); 4682 foreach ( (array) $ancestors as $ancestor ) { 4683 $ancestor_term = get_term( $ancestor, $taxonomy ); 4684 $hierarchical_slugs[] = $ancestor_term->slug; 4685 } 4686 $hierarchical_slugs = array_reverse( $hierarchical_slugs ); 4687 $hierarchical_slugs[] = $slug; 4688 $termlink = str_replace( "%$taxonomy%", implode( '/', $hierarchical_slugs ), $termlink ); 4689 } else { 4690 $termlink = str_replace( "%$taxonomy%", $slug, $termlink ); 4691 } 4692 $termlink = home_url( user_trailingslashit( $termlink, 'category' ) ); 4693 } 4694 4695 // Back compat filters. 4696 if ( 'post_tag' === $taxonomy ) { 4697 4698 /** 4699 * Filters the tag link. 4700 * 4701 * @since 2.3.0 4702 * @since 2.5.0 Deprecated in favor of {@see 'term_link'} filter. 4703 * @since 5.4.1 Restored (un-deprecated). 4704 * 4705 * @param string $termlink Tag link URL. 4706 * @param int $term_id Term ID. 4707 */ 4708 $termlink = apply_filters( 'tag_link', $termlink, $term->term_id ); 4709 } elseif ( 'category' === $taxonomy ) { 4710 4711 /** 4712 * Filters the category link. 4713 * 4714 * @since 1.5.0 4715 * @since 2.5.0 Deprecated in favor of {@see 'term_link'} filter. 4716 * @since 5.4.1 Restored (un-deprecated). 4717 * 4718 * @param string $termlink Category link URL. 4719 * @param int $term_id Term ID. 4720 */ 4721 $termlink = apply_filters( 'category_link', $termlink, $term->term_id ); 4722 } 4723 4724 /** 4725 * Filters the term link. 4726 * 4727 * @since 2.5.0 4728 * 4729 * @param string $termlink Term link URL. 4730 * @param WP_Term $term Term object. 4731 * @param string $taxonomy Taxonomy slug. 4732 */ 4733 return apply_filters( 'term_link', $termlink, $term, $taxonomy ); 4734 } 4735 4736 /** 4737 * Displays the taxonomies of a post with available options. 4738 * 4739 * This function can be used within the loop to display the taxonomies for a 4740 * post without specifying the Post ID. You can also use it outside the Loop to 4741 * display the taxonomies for a specific post. 4742 * 4743 * @since 2.5.0 4744 * 4745 * @param array $args { 4746 * Arguments about which post to use and how to format the output. Shares all of the arguments 4747 * supported by get_the_taxonomies(), in addition to the following. 4748 * 4749 * @type int|WP_Post $post Post ID or object to get taxonomies of. Default current post. 4750 * @type string $before Displays before the taxonomies. Default empty string. 4751 * @type string $sep Separates each taxonomy. Default is a space. 4752 * @type string $after Displays after the taxonomies. Default empty string. 4753 * } 4754 */ 4755 function the_taxonomies( $args = array() ) { 4756 $defaults = array( 4757 'post' => 0, 4758 'before' => '', 4759 'sep' => ' ', 4760 'after' => '', 4761 ); 4762 4763 $parsed_args = wp_parse_args( $args, $defaults ); 4764 4765 echo $parsed_args['before'] . implode( $parsed_args['sep'], get_the_taxonomies( $parsed_args['post'], $parsed_args ) ) . $parsed_args['after']; 4766 } 4767 4768 /** 4769 * Retrieves all taxonomies associated with a post. 4770 * 4771 * This function can be used within the loop. It will also return an array of 4772 * the taxonomies with links to the taxonomy and name. 4773 * 4774 * @since 2.5.0 4775 * 4776 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 4777 * @param array $args { 4778 * Optional. Arguments about how to format the list of taxonomies. Default empty array. 4779 * 4780 * @type string $template Template for displaying a taxonomy label and list of terms. 4781 * Default is "Label: Terms." 4782 * @type string $term_template Template for displaying a single term in the list. Default is the term name 4783 * linked to its archive. 4784 * } 4785 * @return string[] List of taxonomies. 4786 */ 4787 function get_the_taxonomies( $post = 0, $args = array() ) { 4788 $post = get_post( $post ); 4789 4790 $args = wp_parse_args( 4791 $args, 4792 array( 4793 /* translators: %s: Taxonomy label, %l: List of terms formatted as per $term_template. */ 4794 'template' => __( '%s: %l.' ), 4795 'term_template' => '<a href="%1$s">%2$s</a>', 4796 ) 4797 ); 4798 4799 $taxonomies = array(); 4800 4801 if ( ! $post ) { 4802 return $taxonomies; 4803 } 4804 4805 foreach ( get_object_taxonomies( $post ) as $taxonomy ) { 4806 $t = (array) get_taxonomy( $taxonomy ); 4807 if ( empty( $t['label'] ) ) { 4808 $t['label'] = $taxonomy; 4809 } 4810 if ( empty( $t['args'] ) ) { 4811 $t['args'] = array(); 4812 } 4813 if ( empty( $t['template'] ) ) { 4814 $t['template'] = $args['template']; 4815 } 4816 if ( empty( $t['term_template'] ) ) { 4817 $t['term_template'] = $args['term_template']; 4818 } 4819 4820 $terms = get_object_term_cache( $post->ID, $taxonomy ); 4821 if ( false === $terms ) { 4822 $terms = wp_get_object_terms( $post->ID, $taxonomy, $t['args'] ); 4823 } 4824 $links = array(); 4825 4826 foreach ( $terms as $term ) { 4827 $links[] = wp_sprintf( $t['term_template'], esc_attr( get_term_link( $term ) ), $term->name ); 4828 } 4829 if ( $links ) { 4830 $taxonomies[ $taxonomy ] = wp_sprintf( $t['template'], $t['label'], $links, $terms ); 4831 } 4832 } 4833 return $taxonomies; 4834 } 4835 4836 /** 4837 * Retrieves all taxonomy names for the given post. 4838 * 4839 * @since 2.5.0 4840 * 4841 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 4842 * @return string[] An array of all taxonomy names for the given post. 4843 */ 4844 function get_post_taxonomies( $post = 0 ) { 4845 $post = get_post( $post ); 4846 4847 return get_object_taxonomies( $post ); 4848 } 4849 4850 /** 4851 * Determines if the given object is associated with any of the given terms. 4852 * 4853 * The given terms are checked against the object's terms' term_ids, names and slugs. 4854 * Terms given as integers will only be checked against the object's terms' term_ids. 4855 * If no terms are given, determines if object is associated with any terms in the given taxonomy. 4856 * 4857 * @since 2.7.0 4858 * 4859 * @param int $object_id ID of the object (post ID, link ID, ...). 4860 * @param string $taxonomy Single taxonomy name. 4861 * @param int|string|int[]|string[] $terms Optional. Term ID, name, slug, or array of such 4862 * to check against. Default null. 4863 * @return bool|WP_Error WP_Error on input error. 4864 */ 4865 function is_object_in_term( $object_id, $taxonomy, $terms = null ) { 4866 $object_id = (int) $object_id; 4867 if ( ! $object_id ) { 4868 return new WP_Error( 'invalid_object', __( 'Invalid object ID.' ) ); 4869 } 4870 4871 $object_terms = get_object_term_cache( $object_id, $taxonomy ); 4872 if ( false === $object_terms ) { 4873 $object_terms = wp_get_object_terms( $object_id, $taxonomy, array( 'update_term_meta_cache' => false ) ); 4874 if ( is_wp_error( $object_terms ) ) { 4875 return $object_terms; 4876 } 4877 4878 wp_cache_set( $object_id, wp_list_pluck( $object_terms, 'term_id' ), "{$taxonomy}_relationships" ); 4879 } 4880 4881 if ( is_wp_error( $object_terms ) ) { 4882 return $object_terms; 4883 } 4884 if ( empty( $object_terms ) ) { 4885 return false; 4886 } 4887 if ( empty( $terms ) ) { 4888 return ( ! empty( $object_terms ) ); 4889 } 4890 4891 $terms = (array) $terms; 4892 4893 $ints = array_filter( $terms, 'is_int' ); 4894 if ( $ints ) { 4895 $strs = array_diff( $terms, $ints ); 4896 } else { 4897 $strs =& $terms; 4898 } 4899 4900 foreach ( $object_terms as $object_term ) { 4901 // If term is an int, check against term_ids only. 4902 if ( $ints && in_array( $object_term->term_id, $ints, true ) ) { 4903 return true; 4904 } 4905 4906 if ( $strs ) { 4907 // Only check numeric strings against term_id, to avoid false matches due to type juggling. 4908 $numeric_strs = array_map( 'intval', array_filter( $strs, 'is_numeric' ) ); 4909 if ( in_array( $object_term->term_id, $numeric_strs, true ) ) { 4910 return true; 4911 } 4912 4913 if ( in_array( $object_term->name, $strs, true ) ) { 4914 return true; 4915 } 4916 if ( in_array( $object_term->slug, $strs, true ) ) { 4917 return true; 4918 } 4919 } 4920 } 4921 4922 return false; 4923 } 4924 4925 /** 4926 * Determines if the given object type is associated with the given taxonomy. 4927 * 4928 * @since 3.0.0 4929 * 4930 * @param string $object_type Object type string. 4931 * @param string $taxonomy Single taxonomy name. 4932 * @return bool True if object is associated with the taxonomy, otherwise false. 4933 */ 4934 function is_object_in_taxonomy( $object_type, $taxonomy ) { 4935 $taxonomies = get_object_taxonomies( $object_type ); 4936 if ( empty( $taxonomies ) ) { 4937 return false; 4938 } 4939 return in_array( $taxonomy, $taxonomies, true ); 4940 } 4941 4942 /** 4943 * Gets an array of ancestor IDs for a given object. 4944 * 4945 * @since 3.1.0 4946 * @since 4.1.0 Introduced the `$resource_type` argument. 4947 * 4948 * @param int $object_id Optional. The ID of the object. Default 0. 4949 * @param string $object_type Optional. The type of object for which we'll be retrieving 4950 * ancestors. Accepts a post type or a taxonomy name. Default empty. 4951 * @param string $resource_type Optional. Type of resource $object_type is. Accepts 'post_type' 4952 * or 'taxonomy'. Default empty. 4953 * @return int[] An array of IDs of ancestors from lowest to highest in the hierarchy. 4954 */ 4955 function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) { 4956 $object_id = (int) $object_id; 4957 4958 $ancestors = array(); 4959 4960 if ( empty( $object_id ) ) { 4961 4962 /** This filter is documented in wp-includes/taxonomy.php */ 4963 return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type ); 4964 } 4965 4966 if ( ! $resource_type ) { 4967 if ( is_taxonomy_hierarchical( $object_type ) ) { 4968 $resource_type = 'taxonomy'; 4969 } elseif ( post_type_exists( $object_type ) ) { 4970 $resource_type = 'post_type'; 4971 } 4972 } 4973 4974 if ( 'taxonomy' === $resource_type ) { 4975 $term = get_term( $object_id, $object_type ); 4976 while ( ! is_wp_error( $term ) && ! empty( $term->parent ) && ! in_array( $term->parent, $ancestors, true ) ) { 4977 $ancestors[] = (int) $term->parent; 4978 $term = get_term( $term->parent, $object_type ); 4979 } 4980 } elseif ( 'post_type' === $resource_type ) { 4981 $ancestors = get_post_ancestors( $object_id ); 4982 } 4983 4984 /** 4985 * Filters a given object's ancestors. 4986 * 4987 * @since 3.1.0 4988 * @since 4.1.1 Introduced the `$resource_type` parameter. 4989 * 4990 * @param int[] $ancestors An array of IDs of object ancestors. 4991 * @param int $object_id Object ID. 4992 * @param string $object_type Type of object. 4993 * @param string $resource_type Type of resource $object_type is. 4994 */ 4995 return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type ); 4996 } 4997 4998 /** 4999 * Returns the term's parent's term ID. 5000 * 5001 * @since 3.1.0 5002 * 5003 * @param int $term_id Term ID. 5004 * @param string $taxonomy Taxonomy name. 5005 * @return int|false Parent term ID on success, false on failure. 5006 */ 5007 function wp_get_term_taxonomy_parent_id( $term_id, $taxonomy ) { 5008 $term = get_term( $term_id, $taxonomy ); 5009 if ( ! $term || is_wp_error( $term ) ) { 5010 return false; 5011 } 5012 return (int) $term->parent; 5013 } 5014 5015 /** 5016 * Checks the given subset of the term hierarchy for hierarchy loops. 5017 * Prevents loops from forming and breaks those that it finds. 5018 * 5019 * Attached to the {@see 'wp_update_term_parent'} filter. 5020 * 5021 * @since 3.1.0 5022 * 5023 * @param int $parent_term `term_id` of the parent for the term we're checking. 5024 * @param int $term_id The term we're checking. 5025 * @param string $taxonomy The taxonomy of the term we're checking. 5026 * @return int The new parent for the term. 5027 */ 5028 function wp_check_term_hierarchy_for_loops( $parent_term, $term_id, $taxonomy ) { 5029 // Nothing fancy here - bail. 5030 if ( ! $parent_term ) { 5031 return 0; 5032 } 5033 5034 // Can't be its own parent. 5035 if ( $parent_term === $term_id ) { 5036 return 0; 5037 } 5038 5039 // Now look for larger loops. 5040 $loop = wp_find_hierarchy_loop( 'wp_get_term_taxonomy_parent_id', $term_id, $parent_term, array( $taxonomy ) ); 5041 if ( ! $loop ) { 5042 return $parent_term; // No loop. 5043 } 5044 5045 // Setting $parent_term to the given value causes a loop. 5046 if ( isset( $loop[ $term_id ] ) ) { 5047 return 0; 5048 } 5049 5050 // There's a loop, but it doesn't contain $term_id. Break the loop. 5051 foreach ( array_keys( $loop ) as $loop_member ) { 5052 wp_update_term( $loop_member, $taxonomy, array( 'parent' => 0 ) ); 5053 } 5054 5055 return $parent_term; 5056 } 5057 5058 /** 5059 * Determines whether a taxonomy is considered "viewable". 5060 * 5061 * @since 5.1.0 5062 * 5063 * @param string|WP_Taxonomy $taxonomy Taxonomy name or object. 5064 * @return bool Whether the taxonomy should be considered viewable. 5065 */ 5066 function is_taxonomy_viewable( $taxonomy ) { 5067 if ( is_scalar( $taxonomy ) ) { 5068 $taxonomy = get_taxonomy( $taxonomy ); 5069 if ( ! $taxonomy ) { 5070 return false; 5071 } 5072 } 5073 5074 return $taxonomy->publicly_queryable; 5075 } 5076 5077 /** 5078 * Determines whether a term is publicly viewable. 5079 * 5080 * A term is considered publicly viewable if its taxonomy is viewable. 5081 * 5082 * @since 6.1.0 5083 * 5084 * @param int|WP_Term $term Term ID or term object. 5085 * @return bool Whether the term is publicly viewable. 5086 */ 5087 function is_term_publicly_viewable( $term ) { 5088 $term = get_term( $term ); 5089 5090 if ( ! $term ) { 5091 return false; 5092 } 5093 5094 return is_taxonomy_viewable( $term->taxonomy ); 5095 } 5096 5097 /** 5098 * Sets the last changed time for the 'terms' cache group. 5099 * 5100 * @since 5.0.0 5101 */ 5102 function wp_cache_set_terms_last_changed() { 5103 wp_cache_set_last_changed( 'terms' ); 5104 } 5105 5106 /** 5107 * Aborts calls to term meta if it is not supported. 5108 * 5109 * @since 5.0.0 5110 * 5111 * @param mixed $check Skip-value for whether to proceed term meta function execution. 5112 * @return mixed Original value of $check, or false if term meta is not supported. 5113 */ 5114 function wp_check_term_meta_support_prefilter( $check ) { 5115 if ( get_option( 'db_version' ) < 34370 ) { 5116 return false; 5117 } 5118 5119 return $check; 5120 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sun Dec 22 08:20:01 2024 | Cross-referenced by PHPXref |