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



お勧め

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

Login rebuilder:プラグイン作ってみました(2019年4月22日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。