• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
  • Skip to footer
WordPress core a2z

WordPress core a2z

WordPress core only

  • Home
  • Plugins
  • Blocks
  • Shortcodes
  • APIs
  • Classes
  • Files
  • Hooks
  • Sitemap
  • Blog
Home / APIs / _split_shared_term() – Create a new term for a term_taxonomy item that currently shares its term with another term_taxonomy.

You appear to be a bot. Output may be restricted

Description

Create a new term for a term_taxonomy item that currently shares its term with another term_taxonomy.

Usage

$int|WP_Error = _split_shared_term( $term_id, $term_taxonomy_id, $record );

Parameters

$term_id
( int|object ) required – ID of the shared term, or the shared term object.
$term_taxonomy_id
( int|object ) required – ID of the term_taxonomy item to receive a new term, or the term_taxonomy object (corresponding to a row from the term_taxonomy table).
$record
( bool ) optional default: 1 – Whether to record data about the split term in the options table. The recording process has the potential to be resource-intensive, so during batch operations it can be beneficial to skip inline recording and do it just once, after the batch is processed. Only set this to false if you know what you are doing. Default: true.

Returns

int|WP_Error When the current term does not need to be split (or cannot be split on the current database schema), $term_id is returned. When the term is successfully split, the new term_id is returned. A WP_Error is returned for miscellaneous errors.

Source

File name: wordpress/wp-includes/taxonomy.php


Lines:

1 to 100 of 129
function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) {
  global $wpdb;

  if ( is_object( $term_id ) ) {
    $shared_term = $term_id;
    $term_id     = (int) $shared_term->term_id;
  }

  if ( is_object( $term_taxonomy_id ) ) {
    $term_taxonomy    = $term_taxonomy_id;
    $term_taxonomy_id = (int) $term_taxonomy->term_taxonomy_id;
  }

  // If there are no shared term_taxonomy rows, there's nothing to do here.
  $shared_tt_count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy tt WHERE tt.term_id = %d AND tt.term_taxonomy_id != %d", $term_id, $term_taxonomy_id ) );

  if ( ! $shared_tt_count ) {
    return $term_id;
  }

  /*
	 * Verify that the term_taxonomy_id passed to the function is actually associated with the term_id.
	 * If there's a mismatch, it may mean that the term is already split. Return the actual term_id from the db.
	 */
  $check_term_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );
  if ( $check_term_id !== $term_id ) {
    return $check_term_id;
  }

  // Pull up data about the currently shared slug, which we'll use to populate the new one.
  if ( empty( $shared_term ) ) {
    $shared_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.* FROM $wpdb->terms t WHERE t.term_id = %d", $term_id ) );
  }

  $new_term_data = array(
    'name'       => $shared_term->name,
    'slug'       => $shared_term->slug,
    'term_group' => $shared_term->term_group,
  );

  if ( false === $wpdb->insert( $wpdb->terms, $new_term_data ) ) {
    return new WP_Error( 'db_insert_error', __( 'Could not split shared term.' ), $wpdb->last_error );
  }

  $new_term_id = (int) $wpdb->insert_id;

  // Update the existing term_taxonomy to point to the newly created term.
  $wpdb->update(
    $wpdb->term_taxonomy,
    array( 'term_id' => $new_term_id ),
    array( 'term_taxonomy_id' => $term_taxonomy_id )
  );

  // Reassign child terms to the new parent.
  if ( empty( $term_taxonomy ) ) {
    $term_taxonomy = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );
  }

  $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 ) );
  if ( ! empty( $children_tt_ids ) ) {
    foreach ( $children_tt_ids as $child_tt_id ) {
      $wpdb->update(
        $wpdb->term_taxonomy,
        array( 'parent' => $new_term_id ),
        array( 'term_taxonomy_id' => $child_tt_id )
      );
      clean_term_cache( (int) $child_tt_id, '', false );
    }
  } else {
    // If the term has no children, we must force its taxonomy cache to be rebuilt separately.
    clean_term_cache( $new_term_id, $term_taxonomy->taxonomy, false );
  }

  clean_term_cache( $term_id, $term_taxonomy->taxonomy, false );

  /*
	 * Taxonomy cache clearing is delayed to avoid race conditions that may occur when
	 * regenerating the taxonomy's hierarchy tree.
	 */
  $taxonomies_to_clean = array( $term_taxonomy->taxonomy );

  // Clean the cache for term taxonomies formerly shared with the current term.
  $shared_term_taxonomies = $wpdb->get_col( $wpdb->prepare( "SELECT taxonomy FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) );
  $taxonomies_to_clean    = array_merge( $taxonomies_to_clean, $shared_term_taxonomies );

  foreach ( $taxonomies_to_clean as $taxonomy_to_clean ) {
    clean_taxonomy_cache( $taxonomy_to_clean );
  }

  // Keep a record of term_ids that have been split, keyed by old term_id. See wp_get_split_term().
  if ( $record ) {
    $split_term_data = get_option( '_split_terms', array() );
    if ( ! isset( $split_term_data[ $term_id ] ) ) {
      $split_term_data[ $term_id ] = array();
    }

    $split_term_data[ $term_id ][ $term_taxonomy->taxonomy ] = $new_term_id;
    update_option( '_split_terms', $split_term_data );
  }
[1] [2] Next »

 View on GitHub View on Trac

Published: 25th November 2019 | Last updated: 9th December 2020

Primary Sidebar

Information

Function name: _split_shared_term
Plugin ref: WordPress
Version: 5.6
Sourcefile: wp-includes/taxonomy.php
File ref: wp-includes/taxonomy.php
API type: private
Deprecated?: No
API Letters: _,S,T

Footer

WP-a2z
WordPress core a2z
WordPress core only
WordPress 5.6
WordPress a2z
WordPress core a2z
Genesis Theme Framework a2z
Jetpack a2z
WordPress develop tests
Easy Digital Downloads a2z
WooCommerce a2z
Yoast SEO a2z
WordPress Blocks

Site:  core.wp-a2z.org
© Copyright WP-a2z 2014-2021. All rights reserved.


Website designed and developed by Herb Miller
Proudly powered by WordPress and oik plugins

  • Home
  • Blog
  • Sitemap
  • Sites