WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_term_to_edit()

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

In this article

Back to top

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

UsesDescription
sanitize_term()wp-includes/taxonomy.php

Sanitizes all term fields.

get_term()wp-includes/taxonomy.php

Gets all term data from database by term ID.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less

Changelog

VersionDescription
2.3.0Introduced.

User Contributed Notes

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