W3cubDocs

/WordPress

get_term_to_edit( int|object $id, string $taxonomy )

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

$id

(int|object) (Required) Term ID or object.

$taxonomy

(string) (Required) Taxonomy name.

Return

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

Source

File: wp-includes/taxonomy.php 

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' );
}

Uses

Uses Description
wp-includes/taxonomy.php: sanitize_term()

Sanitize Term all fields.
wp-includes/taxonomy.php: get_term()

Get all Term data from database by Term ID.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
2.3.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_term_to_edit