функция
since 4.4.0
add_term_meta()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
add_term_meta( int $term_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false|WP_ErrorОписание
По историческим причинам и ключ метаданных, и значение метаданных на входе должны быть «экранированы обратными слэшами».
Оригинал (английский)
For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.
Параметры
$term_id
int
обязательный
ID термина.
$meta_key
string
обязательный
Имя метаданных.
$meta_value
mixed
обязательный
Значение метаданных. Массивы и объекты сохраняются как сериализованные данные и возвращаются того же типа при получении. Остальные типы данных сохраняются в базе данных как строки:
false сохраняется и возвращается как пустая строка ('')
true сохраняется и возвращается как '1'
числа (как целые, так и с плавающей точкой) сохраняются и возвращаются как строки. Должно быть сериализуемым, если не является скалярным значением.
$unique
bool
необязательный
= false
Следует ли запретить добавление одного и того же ключа.
Возвращаемое значение
int|false|WP_Error
WP_Error
Исходный код
wp-includes/taxonomy.php:1403
function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
if ( wp_term_is_shared( $term_id ) ) {
return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id );
}
return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
}История изменений
| Версия | Описание |
|---|---|
| 4.4.0 | Introduced. |
