update_term_meta

SummerySummery

Updates term metadata.

Syntax

update_term_meta( int $term_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )

DescriptionDescription

Use the $prev_value parameter to differentiate between meta fields with the same key and term ID.

If the meta field for the term does not exist, it will be added.

ParametersParameters

$term_id

(int) (Required) Term ID.

$meta_key

(string) (Required) Metadata key.

$meta_value

(mixed) (Required) Metadata value.

$prev_value

(mixed) (Optional) Previous value to check before removing.

Default value: ''

ReturnReturn

(int|WP_Error|bool) Meta ID if the key didn't previously exist. True on successful update. WP_Error when term_id is ambiguous between taxonomies. False on failure.

SourceSource

File: wp-includes/taxonomy.php


			

ChangelogChangelog

Changelog
Version Description
4.4.0 Introduced.
Scroll to Top