sanitize_term( array|object $term, string $taxonomy, string $context = 'display' ): array|object

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

$termarray|object

The term to check.

$taxonomystring

The taxonomy name to use.

$contextstringoptional

Context in which to sanitize the term.
Accepts 'raw', 'edit', 'db', 'display', 'rss', 'attribute', or 'js'. Default 'display'.Default: 'display'

Return value

array|object

Term with all fields sanitized.

Performance profile

How much work a call to sanitize_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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

15–18

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

9

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

What it touches

• hookthird-party callbacksapply_filters()one call below sanitize_term()

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

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

Uses · 1

• sanitize_term_field()Sanitizes the field value in the term based on the context.

Used by · 9

• WP_Term::__get()Getter.
• WP_Term::filter()Sanitizes term fields, according to the filter type provided.
• WP_Term::get_instance()Retrieve WP_Term instance.
• WP_Terms_List_Table::single_row()
• get_term()Gets all term data from database by term ID.
• get_term_to_edit()Sanitizes term for editing.
• sanitize_category()Sanitizes category data based on context.
• 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 ↗

1734function sanitize_term( $term, $taxonomy, $context = 'display' ) {1735	$fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' );1736 1737	$do_object = is_object( $term );1738 1739	$term_id = $do_object ? ( $term->term_id ?? 0 ) : ( $term['term_id'] ?? 0 );1740 1741	foreach ( (array) $fields as $field ) {1742		if ( $do_object ) {1743			if ( isset( $term->$field ) ) {1744				$term->$field = sanitize_term_field( $field, $term->$field, $term_id, $taxonomy, $context );1745			}1746		} else {1747			if ( isset( $term[ $field ] ) ) {1748				$term[ $field ] = sanitize_term_field( $field, $term[ $field ], $term_id, $taxonomy, $context );1749			}1750		}1751	}1752 1753	if ( $do_object ) {1754		$term->filter = $context;1755	} else {1756		$term['filter'] = $context;1757	}1758 1759	return $term;1760}

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