| [ 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 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 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 Tag'/'Add 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 ); 900 $cache = wp_cache_get_salted( $cache_key, 'term-queries', $last_changed ); 901 if ( false === $cache ) { 902 $object_ids = $wpdb->get_col( $sql ); 903 wp_cache_set_salted( $cache_key, $object_ids, 'term-queries', $last_changed ); 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 * {@internal The `$deprecated` parameter is parsed for backward compatibility only.} 1296 * 1297 * @since 2.3.0 1298 * @since 4.2.0 Introduced 'name' and 'childless' parameters. 1299 * @since 4.4.0 Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter. 1300 * Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return 1301 * a list of WP_Term objects. 1302 * @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter. 1303 * Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata. 1304 * @since 4.8.0 Introduced 'suppress_filter' parameter. 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'] ) ) { 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 * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input. 1386 * 1387 * @since 4.4.0 1388 * 1389 * @param int $term_id Term ID. 1390 * @param string $meta_key Metadata name. 1391 * @param mixed $meta_value Metadata value. Arrays and objects are stored as serialized data and 1392 * will be returned as the same type when retrieved. Other data types will 1393 * be stored as strings in the database: 1394 * - false is stored and retrieved as an empty string ('') 1395 * - true is stored and retrieved as '1' 1396 * - numbers (both integer and float) are stored and retrieved as strings 1397 * Must be serializable if non-scalar. 1398 * @param bool $unique Optional. Whether the same key should not be added. 1399 * Default false. 1400 * @return int|false|WP_Error Meta ID on success, false on failure. 1401 * WP_Error when term_id is ambiguous between taxonomies. 1402 */ 1403 function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) { 1404 if ( wp_term_is_shared( $term_id ) ) { 1405 return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id ); 1406 } 1407 1408 return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique ); 1409 } 1410 1411 /** 1412 * Removes metadata matching criteria from a term. 1413 * 1414 * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input. 1415 * 1416 * @since 4.4.0 1417 * 1418 * @param int $term_id Term ID. 1419 * @param string $meta_key Metadata name. 1420 * @param mixed $meta_value Optional. Metadata value. If provided, 1421 * rows will only be removed that match the value. 1422 * Must be serializable if non-scalar. Default empty. 1423 * @return bool True on success, false on failure. 1424 */ 1425 function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) { 1426 return delete_metadata( 'term', $term_id, $meta_key, $meta_value ); 1427 } 1428 1429 /** 1430 * Retrieves metadata for a term. 1431 * 1432 * @since 4.4.0 1433 * 1434 * @param int $term_id Term ID. 1435 * @param string $key Optional. The meta key to retrieve. By default, 1436 * returns data for all keys. Default empty. 1437 * @param bool $single Optional. Whether to return a single value. 1438 * This parameter has no effect if `$key` is not specified. 1439 * Default false. 1440 * @return mixed An array of values if `$single` is false. 1441 * The value of the meta field if `$single` is true. 1442 * False for an invalid `$term_id` (non-numeric, zero, or negative value). 1443 * An empty array if a valid but non-existing term ID is passed and `$single` is false. 1444 * An empty string if a valid but non-existing term ID is passed and `$single` is true. 1445 * Note: Non-serialized values are returned as strings: 1446 * - false values are returned as empty strings ('') 1447 * - true values are returned as '1' 1448 * - numbers are returned as strings 1449 * Arrays and objects retain their original type. 1450 */ 1451 function get_term_meta( $term_id, $key = '', $single = false ) { 1452 return get_metadata( 'term', $term_id, $key, $single ); 1453 } 1454 1455 /** 1456 * Updates term metadata. 1457 * 1458 * Use the `$prev_value` parameter to differentiate between meta fields with the same key and term ID. 1459 * 1460 * If the meta field for the term does not exist, it will be added. 1461 * 1462 * For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input. 1463 * 1464 * @since 4.4.0 1465 * 1466 * @param int $term_id Term ID. 1467 * @param string $meta_key Metadata key. 1468 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1469 * @param mixed $prev_value Optional. Previous value to check before updating. 1470 * If specified, only update existing metadata entries with 1471 * this value. Otherwise, update all entries. Default empty. 1472 * @return int|bool|WP_Error Meta ID if the key didn't exist. true on successful update, 1473 * false on failure or if the value passed to the function 1474 * is the same as the one that is already in the database. 1475 * WP_Error when term_id is ambiguous between taxonomies. 1476 */ 1477 function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) { 1478 if ( wp_term_is_shared( $term_id ) ) { 1479 return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id ); 1480 } 1481 1482 return update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value ); 1483 } 1484 1485 /** 1486 * Updates metadata cache for list of term IDs. 1487 * 1488 * Performs SQL query to retrieve all metadata for the terms matching `$term_ids` and stores them in the cache. 1489 * Subsequent calls to `get_term_meta()` will not need to query the database. 1490 * 1491 * @since 4.4.0 1492 * 1493 * @param array $term_ids List of term IDs. 1494 * @return array|false An array of metadata on success, false if there is nothing to update. 1495 */ 1496 function update_termmeta_cache( $term_ids ) { 1497 return update_meta_cache( 'term', $term_ids ); 1498 } 1499 1500 1501 /** 1502 * Queue term meta for lazy-loading. 1503 * 1504 * @since 6.3.0 1505 * 1506 * @param array $term_ids List of term IDs. 1507 */ 1508 function wp_lazyload_term_meta( array $term_ids ) { 1509 if ( empty( $term_ids ) ) { 1510 return; 1511 } 1512 $lazyloader = wp_metadata_lazyloader(); 1513 $lazyloader->queue_objects( 'term', $term_ids ); 1514 } 1515 1516 /** 1517 * Gets all meta data, including meta IDs, for the given term ID. 1518 * 1519 * @since 4.9.0 1520 * 1521 * @global wpdb $wpdb WordPress database abstraction object. 1522 * 1523 * @param int $term_id Term ID. 1524 * @return array|false Array with meta data, or false when the meta table is not installed. 1525 */ 1526 function has_term_meta( $term_id ) { 1527 $check = wp_check_term_meta_support_prefilter( null ); 1528 if ( null !== $check ) { 1529 return $check; 1530 } 1531 1532 global $wpdb; 1533 1534 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 ); 1535 } 1536 1537 /** 1538 * Registers a meta key for terms. 1539 * 1540 * @since 4.9.8 1541 * 1542 * @param string $taxonomy Taxonomy to register a meta key for. Pass an empty string 1543 * to register the meta key across all existing taxonomies. 1544 * @param string $meta_key The meta key to register. 1545 * @param array $args Data used to describe the meta key when registered. See 1546 * {@see register_meta()} for a list of supported arguments. 1547 * @return bool True if the meta key was successfully registered, false if not. 1548 */ 1549 function register_term_meta( $taxonomy, $meta_key, array $args ) { 1550 $args['object_subtype'] = $taxonomy; 1551 1552 return register_meta( 'term', $meta_key, $args ); 1553 } 1554 1555 /** 1556 * Unregisters a meta key for terms. 1557 * 1558 * @since 4.9.8 1559 * 1560 * @param string $taxonomy Taxonomy the meta key is currently registered for. Pass 1561 * an empty string if the meta key is registered across all 1562 * existing taxonomies. 1563 * @param string $meta_key The meta key to unregister. 1564 * @return bool True on success, false if the meta key was not previously registered. 1565 */ 1566 function unregister_term_meta( $taxonomy, $meta_key ) { 1567 return unregister_meta_key( 'term', $meta_key, $taxonomy ); 1568 } 1569 1570 /** 1571 * Determines whether a taxonomy term exists. 1572 * 1573 * Formerly is_term(), introduced in 2.3.0. 1574 * 1575 * For more information on this and similar theme functions, check out 1576 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1577 * Conditional Tags} article in the Theme Developer Handbook. 1578 * 1579 * @since 3.0.0 1580 * @since 6.0.0 Converted to use `get_terms()`. 1581 * 1582 * @global bool $_wp_suspend_cache_invalidation 1583 * 1584 * @param int|string|null $term The term to check. Accepts term ID, slug, or name. 1585 * @param string $taxonomy Optional. The taxonomy name to use. 1586 * @param int $parent_term Optional. ID of parent term under which to confine the exists search. 1587 * @return mixed Returns null if the term does not exist. 1588 * Returns the term ID if no taxonomy is specified and the term ID exists. 1589 * Returns an array of the term ID and the term taxonomy ID if the taxonomy is specified and the pairing exists. 1590 * Returns 0 if term ID 0 is passed to the function. 1591 * 1592 * @phpstan-return ( 1593 * $term is null ? null : ( 1594 * $term is 0 ? 0 : ( 1595 * $taxonomy is '' ? int|null : ( 1596 * array{ 1597 * term_id: numeric-string, 1598 * term_taxonomy_id: numeric-string, 1599 * }|null 1600 * ) 1601 * ) 1602 * ) 1603 * ) 1604 */ 1605 function term_exists( $term, $taxonomy = '', $parent_term = null ) { 1606 global $_wp_suspend_cache_invalidation; 1607 1608 if ( null === $term ) { 1609 return null; 1610 } 1611 1612 $defaults = array( 1613 'get' => 'all', 1614 'fields' => 'ids', 1615 'number' => 1, 1616 'update_term_meta_cache' => false, 1617 'order' => 'ASC', 1618 'orderby' => 'term_id', 1619 'suppress_filter' => true, 1620 ); 1621 1622 // Ensure that while importing, queries are not cached. 1623 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 1624 $defaults['cache_results'] = false; 1625 } 1626 1627 if ( ! empty( $taxonomy ) ) { 1628 $defaults['taxonomy'] = $taxonomy; 1629 $defaults['fields'] = 'all'; 1630 } 1631 1632 /** 1633 * Filters default query arguments for checking if a term exists. 1634 * 1635 * @since 6.0.0 1636 * 1637 * @param array $defaults An array of arguments passed to get_terms(). 1638 * @param int|string $term The term to check. Accepts term ID, slug, or name. 1639 * @param string $taxonomy The taxonomy name to use. An empty string indicates 1640 * the search is against all taxonomies. 1641 * @param int|null $parent_term ID of parent term under which to confine the exists search. 1642 * Null indicates the search is unconfined. 1643 */ 1644 $defaults = apply_filters( 'term_exists_default_query_args', $defaults, $term, $taxonomy, $parent_term ); 1645 1646 if ( ! empty( $taxonomy ) && is_numeric( $parent_term ) ) { 1647 $defaults['parent'] = (int) $parent_term; 1648 } 1649 1650 if ( is_int( $term ) ) { 1651 if ( 0 === $term ) { 1652 return 0; 1653 } 1654 $args = wp_parse_args( array( 'include' => array( $term ) ), $defaults ); 1655 $terms = get_terms( $args ); 1656 } else { 1657 $term = trim( wp_unslash( $term ) ); 1658 if ( '' === $term ) { 1659 return null; 1660 } 1661 1662 $args = wp_parse_args( array( 'slug' => sanitize_title( $term ) ), $defaults ); 1663 $terms = get_terms( $args ); 1664 if ( empty( $terms ) || is_wp_error( $terms ) ) { 1665 $args = wp_parse_args( array( 'name' => $term ), $defaults ); 1666 $terms = get_terms( $args ); 1667 } 1668 } 1669 1670 if ( empty( $terms ) || is_wp_error( $terms ) ) { 1671 return null; 1672 } 1673 1674 $_term = array_shift( $terms ); 1675 1676 if ( ! empty( $taxonomy ) ) { 1677 return array( 1678 'term_id' => (string) $_term->term_id, 1679 'term_taxonomy_id' => (string) $_term->term_taxonomy_id, 1680 ); 1681 } 1682 1683 return (string) $_term; 1684 } 1685 1686 /** 1687 * Checks if a term is an ancestor of another term. 1688 * 1689 * You can use either an ID or the term object for both parameters. 1690 * 1691 * @since 3.4.0 1692 * 1693 * @param int|object $term1 ID or object to check if this is the parent term. 1694 * @param int|object $term2 The child term. 1695 * @param string $taxonomy Taxonomy name that $term1 and `$term2` belong to. 1696 * @return bool Whether `$term2` is a child of `$term1`. 1697 */ 1698 function term_is_ancestor_of( $term1, $term2, $taxonomy ) { 1699 if ( ! isset( $term1->term_id ) ) { 1700 $term1 = get_term( $term1, $taxonomy ); 1701 } 1702 if ( ! isset( $term2->parent ) ) { 1703 $term2 = get_term( $term2, $taxonomy ); 1704 } 1705 1706 if ( empty( $term1->term_id ) || empty( $term2->parent ) ) { 1707 return false; 1708 } 1709 if ( $term2->parent === $term1->term_id ) { 1710 return true; 1711 } 1712 1713 return term_is_ancestor_of( $term1, get_term( $term2->parent, $taxonomy ), $taxonomy ); 1714 } 1715 1716 /** 1717 * Sanitizes all term fields. 1718 * 1719 * Relies on sanitize_term_field() to sanitize the term. The difference is that 1720 * this function will sanitize **all** fields. The context is based 1721 * on sanitize_term_field(). 1722 * 1723 * The `$term` is expected to be either an array or an object. 1724 * 1725 * @since 2.3.0 1726 * 1727 * @param array|object $term The term to check. 1728 * @param string $taxonomy The taxonomy name to use. 1729 * @param string $context Optional. Context in which to sanitize the term. 1730 * Accepts 'raw', 'edit', 'db', 'display', 'rss', 1731 * 'attribute', or 'js'. Default 'display'. 1732 * @return array|object Term with all fields sanitized. 1733 */ 1734 function sanitize_term( $term, $taxonomy, $context = 'display' ) { 1735 $fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' ); 1736 1737 $do_object = is_object( $term ); 1738 1739 $term_id = $do_object ? ( $term->term_id ?? 0 ) : ( $term['term_id'] ?? 0 ); 1740 1741 foreach ( (array) $fields as $field ) { 1742 if ( $do_object ) { 1743 if ( isset( $term->$field ) ) { 1744 $term->$field = sanitize_term_field( $field, $term->$field, $term_id, $taxonomy, $context ); 1745 } 1746 } else { 1747 if ( isset( $term[ $field ] ) ) { 1748 $term[ $field ] = sanitize_term_field( $field, $term[ $field ], $term_id, $taxonomy, $context ); 1749 } 1750 } 1751 } 1752 1753 if ( $do_object ) { 1754 $term->filter = $context; 1755 } else { 1756 $term['filter'] = $context; 1757 } 1758 1759 return $term; 1760 } 1761 1762 /** 1763 * Sanitizes the field value in the term based on the context. 1764 * 1765 * Passing a term field value through the function should be assumed to have 1766 * cleansed the value for whatever context the term field is going to be used. 1767 * 1768 * If no context or an unsupported context is given, then default filters will 1769 * be applied. 1770 * 1771 * There are enough filters for each context to support a custom filtering 1772 * without creating your own filter function. Simply create a function that 1773 * hooks into the filter you need. 1774 * 1775 * @since 2.3.0 1776 * 1777 * @param string $field Term field to sanitize. 1778 * @param string $value Search for this term value. 1779 * @param int $term_id Term ID. 1780 * @param string $taxonomy Taxonomy name. 1781 * @param string $context Context in which to sanitize the term field. 1782 * Accepts 'raw', 'edit', 'db', 'display', 'rss', 1783 * 'attribute', or 'js'. 1784 * @return mixed Sanitized field. 1785 */ 1786 function sanitize_term_field( $field, $value, $term_id, $taxonomy, $context ) { 1787 $int_fields = array( 'parent', 'term_id', 'count', 'term_group', 'term_taxonomy_id', 'object_id' ); 1788 if ( in_array( $field, $int_fields, true ) ) { 1789 $value = (int) $value; 1790 if ( $value < 0 ) { 1791 $value = 0; 1792 } 1793 } 1794 1795 $context = strtolower( $context ); 1796 1797 if ( 'raw' === $context ) { 1798 return $value; 1799 } 1800 1801 if ( 'edit' === $context ) { 1802 1803 /** 1804 * Filters a term field to edit before it is sanitized. 1805 * 1806 * The dynamic portion of the hook name, `$field`, refers to the term field. 1807 * 1808 * @since 2.3.0 1809 * 1810 * @param mixed $value Value of the term field. 1811 * @param int $term_id Term ID. 1812 * @param string $taxonomy Taxonomy slug. 1813 */ 1814 $value = apply_filters( "edit_term_{$field}", $value, $term_id, $taxonomy ); 1815 1816 /** 1817 * Filters the taxonomy field to edit before it is sanitized. 1818 * 1819 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer 1820 * to the taxonomy slug and taxonomy field, respectively. 1821 * 1822 * @since 2.3.0 1823 * 1824 * @param mixed $value Value of the taxonomy field to edit. 1825 * @param int $term_id Term ID. 1826 */ 1827 $value = apply_filters( "edit_{$taxonomy}_{$field}", $value, $term_id ); 1828 1829 if ( 'description' === $field ) { 1830 $value = esc_html( $value ); // textarea_escaped 1831 } else { 1832 $value = esc_attr( $value ); 1833 } 1834 } elseif ( 'db' === $context ) { 1835 1836 /** 1837 * Filters a term field value before it is sanitized. 1838 * 1839 * The dynamic portion of the hook name, `$field`, refers to the term field. 1840 * 1841 * @since 2.3.0 1842 * 1843 * @param mixed $value Value of the term field. 1844 * @param string $taxonomy Taxonomy slug. 1845 */ 1846 $value = apply_filters( "pre_term_{$field}", $value, $taxonomy ); 1847 1848 /** 1849 * Filters a taxonomy field before it is sanitized. 1850 * 1851 * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer 1852 * to the taxonomy slug and field name, respectively. 1853 * 1854 * @since 2.3.0 1855 * 1856 * @param mixed $value Value of the taxonomy field. 1857 */ 1858 $value = apply_filters( "pre_{$taxonomy}_{$field}", $value ); 1859 1860 // Back compat filters. 1861 if ( 'slug' === $field ) { 1862 /** 1863 * Filters the category nicename before it is sanitized. 1864 * 1865 * Use the {@see 'pre_$taxonomy_$field'} hook instead. 1866 * 1867 * @since 2.0.3 1868 * 1869 * @param string $value The category nicename. 1870 */ 1871 $value = apply_filters( 'pre_category_nicename', $value ); 1872 } 1873 } elseif ( 'rss' === $context ) { 1874 1875 /** 1876 * Filters the term field for use in RSS. 1877 * 1878 * The dynamic portion of the hook name, `$field`, refers to the term field. 1879 * 1880 * @since 2.3.0 1881 * 1882 * @param mixed $value Value of the term field. 1883 * @param string $taxonomy Taxonomy slug. 1884 */ 1885 $value = apply_filters( "term_{$field}_rss", $value, $taxonomy ); 1886 1887 /** 1888 * Filters the taxonomy field for use in RSS. 1889 * 1890 * The dynamic portions of the hook name, `$taxonomy`, and `$field`, refer 1891 * to the taxonomy slug and field name, respectively. 1892 * 1893 * @since 2.3.0 1894 * 1895 * @param mixed $value Value of the taxonomy field. 1896 */ 1897 $value = apply_filters( "{$taxonomy}_{$field}_rss", $value ); 1898 } else { 1899 // Use display filters by default. 1900 1901 /** 1902 * Filters the term field sanitized for display. 1903 * 1904 * The dynamic portion of the hook name, `$field`, refers to the term field name. 1905 * 1906 * @since 2.3.0 1907 * 1908 * @param mixed $value Value of the term field. 1909 * @param int $term_id Term ID. 1910 * @param string $taxonomy Taxonomy slug. 1911 * @param string $context Context to retrieve the term field value. 1912 */ 1913 $value = apply_filters( "term_{$field}", $value, $term_id, $taxonomy, $context ); 1914 1915 /** 1916 * Filters the taxonomy field sanitized for display. 1917 * 1918 * The dynamic portions of the filter name, `$taxonomy`, and `$field`, refer 1919 * to the taxonomy slug and taxonomy field, respectively. 1920 * 1921 * @since 2.3.0 1922 * 1923 * @param mixed $value Value of the taxonomy field. 1924 * @param int $term_id Term ID. 1925 * @param string $context Context to retrieve the taxonomy field value. 1926 */ 1927 $value = apply_filters( "{$taxonomy}_{$field}", $value, $term_id, $context ); 1928 } 1929 1930 if ( 'attribute' === $context ) { 1931 $value = esc_attr( $value ); 1932 } elseif ( 'js' === $context ) { 1933 $value = esc_js( $value ); 1934 } 1935 1936 // Restore the type for integer fields after esc_attr(). 1937 if ( in_array( $field, $int_fields, true ) ) { 1938 $value = (int) $value; 1939 } 1940 1941 return $value; 1942 } 1943 1944 /** 1945 * Counts how many terms are in taxonomy. 1946 * 1947 * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true). 1948 * 1949 * {@internal The `$deprecated` parameter is parsed for backward compatibility only.} 1950 * 1951 * @since 2.3.0 1952 * @since 5.6.0 Changed the function signature so that the `$args` array can be provided as the first parameter. 1953 * 1954 * @param array|string $args Optional. Array or string of arguments. See WP_Term_Query::__construct() 1955 * for information on accepted arguments. Default empty array. 1956 * @param array|string $deprecated Optional. Argument array, when using the legacy function parameter format. 1957 * If present, this parameter will be interpreted as `$args`, and the first 1958 * function parameter will be parsed as a taxonomy or array of taxonomies. 1959 * Default empty. 1960 * @return string|WP_Error Numeric string containing the number of terms in that 1961 * taxonomy or WP_Error if the taxonomy does not exist. 1962 */ 1963 function wp_count_terms( $args = array(), $deprecated = '' ) { 1964 $use_legacy_args = false; 1965 1966 // Check whether function is used with legacy signature: `$taxonomy` and `$args`. 1967 if ( $args 1968 && ( is_string( $args ) && taxonomy_exists( $args ) 1969 || is_array( $args ) && wp_is_numeric_array( $args ) ) 1970 ) { 1971 $use_legacy_args = true; 1972 } 1973 1974 $defaults = array( 'hide_empty' => false ); 1975 1976 if ( $use_legacy_args ) { 1977 $defaults['taxonomy'] = $args; 1978 $args = $deprecated; 1979 } 1980 1981 $args = wp_parse_args( $args, $defaults ); 1982 1983 // Backward compatibility. 1984 if ( isset( $args['ignore_empty'] ) ) { 1985 $args['hide_empty'] = $args['ignore_empty']; 1986 unset( $args['ignore_empty'] ); 1987 } 1988 1989 $args['fields'] = 'count'; 1990 1991 return get_terms( $args ); 1992 } 1993 1994 /** 1995 * Unlinks the object from the taxonomy or taxonomies. 1996 * 1997 * Will remove all relationships between the object and any terms in 1998 * a particular taxonomy or taxonomies. Does not remove the term or 1999 * taxonomy itself. 2000 * 2001 * @since 2.3.0 2002 * 2003 * @param int $object_id The term object ID that refers to the term. 2004 * @param string|array $taxonomies List of taxonomy names or single taxonomy name. 2005 */ 2006 function wp_delete_object_term_relationships( $object_id, $taxonomies ) { 2007 $object_id = (int) $object_id; 2008 2009 if ( ! is_array( $taxonomies ) ) { 2010 $taxonomies = array( $taxonomies ); 2011 } 2012 2013 foreach ( (array) $taxonomies as $taxonomy ) { 2014 $term_ids = wp_get_object_terms( $object_id, $taxonomy, array( 'fields' => 'ids' ) ); 2015 if ( ! is_array( $term_ids ) ) { 2016 // Skip return value in the case of an error or the 'wp_get_object_terms' filter returning an invalid value. 2017 continue; 2018 } 2019 $term_ids = array_map( 'intval', $term_ids ); 2020 wp_remove_object_terms( $object_id, $term_ids, $taxonomy ); 2021 } 2022 } 2023 2024 /** 2025 * Removes a term from the database. 2026 * 2027 * If the term is a parent of other terms, then the children will be updated to 2028 * that term's parent. 2029 * 2030 * Metadata associated with the term will be deleted. 2031 * 2032 * @since 2.3.0 2033 * 2034 * @global wpdb $wpdb WordPress database abstraction object. 2035 * 2036 * @param int $term Term ID. 2037 * @param string $taxonomy Taxonomy name. 2038 * @param array|string $args { 2039 * Optional. Array of arguments to override the default term ID. Default empty array. 2040 * 2041 * @type int $default The term ID to make the default term. This will only override 2042 * the terms found if there is only one term found. Any other and 2043 * the found terms are used. 2044 * @type bool $force_default Optional. Whether to force the supplied term as default to be 2045 * assigned even if the object was not going to be term-less. 2046 * Default false. 2047 * } 2048 * @return bool|int|WP_Error True on success, false if term does not exist. Zero on attempted 2049 * deletion of default Category. WP_Error if the taxonomy does not exist. 2050 * @phpstan-param non-empty-string $taxonomy 2051 * @phpstan-param string|array{ 2052 * default?: positive-int, 2053 * force_default?: bool, 2054 * } $args 2055 * @phpstan-return bool|WP_Error|0 2056 */ 2057 function wp_delete_term( $term, $taxonomy, $args = array() ) { 2058 global $wpdb; 2059 2060 $term = (int) $term; 2061 2062 $ids = term_exists( $term, $taxonomy ); 2063 if ( ! $ids ) { 2064 return false; 2065 } 2066 if ( is_wp_error( $ids ) ) { 2067 return $ids; 2068 } 2069 2070 $tt_id = $ids['term_taxonomy_id']; 2071 2072 $defaults = array(); 2073 2074 if ( 'category' === $taxonomy ) { 2075 $defaults['default'] = (int) get_option( 'default_category' ); 2076 if ( $defaults['default'] === $term ) { 2077 return 0; // Don't delete the default category. 2078 } 2079 } 2080 2081 // Don't delete the default custom taxonomy term. 2082 $taxonomy_object = get_taxonomy( $taxonomy ); 2083 if ( ! empty( $taxonomy_object->default_term ) ) { 2084 $defaults['default'] = (int) get_option( 'default_term_' . $taxonomy ); 2085 if ( $defaults['default'] === $term ) { 2086 return 0; 2087 } 2088 } 2089 2090 $args = wp_parse_args( $args, $defaults ); 2091 2092 if ( isset( $args['default'] ) ) { 2093 $default = (int) $args['default']; 2094 if ( ! term_exists( $default, $taxonomy ) ) { 2095 unset( $default ); 2096 } 2097 } 2098 2099 if ( isset( $args['force_default'] ) ) { 2100 $force_default = $args['force_default']; 2101 } 2102 2103 /** 2104 * Fires when deleting a term, before any modifications are made to posts or terms. 2105 * 2106 * @since 4.1.0 2107 * 2108 * @param int $term Term ID. 2109 * @param string $taxonomy Taxonomy name. 2110 */ 2111 do_action( 'pre_delete_term', $term, $taxonomy ); 2112 2113 // Update children to point to new parent. 2114 if ( is_taxonomy_hierarchical( $taxonomy ) ) { 2115 $term_obj = get_term( $term, $taxonomy ); 2116 if ( is_wp_error( $term_obj ) ) { 2117 return $term_obj; 2118 } 2119 $parent = $term_obj->parent; 2120 2121 $edit_ids = $wpdb->get_results( "SELECT term_id, term_taxonomy_id FROM $wpdb->term_taxonomy WHERE `parent` = " . (int) $term_obj->term_id ); 2122 $edit_tt_ids = wp_list_pluck( $edit_ids, 'term_taxonomy_id' ); 2123 2124 /** 2125 * Fires immediately before a term to delete's children are reassigned a parent. 2126 * 2127 * @since 2.9.0 2128 * 2129 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term. 2130 */ 2131 do_action( 'edit_term_taxonomies', $edit_tt_ids ); 2132 2133 $wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id ) + compact( 'taxonomy' ) ); 2134 2135 // Clean the cache for all child terms. 2136 $edit_term_ids = wp_list_pluck( $edit_ids, 'term_id' ); 2137 clean_term_cache( $edit_term_ids, $taxonomy ); 2138 2139 /** 2140 * Fires immediately after a term to delete's children are reassigned a parent. 2141 * 2142 * @since 2.9.0 2143 * 2144 * @param array $edit_tt_ids An array of term taxonomy IDs for the given term. 2145 */ 2146 do_action( 'edited_term_taxonomies', $edit_tt_ids ); 2147 } 2148 2149 // Get the term before deleting it or its term relationships so we can pass to actions below. 2150 $deleted_term = get_term( $term, $taxonomy ); 2151 2152 $object_ids = (array) $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) ); 2153 2154 foreach ( $object_ids as $object_id ) { 2155 if ( ! isset( $default ) ) { 2156 wp_remove_object_terms( $object_id, $term, $taxonomy ); 2157 continue; 2158 } 2159 2160 $terms = wp_get_object_terms( 2161 $object_id, 2162 $taxonomy, 2163 array( 2164 'fields' => 'ids', 2165 'orderby' => 'none', 2166 ) 2167 ); 2168 2169 if ( 1 === count( $terms ) ) { 2170 $terms = array( $default ); 2171 } else { 2172 $terms = array_diff( $terms, array( $term ) ); 2173 if ( isset( $force_default ) && $force_default ) { 2174 $terms = array_merge( $terms, array( $default ) ); 2175 } 2176 } 2177 2178 $terms = array_map( 'intval', $terms ); 2179 wp_set_object_terms( $object_id, $terms, $taxonomy ); 2180 } 2181 2182 // Clean the relationship caches for all object types using this term. 2183 $tax_object = get_taxonomy( $taxonomy ); 2184 foreach ( $tax_object->object_type as $object_type ) { 2185 clean_object_term_cache( $object_ids, $object_type ); 2186 } 2187 2188 $term_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->termmeta WHERE term_id = %d ", $term ) ); 2189 foreach ( $term_meta_ids as $mid ) { 2190 delete_metadata_by_mid( 'term', $mid ); 2191 } 2192 2193 /** 2194 * Fires immediately before a term taxonomy ID is deleted. 2195 * 2196 * @since 2.9.0 2197 * 2198 * @param int $tt_id Term taxonomy ID. 2199 */ 2200 do_action( 'delete_term_taxonomy', $tt_id ); 2201 2202 $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) ); 2203 2204 /** 2205 * Fires immediately after a term taxonomy ID is deleted. 2206 * 2207 * @since 2.9.0 2208 * 2209 * @param int $tt_id Term taxonomy ID. 2210 */ 2211 do_action( 'deleted_term_taxonomy', $tt_id ); 2212 2213 // Delete the term if no taxonomies use it. 2214 if ( ! $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term ) ) ) { 2215 $wpdb->delete( $wpdb->terms, array( 'term_id' => $term ) ); 2216 } 2217 2218 clean_term_cache( $term, $taxonomy ); 2219 2220 /** 2221 * Fires after a term is deleted from the database and the cache is cleaned. 2222 * 2223 * The {@see 'delete_$taxonomy'} hook is also available for targeting a specific 2224 * taxonomy. 2225 * 2226 * @since 2.5.0 2227 * @since 4.5.0 Introduced the `$object_ids` argument. 2228 * 2229 * @param int $term Term ID. 2230 * @param int $tt_id Term taxonomy ID. 2231 * @param string $taxonomy Taxonomy slug. 2232 * @param WP_Term $deleted_term Copy of the already-deleted term. 2233 * @param array $object_ids List of term object IDs. 2234 */ 2235 do_action( 'delete_term', $term, $tt_id, $taxonomy, $deleted_term, $object_ids ); 2236 2237 /** 2238 * Fires after a term in a specific taxonomy is deleted. 2239 * 2240 * The dynamic portion of the hook name, `$taxonomy`, refers to the specific 2241 * taxonomy the term belonged to. 2242 * 2243 * Possible hook names include: 2244 * 2245 * - `delete_category` 2246 * - `delete_post_tag` 2247 * 2248 * @since 2.3.0 2249 * @since 4.5.0 Introduced the `$object_ids` argument. 2250 * 2251 * @param int $term Term ID. 2252 * @param int $tt_id Term taxonomy ID. 2253 * @param WP_Term $deleted_term Copy of the already-deleted term. 2254 * @param array $object_ids List of term object IDs. 2255 */ 2256 do_action( "delete_{$taxonomy}", $term, $tt_id, $deleted_term, $object_ids ); 2257 2258 return true; 2259 } 2260 2261 /** 2262 * Deletes one existing category. 2263 * 2264 * @since 2.0.0 2265 * 2266 * @param int $cat_id Category term ID. 2267 * @return bool|int|WP_Error Returns true if completes delete action; false if term doesn't exist; 2268 * Zero on attempted deletion of default Category; WP_Error object is 2269 * also a possibility. 2270 */ 2271 function wp_delete_category( $cat_id ) { 2272 return wp_delete_term( $cat_id, 'category' ); 2273 } 2274 2275 /** 2276 * Retrieves the terms associated with the given object(s), in the supplied taxonomies. 2277 * 2278 * @since 2.3.0 2279 * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`. 2280 * Introduced `$parent` argument. 2281 * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or 2282 * 'all_with_object_id', an array of `WP_Term` objects will be returned. 2283 * @since 4.7.0 Refactored to use WP_Term_Query, and to support any WP_Term_Query arguments. 2284 * @since 6.3.0 Passing `update_term_meta_cache` argument value false by default resulting in get_terms() to not 2285 * prime the term meta cache. 2286 * 2287 * @param int|int[] $object_ids The ID(s) of the object(s) to retrieve. 2288 * @param string|string[] $taxonomies The taxonomy names to retrieve terms from. 2289 * @param array|string $args See WP_Term_Query::__construct() for supported arguments. 2290 * @return WP_Term[]|int[]|string[]|string|WP_Error Array of terms, a count thereof as a numeric string, 2291 * or WP_Error if any of the taxonomies do not exist. 2292 * See WP_Term_Query::get_terms() for more information. 2293 */ 2294 function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) { 2295 if ( empty( $object_ids ) || empty( $taxonomies ) ) { 2296 return array(); 2297 } 2298 2299 if ( ! is_array( $taxonomies ) ) { 2300 $taxonomies = array( $taxonomies ); 2301 } 2302 2303 foreach ( $taxonomies as $taxonomy ) { 2304 if ( ! taxonomy_exists( $taxonomy ) ) { 2305 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2306 } 2307 } 2308 2309 if ( ! is_array( $object_ids ) ) { 2310 $object_ids = array( $object_ids ); 2311 } 2312 $object_ids = array_map( 'intval', $object_ids ); 2313 2314 $defaults = array( 2315 'update_term_meta_cache' => false, 2316 ); 2317 2318 $args = wp_parse_args( $args, $defaults ); 2319 2320 /** 2321 * Filters arguments for retrieving object terms. 2322 * 2323 * @since 4.9.0 2324 * 2325 * @param array $args An array of arguments for retrieving terms for the given object(s). 2326 * See {@see wp_get_object_terms()} for details. 2327 * @param int[] $object_ids Array of object IDs. 2328 * @param string[] $taxonomies Array of taxonomy names to retrieve terms from. 2329 */ 2330 $args = apply_filters( 'wp_get_object_terms_args', $args, $object_ids, $taxonomies ); 2331 2332 /* 2333 * When one or more queried taxonomies is registered with an 'args' array, 2334 * those params override the `$args` passed to this function. 2335 */ 2336 $terms = array(); 2337 if ( count( $taxonomies ) > 1 ) { 2338 foreach ( $taxonomies as $index => $taxonomy ) { 2339 $t = get_taxonomy( $taxonomy ); 2340 if ( isset( $t->args ) && is_array( $t->args ) && array_merge( $args, $t->args ) != $args ) { 2341 unset( $taxonomies[ $index ] ); 2342 $terms = array_merge( $terms, wp_get_object_terms( $object_ids, $taxonomy, array_merge( $args, $t->args ) ) ); 2343 } 2344 } 2345 } else { 2346 $t = get_taxonomy( $taxonomies[0] ); 2347 if ( isset( $t->args ) && is_array( $t->args ) ) { 2348 $args = array_merge( $args, $t->args ); 2349 } 2350 } 2351 2352 $args['taxonomy'] = $taxonomies; 2353 $args['object_ids'] = $object_ids; 2354 2355 // Taxonomies registered without an 'args' param are handled here. 2356 if ( ! empty( $taxonomies ) ) { 2357 $terms_from_remaining_taxonomies = get_terms( $args ); 2358 2359 // Array keys should be preserved for values of $fields that use term_id for keys. 2360 if ( ! empty( $args['fields'] ) && str_starts_with( $args['fields'], 'id=>' ) ) { 2361 $terms = $terms + $terms_from_remaining_taxonomies; 2362 } else { 2363 $terms = array_merge( $terms, $terms_from_remaining_taxonomies ); 2364 } 2365 } 2366 2367 /** 2368 * Filters the terms for a given object or objects. 2369 * 2370 * @since 4.2.0 2371 * 2372 * @param WP_Term[]|int[]|string[]|string $terms Array of terms or a count thereof as a numeric string. 2373 * @param int[] $object_ids Array of object IDs for which terms were retrieved. 2374 * @param string[] $taxonomies Array of taxonomy names from which terms were retrieved. 2375 * @param array $args Array of arguments for retrieving terms for the given 2376 * object(s). See wp_get_object_terms() for details. 2377 */ 2378 $terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomies, $args ); 2379 2380 $object_ids = implode( ',', $object_ids ); 2381 $taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'"; 2382 2383 /** 2384 * Filters the terms for a given object or objects. 2385 * 2386 * The `$taxonomies` parameter passed to this filter is formatted as a SQL fragment. The 2387 * {@see 'get_object_terms'} filter is recommended as an alternative. 2388 * 2389 * @since 2.8.0 2390 * 2391 * @param WP_Term[]|int[]|string[]|string $terms Array of terms or a count thereof as a numeric string. 2392 * @param string $object_ids Comma separated list of object IDs for which terms were retrieved. 2393 * @param string $taxonomies SQL fragment of taxonomy names from which terms were retrieved. 2394 * @param array $args Array of arguments for retrieving terms for the given 2395 * object(s). See wp_get_object_terms() for details. 2396 */ 2397 return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args ); 2398 } 2399 2400 /** 2401 * Adds a new term to the database. 2402 * 2403 * A non-existent term is inserted in the following sequence: 2404 * 1. The term is added to the term table, then related to the taxonomy. 2405 * 2. If everything is correct, several actions are fired. 2406 * 3. The 'term_id_filter' is evaluated. 2407 * 4. The term cache is cleaned. 2408 * 5. Several more actions are fired. 2409 * 6. An array is returned containing the `term_id` and `term_taxonomy_id`. 2410 * 2411 * If the 'slug' argument is not empty, then it is checked to see if the term 2412 * is invalid. If it is not a valid, existing term, it is added and the term_id 2413 * is given. 2414 * 2415 * If the taxonomy is hierarchical, and the 'parent' argument is not empty, 2416 * the term is inserted and the term_id will be given. 2417 * 2418 * Error handling: 2419 * If `$taxonomy` does not exist or `$term` is empty, 2420 * a WP_Error object will be returned. 2421 * 2422 * If the term already exists on the same hierarchical level, 2423 * or the term slug and name are not unique, a WP_Error object will be returned. 2424 * 2425 * @global wpdb $wpdb WordPress database abstraction object. 2426 * 2427 * @since 2.3.0 2428 * 2429 * @param string $term The term name to add. 2430 * @param string $taxonomy The taxonomy to which to add the term. 2431 * @param array|string $args { 2432 * Optional. Array or query string of arguments for inserting a term. 2433 * 2434 * @type string $alias_of Slug of the term to make this term an alias of. 2435 * Default empty string. Accepts a term slug. 2436 * @type string $description The term description. Default empty string. 2437 * @type int $parent The id of the parent term. Default 0. 2438 * @type string $slug The term slug to use. Default empty string. 2439 * } 2440 * @return array|WP_Error { 2441 * An array of the new term data, WP_Error otherwise. 2442 * 2443 * @type int $term_id The new term ID. 2444 * @type int|string $term_taxonomy_id The new term taxonomy ID. Can be a numeric string. 2445 * } 2446 * @phpstan-param string|array{ 2447 * alias_of?: string, 2448 * description?: string|null, 2449 * parent?: non-negative-int, 2450 * slug?: string|null, 2451 * ... 2452 * } $args 2453 * @phpstan-return array{ 2454 * term_id: int, 2455 * term_taxonomy_id: int|numeric-string, 2456 * }|WP_Error 2457 */ 2458 function wp_insert_term( $term, $taxonomy, $args = array() ) { 2459 global $wpdb; 2460 2461 if ( ! taxonomy_exists( $taxonomy ) ) { 2462 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2463 } 2464 2465 /** 2466 * Filters a term before it is sanitized and inserted into the database. 2467 * 2468 * @since 3.0.0 2469 * @since 6.1.0 The `$args` parameter was added. 2470 * 2471 * @param string|WP_Error $term The term name to add, or a WP_Error object if there's an error. 2472 * @param string $taxonomy Taxonomy slug. 2473 * @param array|string $args Array or query string of arguments passed to wp_insert_term(). 2474 */ 2475 $term = apply_filters( 'pre_insert_term', $term, $taxonomy, $args ); 2476 2477 if ( is_wp_error( $term ) ) { 2478 return $term; 2479 } 2480 2481 if ( is_int( $term ) && 0 === $term ) { 2482 return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) ); 2483 } 2484 2485 if ( '' === trim( $term ) ) { 2486 return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) ); 2487 } 2488 2489 $defaults = array( 2490 'alias_of' => '', 2491 'description' => '', 2492 'parent' => 0, 2493 'slug' => '', 2494 ); 2495 $args = wp_parse_args( $args, $defaults ); 2496 2497 if ( (int) $args['parent'] > 0 && ! term_exists( (int) $args['parent'] ) ) { 2498 return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) ); 2499 } 2500 2501 $args['name'] = $term; 2502 $args['taxonomy'] = $taxonomy; 2503 2504 // Coerce null description to strings, to avoid database errors. 2505 $args['description'] = (string) $args['description']; 2506 2507 $args = sanitize_term( $args, $taxonomy, 'db' ); 2508 2509 // expected_slashed ($name) 2510 $name = wp_unslash( $args['name'] ); 2511 $description = wp_unslash( $args['description'] ); 2512 $parent = (int) $args['parent']; 2513 2514 // Sanitization could clean the name to an empty string that must be checked again. 2515 if ( '' === $name ) { 2516 return new WP_Error( 'invalid_term_name', __( 'Invalid term name.' ) ); 2517 } 2518 2519 $slug_provided = ! empty( $args['slug'] ); 2520 if ( ! $slug_provided ) { 2521 $slug = sanitize_title( $name ); 2522 } else { 2523 $slug = $args['slug']; 2524 } 2525 2526 $term_group = 0; 2527 if ( $args['alias_of'] ) { 2528 $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy ); 2529 if ( ! empty( $alias->term_group ) ) { 2530 // The alias we want is already in a group, so let's use that one. 2531 $term_group = $alias->term_group; 2532 } elseif ( ! empty( $alias->term_id ) ) { 2533 /* 2534 * The alias is not in a group, so we create a new one 2535 * and add the alias to it. 2536 */ 2537 $term_group = $wpdb->get_var( "SELECT MAX(term_group) FROM $wpdb->terms" ) + 1; 2538 2539 wp_update_term( 2540 $alias->term_id, 2541 $taxonomy, 2542 array( 2543 'term_group' => $term_group, 2544 ) 2545 ); 2546 } 2547 } 2548 2549 /* 2550 * Prevent the creation of terms with duplicate names at the same level of a taxonomy hierarchy, 2551 * unless a unique slug has been explicitly provided. 2552 */ 2553 $name_matches = get_terms( 2554 array( 2555 'taxonomy' => $taxonomy, 2556 'name' => $name, 2557 'hide_empty' => false, 2558 'parent' => $args['parent'], 2559 'update_term_meta_cache' => false, 2560 ) 2561 ); 2562 2563 /* 2564 * The `name` match in `get_terms()` doesn't differentiate accented characters, 2565 * so we do a stricter comparison here. 2566 */ 2567 $name_match = null; 2568 if ( $name_matches ) { 2569 foreach ( $name_matches as $_match ) { 2570 if ( strtolower( $name ) === strtolower( $_match->name ) ) { 2571 $name_match = $_match; 2572 break; 2573 } 2574 } 2575 } 2576 2577 if ( $name_match ) { 2578 $slug_match = get_term_by( 'slug', $slug, $taxonomy ); 2579 if ( ! $slug_provided || $name_match->slug === $slug || $slug_match ) { 2580 if ( is_taxonomy_hierarchical( $taxonomy ) ) { 2581 $siblings = get_terms( 2582 array( 2583 'taxonomy' => $taxonomy, 2584 'get' => 'all', 2585 'parent' => $parent, 2586 'update_term_meta_cache' => false, 2587 ) 2588 ); 2589 2590 $existing_term = null; 2591 $sibling_names = wp_list_pluck( $siblings, 'name' ); 2592 $sibling_slugs = wp_list_pluck( $siblings, 'slug' ); 2593 2594 if ( ( ! $slug_provided || $name_match->slug === $slug ) && in_array( $name, $sibling_names, true ) ) { 2595 $existing_term = $name_match; 2596 } elseif ( $slug_match && in_array( $slug, $sibling_slugs, true ) ) { 2597 $existing_term = $slug_match; 2598 } 2599 2600 if ( $existing_term ) { 2601 return new WP_Error( 'term_exists', __( 'A term with the name provided already exists with this parent.' ), $existing_term->term_id ); 2602 } 2603 } else { 2604 return new WP_Error( 'term_exists', __( 'A term with the name provided already exists in this taxonomy.' ), $name_match->term_id ); 2605 } 2606 } 2607 } 2608 2609 $slug = wp_unique_term_slug( $slug, (object) $args ); 2610 2611 $data = compact( 'name', 'slug', 'term_group' ); 2612 2613 /** 2614 * Filters term data before it is inserted into the database. 2615 * 2616 * @since 4.7.0 2617 * 2618 * @param array $data Term data to be inserted. 2619 * @param string $taxonomy Taxonomy slug. 2620 * @param array $args Arguments passed to wp_insert_term(). 2621 */ 2622 $data = apply_filters( 'wp_insert_term_data', $data, $taxonomy, $args ); 2623 2624 if ( false === $wpdb->insert( $wpdb->terms, $data ) ) { 2625 return new WP_Error( 'db_insert_error', __( 'Could not insert term into the database.' ), $wpdb->last_error ); 2626 } 2627 2628 $term_id = (int) $wpdb->insert_id; 2629 2630 // Seems unreachable. However, is used in the case that a term name is provided, which sanitizes to an empty string. 2631 if ( empty( $slug ) ) { 2632 $slug = sanitize_title( $slug, $term_id ); 2633 2634 /** This action is documented in wp-includes/taxonomy.php */ 2635 do_action( 'edit_terms', $term_id, $taxonomy ); 2636 $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) ); 2637 2638 /** This action is documented in wp-includes/taxonomy.php */ 2639 do_action( 'edited_terms', $term_id, $taxonomy ); 2640 } 2641 2642 /** @var numeric-string|null $tt_id */ 2643 $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 ) ); 2644 2645 if ( ! empty( $tt_id ) ) { 2646 return array( 2647 'term_id' => $term_id, 2648 'term_taxonomy_id' => $tt_id, 2649 ); 2650 } 2651 2652 if ( false === $wpdb->insert( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ) + array( 'count' => 0 ) ) ) { 2653 return new WP_Error( 'db_insert_error', __( 'Could not insert term taxonomy into the database.' ), $wpdb->last_error ); 2654 } 2655 2656 $tt_id = (int) $wpdb->insert_id; 2657 2658 /* 2659 * Confidence check: if we just created a term with the same parent + taxonomy + slug but a higher term_id than 2660 * an existing term, then we have unwittingly created a duplicate term. Delete the dupe, and use the term_id 2661 * and term_taxonomy_id of the older term instead. Then return out of the function so that the "create" hooks 2662 * are not fired. 2663 */ 2664 $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 ) ); 2665 2666 /** 2667 * Filters the duplicate term check that takes place during term creation. 2668 * 2669 * Term parent + taxonomy + slug combinations are meant to be unique, and wp_insert_term() 2670 * performs a last-minute confirmation of this uniqueness before allowing a new term 2671 * to be created. Plugins with different uniqueness requirements may use this filter 2672 * to bypass or modify the duplicate-term check. 2673 * 2674 * @since 5.1.0 2675 * 2676 * @param object $duplicate_term Duplicate term row from terms table, if found. 2677 * @param string $term Term being inserted. 2678 * @param string $taxonomy Taxonomy name. 2679 * @param array $args Arguments passed to wp_insert_term(). 2680 * @param int $tt_id term_taxonomy_id for the newly created term. 2681 */ 2682 $duplicate_term = apply_filters( 'wp_insert_term_duplicate_term_check', $duplicate_term, $term, $taxonomy, $args, $tt_id ); 2683 2684 if ( $duplicate_term ) { 2685 $wpdb->delete( $wpdb->terms, array( 'term_id' => $term_id ) ); 2686 $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) ); 2687 2688 $term_id = (int) $duplicate_term->term_id; 2689 $tt_id = (int) $duplicate_term->term_taxonomy_id; 2690 2691 clean_term_cache( $term_id, $taxonomy ); 2692 return array( 2693 'term_id' => $term_id, 2694 'term_taxonomy_id' => $tt_id, 2695 ); 2696 } 2697 2698 /** 2699 * Fires immediately after a new term is created, before the term cache is cleaned. 2700 * 2701 * The {@see 'create_$taxonomy'} hook is also available for targeting a specific 2702 * taxonomy. 2703 * 2704 * @since 2.3.0 2705 * @since 6.1.0 The `$args` parameter was added. 2706 * 2707 * @param int $term_id Term ID. 2708 * @param int $tt_id Term taxonomy ID. 2709 * @param string $taxonomy Taxonomy slug. 2710 * @param array $args Arguments passed to wp_insert_term(). 2711 */ 2712 do_action( 'create_term', $term_id, $tt_id, $taxonomy, $args ); 2713 2714 /** 2715 * Fires after a new term is created for a specific taxonomy. 2716 * 2717 * The dynamic portion of the hook name, `$taxonomy`, refers 2718 * to the slug of the taxonomy the term was created for. 2719 * 2720 * Possible hook names include: 2721 * 2722 * - `create_category` 2723 * - `create_post_tag` 2724 * 2725 * @since 2.3.0 2726 * @since 6.1.0 The `$args` parameter was added. 2727 * 2728 * @param int $term_id Term ID. 2729 * @param int $tt_id Term taxonomy ID. 2730 * @param array $args Arguments passed to wp_insert_term(). 2731 */ 2732 do_action( "create_{$taxonomy}", $term_id, $tt_id, $args ); 2733 2734 /** 2735 * Filters the term ID after a new term is created. 2736 * 2737 * @since 2.3.0 2738 * @since 6.1.0 The `$args` parameter was added. 2739 * 2740 * @param int $term_id Term ID. 2741 * @param int $tt_id Term taxonomy ID. 2742 * @param array $args Arguments passed to wp_insert_term(). 2743 */ 2744 $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id, $args ); 2745 2746 clean_term_cache( $term_id, $taxonomy ); 2747 2748 /** 2749 * Fires after a new term is created, and after the term cache has been cleaned. 2750 * 2751 * The {@see 'created_$taxonomy'} hook is also available for targeting a specific 2752 * taxonomy. 2753 * 2754 * @since 2.3.0 2755 * @since 6.1.0 The `$args` parameter was added. 2756 * 2757 * @param int $term_id Term ID. 2758 * @param int $tt_id Term taxonomy ID. 2759 * @param string $taxonomy Taxonomy slug. 2760 * @param array $args Arguments passed to wp_insert_term(). 2761 */ 2762 do_action( 'created_term', $term_id, $tt_id, $taxonomy, $args ); 2763 2764 /** 2765 * Fires after a new term in a specific taxonomy is created, and after the term 2766 * cache has been cleaned. 2767 * 2768 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 2769 * 2770 * Possible hook names include: 2771 * 2772 * - `created_category` 2773 * - `created_post_tag` 2774 * 2775 * @since 2.3.0 2776 * @since 6.1.0 The `$args` parameter was added. 2777 * 2778 * @param int $term_id Term ID. 2779 * @param int $tt_id Term taxonomy ID. 2780 * @param array $args Arguments passed to wp_insert_term(). 2781 */ 2782 do_action( "created_{$taxonomy}", $term_id, $tt_id, $args ); 2783 2784 /** 2785 * Fires after a term has been saved, and the term cache has been cleared. 2786 * 2787 * The {@see 'saved_$taxonomy'} hook is also available for targeting a specific 2788 * taxonomy. 2789 * 2790 * @since 5.5.0 2791 * @since 6.1.0 The `$args` parameter was added. 2792 * 2793 * @param int $term_id Term ID. 2794 * @param int $tt_id Term taxonomy ID. 2795 * @param string $taxonomy Taxonomy slug. 2796 * @param bool $update Whether this is an existing term being updated. 2797 * @param array $args Arguments passed to wp_insert_term(). 2798 */ 2799 do_action( 'saved_term', $term_id, $tt_id, $taxonomy, false, $args ); 2800 2801 /** 2802 * Fires after a term in a specific taxonomy has been saved, and the term 2803 * cache has been cleared. 2804 * 2805 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 2806 * 2807 * Possible hook names include: 2808 * 2809 * - `saved_category` 2810 * - `saved_post_tag` 2811 * 2812 * @since 5.5.0 2813 * @since 6.1.0 The `$args` parameter was added. 2814 * 2815 * @param int $term_id Term ID. 2816 * @param int $tt_id Term taxonomy ID. 2817 * @param bool $update Whether this is an existing term being updated. 2818 * @param array $args Arguments passed to wp_insert_term(). 2819 */ 2820 do_action( "saved_{$taxonomy}", $term_id, $tt_id, false, $args ); 2821 2822 return array( 2823 'term_id' => $term_id, 2824 'term_taxonomy_id' => $tt_id, 2825 ); 2826 } 2827 2828 /** 2829 * Creates term and taxonomy relationships. 2830 * 2831 * Relates an object (post, link, etc.) to a term and taxonomy type. Creates the 2832 * term and taxonomy relationship if it doesn't already exist. Creates a term if 2833 * it doesn't exist (using the slug). 2834 * 2835 * A relationship means that the term is grouped in or belongs to the taxonomy. 2836 * A term has no meaning until it is given context by defining which taxonomy it 2837 * exists under. 2838 * 2839 * @since 2.3.0 2840 * 2841 * @global wpdb $wpdb WordPress database abstraction object. 2842 * 2843 * @param int $object_id The object to relate to. 2844 * @param string|int|array $terms A single term slug, single term ID, or array of either term slugs or IDs. 2845 * Will replace all existing related terms in this taxonomy. Passing an 2846 * empty array will remove all related terms. 2847 * @param string $taxonomy The context in which to relate the term to the object. 2848 * @param bool $append Optional. If false will delete difference of terms. Default false. 2849 * @return array|WP_Error Term taxonomy IDs of the affected terms or WP_Error on failure. 2850 */ 2851 function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) { 2852 global $wpdb; 2853 2854 $object_id = (int) $object_id; 2855 2856 if ( ! taxonomy_exists( $taxonomy ) ) { 2857 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 2858 } 2859 2860 if ( empty( $terms ) ) { 2861 $terms = array(); 2862 } elseif ( ! is_array( $terms ) ) { 2863 $terms = array( $terms ); 2864 } 2865 2866 if ( ! $append ) { 2867 $old_tt_ids = wp_get_object_terms( 2868 $object_id, 2869 $taxonomy, 2870 array( 2871 'fields' => 'tt_ids', 2872 'orderby' => 'none', 2873 'update_term_meta_cache' => false, 2874 ) 2875 ); 2876 } else { 2877 $old_tt_ids = array(); 2878 } 2879 2880 $tt_ids = array(); 2881 $new_tt_ids = array(); 2882 2883 foreach ( (array) $terms as $term ) { 2884 if ( '' === trim( $term ) ) { 2885 continue; 2886 } 2887 2888 $term_info = term_exists( $term, $taxonomy ); 2889 2890 if ( ! $term_info ) { 2891 // Skip if a non-existent term ID is passed. 2892 if ( is_int( $term ) ) { 2893 continue; 2894 } 2895 2896 $term_info = wp_insert_term( $term, $taxonomy ); 2897 } 2898 2899 if ( is_wp_error( $term_info ) ) { 2900 return $term_info; 2901 } 2902 2903 $tt_id = $term_info['term_taxonomy_id']; 2904 $tt_ids[] = $tt_id; 2905 2906 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 ) ) ) { 2907 continue; 2908 } 2909 2910 /** 2911 * Fires immediately before an object-term relationship is added. 2912 * 2913 * @since 2.9.0 2914 * @since 4.7.0 Added the `$taxonomy` parameter. 2915 * 2916 * @param int $object_id Object ID. 2917 * @param int $tt_id Term taxonomy ID. 2918 * @param string $taxonomy Taxonomy slug. 2919 */ 2920 do_action( 'add_term_relationship', $object_id, $tt_id, $taxonomy ); 2921 2922 $wpdb->insert( 2923 $wpdb->term_relationships, 2924 array( 2925 'object_id' => $object_id, 2926 'term_taxonomy_id' => $tt_id, 2927 ) 2928 ); 2929 2930 /** 2931 * Fires immediately after an object-term relationship is added. 2932 * 2933 * @since 2.9.0 2934 * @since 4.7.0 Added the `$taxonomy` parameter. 2935 * 2936 * @param int $object_id Object ID. 2937 * @param int $tt_id Term taxonomy ID. 2938 * @param string $taxonomy Taxonomy slug. 2939 */ 2940 do_action( 'added_term_relationship', $object_id, $tt_id, $taxonomy ); 2941 2942 $new_tt_ids[] = $tt_id; 2943 } 2944 2945 if ( $new_tt_ids ) { 2946 wp_update_term_count( $new_tt_ids, $taxonomy ); 2947 } 2948 2949 if ( ! $append ) { 2950 $delete_tt_ids = array_diff( $old_tt_ids, $tt_ids ); 2951 2952 if ( $delete_tt_ids ) { 2953 $in_delete_tt_ids = "'" . implode( "', '", $delete_tt_ids ) . "'"; 2954 $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 ) ); 2955 $delete_term_ids = array_map( 'intval', $delete_term_ids ); 2956 2957 $remove = wp_remove_object_terms( $object_id, $delete_term_ids, $taxonomy ); 2958 if ( is_wp_error( $remove ) ) { 2959 return $remove; 2960 } 2961 } 2962 } 2963 2964 $t = get_taxonomy( $taxonomy ); 2965 2966 if ( ! $append && isset( $t->sort ) && $t->sort ) { 2967 $values = array(); 2968 $term_order = 0; 2969 2970 $final_tt_ids = wp_get_object_terms( 2971 $object_id, 2972 $taxonomy, 2973 array( 2974 'fields' => 'tt_ids', 2975 'update_term_meta_cache' => false, 2976 ) 2977 ); 2978 2979 foreach ( $tt_ids as $tt_id ) { 2980 if ( in_array( (int) $tt_id, $final_tt_ids, true ) ) { 2981 $values[] = $wpdb->prepare( '(%d, %d, %d)', $object_id, $tt_id, ++$term_order ); 2982 } 2983 } 2984 2985 if ( $values ) { 2986 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)' ) ) { 2987 return new WP_Error( 'db_insert_error', __( 'Could not insert term relationship into the database.' ), $wpdb->last_error ); 2988 } 2989 } 2990 } 2991 2992 wp_cache_delete( $object_id, $taxonomy . '_relationships' ); 2993 wp_cache_set_terms_last_changed(); 2994 2995 /** 2996 * Fires after an object's terms have been set. 2997 * 2998 * @since 2.8.0 2999 * 3000 * @param int $object_id Object ID. 3001 * @param array $terms An array of object term IDs or slugs. 3002 * @param array $tt_ids An array of term taxonomy IDs. 3003 * @param string $taxonomy Taxonomy slug. 3004 * @param bool $append Whether to append new terms to the old terms. 3005 * @param array $old_tt_ids Old array of term taxonomy IDs. 3006 */ 3007 do_action( 'set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids ); 3008 3009 return $tt_ids; 3010 } 3011 3012 /** 3013 * Adds term(s) associated with a given object. 3014 * 3015 * @since 3.6.0 3016 * 3017 * @param int $object_id The ID of the object to which the terms will be added. 3018 * @param string|int|array $terms The slug(s) or ID(s) of the term(s) to add. 3019 * @param array|string $taxonomy Taxonomy name. 3020 * @return array|WP_Error Term taxonomy IDs of the affected terms. 3021 */ 3022 function wp_add_object_terms( $object_id, $terms, $taxonomy ) { 3023 return wp_set_object_terms( $object_id, $terms, $taxonomy, true ); 3024 } 3025 3026 /** 3027 * Removes term(s) associated with a given object. 3028 * 3029 * @since 3.6.0 3030 * 3031 * @global wpdb $wpdb WordPress database abstraction object. 3032 * 3033 * @param int $object_id The ID of the object from which the terms will be removed. 3034 * @param string|int|array $terms The slug(s) or ID(s) of the term(s) to remove. 3035 * @param string $taxonomy Taxonomy name. 3036 * @return bool|WP_Error True on success, false or WP_Error on failure. 3037 */ 3038 function wp_remove_object_terms( $object_id, $terms, $taxonomy ) { 3039 global $wpdb; 3040 3041 $object_id = (int) $object_id; 3042 3043 if ( ! taxonomy_exists( $taxonomy ) ) { 3044 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 3045 } 3046 3047 if ( ! is_array( $terms ) ) { 3048 $terms = array( $terms ); 3049 } 3050 3051 $tt_ids = array(); 3052 3053 foreach ( (array) $terms as $term ) { 3054 if ( '' === trim( $term ) ) { 3055 continue; 3056 } 3057 3058 $term_info = term_exists( $term, $taxonomy ); 3059 if ( ! $term_info ) { 3060 // Skip if a non-existent term ID is passed. 3061 if ( is_int( $term ) ) { 3062 continue; 3063 } 3064 } 3065 3066 if ( is_wp_error( $term_info ) ) { 3067 return $term_info; 3068 } 3069 3070 $tt_ids[] = $term_info['term_taxonomy_id']; 3071 } 3072 3073 if ( $tt_ids ) { 3074 $in_tt_ids = "'" . implode( "', '", $tt_ids ) . "'"; 3075 3076 /** 3077 * Fires immediately before an object-term relationship is deleted. 3078 * 3079 * @since 2.9.0 3080 * @since 4.7.0 Added the `$taxonomy` parameter. 3081 * 3082 * @param int $object_id Object ID. 3083 * @param array $tt_ids An array of term taxonomy IDs. 3084 * @param string $taxonomy Taxonomy slug. 3085 */ 3086 do_action( 'delete_term_relationships', $object_id, $tt_ids, $taxonomy ); 3087 3088 $deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) ); 3089 3090 wp_cache_delete( $object_id, $taxonomy . '_relationships' ); 3091 wp_cache_set_terms_last_changed(); 3092 3093 /** 3094 * Fires immediately after an object-term relationship is deleted. 3095 * 3096 * @since 2.9.0 3097 * @since 4.7.0 Added the `$taxonomy` parameter. 3098 * 3099 * @param int $object_id Object ID. 3100 * @param array $tt_ids An array of term taxonomy IDs. 3101 * @param string $taxonomy Taxonomy slug. 3102 */ 3103 do_action( 'deleted_term_relationships', $object_id, $tt_ids, $taxonomy ); 3104 3105 wp_update_term_count( $tt_ids, $taxonomy ); 3106 3107 return (bool) $deleted; 3108 } 3109 3110 return false; 3111 } 3112 3113 /** 3114 * Makes term slug unique, if it isn't already. 3115 * 3116 * The `$slug` has to be unique global to every taxonomy, meaning that one 3117 * taxonomy term can't have a matching slug with another taxonomy term. Each 3118 * slug has to be globally unique for every taxonomy. 3119 * 3120 * The way this works is that if the taxonomy that the term belongs to is 3121 * hierarchical and has a parent, it will append that parent to the $slug. 3122 * 3123 * If that still doesn't return a unique slug, then it tries to append a number 3124 * until it finds a number that is truly unique. 3125 * 3126 * The only purpose for `$term` is for appending a parent, if one exists. 3127 * 3128 * @since 2.3.0 3129 * 3130 * @global wpdb $wpdb WordPress database abstraction object. 3131 * 3132 * @param string $slug The string that will be tried for a unique slug. 3133 * @param object $term The term object that the `$slug` will belong to. 3134 * @return string Will return a true unique slug. 3135 */ 3136 function wp_unique_term_slug( $slug, $term ) { 3137 global $wpdb; 3138 3139 $needs_suffix = true; 3140 $original_slug = $slug; 3141 3142 // As of 4.1, duplicate slugs are allowed as long as they're in different taxonomies. 3143 if ( ! term_exists( $slug ) || get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) { 3144 $needs_suffix = false; 3145 } 3146 3147 /* 3148 * If the taxonomy supports hierarchy and the term has a parent, make the slug unique 3149 * by incorporating parent slugs. 3150 */ 3151 $parent_suffix = ''; 3152 if ( $needs_suffix && is_taxonomy_hierarchical( $term->taxonomy ) && ! empty( $term->parent ) ) { 3153 $the_parent = $term->parent; 3154 while ( ! empty( $the_parent ) ) { 3155 $parent_term = get_term( $the_parent, $term->taxonomy ); 3156 if ( is_wp_error( $parent_term ) || empty( $parent_term ) ) { 3157 break; 3158 } 3159 $parent_suffix .= '-' . $parent_term->slug; 3160 if ( ! term_exists( $slug . $parent_suffix ) ) { 3161 break; 3162 } 3163 3164 if ( empty( $parent_term->parent ) ) { 3165 break; 3166 } 3167 $the_parent = $parent_term->parent; 3168 } 3169 } 3170 3171 // If we didn't get a unique slug, try appending a number to make it unique. 3172 3173 /** 3174 * Filters whether the proposed unique term slug is bad. 3175 * 3176 * @since 4.3.0 3177 * 3178 * @param bool $needs_suffix Whether the slug needs to be made unique with a suffix. 3179 * @param string $slug The slug. 3180 * @param object $term Term object. 3181 */ 3182 if ( apply_filters( 'wp_unique_term_slug_is_bad_slug', $needs_suffix, $slug, $term ) ) { 3183 if ( $parent_suffix ) { 3184 $slug .= $parent_suffix; 3185 } 3186 3187 if ( ! empty( $term->term_id ) ) { 3188 $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id ); 3189 } else { 3190 $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug ); 3191 } 3192 3193 if ( $wpdb->get_var( $query ) ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared 3194 $num = 2; 3195 do { 3196 $alt_slug = $slug . "-$num"; 3197 ++$num; 3198 $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) ); 3199 } while ( $slug_check ); 3200 $slug = $alt_slug; 3201 } 3202 } 3203 3204 /** 3205 * Filters the unique term slug. 3206 * 3207 * @since 4.3.0 3208 * 3209 * @param string $slug Unique term slug. 3210 * @param object $term Term object. 3211 * @param string $original_slug Slug originally passed to the function for testing. 3212 */ 3213 return apply_filters( 'wp_unique_term_slug', $slug, $term, $original_slug ); 3214 } 3215 3216 /** 3217 * Updates term based on arguments provided. 3218 * 3219 * The `$args` will indiscriminately override all values with the same field name. 3220 * Care must be taken to not override important information need to update or 3221 * update will fail (or perhaps create a new term, neither would be acceptable). 3222 * 3223 * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not 3224 * defined in `$args` already. 3225 * 3226 * 'alias_of' will create a term group, if it doesn't already exist, and 3227 * update it for the `$term`. 3228 * 3229 * If the 'slug' argument in `$args` is missing, then the 'name' will be used. 3230 * If you set 'slug' and it isn't unique, then a WP_Error is returned. 3231 * If you don't pass any slug, then a unique one will be created. 3232 * 3233 * @since 2.3.0 3234 * 3235 * @global wpdb $wpdb WordPress database abstraction object. 3236 * 3237 * @param int $term_id The ID of the term. 3238 * @param string $taxonomy The taxonomy of the term. 3239 * @param array $args { 3240 * Optional. Array of arguments for updating a term. 3241 * 3242 * @type string $alias_of Slug of the term to make this term an alias of. 3243 * Default empty string. Accepts a term slug. 3244 * @type string $description The term description. Default empty string. 3245 * @type int $parent The id of the parent term. Default 0. 3246 * @type string $slug The term slug to use. Default empty string. 3247 * } 3248 * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`, 3249 * WP_Error otherwise. 3250 * @phpstan-param array{ 3251 * alias_of?: string, 3252 * description?: string, 3253 * parent?: non-negative-int, 3254 * slug?: string|null, 3255 * ... 3256 * } $args 3257 * @phpstan-return array{ 3258 * term_id: int, 3259 * term_taxonomy_id: int, 3260 * }|WP_Error 3261 */ 3262 function wp_update_term( $term_id, $taxonomy, $args = array() ) { 3263 global $wpdb; 3264 3265 if ( ! taxonomy_exists( $taxonomy ) ) { 3266 return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) ); 3267 } 3268 3269 $term_id = (int) $term_id; 3270 3271 // First, get all of the original args. 3272 $term = get_term( $term_id, $taxonomy ); 3273 3274 if ( is_wp_error( $term ) ) { 3275 return $term; 3276 } 3277 3278 if ( ! $term ) { 3279 return new WP_Error( 'invalid_term', __( 'Empty Term.' ) ); 3280 } 3281 3282 $term = (array) $term->data; 3283 3284 // Escape data pulled from DB. 3285 $term = wp_slash( $term ); 3286 3287 // Merge old and new args with new args overwriting old ones. 3288 $args = array_merge( $term, $args ); 3289 3290 $defaults = array( 3291 'alias_of' => '', 3292 'description' => '', 3293 'parent' => 0, 3294 'slug' => '', 3295 ); 3296 $args = wp_parse_args( $args, $defaults ); 3297 $args = sanitize_term( $args, $taxonomy, 'db' ); 3298 $parsed_args = $args; 3299 3300 // expected_slashed ($name) 3301 $name = wp_unslash( $args['name'] ); 3302 $description = wp_unslash( $args['description'] ); 3303 3304 $parsed_args['name'] = $name; 3305 $parsed_args['description'] = $description; 3306 3307 if ( '' === trim( $name ) ) { 3308 return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) ); 3309 } 3310 3311 if ( (int) $parsed_args['parent'] > 0 && ! term_exists( (int) $parsed_args['parent'] ) ) { 3312 return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) ); 3313 } 3314 3315 $empty_slug = false; 3316 if ( empty( $args['slug'] ) ) { 3317 $empty_slug = true; 3318 $slug = sanitize_title( $name ); 3319 } else { 3320 $slug = $args['slug']; 3321 } 3322 3323 $parsed_args['slug'] = $slug; 3324 3325 $term_group = $parsed_args['term_group'] ?? 0; 3326 if ( $args['alias_of'] ) { 3327 $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy ); 3328 if ( ! empty( $alias->term_group ) ) { 3329 // The alias we want is already in a group, so let's use that one. 3330 $term_group = $alias->term_group; 3331 } elseif ( ! empty( $alias->term_id ) ) { 3332 /* 3333 * The alias is not in a group, so we create a new one 3334 * and add the alias to it. 3335 */ 3336 $term_group = $wpdb->get_var( "SELECT MAX(term_group) FROM $wpdb->terms" ) + 1; 3337 3338 wp_update_term( 3339 $alias->term_id, 3340 $taxonomy, 3341 array( 3342 'term_group' => $term_group, 3343 ) 3344 ); 3345 } 3346 3347 $parsed_args['term_group'] = $term_group; 3348 } 3349 3350 /** 3351 * Filters the term parent. 3352 * 3353 * Hook to this filter to see if it will cause a hierarchy loop. 3354 * 3355 * @since 3.1.0 3356 * 3357 * @param int $parent_term ID of the parent term. 3358 * @param int $term_id Term ID. 3359 * @param string $taxonomy Taxonomy slug. 3360 * @param array $parsed_args An array of potentially altered update arguments for the given term. 3361 * @param array $args Arguments passed to wp_update_term(). 3362 */ 3363 $parent = (int) apply_filters( 'wp_update_term_parent', $args['parent'], $term_id, $taxonomy, $parsed_args, $args ); 3364 3365 // Check for duplicate slug. 3366 $duplicate = get_term_by( 'slug', $slug, $taxonomy ); 3367 if ( $duplicate && $duplicate->term_id !== $term_id ) { 3368 /* 3369 * If an empty slug was passed or the parent changed, reset the slug to something unique. 3370 * Otherwise, bail. 3371 */ 3372 if ( $empty_slug || ( $parent !== (int) $term['parent'] ) ) { 3373 $slug = wp_unique_term_slug( $slug, (object) $args ); 3374 } else { 3375 /* translators: %s: Taxonomy term slug. */ 3376 return new WP_Error( 'duplicate_term_slug', sprintf( __( 'The slug “%s” is already in use by another term.' ), $slug ) ); 3377 } 3378 } 3379 3380 $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 ) ); 3381 3382 // Check whether this is a shared term that needs splitting. 3383 $_term_id = _split_shared_term( $term_id, $tt_id ); 3384 if ( ! is_wp_error( $_term_id ) ) { 3385 $term_id = $_term_id; 3386 } 3387 3388 /** 3389 * Fires immediately before the given terms are edited. 3390 * 3391 * @since 2.9.0 3392 * @since 6.1.0 The `$args` parameter was added. 3393 * 3394 * @param int $term_id Term ID. 3395 * @param string $taxonomy Taxonomy slug. 3396 * @param array $args Arguments passed to wp_update_term(). 3397 */ 3398 do_action( 'edit_terms', $term_id, $taxonomy, $args ); 3399 3400 $data = compact( 'name', 'slug', 'term_group' ); 3401 3402 /** 3403 * Filters term data before it is updated in the database. 3404 * 3405 * @since 4.7.0 3406 * 3407 * @param array $data Term data to be updated. 3408 * @param int $term_id Term ID. 3409 * @param string $taxonomy Taxonomy slug. 3410 * @param array $args Arguments passed to wp_update_term(). 3411 */ 3412 $data = apply_filters( 'wp_update_term_data', $data, $term_id, $taxonomy, $args ); 3413 3414 $wpdb->update( $wpdb->terms, $data, compact( 'term_id' ) ); 3415 3416 if ( empty( $slug ) ) { 3417 $slug = sanitize_title( $name, $term_id ); 3418 $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) ); 3419 } 3420 3421 /** 3422 * Fires immediately after a term is updated in the database, but before its 3423 * term-taxonomy relationship is updated. 3424 * 3425 * @since 2.9.0 3426 * @since 6.1.0 The `$args` parameter was added. 3427 * 3428 * @param int $term_id Term ID. 3429 * @param string $taxonomy Taxonomy slug. 3430 * @param array $args Arguments passed to wp_update_term(). 3431 */ 3432 do_action( 'edited_terms', $term_id, $taxonomy, $args ); 3433 3434 /** 3435 * Fires immediate before a term-taxonomy relationship is updated. 3436 * 3437 * @since 2.9.0 3438 * @since 6.1.0 The `$args` parameter was added. 3439 * 3440 * @param int $tt_id Term taxonomy ID. 3441 * @param string $taxonomy Taxonomy slug. 3442 * @param array $args Arguments passed to wp_update_term(). 3443 */ 3444 do_action( 'edit_term_taxonomy', $tt_id, $taxonomy, $args ); 3445 3446 $wpdb->update( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ), array( 'term_taxonomy_id' => $tt_id ) ); 3447 3448 /** 3449 * Fires immediately after a term-taxonomy relationship is updated. 3450 * 3451 * @since 2.9.0 3452 * @since 6.1.0 The `$args` parameter was added. 3453 * 3454 * @param int $tt_id Term taxonomy ID. 3455 * @param string $taxonomy Taxonomy slug. 3456 * @param array $args Arguments passed to wp_update_term(). 3457 */ 3458 do_action( 'edited_term_taxonomy', $tt_id, $taxonomy, $args ); 3459 3460 /** 3461 * Fires after a term has been updated, but before the term cache has been cleaned. 3462 * 3463 * The {@see 'edit_$taxonomy'} hook is also available for targeting a specific 3464 * taxonomy. 3465 * 3466 * @since 2.3.0 3467 * @since 6.1.0 The `$args` parameter was added. 3468 * 3469 * @param int $term_id Term ID. 3470 * @param int $tt_id Term taxonomy ID. 3471 * @param string $taxonomy Taxonomy slug. 3472 * @param array $args Arguments passed to wp_update_term(). 3473 */ 3474 do_action( 'edit_term', $term_id, $tt_id, $taxonomy, $args ); 3475 3476 /** 3477 * Fires after a term in a specific taxonomy has been updated, but before the term 3478 * cache has been cleaned. 3479 * 3480 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 3481 * 3482 * Possible hook names include: 3483 * 3484 * - `edit_category` 3485 * - `edit_post_tag` 3486 * 3487 * @since 2.3.0 3488 * @since 6.1.0 The `$args` parameter was added. 3489 * 3490 * @param int $term_id Term ID. 3491 * @param int $tt_id Term taxonomy ID. 3492 * @param array $args Arguments passed to wp_update_term(). 3493 */ 3494 do_action( "edit_{$taxonomy}", $term_id, $tt_id, $args ); 3495 3496 /** This filter is documented in wp-includes/taxonomy.php */ 3497 $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id ); 3498 3499 clean_term_cache( $term_id, $taxonomy ); 3500 3501 /** 3502 * Fires after a term has been updated, and the term cache has been cleaned. 3503 * 3504 * The {@see 'edited_$taxonomy'} hook is also available for targeting a specific 3505 * taxonomy. 3506 * 3507 * @since 2.3.0 3508 * @since 6.1.0 The `$args` parameter was added. 3509 * 3510 * @param int $term_id Term ID. 3511 * @param int $tt_id Term taxonomy ID. 3512 * @param string $taxonomy Taxonomy slug. 3513 * @param array $args Arguments passed to wp_update_term(). 3514 */ 3515 do_action( 'edited_term', $term_id, $tt_id, $taxonomy, $args ); 3516 3517 /** 3518 * Fires after a term for a specific taxonomy has been updated, and the term 3519 * cache has been cleaned. 3520 * 3521 * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug. 3522 * 3523 * Possible hook names include: 3524 * 3525 * - `edited_category` 3526 * - `edited_post_tag` 3527 * 3528 * @since 2.3.0 3529 * @since 6.1.0 The `$args` parameter was added. 3530 * 3531 * @param int $term_id Term ID. 3532 * @param int $tt_id Term taxonomy ID. 3533 * @param array $args Arguments passed to wp_update_term(). 3534 */ 3535 do_action( "edited_{$taxonomy}", $term_id, $tt_id, $args ); 3536 3537 /** This action is documented in wp-includes/taxonomy.php */ 3538 do_action( 'saved_term', $term_id, $tt_id, $taxonomy, true, $args ); 3539 3540 /** This action is documented in wp-includes/taxonomy.php */ 3541 do_action( "saved_{$taxonomy}", $term_id, $tt_id, true, $args ); 3542 3543 return array( 3544 'term_id' => $term_id, 3545 'term_taxonomy_id' => $tt_id, 3546 ); 3547 } 3548 3549 /** 3550 * Enables or disables term counting. 3551 * 3552 * @since 2.5.0 3553 * 3554 * @param bool $defer Optional. Enable if true, disable if false. 3555 * @return bool Whether term counting is enabled or disabled. 3556 */ 3557 function wp_defer_term_counting( $defer = null ) { 3558 static $_defer = false; 3559 3560 if ( is_bool( $defer ) ) { 3561 $_defer = $defer; 3562 // Flush any deferred counts. 3563 if ( ! $defer ) { 3564 wp_update_term_count( null, null, true ); 3565 } 3566 } 3567 3568 return $_defer; 3569 } 3570 3571 /** 3572 * Updates the amount of terms in taxonomy. 3573 * 3574 * If there is a taxonomy callback applied, then it will be called for updating 3575 * the count. 3576 * 3577 * The default action is to count what the amount of terms have the relationship 3578 * of term ID. Once that is done, then update the database. 3579 * 3580 * @since 2.3.0 3581 * 3582 * @param int|array $terms The term_taxonomy_id of the terms. 3583 * @param string $taxonomy The context of the term. 3584 * @param bool $do_deferred Whether to flush the deferred term counts too. Default false. 3585 * @return bool If no terms will return false, and if successful will return true. 3586 */ 3587 function wp_update_term_count( $terms, $taxonomy, $do_deferred = false ) { 3588 static $_deferred = array(); 3589 3590 if ( $do_deferred ) { 3591 foreach ( (array) array_keys( $_deferred ) as $tax ) { 3592 wp_update_term_count_now( $_deferred[ $tax ], $tax ); 3593 unset( $_deferred[ $tax ] ); 3594 } 3595 } 3596 3597 if ( empty( $terms ) ) { 3598 return false; 3599 } 3600 3601 if ( ! is_array( $terms ) ) { 3602 $terms = array( $terms ); 3603 } 3604 3605 if ( wp_defer_term_counting() ) { 3606 if ( ! isset( $_deferred[ $taxonomy ] ) ) { 3607 $_deferred[ $taxonomy ] = array(); 3608 } 3609 $_deferred[ $taxonomy ] = array_unique( array_merge( $_deferred[ $taxonomy ], $terms ) ); 3610 return true; 3611 } 3612 3613 return wp_update_term_count_now( $terms, $taxonomy ); 3614 } 3615 3616 /** 3617 * Performs term count update immediately. 3618 * 3619 * @since 2.5.0 3620 * 3621 * @param array $terms The term_taxonomy_id of terms to update. 3622 * @param string $taxonomy The context of the term. 3623 * @return true Always true when complete. 3624 */ 3625 function wp_update_term_count_now( $terms, $taxonomy ) { 3626 $terms = array_map( 'intval', $terms ); 3627 3628 $taxonomy = get_taxonomy( $taxonomy ); 3629 if ( ! empty( $taxonomy->update_count_callback ) ) { 3630 call_user_func( $taxonomy->update_count_callback, $terms, $taxonomy ); 3631 } else { 3632 $object_types = (array) $taxonomy->object_type; 3633 foreach ( $object_types as &$object_type ) { 3634 if ( str_starts_with( $object_type, 'attachment:' ) ) { 3635 list( $object_type ) = explode( ':', $object_type ); 3636 } 3637 } 3638 3639 if ( array_filter( $object_types, 'post_type_exists' ) == $object_types ) { 3640 // Only post types are attached to this taxonomy. 3641 _update_post_term_count( $terms, $taxonomy ); 3642 } else { 3643 // Default count updater. 3644 _update_generic_term_count( $terms, $taxonomy ); 3645 } 3646 } 3647 3648 clean_term_cache( $terms, '', false ); 3649 3650 return true; 3651 } 3652 3653 // 3654 // Cache. 3655 // 3656 3657 /** 3658 * Removes the taxonomy relationship to terms from the cache. 3659 * 3660 * Will remove the entire taxonomy relationship containing term `$object_id`. The 3661 * term IDs have to exist within the taxonomy `$object_type` for the deletion to 3662 * take place. 3663 * 3664 * @since 2.3.0 3665 * 3666 * @global bool $_wp_suspend_cache_invalidation 3667 * 3668 * @see get_object_taxonomies() for more on $object_type. 3669 * 3670 * @param int|array $object_ids Single or list of term object ID(s). 3671 * @param array|string $object_type The taxonomy object type. 3672 */ 3673 function clean_object_term_cache( $object_ids, $object_type ) { 3674 global $_wp_suspend_cache_invalidation; 3675 3676 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 3677 return; 3678 } 3679 3680 if ( ! is_array( $object_ids ) ) { 3681 $object_ids = array( $object_ids ); 3682 } 3683 3684 $taxonomies = get_object_taxonomies( $object_type ); 3685 3686 foreach ( $taxonomies as $taxonomy ) { 3687 wp_cache_delete_multiple( $object_ids, "{$taxonomy}_relationships" ); 3688 } 3689 3690 wp_cache_set_terms_last_changed(); 3691 3692 /** 3693 * Fires after the object term cache has been cleaned. 3694 * 3695 * @since 2.5.0 3696 * 3697 * @param array $object_ids An array of object IDs. 3698 * @param string $object_type Object type. 3699 */ 3700 do_action( 'clean_object_term_cache', $object_ids, $object_type ); 3701 } 3702 3703 /** 3704 * Removes all of the term IDs from the cache. 3705 * 3706 * @since 2.3.0 3707 * 3708 * @global wpdb $wpdb WordPress database abstraction object. 3709 * @global bool $_wp_suspend_cache_invalidation 3710 * 3711 * @param int|int[] $ids Single or array of term IDs. 3712 * @param string $taxonomy Optional. Taxonomy slug. Can be empty, in which case the taxonomies of the passed 3713 * term IDs will be used. Default empty. 3714 * @param bool $clean_taxonomy Optional. Whether to clean taxonomy wide caches (true), or just individual 3715 * term object caches (false). Default true. 3716 */ 3717 function clean_term_cache( $ids, $taxonomy = '', $clean_taxonomy = true ) { 3718 global $wpdb, $_wp_suspend_cache_invalidation; 3719 3720 if ( ! empty( $_wp_suspend_cache_invalidation ) ) { 3721 return; 3722 } 3723 3724 if ( ! is_array( $ids ) ) { 3725 $ids = array( $ids ); 3726 } 3727 3728 $taxonomies = array(); 3729 // If no taxonomy, assume tt_ids. 3730 if ( empty( $taxonomy ) ) { 3731 $tt_ids = array_map( 'intval', $ids ); 3732 $tt_ids = implode( ', ', $tt_ids ); 3733 $terms = $wpdb->get_results( "SELECT term_id, taxonomy FROM $wpdb->term_taxonomy WHERE term_taxonomy_id IN ($tt_ids)" ); 3734 $ids = array(); 3735 3736 foreach ( (array) $terms as $term ) { 3737 $taxonomies[] = $term->taxonomy; 3738 $ids[] = $term->term_id; 3739 } 3740 wp_cache_delete_multiple( $ids, 'terms' ); 3741 $taxonomies = array_unique( $taxonomies ); 3742 } else { 3743 wp_cache_delete_multiple( $ids, 'terms' ); 3744 $taxonomies = array( $taxonomy ); 3745 } 3746 3747 foreach ( $taxonomies as $taxonomy ) { 3748 if ( $clean_taxonomy ) { 3749 clean_taxonomy_cache( $taxonomy ); 3750 } 3751 3752 /** 3753 * Fires once after each taxonomy's term cache has been cleaned. 3754 * 3755 * @since 2.5.0 3756 * @since 4.5.0 Added the `$clean_taxonomy` parameter. 3757 * 3758 * @param array $ids An array of term IDs. 3759 * @param string $taxonomy Taxonomy slug. 3760 * @param bool $clean_taxonomy Whether or not to clean taxonomy-wide caches 3761 */ 3762 do_action( 'clean_term_cache', $ids, $taxonomy, $clean_taxonomy ); 3763 } 3764 3765 wp_cache_set_terms_last_changed(); 3766 } 3767 3768 /** 3769 * Cleans the caches for a taxonomy. 3770 * 3771 * @since 4.9.0 3772 * 3773 * @param string $taxonomy Taxonomy slug. 3774 */ 3775 function clean_taxonomy_cache( $taxonomy ) { 3776 wp_cache_delete( 'all_ids', $taxonomy ); 3777 wp_cache_delete( 'get', $taxonomy ); 3778 wp_cache_set_terms_last_changed(); 3779 3780 // Regenerate cached hierarchy. 3781 if ( is_taxonomy_hierarchical( $taxonomy ) ) { 3782 delete_option( "{$taxonomy}_children" ); 3783 _get_term_hierarchy( $taxonomy ); 3784 } 3785 3786 /** 3787 * Fires after a taxonomy's caches have been cleaned. 3788 * 3789 * @since 4.9.0 3790 * 3791 * @param string $taxonomy Taxonomy slug. 3792 */ 3793 do_action( 'clean_taxonomy_cache', $taxonomy ); 3794 } 3795 3796 /** 3797 * Retrieves the cached term objects for the given object ID. 3798 * 3799 * Upstream functions (like get_the_terms() and is_object_in_term()) are 3800 * responsible for populating the object-term relationship cache. The current 3801 * function only fetches relationship data that is already in the cache. 3802 * 3803 * @since 2.3.0 3804 * @since 4.7.0 Returns a `WP_Error` object if there's an error with 3805 * any of the matched terms. 3806 * 3807 * @param int $id Term object ID, for example a post, comment, or user ID. 3808 * @param string $taxonomy Taxonomy name. 3809 * @return bool|WP_Term[]|WP_Error Array of `WP_Term` objects, if cached. 3810 * False if cache is empty for `$taxonomy` and `$id`. 3811 * WP_Error if get_term() returns an error object for any term. 3812 */ 3813 function get_object_term_cache( $id, $taxonomy ) { 3814 $_term_ids = wp_cache_get( $id, "{$taxonomy}_relationships" ); 3815 3816 // We leave the priming of relationship caches to upstream functions. 3817 if ( false === $_term_ids ) { 3818 return false; 3819 } 3820 3821 // Backward compatibility for if a plugin is putting objects into the cache, rather than IDs. 3822 $term_ids = array(); 3823 foreach ( $_term_ids as $term_id ) { 3824 if ( is_numeric( $term_id ) ) { 3825 $term_ids[] = (int) $term_id; 3826 } elseif ( isset( $term_id->term_id ) ) { 3827 $term_ids[] = (int) $term_id->term_id; 3828 } 3829 } 3830 3831 // Fill the term objects. 3832 _prime_term_caches( $term_ids ); 3833 3834 $terms = array(); 3835 foreach ( $term_ids as $term_id ) { 3836 $term = get_term( $term_id, $taxonomy ); 3837 if ( is_wp_error( $term ) ) { 3838 return $term; 3839 } 3840 3841 $terms[] = $term; 3842 } 3843 3844 return $terms; 3845 } 3846 3847 /** 3848 * Updates the cache for the given term object ID(s). 3849 * 3850 * Note: Due to performance concerns, great care should be taken to only update 3851 * term caches when necessary. Processing time can increase exponentially depending 3852 * on both the number of passed term IDs and the number of taxonomies those terms 3853 * belong to. 3854 * 3855 * Caches will only be updated for terms not already cached. 3856 * 3857 * @since 2.3.0 3858 * 3859 * @param string|int[] $object_ids Comma-separated list or array of term object IDs. 3860 * @param string|string[] $object_type The taxonomy object type or array of the same. 3861 * @return void|false Void on success or if the `$object_ids` parameter is empty, 3862 * false if all of the terms in `$object_ids` are already cached. 3863 */ 3864 function update_object_term_cache( $object_ids, $object_type ) { 3865 if ( empty( $object_ids ) ) { 3866 return; 3867 } 3868 3869 if ( ! is_array( $object_ids ) ) { 3870 $object_ids = explode( ',', $object_ids ); 3871 } 3872 3873 $object_ids = array_map( 'intval', $object_ids ); 3874 $non_cached_ids = array(); 3875 3876 $taxonomies = get_object_taxonomies( $object_type ); 3877 3878 foreach ( $taxonomies as $taxonomy ) { 3879 $cache_values = wp_cache_get_multiple( (array) $object_ids, "{$taxonomy}_relationships" ); 3880 3881 foreach ( $cache_values as $id => $value ) { 3882 if ( false === $value ) { 3883 $non_cached_ids[] = $id; 3884 } 3885 } 3886 } 3887 3888 if ( empty( $non_cached_ids ) ) { 3889 return false; 3890 } 3891 3892 $non_cached_ids = array_unique( $non_cached_ids ); 3893 3894 $terms = wp_get_object_terms( 3895 $non_cached_ids, 3896 $taxonomies, 3897 array( 3898 'fields' => 'all_with_object_id', 3899 'orderby' => 'name', 3900 'update_term_meta_cache' => false, 3901 ) 3902 ); 3903 3904 $object_terms = array(); 3905 foreach ( (array) $terms as $term ) { 3906 $object_terms[ $term->object_id ][ $term->taxonomy ][] = $term->term_id; 3907 } 3908 3909 foreach ( $non_cached_ids as $id ) { 3910 foreach ( $taxonomies as $taxonomy ) { 3911 if ( ! isset( $object_terms[ $id ][ $taxonomy ] ) ) { 3912 if ( ! isset( $object_terms[ $id ] ) ) { 3913 $object_terms[ $id ] = array(); 3914 } 3915 $object_terms[ $id ][ $taxonomy ] = array(); 3916 } 3917 } 3918 } 3919 3920 $cache_values = array(); 3921 foreach ( $object_terms as $id => $value ) { 3922 foreach ( $value as $taxonomy => $terms ) { 3923 $cache_values[ $taxonomy ][ $id ] = $terms; 3924 } 3925 } 3926 foreach ( $cache_values as $taxonomy => $data ) { 3927 wp_cache_add_multiple( $data, "{$taxonomy}_relationships" ); 3928 } 3929 } 3930 3931 /** 3932 * Updates terms in cache. 3933 * 3934 * @since 2.3.0 3935 * 3936 * @param WP_Term[] $terms Array of term objects to change. 3937 * @param string $taxonomy Not used. 3938 */ 3939 function update_term_cache( $terms, $taxonomy = '' ) { 3940 $data = array(); 3941 foreach ( (array) $terms as $term ) { 3942 // Create a copy in case the array was passed by reference. 3943 $_term = clone $term; 3944 3945 // Object ID should not be cached. 3946 unset( $_term->object_id ); 3947 3948 $data[ $term->term_id ] = $_term; 3949 } 3950 wp_cache_add_multiple( $data, 'terms' ); 3951 } 3952 3953 // 3954 // Private. 3955 // 3956 3957 /** 3958 * Retrieves children of taxonomy as term IDs. 3959 * 3960 * @access private 3961 * @since 2.3.0 3962 * 3963 * @param string $taxonomy Taxonomy name. 3964 * @return array Empty if $taxonomy isn't hierarchical or returns children as term IDs. 3965 */ 3966 function _get_term_hierarchy( $taxonomy ) { 3967 if ( ! is_taxonomy_hierarchical( $taxonomy ) ) { 3968 return array(); 3969 } 3970 $children = get_option( "{$taxonomy}_children" ); 3971 3972 if ( is_array( $children ) ) { 3973 return $children; 3974 } 3975 $children = array(); 3976 $terms = get_terms( 3977 array( 3978 'taxonomy' => $taxonomy, 3979 'get' => 'all', 3980 'orderby' => 'id', 3981 'fields' => 'id=>parent', 3982 'update_term_meta_cache' => false, 3983 ) 3984 ); 3985 foreach ( $terms as $term_id => $parent ) { 3986 if ( $parent > 0 ) { 3987 $children[ $parent ][] = $term_id; 3988 } 3989 } 3990 update_option( "{$taxonomy}_children", $children ); 3991 3992 return $children; 3993 } 3994 3995 /** 3996 * Gets the subset of $terms that are descendants of $term_id. 3997 * 3998 * If `$terms` is an array of objects, then _get_term_children() returns an array of objects. 3999 * If `$terms` is an array of IDs, then _get_term_children() returns an array of IDs. 4000 * 4001 * @access private 4002 * @since 2.3.0 4003 * 4004 * @param int $term_id The ancestor term: all returned terms should be descendants of `$term_id`. 4005 * @param array $terms The set of terms - either an array of term objects or term IDs - from which those that 4006 * are descendants of $term_id will be chosen. 4007 * @param string $taxonomy The taxonomy which determines the hierarchy of the terms. 4008 * @param array $ancestors Optional. Term ancestors that have already been identified. Passed by reference, to keep 4009 * track of found terms when recursing the hierarchy. The array of located ancestors is used 4010 * to prevent infinite recursion loops. For performance, `term_ids` are used as array keys, 4011 * with 1 as value. Default empty array. 4012 * @return array|WP_Error The subset of $terms that are descendants of $term_id. 4013 */ 4014 function _get_term_children( $term_id, $terms, $taxonomy, &$ancestors = array() ) { 4015 $empty_array = array(); 4016 if ( empty( $terms ) ) { 4017 return $empty_array; 4018 } 4019 4020 $term_id = (int) $term_id; 4021 $term_list = array(); 4022 $has_children = _get_term_hierarchy( $taxonomy ); 4023 4024 if ( $term_id && ! isset( $has_children[ $term_id ] ) ) { 4025 return $empty_array; 4026 } 4027 4028 // Include the term itself in the ancestors array, so we can properly detect when a loop has occurred. 4029 if ( empty( $ancestors ) ) { 4030 $ancestors[ $term_id ] = 1; 4031 } 4032 4033 foreach ( (array) $terms as $term ) { 4034 $use_id = false; 4035 if ( ! is_object( $term ) ) { 4036 $term = get_term( $term, $taxonomy ); 4037 if ( is_wp_error( $term ) ) { 4038 return $term; 4039 } 4040 $use_id = true; 4041 } 4042 4043 // Don't recurse if we've already identified the term as a child - this indicates a loop. 4044 if ( isset( $ancestors[ $term->term_id ] ) ) { 4045 continue; 4046 } 4047 4048 if ( (int) $term->parent === $term_id ) { 4049 if ( $use_id ) { 4050 $term_list[] = $term->term_id; 4051 } else { 4052 $term_list[] = $term; 4053 } 4054 4055 if ( ! isset( $has_children[ $term->term_id ] ) ) { 4056 continue; 4057 } 4058 4059 $ancestors[ $term->term_id ] = 1; 4060 4061 $children = _get_term_children( $term->term_id, $terms, $taxonomy, $ancestors ); 4062 if ( $children ) { 4063 $term_list = array_merge( $term_list, $children ); 4064 } 4065 } 4066 } 4067 4068 return $term_list; 4069 } 4070 4071 /** 4072 * Adds count of children to parent count. 4073 * 4074 * Recalculates term counts by including items from child terms. Assumes all 4075 * relevant children are already in the $terms argument. 4076 * 4077 * @access private 4078 * @since 2.3.0 4079 * 4080 * @global wpdb $wpdb WordPress database abstraction object. 4081 * 4082 * @param object[]|WP_Term[] $terms List of term objects (passed by reference). 4083 * @param string $taxonomy Term context. 4084 */ 4085 function _pad_term_counts( &$terms, $taxonomy ) { 4086 global $wpdb; 4087 4088 // This function only works for hierarchical taxonomies like post categories. 4089 if ( ! is_taxonomy_hierarchical( $taxonomy ) ) { 4090 return; 4091 } 4092 4093 $term_hier = _get_term_hierarchy( $taxonomy ); 4094 4095 if ( empty( $term_hier ) ) { 4096 return; 4097 } 4098 4099 $term_items = array(); 4100 $terms_by_id = array(); 4101 $term_ids = array(); 4102 4103 foreach ( (array) $terms as $key => $term ) { 4104 $terms_by_id[ $term->term_id ] = & $terms[ $key ]; 4105 $term_ids[ $term->term_taxonomy_id ] = $term->term_id; 4106 } 4107 4108 // Get the object and term IDs and stick them in a lookup table. 4109 $tax_obj = get_taxonomy( $taxonomy ); 4110 $object_types = esc_sql( $tax_obj->object_type ); 4111 $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'" ); 4112 4113 foreach ( $results as $row ) { 4114 $id = $term_ids[ $row->term_taxonomy_id ]; 4115 4116 $term_items[ $id ][ $row->object_id ] = isset( $term_items[ $id ][ $row->object_id ] ) ? ++$term_items[ $id ][ $row->object_id ] : 1; 4117 } 4118 4119 // Touch every ancestor's lookup row for each post in each term. 4120 foreach ( $term_ids as $term_id ) { 4121 $child = $term_id; 4122 $ancestors = array(); 4123 while ( ! empty( $terms_by_id[ $child ] ) && $parent = $terms_by_id[ $child ]->parent ) { 4124 $ancestors[] = $child; 4125 4126 if ( ! empty( $term_items[ $term_id ] ) ) { 4127 foreach ( $term_items[ $term_id ] as $item_id => $touches ) { 4128 $term_items[ $parent ][ $item_id ] = isset( $term_items[ $parent ][ $item_id ] ) ? ++$term_items[ $parent ][ $item_id ] : 1; 4129 } 4130 } 4131 4132 $child = $parent; 4133 4134 if ( in_array( $parent, $ancestors, true ) ) { 4135 break; 4136 } 4137 } 4138 } 4139 4140 // Transfer the touched cells. 4141 foreach ( (array) $term_items as $id => $items ) { 4142 if ( isset( $terms_by_id[ $id ] ) ) { 4143 $terms_by_id[ $id ]->count = count( $items ); 4144 } 4145 } 4146 } 4147 4148 /** 4149 * Adds any terms from the given IDs to the cache that do not already exist in cache. 4150 * 4151 * @since 4.6.0 4152 * @since 6.1.0 This function is no longer marked as "private". 4153 * @since 6.3.0 Use wp_lazyload_term_meta() for lazy-loading of term meta. 4154 * 4155 * @global wpdb $wpdb WordPress database abstraction object. 4156 * 4157 * @param array $term_ids Array of term IDs. 4158 * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true. 4159 */ 4160 function _prime_term_caches( $term_ids, $update_meta_cache = true ) { 4161 global $wpdb; 4162 4163 $non_cached_ids = _get_non_cached_ids( $term_ids, 'terms' ); 4164 if ( ! empty( $non_cached_ids ) ) { 4165 $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 ) ) ) ); 4166 4167 update_term_cache( $fresh_terms ); 4168 } 4169 4170 if ( $update_meta_cache ) { 4171 wp_lazyload_term_meta( $term_ids ); 4172 } 4173 } 4174 4175 // 4176 // Default callbacks. 4177 // 4178 4179 /** 4180 * Updates term count based on object types of the current taxonomy. 4181 * 4182 * Private function for the default callback for post_tag and category 4183 * taxonomies. 4184 * 4185 * @access private 4186 * @since 2.3.0 4187 * 4188 * @global wpdb $wpdb WordPress database abstraction object. 4189 * 4190 * @param int[] $terms List of term taxonomy IDs. 4191 * @param WP_Taxonomy $taxonomy Current taxonomy object of terms. 4192 */ 4193 function _update_post_term_count( $terms, $taxonomy ) { 4194 global $wpdb; 4195 4196 $object_types = (array) $taxonomy->object_type; 4197 4198 foreach ( $object_types as &$object_type ) { 4199 list( $object_type ) = explode( ':', $object_type ); 4200 } 4201 4202 $object_types = array_unique( $object_types ); 4203 4204 $check_attachments = array_search( 'attachment', $object_types, true ); 4205 if ( false !== $check_attachments ) { 4206 unset( $object_types[ $check_attachments ] ); 4207 $check_attachments = true; 4208 } 4209 4210 if ( $object_types ) { 4211 $object_types = esc_sql( array_filter( $object_types, 'post_type_exists' ) ); 4212 } 4213 4214 $post_statuses = array( 'publish' ); 4215 4216 /** 4217 * Filters the post statuses for updating the term count. 4218 * 4219 * @since 5.7.0 4220 * 4221 * @param string[] $post_statuses List of post statuses to include in the count. Default is 'publish'. 4222 * @param WP_Taxonomy $taxonomy Current taxonomy object. 4223 */ 4224 $post_statuses = esc_sql( apply_filters( 'update_post_term_count_statuses', $post_statuses, $taxonomy ) ); 4225 4226 foreach ( (array) $terms as $tt_id ) { 4227 $count = 0; 4228 4229 // Attachments can be 'inherit' status, we need to base count off the parent's status if so. 4230 if ( $check_attachments ) { 4231 // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration 4232 $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", $tt_id ) ); 4233 } 4234 4235 if ( $object_types ) { 4236 // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.QuotedDynamicPlaceholderGeneration 4237 $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", $tt_id ) ); 4238 } 4239 4240 /** 4241 * Fires when a term count is calculated, before it is updated in the database. 4242 * 4243 * @since 6.9.0 4244 * 4245 * @param int $tt_id Term taxonomy ID. 4246 * @param string $taxonomy_name Taxonomy slug. 4247 * @param int $count Term count. 4248 */ 4249 do_action( 'update_term_count', $tt_id, $taxonomy->name, $count ); 4250 4251 /** This action is documented in wp-includes/taxonomy.php */ 4252 do_action( 'edit_term_taxonomy', $tt_id, $taxonomy->name ); 4253 $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $tt_id ) ); 4254 4255 /** This action is documented in wp-includes/taxonomy.php */ 4256 do_action( 'edited_term_taxonomy', $tt_id, $taxonomy->name ); 4257 } 4258 } 4259 4260 /** 4261 * Updates term count based on number of objects. 4262 * 4263 * Default callback for the 'link_category' taxonomy. 4264 * 4265 * @since 3.3.0 4266 * 4267 * @global wpdb $wpdb WordPress database abstraction object. 4268 * 4269 * @param int[] $terms List of term taxonomy IDs. 4270 * @param WP_Taxonomy $taxonomy Current taxonomy object of terms. 4271 */ 4272 function _update_generic_term_count( $terms, $taxonomy ) { 4273 global $wpdb; 4274 4275 foreach ( (array) $terms as $term ) { 4276 $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term ) ); 4277 4278 /** This action is documented in wp-includes/taxonomy.php */ 4279 do_action( 'update_term_count', $term, $taxonomy->name, $count ); 4280 4281 /** This action is documented in wp-includes/taxonomy.php */ 4282 do_action( 'edit_term_taxonomy', $term, $taxonomy->name ); 4283 $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) ); 4284 4285 /** This action is documented in wp-includes/taxonomy.php */ 4286 do_action( 'edited_term_taxonomy', $term, $taxonomy->name ); 4287 } 4288 } 4289 4290 /** 4291 * Creates a new term for a term_taxonomy item that currently shares its term 4292 * with another term_taxonomy. 4293 * 4294 * @ignore 4295 * @since 4.2.0 4296 * @since 4.3.0 Introduced `$record` parameter. Also, `$term_id` and 4297 * `$term_taxonomy_id` can now accept objects. 4298 * 4299 * @global wpdb $wpdb WordPress database abstraction object. 4300 * 4301 * @param int|object $term_id ID of the shared term, or the shared term object. 4302 * @param int|object $term_taxonomy_id ID of the term_taxonomy item to receive a new term, or the term_taxonomy object 4303 * (corresponding to a row from the term_taxonomy table). 4304 * @param bool $record Whether to record data about the split term in the options table. The recording 4305 * process has the potential to be resource-intensive, so during batch operations 4306 * it can be beneficial to skip inline recording and do it just once, after the 4307 * batch is processed. Only set this to `false` if you know what you are doing. 4308 * Default: true. 4309 * @return int|WP_Error When the current term does not need to be split (or cannot be split on the current 4310 * database schema), `$term_id` is returned. When the term is successfully split, the 4311 * new term_id is returned. A WP_Error is returned for miscellaneous errors. 4312 */ 4313 function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) { 4314 global $wpdb; 4315 4316 if ( is_object( $term_id ) ) { 4317 $shared_term = $term_id; 4318 $term_id = (int) $shared_term->term_id; 4319 } 4320 4321 if ( is_object( $term_taxonomy_id ) ) { 4322 $term_taxonomy = $term_taxonomy_id; 4323 $term_taxonomy_id = (int) $term_taxonomy->term_taxonomy_id; 4324 } 4325 4326 // If there are no shared term_taxonomy rows, there's nothing to do here. 4327 $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 ) ); 4328 4329 if ( ! $shared_tt_count ) { 4330 return $term_id; 4331 } 4332 4333 /* 4334 * Verify that the term_taxonomy_id passed to the function is actually associated with the term_id. 4335 * If there's a mismatch, it may mean that the term is already split. Return the actual term_id from the db. 4336 */ 4337 $check_term_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) ); 4338 if ( $check_term_id !== $term_id ) { 4339 return $check_term_id; 4340 } 4341 4342 // Pull up data about the currently shared slug, which we'll use to populate the new one. 4343 if ( empty( $shared_term ) ) { 4344 $shared_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.* FROM $wpdb->terms t WHERE t.term_id = %d", $term_id ) ); 4345 } 4346 4347 $new_term_data = array( 4348 'name' => $shared_term->name, 4349 'slug' => $shared_term->slug, 4350 'term_group' => $shared_term->term_group, 4351 ); 4352 4353 if ( false === $wpdb->insert( $wpdb->terms, $new_term_data ) ) { 4354 return new WP_Error( 'db_insert_error', __( 'Could not split shared term.' ), $wpdb->last_error ); 4355 } 4356 4357 $new_term_id = (int) $wpdb->insert_id; 4358 4359 // Update the existing term_taxonomy to point to the newly created term. 4360 $wpdb->update( 4361 $wpdb->term_taxonomy, 4362 array( 'term_id' => $new_term_id ), 4363 array( 'term_taxonomy_id' => $term_taxonomy_id ) 4364 ); 4365 4366 // Reassign child terms to the new parent. 4367 if ( empty( $term_taxonomy ) ) { 4368 $term_taxonomy = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) ); 4369 } 4370 4371 $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 ) ); 4372 if ( ! empty( $children_tt_ids ) ) { 4373 foreach ( $children_tt_ids as $child_tt_id ) { 4374 $wpdb->update( 4375 $wpdb->term_taxonomy, 4376 array( 'parent' => $new_term_id ), 4377 array( 'term_taxonomy_id' => $child_tt_id ) 4378 ); 4379 clean_term_cache( (int) $child_tt_id, '', false ); 4380 } 4381 } else { 4382 // If the term has no children, we must force its taxonomy cache to be rebuilt separately. 4383 clean_term_cache( $new_term_id, $term_taxonomy->taxonomy, false ); 4384 } 4385 4386 clean_term_cache( $term_id, $term_taxonomy->taxonomy, false ); 4387 4388 /* 4389 * Taxonomy cache clearing is delayed to avoid race conditions that may occur when 4390 * regenerating the taxonomy's hierarchy tree. 4391 */ 4392 $taxonomies_to_clean = array( $term_taxonomy->taxonomy ); 4393 4394 // Clean the cache for term taxonomies formerly shared with the current term. 4395 $shared_term_taxonomies = $wpdb->get_col( $wpdb->prepare( "SELECT taxonomy FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) ); 4396 $taxonomies_to_clean = array_merge( $taxonomies_to_clean, $shared_term_taxonomies ); 4397 4398 foreach ( $taxonomies_to_clean as $taxonomy_to_clean ) { 4399 clean_taxonomy_cache( $taxonomy_to_clean ); 4400 } 4401 4402 // Keep a record of term_ids that have been split, keyed by old term_id. See wp_get_split_term(). 4403 if ( $record ) { 4404 $split_term_data = get_option( '_split_terms', array() ); 4405 if ( ! isset( $split_term_data[ $term_id ] ) ) { 4406 $split_term_data[ $term_id ] = array(); 4407 } 4408 4409 $split_term_data[ $term_id ][ $term_taxonomy->taxonomy ] = $new_term_id; 4410 update_option( '_split_terms', $split_term_data ); 4411 } 4412 4413 // If we've just split the final shared term, set the "finished" flag. 4414 $shared_terms_exist = $wpdb->get_results( 4415 "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt 4416 LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id 4417 GROUP BY t.term_id 4418 HAVING term_tt_count > 1 4419 LIMIT 1" 4420 ); 4421 if ( ! $shared_terms_exist ) { 4422 update_option( 'finished_splitting_shared_terms', true ); 4423 } 4424 4425 /** 4426 * Fires after a previously shared taxonomy term is split into two separate terms. 4427 * 4428 * @since 4.2.0 4429 * 4430 * @param int $term_id ID of the formerly shared term. 4431 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4432 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4433 * @param string $taxonomy Taxonomy for the split term. 4434 */ 4435 do_action( 'split_shared_term', $term_id, $new_term_id, $term_taxonomy_id, $term_taxonomy->taxonomy ); 4436 4437 return $new_term_id; 4438 } 4439 4440 /** 4441 * Splits a batch of shared taxonomy terms. 4442 * 4443 * @since 4.3.0 4444 * 4445 * @global wpdb $wpdb WordPress database abstraction object. 4446 */ 4447 function _wp_batch_split_terms() { 4448 global $wpdb; 4449 4450 $lock_name = 'term_split.lock'; 4451 4452 // Try to lock. 4453 $lock_result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'off') /* LOCK */", $lock_name, time() ) ); 4454 4455 if ( ! $lock_result ) { 4456 $lock_result = get_option( $lock_name ); 4457 4458 // Bail if we were unable to create a lock, or if the existing lock is still valid. 4459 if ( ! $lock_result || ( $lock_result > ( time() - HOUR_IN_SECONDS ) ) ) { 4460 wp_schedule_single_event( time() + ( 5 * MINUTE_IN_SECONDS ), 'wp_split_shared_term_batch' ); 4461 return; 4462 } 4463 } 4464 4465 // Update the lock, as by this point we've definitely got a lock, just need to fire the actions. 4466 update_option( $lock_name, time() ); 4467 4468 // Get a list of shared terms (those with more than one associated row in term_taxonomy). 4469 $shared_terms = $wpdb->get_results( 4470 "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt 4471 LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id 4472 GROUP BY t.term_id 4473 HAVING term_tt_count > 1 4474 LIMIT 10" 4475 ); 4476 4477 // No more terms, we're done here. 4478 if ( ! $shared_terms ) { 4479 update_option( 'finished_splitting_shared_terms', true ); 4480 delete_option( $lock_name ); 4481 return; 4482 } 4483 4484 // Shared terms found? We'll need to run this script again. 4485 wp_schedule_single_event( time() + ( 2 * MINUTE_IN_SECONDS ), 'wp_split_shared_term_batch' ); 4486 4487 // Rekey shared term array for faster lookups. 4488 $_shared_terms = array(); 4489 foreach ( $shared_terms as $shared_term ) { 4490 $term_id = (int) $shared_term->term_id; 4491 $_shared_terms[ $term_id ] = $shared_term; 4492 } 4493 $shared_terms = $_shared_terms; 4494 4495 // Get term taxonomy data for all shared terms. 4496 $shared_term_ids = implode( ',', array_keys( $shared_terms ) ); 4497 $shared_tts = $wpdb->get_results( "SELECT * FROM {$wpdb->term_taxonomy} WHERE `term_id` IN ({$shared_term_ids})" ); 4498 4499 // Split term data recording is slow, so we do it just once, outside the loop. 4500 $split_term_data = get_option( '_split_terms', array() ); 4501 $skipped_first_term = array(); 4502 $taxonomies = array(); 4503 foreach ( $shared_tts as $shared_tt ) { 4504 $term_id = (int) $shared_tt->term_id; 4505 4506 // Don't split the first tt belonging to a given term_id. 4507 if ( ! isset( $skipped_first_term[ $term_id ] ) ) { 4508 $skipped_first_term[ $term_id ] = 1; 4509 continue; 4510 } 4511 4512 if ( ! isset( $split_term_data[ $term_id ] ) ) { 4513 $split_term_data[ $term_id ] = array(); 4514 } 4515 4516 // Keep track of taxonomies whose hierarchies need flushing. 4517 if ( ! isset( $taxonomies[ $shared_tt->taxonomy ] ) ) { 4518 $taxonomies[ $shared_tt->taxonomy ] = 1; 4519 } 4520 4521 // Split the term. 4522 $split_term_data[ $term_id ][ $shared_tt->taxonomy ] = _split_shared_term( $shared_terms[ $term_id ], $shared_tt, false ); 4523 } 4524 4525 // Rebuild the cached hierarchy for each affected taxonomy. 4526 foreach ( array_keys( $taxonomies ) as $tax ) { 4527 delete_option( "{$tax}_children" ); 4528 _get_term_hierarchy( $tax ); 4529 } 4530 4531 update_option( '_split_terms', $split_term_data ); 4532 4533 delete_option( $lock_name ); 4534 } 4535 4536 /** 4537 * In order to avoid the _wp_batch_split_terms() job being accidentally removed, 4538 * checks that it's still scheduled while we haven't finished splitting terms. 4539 * 4540 * @ignore 4541 * @since 4.3.0 4542 */ 4543 function _wp_check_for_scheduled_split_terms() { 4544 if ( ! get_option( 'finished_splitting_shared_terms' ) && ! wp_next_scheduled( 'wp_split_shared_term_batch' ) ) { 4545 wp_schedule_single_event( time() + MINUTE_IN_SECONDS, 'wp_split_shared_term_batch' ); 4546 } 4547 } 4548 4549 /** 4550 * Checks default categories when a term gets split to see if any of them need to be updated. 4551 * 4552 * @ignore 4553 * @since 4.2.0 4554 * 4555 * @param int $term_id ID of the formerly shared term. 4556 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4557 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4558 * @param string $taxonomy Taxonomy for the split term. 4559 */ 4560 function _wp_check_split_default_terms( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { 4561 if ( 'category' !== $taxonomy ) { 4562 return; 4563 } 4564 4565 foreach ( array( 'default_category', 'default_link_category', 'default_email_category' ) as $option ) { 4566 if ( (int) get_option( $option, -1 ) === $term_id ) { 4567 update_option( $option, $new_term_id ); 4568 } 4569 } 4570 } 4571 4572 /** 4573 * Checks menu items when a term gets split to see if any of them need to be updated. 4574 * 4575 * @ignore 4576 * @since 4.2.0 4577 * 4578 * @global wpdb $wpdb WordPress database abstraction object. 4579 * 4580 * @param int $term_id ID of the formerly shared term. 4581 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4582 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4583 * @param string $taxonomy Taxonomy for the split term. 4584 */ 4585 function _wp_check_split_terms_in_menus( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { 4586 global $wpdb; 4587 $post_ids = $wpdb->get_col( 4588 $wpdb->prepare( 4589 "SELECT m1.post_id 4590 FROM {$wpdb->postmeta} AS m1 4591 INNER JOIN {$wpdb->postmeta} AS m2 ON ( m2.post_id = m1.post_id ) 4592 INNER JOIN {$wpdb->postmeta} AS m3 ON ( m3.post_id = m1.post_id ) 4593 WHERE ( m1.meta_key = '_menu_item_type' AND m1.meta_value = 'taxonomy' ) 4594 AND ( m2.meta_key = '_menu_item_object' AND m2.meta_value = %s ) 4595 AND ( m3.meta_key = '_menu_item_object_id' AND m3.meta_value = %d )", 4596 $taxonomy, 4597 $term_id 4598 ) 4599 ); 4600 4601 if ( $post_ids ) { 4602 foreach ( $post_ids as $post_id ) { 4603 update_post_meta( $post_id, '_menu_item_object_id', $new_term_id, $term_id ); 4604 } 4605 } 4606 } 4607 4608 /** 4609 * If the term being split is a nav_menu, changes associations. 4610 * 4611 * @ignore 4612 * @since 4.3.0 4613 * 4614 * @param int $term_id ID of the formerly shared term. 4615 * @param int $new_term_id ID of the new term created for the $term_taxonomy_id. 4616 * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split. 4617 * @param string $taxonomy Taxonomy for the split term. 4618 */ 4619 function _wp_check_split_nav_menu_terms( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { 4620 if ( 'nav_menu' !== $taxonomy ) { 4621 return; 4622 } 4623 4624 // Update menu locations. 4625 $locations = get_nav_menu_locations(); 4626 foreach ( $locations as $location => $menu_id ) { 4627 if ( $term_id === $menu_id ) { 4628 $locations[ $location ] = $new_term_id; 4629 } 4630 } 4631 set_theme_mod( 'nav_menu_locations', $locations ); 4632 } 4633 4634 /** 4635 * Gets data about terms that previously shared a single term_id, but have since been split. 4636 * 4637 * @since 4.2.0 4638 * 4639 * @param int $old_term_id Term ID. This is the old, pre-split term ID. 4640 * @return array Array of new term IDs, keyed by taxonomy. 4641 */ 4642 function wp_get_split_terms( $old_term_id ) { 4643 $split_terms = get_option( '_split_terms', array() ); 4644 4645 $terms = array(); 4646 if ( isset( $split_terms[ $old_term_id ] ) ) { 4647 $terms = $split_terms[ $old_term_id ]; 4648 } 4649 4650 return $terms; 4651 } 4652 4653 /** 4654 * Gets the new term ID corresponding to a previously split term. 4655 * 4656 * @since 4.2.0 4657 * 4658 * @param int $old_term_id Term ID. This is the old, pre-split term ID. 4659 * @param string $taxonomy Taxonomy that the term belongs to. 4660 * @return int|false If a previously split term is found corresponding to the old term_id and taxonomy, 4661 * the new term_id will be returned. If no previously split term is found matching 4662 * the parameters, returns false. 4663 */ 4664 function wp_get_split_term( $old_term_id, $taxonomy ) { 4665 $split_terms = wp_get_split_terms( $old_term_id ); 4666 4667 $term_id = false; 4668 if ( isset( $split_terms[ $taxonomy ] ) ) { 4669 $term_id = (int) $split_terms[ $taxonomy ]; 4670 } 4671 4672 return $term_id; 4673 } 4674 4675 /** 4676 * Determines whether a term is shared between multiple taxonomies. 4677 * 4678 * Shared taxonomy terms began to be split in 4.3, but failed cron tasks or 4679 * other delays in upgrade routines may cause shared terms to remain. 4680 * 4681 * @since 4.4.0 4682 * 4683 * @global wpdb $wpdb WordPress database abstraction object. 4684 * 4685 * @param int $term_id Term ID. 4686 * @return bool Returns false if a term is not shared between multiple taxonomies or 4687 * if splitting shared taxonomy terms is finished. 4688 */ 4689 function wp_term_is_shared( $term_id ) { 4690 global $wpdb; 4691 4692 if ( get_option( 'finished_splitting_shared_terms' ) ) { 4693 return false; 4694 } 4695 4696 $tt_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) ); 4697 4698 return $tt_count > 1; 4699 } 4700 4701 /** 4702 * Generates a permalink for a taxonomy term archive. 4703 * 4704 * @since 2.5.0 4705 * 4706 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 4707 * 4708 * @param WP_Term|int|string $term The term object, ID, or slug whose link will be retrieved. 4709 * @param string $taxonomy Optional. Taxonomy. Default empty. 4710 * @return string|WP_Error URL of the taxonomy term archive on success, WP_Error if term does not exist. 4711 */ 4712 function get_term_link( $term, $taxonomy = '' ) { 4713 global $wp_rewrite; 4714 4715 if ( ! is_object( $term ) ) { 4716 if ( is_int( $term ) ) { 4717 $term = get_term( $term, $taxonomy ); 4718 } else { 4719 $term = get_term_by( 'slug', $term, $taxonomy ); 4720 } 4721 } 4722 4723 if ( ! is_object( $term ) ) { 4724 $term = new WP_Error( 'invalid_term', __( 'Empty Term.' ) ); 4725 } 4726 4727 if ( is_wp_error( $term ) ) { 4728 return $term; 4729 } 4730 4731 $taxonomy = $term->taxonomy; 4732 4733 $termlink = $wp_rewrite->get_extra_permastruct( $taxonomy ); 4734 4735 /** 4736 * Filters the permalink structure for a term before token replacement occurs. 4737 * 4738 * @since 4.9.0 4739 * 4740 * @param string $termlink The permalink structure for the term's taxonomy. 4741 * @param WP_Term $term The term object. 4742 */ 4743 $termlink = apply_filters( 'pre_term_link', $termlink, $term ); 4744 4745 $slug = $term->slug; 4746 $t = get_taxonomy( $taxonomy ); 4747 4748 if ( empty( $termlink ) ) { 4749 if ( 'category' === $taxonomy ) { 4750 $termlink = '?cat=' . $term->term_id; 4751 } elseif ( $t->query_var ) { 4752 $termlink = "?$t->query_var=$slug"; 4753 } else { 4754 $termlink = "?taxonomy=$taxonomy&term=$slug"; 4755 } 4756 $termlink = home_url( $termlink ); 4757 } else { 4758 if ( ! empty( $t->rewrite['hierarchical'] ) ) { 4759 $hierarchical_slugs = array(); 4760 $ancestors = get_ancestors( $term->term_id, $taxonomy, 'taxonomy' ); 4761 foreach ( (array) $ancestors as $ancestor ) { 4762 $ancestor_term = get_term( $ancestor, $taxonomy ); 4763 $hierarchical_slugs[] = $ancestor_term->slug; 4764 } 4765 $hierarchical_slugs = array_reverse( $hierarchical_slugs ); 4766 $hierarchical_slugs[] = $slug; 4767 $termlink = str_replace( "%$taxonomy%", implode( '/', $hierarchical_slugs ), $termlink ); 4768 } else { 4769 $termlink = str_replace( "%$taxonomy%", $slug, $termlink ); 4770 } 4771 $termlink = home_url( user_trailingslashit( $termlink, 'category' ) ); 4772 } 4773 4774 // Back compat filters. 4775 if ( 'post_tag' === $taxonomy ) { 4776 4777 /** 4778 * Filters the tag link. 4779 * 4780 * @since 2.3.0 4781 * @since 2.5.0 Deprecated in favor of {@see 'term_link'} filter. 4782 * @since 5.4.1 Restored (un-deprecated). 4783 * 4784 * @param string $termlink Tag link URL. 4785 * @param int $term_id Term ID. 4786 */ 4787 $termlink = apply_filters( 'tag_link', $termlink, $term->term_id ); 4788 } elseif ( 'category' === $taxonomy ) { 4789 4790 /** 4791 * Filters the category link. 4792 * 4793 * @since 1.5.0 4794 * @since 2.5.0 Deprecated in favor of {@see 'term_link'} filter. 4795 * @since 5.4.1 Restored (un-deprecated). 4796 * 4797 * @param string $termlink Category link URL. 4798 * @param int $term_id Term ID. 4799 */ 4800 $termlink = apply_filters( 'category_link', $termlink, $term->term_id ); 4801 } 4802 4803 /** 4804 * Filters the term link. 4805 * 4806 * @since 2.5.0 4807 * 4808 * @param string $termlink Term link URL. 4809 * @param WP_Term $term Term object. 4810 * @param string $taxonomy Taxonomy slug. 4811 */ 4812 return apply_filters( 'term_link', $termlink, $term, $taxonomy ); 4813 } 4814 4815 /** 4816 * Displays the taxonomies of a post with available options. 4817 * 4818 * This function can be used within the loop to display the taxonomies for a 4819 * post without specifying the Post ID. You can also use it outside the Loop to 4820 * display the taxonomies for a specific post. 4821 * 4822 * @since 2.5.0 4823 * 4824 * @param array $args { 4825 * Arguments about which post to use and how to format the output. Shares all of the arguments 4826 * supported by get_the_taxonomies(), in addition to the following. 4827 * 4828 * @type int|WP_Post $post Post ID or object to get taxonomies of. Default current post. 4829 * @type string $before Displays before the taxonomies. Default empty string. 4830 * @type string $sep Separates each taxonomy. Default is a space. 4831 * @type string $after Displays after the taxonomies. Default empty string. 4832 * } 4833 */ 4834 function the_taxonomies( $args = array() ) { 4835 $defaults = array( 4836 'post' => 0, 4837 'before' => '', 4838 'sep' => ' ', 4839 'after' => '', 4840 ); 4841 4842 $parsed_args = wp_parse_args( $args, $defaults ); 4843 4844 echo $parsed_args['before'] . implode( $parsed_args['sep'], get_the_taxonomies( $parsed_args['post'], $parsed_args ) ) . $parsed_args['after']; 4845 } 4846 4847 /** 4848 * Retrieves all taxonomies associated with a post. 4849 * 4850 * This function can be used within the loop. It will also return an array of 4851 * the taxonomies with links to the taxonomy and name. 4852 * 4853 * @since 2.5.0 4854 * 4855 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 4856 * @param array $args { 4857 * Optional. Arguments about how to format the list of taxonomies. Default empty array. 4858 * 4859 * @type string $template Template for displaying a taxonomy label and list of terms. 4860 * Default is "Label: Terms." 4861 * @type string $term_template Template for displaying a single term in the list. Default is the term name 4862 * linked to its archive. 4863 * } 4864 * @return string[] List of taxonomies. 4865 */ 4866 function get_the_taxonomies( $post = 0, $args = array() ) { 4867 $post = get_post( $post ); 4868 4869 $args = wp_parse_args( 4870 $args, 4871 array( 4872 /* translators: %s: Taxonomy label, %l: List of terms formatted as per $term_template. */ 4873 'template' => __( '%s: %l.' ), 4874 'term_template' => '<a href="%1$s">%2$s</a>', 4875 ) 4876 ); 4877 4878 $taxonomies = array(); 4879 4880 if ( ! $post ) { 4881 return $taxonomies; 4882 } 4883 4884 foreach ( get_object_taxonomies( $post ) as $taxonomy ) { 4885 $t = (array) get_taxonomy( $taxonomy ); 4886 if ( empty( $t['label'] ) ) { 4887 $t['label'] = $taxonomy; 4888 } 4889 if ( empty( $t['args'] ) ) { 4890 $t['args'] = array(); 4891 } 4892 if ( empty( $t['template'] ) ) { 4893 $t['template'] = $args['template']; 4894 } 4895 if ( empty( $t['term_template'] ) ) { 4896 $t['term_template'] = $args['term_template']; 4897 } 4898 4899 $terms = get_object_term_cache( $post->ID, $taxonomy ); 4900 if ( false === $terms ) { 4901 $terms = wp_get_object_terms( $post->ID, $taxonomy, $t['args'] ); 4902 } 4903 $links = array(); 4904 4905 foreach ( $terms as $term ) { 4906 $links[] = wp_sprintf( $t['term_template'], esc_attr( get_term_link( $term ) ), $term->name ); 4907 } 4908 if ( $links ) { 4909 $taxonomies[ $taxonomy ] = wp_sprintf( $t['template'], $t['label'], $links, $terms ); 4910 } 4911 } 4912 return $taxonomies; 4913 } 4914 4915 /** 4916 * Retrieves all taxonomy names for the given post. 4917 * 4918 * @since 2.5.0 4919 * 4920 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 4921 * @return string[] An array of all taxonomy names for the given post. 4922 */ 4923 function get_post_taxonomies( $post = 0 ) { 4924 $post = get_post( $post ); 4925 4926 return get_object_taxonomies( $post ); 4927 } 4928 4929 /** 4930 * Determines if the given object is associated with any of the given terms. 4931 * 4932 * The given terms are checked against the object's terms' term_ids, names and slugs. 4933 * Terms given as integers will only be checked against the object's terms' term_ids. 4934 * If no terms are given, determines if object is associated with any terms in the given taxonomy. 4935 * 4936 * @since 2.7.0 4937 * 4938 * @param int $object_id ID of the object (post ID, link ID, ...). 4939 * @param string $taxonomy Single taxonomy name. 4940 * @param int|string|int[]|string[] $terms Optional. Term ID, name, slug, or array of such 4941 * to check against. Default null. 4942 * @return bool|WP_Error WP_Error on input error. 4943 */ 4944 function is_object_in_term( $object_id, $taxonomy, $terms = null ) { 4945 $object_id = (int) $object_id; 4946 if ( ! $object_id ) { 4947 return new WP_Error( 'invalid_object', __( 'Invalid object ID.' ) ); 4948 } 4949 4950 $object_terms = get_object_term_cache( $object_id, $taxonomy ); 4951 if ( false === $object_terms ) { 4952 $object_terms = wp_get_object_terms( $object_id, $taxonomy, array( 'update_term_meta_cache' => false ) ); 4953 if ( is_wp_error( $object_terms ) ) { 4954 return $object_terms; 4955 } 4956 4957 wp_cache_set( $object_id, wp_list_pluck( $object_terms, 'term_id' ), "{$taxonomy}_relationships" ); 4958 } 4959 4960 if ( is_wp_error( $object_terms ) ) { 4961 return $object_terms; 4962 } 4963 4964 if ( empty( $object_terms ) ) { 4965 return false; 4966 } 4967 4968 if ( empty( $terms ) ) { 4969 return true; 4970 } 4971 4972 $terms = (array) $terms; 4973 4974 $ints = array_filter( $terms, 'is_int' ); 4975 if ( $ints ) { 4976 $strs = array_diff( $terms, $ints ); 4977 } else { 4978 $strs =& $terms; 4979 } 4980 4981 foreach ( $object_terms as $object_term ) { 4982 // If term is an int, check against term_ids only. 4983 if ( $ints && in_array( $object_term->term_id, $ints, true ) ) { 4984 return true; 4985 } 4986 4987 if ( $strs ) { 4988 // Only check numeric strings against term_id, to avoid false matches due to type juggling. 4989 $numeric_strs = array_map( 'intval', array_filter( $strs, 'is_numeric' ) ); 4990 if ( in_array( $object_term->term_id, $numeric_strs, true ) ) { 4991 return true; 4992 } 4993 4994 if ( in_array( $object_term->name, $strs, true ) ) { 4995 return true; 4996 } 4997 if ( in_array( $object_term->slug, $strs, true ) ) { 4998 return true; 4999 } 5000 } 5001 } 5002 5003 return false; 5004 } 5005 5006 /** 5007 * Determines if the given object type is associated with the given taxonomy. 5008 * 5009 * @since 3.0.0 5010 * 5011 * @param string $object_type Object type string. 5012 * @param string $taxonomy Single taxonomy name. 5013 * @return bool True if object is associated with the taxonomy, otherwise false. 5014 */ 5015 function is_object_in_taxonomy( $object_type, $taxonomy ) { 5016 $taxonomies = get_object_taxonomies( $object_type ); 5017 if ( empty( $taxonomies ) ) { 5018 return false; 5019 } 5020 return in_array( $taxonomy, $taxonomies, true ); 5021 } 5022 5023 /** 5024 * Gets an array of ancestor IDs for a given object. 5025 * 5026 * @since 3.1.0 5027 * @since 4.1.0 Introduced the `$resource_type` argument. 5028 * 5029 * @param int $object_id Optional. The ID of the object. Default 0. 5030 * @param string $object_type Optional. The type of object for which we'll be retrieving 5031 * ancestors. Accepts a post type or a taxonomy name. Default empty. 5032 * @param string $resource_type Optional. Type of resource $object_type is. Accepts 'post_type' 5033 * or 'taxonomy'. Default empty. 5034 * @return int[] An array of IDs of ancestors from lowest to highest in the hierarchy. 5035 */ 5036 function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) { 5037 $object_id = (int) $object_id; 5038 5039 $ancestors = array(); 5040 5041 if ( empty( $object_id ) ) { 5042 5043 /** This filter is documented in wp-includes/taxonomy.php */ 5044 return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type ); 5045 } 5046 5047 if ( ! $resource_type ) { 5048 if ( is_taxonomy_hierarchical( $object_type ) ) { 5049 $resource_type = 'taxonomy'; 5050 } elseif ( post_type_exists( $object_type ) ) { 5051 $resource_type = 'post_type'; 5052 } 5053 } 5054 5055 if ( 'taxonomy' === $resource_type ) { 5056 $term = get_term( $object_id, $object_type ); 5057 while ( ! is_wp_error( $term ) && ! empty( $term->parent ) && ! in_array( $term->parent, $ancestors, true ) ) { 5058 $ancestors[] = (int) $term->parent; 5059 $term = get_term( $term->parent, $object_type ); 5060 } 5061 } elseif ( 'post_type' === $resource_type ) { 5062 $ancestors = get_post_ancestors( $object_id ); 5063 } 5064 5065 /** 5066 * Filters a given object's ancestors. 5067 * 5068 * @since 3.1.0 5069 * @since 4.1.1 Introduced the `$resource_type` parameter. 5070 * 5071 * @param int[] $ancestors An array of IDs of object ancestors. 5072 * @param int $object_id Object ID. 5073 * @param string $object_type Type of object. 5074 * @param string $resource_type Type of resource $object_type is. 5075 */ 5076 return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type ); 5077 } 5078 5079 /** 5080 * Returns the term's parent's term ID. 5081 * 5082 * @since 3.1.0 5083 * 5084 * @param int $term_id Term ID. 5085 * @param string $taxonomy Taxonomy name. 5086 * @return int|false Parent term ID on success, false on failure. 5087 */ 5088 function wp_get_term_taxonomy_parent_id( $term_id, $taxonomy ) { 5089 $term = get_term( $term_id, $taxonomy ); 5090 if ( ! $term || is_wp_error( $term ) ) { 5091 return false; 5092 } 5093 return (int) $term->parent; 5094 } 5095 5096 /** 5097 * Checks the given subset of the term hierarchy for hierarchy loops. 5098 * Prevents loops from forming and breaks those that it finds. 5099 * 5100 * Attached to the {@see 'wp_update_term_parent'} filter. 5101 * 5102 * @since 3.1.0 5103 * 5104 * @param int $parent_term `term_id` of the parent for the term we're checking. 5105 * @param int $term_id The term we're checking. 5106 * @param string $taxonomy The taxonomy of the term we're checking. 5107 * @return int The new parent for the term. 5108 */ 5109 function wp_check_term_hierarchy_for_loops( $parent_term, $term_id, $taxonomy ) { 5110 // Nothing fancy here - bail. 5111 if ( ! $parent_term ) { 5112 return 0; 5113 } 5114 5115 // Can't be its own parent. 5116 if ( $parent_term === $term_id ) { 5117 return 0; 5118 } 5119 5120 // Now look for larger loops. 5121 $loop = wp_find_hierarchy_loop( 'wp_get_term_taxonomy_parent_id', $term_id, $parent_term, array( $taxonomy ) ); 5122 if ( ! $loop ) { 5123 return $parent_term; // No loop. 5124 } 5125 5126 // Setting $parent_term to the given value causes a loop. 5127 if ( isset( $loop[ $term_id ] ) ) { 5128 return 0; 5129 } 5130 5131 // There's a loop, but it doesn't contain $term_id. Break the loop. 5132 foreach ( array_keys( $loop ) as $loop_member ) { 5133 wp_update_term( $loop_member, $taxonomy, array( 'parent' => 0 ) ); 5134 } 5135 5136 return $parent_term; 5137 } 5138 5139 /** 5140 * Determines whether a taxonomy is considered "viewable". 5141 * 5142 * @since 5.1.0 5143 * 5144 * @param string|WP_Taxonomy $taxonomy Taxonomy name or object. 5145 * @return bool Whether the taxonomy should be considered viewable. 5146 */ 5147 function is_taxonomy_viewable( $taxonomy ) { 5148 if ( is_scalar( $taxonomy ) ) { 5149 $taxonomy = get_taxonomy( $taxonomy ); 5150 if ( ! $taxonomy ) { 5151 return false; 5152 } 5153 } 5154 5155 return $taxonomy->publicly_queryable; 5156 } 5157 5158 /** 5159 * Determines whether a term is publicly viewable. 5160 * 5161 * A term is considered publicly viewable if its taxonomy is viewable. 5162 * 5163 * @since 6.1.0 5164 * 5165 * @param int|WP_Term $term Term ID or term object. 5166 * @return bool Whether the term is publicly viewable. 5167 */ 5168 function is_term_publicly_viewable( $term ) { 5169 $term = get_term( $term ); 5170 5171 if ( ! $term ) { 5172 return false; 5173 } 5174 5175 return is_taxonomy_viewable( $term->taxonomy ); 5176 } 5177 5178 /** 5179 * Sets the last changed time for the 'terms' cache group. 5180 * 5181 * @since 5.0.0 5182 */ 5183 function wp_cache_set_terms_last_changed() { 5184 wp_cache_set_last_changed( 'terms' ); 5185 } 5186 5187 /** 5188 * Aborts calls to term meta if it is not supported. 5189 * 5190 * @since 5.0.0 5191 * 5192 * @param mixed $check Skip-value for whether to proceed term meta function execution. 5193 * @return mixed Original value of $check, or false if term meta is not supported. 5194 */ 5195 function wp_check_term_meta_support_prefilter( $check ) { 5196 if ( get_option( 'db_version' ) < 34370 ) { 5197 return false; 5198 } 5199 5200 return $check; 5201 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Wed Jul 22 08:20:19 2026 | Cross-referenced by PHPXref |