説明
update_term_meta() は、タームのメタデータを更新する関数です。
基本構文
update_term_meta( int $term_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|bool|WP_Error引数
$term_id：タームID$meta_key：メタキー$meta_value：値$prev_value：旧値（省略可）
戻り値
メタIDまたは true。失敗時は false か WP_Error。
使い方（サンプル）
update_term_meta( 5, 'color', 'red' );注意点
- WordPress 4.4 以降で利用できます。
- 保存前に値をサニタイズします。
実務での使いどころ
- カテゴリーやタームごとの、追加情報（色、アイコン、並び順など）を保存するとき。
- タームの編集画面に追加したフィールドの値を、保存するとき。
よくあるミスと対処
- 戻り値が
falseのとき、失敗したと考える。値が変わらないときもfalseが返る。 - 権限や入力値の確認をしていない。
- WordPress 4.4より前のバージョンでは、使えない。
NG例
update_term_meta( $term_id, 'color', $_POST['color'] ); // 検証・サニタイズがないOK例
if ( current_user_can( 'manage_categories' ) && isset( $_POST['color'] ) ) {
update_term_meta( $term_id, 'color', sanitize_hex_color( wp_unslash( $_POST['color'] ) ) );
}使い分け早見表
| 関数 | 役割 |
|---|---|
update_term_meta() |
値を保存する（なければ作成、あれば更新） |
get_term_meta() |
値を取得する |
delete_term_meta() |
値を削除する |
関連項目
get_term_meta()、delete_term_meta()
公式リファレンス：update_term_meta() | Function | WordPress Developer Resources
コメント