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

Sanitize Term all fields.

Description Description

Relies on sanitize_term_field() to sanitize the term. The difference is that this function will sanitize all fields. The context is based on sanitize_term_field().

The $term is expected to be either an array or an object.

Parameters Parameters


(array|object) (Required) The term to check.


(string) (Required) The taxonomy name to use.


(string) (Optional) Context in which to sanitize the term. Accepts 'edit', 'db', 'display', 'attribute', or 'js'.

Default value: 'display'

Top ↑

Return Return

(array|object) Term with all fields sanitized.

Top ↑

Source Source

File: wp-includes/taxonomy.php

function sanitize_term($term, $taxonomy, $context = 'display') {
	$fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' );

	$do_object = is_object( $term );

	$term_id = $do_object ? $term->term_id : (isset($term['term_id']) ? $term['term_id'] : 0);

	foreach ( (array) $fields as $field ) {
		if ( $do_object ) {
			if ( isset($term->$field) )
				$term->$field = sanitize_term_field($field, $term->$field, $term_id, $taxonomy, $context);
		} else {
			if ( isset($term[$field]) )
				$term[$field] = sanitize_term_field($field, $term[$field], $term_id, $taxonomy, $context);

	if ( $do_object )
		$term->filter = $context;
		$term['filter'] = $context;

	return $term;

Top ↑

Changelog Changelog

Version Description
2.3.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.