get_term_to_edit() – Function | Developer.WordPress.org

get_term_to_edit( int|object $id, string $taxonomy ): string|int|null|WP_Error

Sanitizes term for editing.

Description

Return value is sanitize_term() and usage is for sanitizing the term for editing. Function is for contextual and simplicity.

Parameters

$idint|objectrequired: Term ID or object.
$taxonomystringrequired: Taxonomy name.

Return

string|int|null|WP_Error Will return empty string if $term is not an object.

Source

function get_term_to_edit( $id, $taxonomy ) {
	$term = get_term( $id, $taxonomy );

	if ( is_wp_error( $term ) ) {
		return $term;
	}

	if ( ! is_object( $term ) ) {
		return '';
	}

	return sanitize_term( $term, $taxonomy, 'edit' );
}

View all references View on Trac View on GitHub

Changelog

Version	Description
2.3.0	Introduced.

User Contributed Notes

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