説明
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
関連
お勧め
5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)
「5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。
ログインページのタイトルを変更してみる(2018年5月27日 更新)
バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。
プラグインで注意が必要な関数(2013年11月27日 更新)
先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。