説明
array get_tags( [ mixed $args = '' ] )
条件を指定してタグ情報を検索し、マッチしたすべてのタグ情報を取得する。
パラメータ
- $args検索条件を指定する文字列(または連想配列)。文字列の場合はname=valueの形式で指定し、複数の条件はname1=value1&name2=value2のように'&'の後に続ける。主なキーワードは次の通り。
キーワード 意味 orderby ソート対象を示すname、countなど。省略時は'name'が適用され、指定しない場合はIDが適用される order ソート順を示すASCかDESC(省略時はASC) hide_empty 投稿数が0のタグ情報を除外する場合はtrue(1)、除外しない場合はfalse(0)を指定(省略時はtrue) exclude 除外する投稿ID(省略時は'')。複数指定する場合は,で区切る include 取得したい投稿ID(省略時は'')。複数指定する場合は,で区切る number 最大件数(省略時は''で制限なし) fields 取得したいタグ情報のフィールドを示すall、ids、namesなど(省略時は'all') slug タグ情報のスラッグ(省略時は'') offset 取得開始位置(先頭は0)
返り値
条件にマッチしたタグ情報(オブジェクト)を配列に格納して返す。条件にマッチしたタグがない場合は、空の配列を返す。タグ情報のメンバー変数は次の通り。
| プロパティ名 | データ型 | 意味 |
|---|---|---|
| term_id | int | ID |
| name | string | 名前 |
| slug | string | スラッグ |
| term_group | int | グループID |
| term_taxonomy_id | int | タクソノミーID |
| taxonomy | string | タクソノミー名。タグの場合は必ず'post_tag'となる |
| description | string | 説明。現在は必ず''となる |
| parent | int | 親タグID。現在は必ず0となる |
| count | int | 投稿数 |
注意
特にありません。使用例
- すべてのタグ情報を取得する。<?php $tags = get_tags(); ?>
フィルター
get_terms関数にて投稿タグ情報を取得できた場合、get_tagsフィルターで処理を行いその戻り値を返している(なお投稿タグ情報を取得できなかった場合は、このフィルターは呼ばれない)。$tags = apply_filters( 'get_tags', $tags, $args );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/category.php最終更新 : 2018年05月27日 10:49
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。