get_term_by

説明

mixed get_term_by( string $field , mixed $value , string $taxonomy [ , string $output = OBJECT [ , string $filter = 'raw' ] ] )
ID、名前、スラッグを指定してカテゴリー・タグ情報を取得する。

パラメータ

  • $field
    検索する値のフィールド名を示す'slug'、'name'、'id'、'term_taxonomy_id'など。なお、'slug'または'name'以外はIDとして解釈される。
  • $value
    検索する値。
  • $taxonomy
    タクソノミー名を示す'category'、'post_tag'、'link_category'の何れか。
  • $output
    出力型を示すOBJECT、ARRAY_A、ARRAY_Nの何れか(省略時はOBJECT)。
  • $filter
    フィルター名(省略時は'raw')。

返り値

カテゴリー・タグが見つかった場合はそのカテゴリー・タグ情報をパラメータ$outputで指定された型で返す。カテゴリー・タグが見つからなかった場合はfalseを返す。 $outputがOBJECTの場合(デフォルト)、メンバー変数は次の通り。
プロパティ名データ型意味
term_idintID
namestring名前
slugstringスラッグ
term_groupintグループID
term_taxonomy_idintタクソノミーID
taxonomystringタクソノミー名。カテゴリーの場合は'category'、タグの場合は'post_tag'となる
descriptionstring説明
parentint親カテゴリーID。親カテゴリーがない場合は0となる
countint投稿数

注意

パラメータ$outputの値は、決められた定数(OBJECT、ARRAY_A、ARRAY_N)以外は無効となる。

[4.4.0]パラメータ$fieldが'term_taxonomy_id'の場合、パラメータ$taxonomyは省略可能。パラメータ$outputがOBJECTの場合、WP_Termオブジェクトを返すように変更された。

[5.5.0]パラメータ$fieldに'ID'が指定可能になった('id'のエイリアス)。


使用例

  • スラッグが'blog'のカテゴリー情報を取得する。
    <?php $cat = get_term_by( 'slug' , 'blog' , 'category' ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/taxonomy.php

最終更新 : 2020年08月28日 14:06



お勧め

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

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

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)

少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。