update_term_meta

説明

mixed update_term_meta( int $term_id, string $meta_key, mixed $meta_value [ , mixed $prev_value = '' ] )
タームのメタ情報を更新する。

パラメータ

  • $term_id
    タームIDを指定。
  • $meta_key
    メタ情報のキー名を指定。
  • $meta_value
    メタ情報の値を指定。
  • $prev_value
    現在のメタ情報の値を指定(省略時は'')。

返り値

メタ情報の値を更新した場合はtrueを、メタ情報が存在せず追加できた場合はそのメタ情報IDを、更新できなかった場合はfalseかWP_Errorオブジェクトを返す。

注意

WordPressのDBバージョン番号が34370(WordPress 4.4.0は35700)より小さい場合は必ずfalseとなる。

パラメータ$prev_valueに''(empty以外)の値を指定した場合、現在の値と一致する場合のみパラメータ$meta_valueの値に更新される。


使用例

  • タームのメタ情報を更新する。
    <?php update_term_meta( $term_id, 'image', $meta_value ); ?>
  • 現在の値が10の場合のみタームのメタ情報を更新する。
    <?php update_term_meta( $term_id, 'image', $meta_value, 10 ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/taxonomy.php

最終更新 : 2018年05月27日 10:44



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。