WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

sanitize_term()

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

In this article

Back to top

Sanitizes all term fields.

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

$termarray|objectrequired
The term to check.
$taxonomystringrequired
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

array|object Term with all fields sanitized.

Source

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;
	} else {
		$term['filter'] = $context;
	}

	return $term;
}

View all references View on Trac View on GitHub

UsesDescription
sanitize_term_field()wp-includes/taxonomy.php

Sanitizes the field value in the term based on the context.

Used byDescription
WP_Term::filter()wp-includes/class-wp-term.php

Sanitizes term fields, according to the filter type provided.

WP_Term::__get()wp-includes/class-wp-term.php

Getter.

WP_Term::get_instance()wp-includes/class-wp-term.php

Retrieve WP_Term instance.

WP_Terms_List_Table::single_row()wp-admin/includes/class-wp-terms-list-table.php
sanitize_category()wp-includes/category.php

Sanitizes category data based on context.

wp_update_term()wp-includes/taxonomy.php

Updates term based on arguments provided.

wp_insert_term()wp-includes/taxonomy.php

Adds a new term to the database.

get_term_to_edit()wp-includes/taxonomy.php

Sanitizes term for editing.

get_term()wp-includes/taxonomy.php

Gets all term data from database by term ID.

Show 4 moreShow less

Changelog

VersionDescription
2.3.0Introduced.

User Contributed Notes

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