delete_term_meta() WordPress Function

The delete_term_meta() function is used to delete custom fields for a given term. This function takes two parameters: the term ID and the meta key. The function will delete all metadata for the given term ID and meta key.

delete_term_meta( int $term_id, string $meta_key, mixed $meta_value = '' ) #

Removes metadata matching criteria from a term.


Parameters

$term_id

(int)(Required)Term ID.

$meta_key

(string)(Required)Metadata name.

$meta_value

(mixed)(Optional) Metadata value. If provided, rows will only be removed that match the value. Must be serializable if non-scalar.

Default value: ''


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

File: wp-includes/taxonomy.php

function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
	return delete_metadata( 'term', $term_id, $meta_key, $meta_value );
}


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More