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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。