_split_shared_term( int|object $term_id, int|object $term_taxonomy_id, bool $record = true ): int|WP_Error

Parameters

$term_idint|object

ID of the shared term, or the shared term object.

$term_taxonomy_idint|object

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).

$recordbooloptional

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.Default: true

Return

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.

Hooks fired · 1

One hook fires while _split_shared_term() runs, in this order:

1. 1
   do_action( split_shared_term )actionline 4393 (+122 into the body)

   Fires after a previously shared taxonomy term is split into two separate terms.

Uses · 7

• __()Retrieves the translation of $text.
• clean_term_cache()Removes all of the term IDs from the cache.
• clean_taxonomy_cache()Cleans the caches for a taxonomy.
• get_option()Retrieves an option value based on an option name.
• update_option()Updates the value of an option that was already added.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Error::__construct()Initializes the error.

Used by · 2

• _wp_batch_split_terms()Splits a batch of shared taxonomy terms.
• wp_update_term()Updates term based on arguments provided.

Source

View on Trac ↗View on GitHub ↗

4271function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) {4272	global $wpdb;4273 4274	if ( is_object( $term_id ) ) {4275		$shared_term = $term_id;4276		$term_id     = (int) $shared_term->term_id;4277	}4278 4279	if ( is_object( $term_taxonomy_id ) ) {4280		$term_taxonomy    = $term_taxonomy_id;4281		$term_taxonomy_id = (int) $term_taxonomy->term_taxonomy_id;4282	}4283 4284	// If there are no shared term_taxonomy rows, there's nothing to do here.4285	$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 ) );4286 4287	if ( ! $shared_tt_count ) {4288		return $term_id;4289	}4290 4291	/*4292	 * Verify that the term_taxonomy_id passed to the function is actually associated with the term_id.4293	 * If there's a mismatch, it may mean that the term is already split. Return the actual term_id from the db.4294	 */4295	$check_term_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );4296	if ( $check_term_id !== $term_id ) {4297		return $check_term_id;4298	}4299 4300	// Pull up data about the currently shared slug, which we'll use to populate the new one.4301	if ( empty( $shared_term ) ) {4302		$shared_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.* FROM $wpdb->terms t WHERE t.term_id = %d", $term_id ) );4303	}4304 4305	$new_term_data = array(4306		'name'       => $shared_term->name,4307		'slug'       => $shared_term->slug,4308		'term_group' => $shared_term->term_group,4309	);4310 4311	if ( false === $wpdb->insert( $wpdb->terms, $new_term_data ) ) {4312		return new WP_Error( 'db_insert_error', __( 'Could not split shared term.' ), $wpdb->last_error );4313	}4314 4315	$new_term_id = (int) $wpdb->insert_id;4316 4317	// Update the existing term_taxonomy to point to the newly created term.4318	$wpdb->update(4319		$wpdb->term_taxonomy,4320		array( 'term_id' => $new_term_id ),4321		array( 'term_taxonomy_id' => $term_taxonomy_id )4322	);4323 4324	// Reassign child terms to the new parent.4325	if ( empty( $term_taxonomy ) ) {4326		$term_taxonomy = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );4327	}4328 4329	$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 ) );4330	if ( ! empty( $children_tt_ids ) ) {4331		foreach ( $children_tt_ids as $child_tt_id ) {4332			$wpdb->update(4333				$wpdb->term_taxonomy,4334				array( 'parent' => $new_term_id ),4335				array( 'term_taxonomy_id' => $child_tt_id )4336			);4337			clean_term_cache( (int) $child_tt_id, '', false );4338		}4339	} else {4340		// If the term has no children, we must force its taxonomy cache to be rebuilt separately.4341		clean_term_cache( $new_term_id, $term_taxonomy->taxonomy, false );4342	}4343 4344	clean_term_cache( $term_id, $term_taxonomy->taxonomy, false );4345 4346	/*4347	 * Taxonomy cache clearing is delayed to avoid race conditions that may occur when4348	 * regenerating the taxonomy's hierarchy tree.4349	 */4350	$taxonomies_to_clean = array( $term_taxonomy->taxonomy );

History

Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.