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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

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.

Performance profile

How much work a call to _split_shared_term() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_var().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

23–195

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 232.

Plugin surface

1 hook

Third-party callbacks on 'split_shared_term' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksdo_action()called directly
• sqldatabase query->get_var()called directly
• cacheobject cachewp_cache_delete_multiple()one call below _split_shared_term()
• serializeserialisationmaybe_unserialize()one call below _split_shared_term()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 36 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _split_shared_term() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   do_action( split_shared_term )actionline 4356 (+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 code

View on Trac ↗View on GitHub ↗

4234function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) {4235	global $wpdb;4236 4237	if ( is_object( $term_id ) ) {4238		$shared_term = $term_id;4239		$term_id     = (int) $shared_term->term_id;4240	}4241 4242	if ( is_object( $term_taxonomy_id ) ) {4243		$term_taxonomy    = $term_taxonomy_id;4244		$term_taxonomy_id = (int) $term_taxonomy->term_taxonomy_id;4245	}4246 4247	// If there are no shared term_taxonomy rows, there's nothing to do here.4248	$shared_tt_count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy tt WHERE tt.term_id = %d AND tt.term_taxonomy_id != %d", $term_id, $term_taxonomy_id ) );4249 4250	if ( ! $shared_tt_count ) {4251		return $term_id;4252	}4253 4254	/*4255	 * Verify that the term_taxonomy_id passed to the function is actually associated with the term_id.4256	 * If there's a mismatch, it may mean that the term is already split. Return the actual term_id from the db.4257	 */4258	$check_term_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );4259	if ( $check_term_id !== $term_id ) {4260		return $check_term_id;4261	}4262 4263	// Pull up data about the currently shared slug, which we'll use to populate the new one.4264	if ( empty( $shared_term ) ) {4265		$shared_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.* FROM $wpdb->terms t WHERE t.term_id = %d", $term_id ) );4266	}4267 4268	$new_term_data = array(4269		'name'       => $shared_term->name,4270		'slug'       => $shared_term->slug,4271		'term_group' => $shared_term->term_group,4272	);4273 4274	if ( false === $wpdb->insert( $wpdb->terms, $new_term_data ) ) {4275		return new WP_Error( 'db_insert_error', __( 'Could not split shared term.' ), $wpdb->last_error );4276	}4277 4278	$new_term_id = (int) $wpdb->insert_id;4279 4280	// Update the existing term_taxonomy to point to the newly created term.4281	$wpdb->update(4282		$wpdb->term_taxonomy,4283		array( 'term_id' => $new_term_id ),4284		array( 'term_taxonomy_id' => $term_taxonomy_id )4285	);4286 4287	// Reassign child terms to the new parent.4288	if ( empty( $term_taxonomy ) ) {4289		$term_taxonomy = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );4290	}4291 4292	$children_tt_ids = $wpdb->get_col( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_taxonomy WHERE parent = %d AND taxonomy = %s", $term_id, $term_taxonomy->taxonomy ) );4293	if ( ! empty( $children_tt_ids ) ) {4294		foreach ( $children_tt_ids as $child_tt_id ) {4295			$wpdb->update(4296				$wpdb->term_taxonomy,4297				array( 'parent' => $new_term_id ),4298				array( 'term_taxonomy_id' => $child_tt_id )4299			);4300			clean_term_cache( (int) $child_tt_id, '', false );4301		}4302	} else {4303		// If the term has no children, we must force its taxonomy cache to be rebuilt separately.4304		clean_term_cache( $new_term_id, $term_taxonomy->taxonomy, false );4305	}4306 4307	clean_term_cache( $term_id, $term_taxonomy->taxonomy, false );4308 4309	/*4310	 * Taxonomy cache clearing is delayed to avoid race conditions that may occur when4311	 * regenerating the taxonomy's hierarchy tree.4312	 */4313	$taxonomies_to_clean = array( $term_taxonomy->taxonomy );

Changelog

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