wp_unique_term_slug( string $slug, object $term ): string

Description

Compatibility

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

Parameters

$slugstring

The string that will be tried for a unique slug.

$termobject

The term object that the $slug will belong to.

Return value

string

Will return a true unique slug.

Performance profile

How much work a call to wp_unique_term_slug() 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

26–114

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_unique_term_slug_is_bad_slug', 'wp_unique_term_slug' 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
• querycontent queryget_term()called directly
• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->get_var()called directly
• cacheobject cachewp_cache_get()one call below wp_unique_term_slug()
• serializeserialisationmaybe_unserialize()one call below wp_unique_term_slug()

Further down the call graph this can also reach transient. That is 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 wp_unique_term_slug() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_unique_term_slug() runs, in this order:

1. 1
   apply_filters( wp_unique_term_slug_is_bad_slug )filterline 3141 (+46 into the body)

   Filters whether the proposed unique term slug is bad.

2. 2
   apply_filters( wp_unique_term_slug )filterline 3172 (+77 into the body)

   Filters the unique term slug.

Uses · 7

• term_exists()Determines whether a taxonomy term exists.
• get_option()Retrieves an option value based on an option name.
• get_term_by()Gets all term data from database by term field and data.
• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• get_term()Gets all term data from database by term ID.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• wp_insert_term()Adds a new term to the database.
• wp_update_term()Updates term based on arguments provided.

Source code

View on Trac ↗View on GitHub ↗

3095function wp_unique_term_slug( $slug, $term ) {3096	global $wpdb;3097 3098	$needs_suffix  = true;3099	$original_slug = $slug;3100 3101	// As of 4.1, duplicate slugs are allowed as long as they're in different taxonomies.3102	if ( ! term_exists( $slug ) || get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) {3103		$needs_suffix = false;3104	}3105 3106	/*3107	 * If the taxonomy supports hierarchy and the term has a parent, make the slug unique3108	 * by incorporating parent slugs.3109	 */3110	$parent_suffix = '';3111	if ( $needs_suffix && is_taxonomy_hierarchical( $term->taxonomy ) && ! empty( $term->parent ) ) {3112		$the_parent = $term->parent;3113		while ( ! empty( $the_parent ) ) {3114			$parent_term = get_term( $the_parent, $term->taxonomy );3115			if ( is_wp_error( $parent_term ) || empty( $parent_term ) ) {3116				break;3117			}3118			$parent_suffix .= '-' . $parent_term->slug;3119			if ( ! term_exists( $slug . $parent_suffix ) ) {3120				break;3121			}3122 3123			if ( empty( $parent_term->parent ) ) {3124				break;3125			}3126			$the_parent = $parent_term->parent;3127		}3128	}3129 3130	// If we didn't get a unique slug, try appending a number to make it unique.3131 3132	/**3133	 * Filters whether the proposed unique term slug is bad.3134	 *3135	 * @since 4.3.03136	 *3137	 * @param bool   $needs_suffix Whether the slug needs to be made unique with a suffix.3138	 * @param string $slug         The slug.3139	 * @param object $term         Term object.3140	 */3141	if ( apply_filters( 'wp_unique_term_slug_is_bad_slug', $needs_suffix, $slug, $term ) ) {3142		if ( $parent_suffix ) {3143			$slug .= $parent_suffix;3144		}3145 3146		if ( ! empty( $term->term_id ) ) {3147			$query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id );3148		} else {3149			$query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );3150		}3151 3152		if ( $wpdb->get_var( $query ) ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared3153			$num = 2;3154			do {3155				$alt_slug = $slug . "-$num";3156				++$num;3157				$slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );3158			} while ( $slug_check );3159			$slug = $alt_slug;3160		}3161	}3162 3163	/**3164	 * Filters the unique term slug.3165	 *3166	 * @since 4.3.03167	 *3168	 * @param string $slug          Unique term slug.3169	 * @param object $term          Term object.3170	 * @param string $original_slug Slug originally passed to the function for testing.3171	 */3172	return apply_filters( 'wp_unique_term_slug', $slug, $term, $original_slug );3173}

Changelog

Introduced in 2.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.8.8 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.