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



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。