wppaste
WordPress

taxonomy_meta_box_sanitize_cb_input( string $taxonomy, array|string $terms ): array

Since
5.1.0
Source
wp-admin/includes/post.php:2254
Sanitizes POST values from an input taxonomy metabox.

Compatibility

WordPress
since 5.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$taxonomystring
The taxonomy name.
$termsarray|string
Raw term data from the 'tax_input' field.

Return value

array

Performance profile

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

Scaling
Scales with input

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

Instructions
8–25

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • querycontent queryget_terms()called directly
  • hookthird-party callbacksapply_filters()one call below taxonomy_meta_box_sanitize_cb_input()

Further down the call graph this can also reach option, cache, serialize 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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
is_array($terms)8–9none
!is_array($terms)21–25_x(), explode()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev458–256
8.5458–256
8.4458–2566 fewer instructions than PHP 8.3
8.3518–316
8.2518–316
8.1518–316
7.4518–316

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

  • _x()Retrieves translated string with gettext context.
  • get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.

Source code

function taxonomy_meta_box_sanitize_cb_input( $taxonomy, $terms ) {	/*	 * Assume that a 'tax_input' string is a comma-separated list of term names.	 * Some languages may use a character other than a comma as a delimiter, so we standardize on	 * commas before parsing the list.	 */	if ( ! is_array( $terms ) ) {		$comma = _x( ',', 'tag delimiter' );		if ( ',' !== $comma ) {			$terms = str_replace( $comma, ',', $terms );		}		$terms = explode( ',', trim( $terms, " \n\t\r\0\x0B," ) );	} 	$clean_terms = array();	foreach ( $terms as $term ) {		// Empty terms are invalid input.		if ( empty( $term ) ) {			continue;		} 		$_term = get_terms(			array(				'taxonomy'   => $taxonomy,				'name'       => $term,				'fields'     => 'ids',				'hide_empty' => false,			)		); 		if ( ! empty( $_term ) ) {			$clean_terms[] = (int) $_term[0];		} else {			// No existing term was found, so pass the string. A new term will be created.			$clean_terms[] = $term;		}	} 	return $clean_terms;}

Changelog

Introduced in 5.1.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.1.0 tag, from src/wp-admin/includes/post.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.