add_term_meta

説明

mixed add_term_meta( int $term_id, string $meta_key, mixed $meta_value [ , bool $unique = false ] )
タームのメタ情報を追加する。

パラメータ

  • $term_id
    タームIDを指定。
  • $meta_key
    メタ情報のキー名を指定。
  • $meta_value
    メタ情報の値を指定。
  • $unique
    メタ情報が存在しない場合のみ登録する場合はtrueを、常に追加する場合はfalseを指定(省略時はfalse)。

返り値

メタ情報の値を追加した場合はメタ情報IDを、追加できなかった場合はfalseかWP_Errorオブジェクトを返す。

注意

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

同じキー名の値を登録したくない場合はパラメータ$uniqueがtrueにするか、 update_term_meta関数を使用する。


使用例

  • タームのメタ情報を追加する。
    <?php add_term_meta( $term_id, 'image', $meta_value ); ?>
  • タームのメタ情報が存在しない場合のみ追加する。
    <?php add_term_meta( $term_id, 'image', $meta_value, true ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/taxonomy.php

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



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。