[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> taxonomy.php (source)

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


Generated: Mon Jun 17 08:20:02 2019 Cross-referenced by PHPXref 0.7