get_tags

説明

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_idintID
namestring名前
slugstringスラッグ
term_groupintグループID
term_taxonomy_idintタクソノミーID
taxonomystringタクソノミー名。タグの場合は必ず'post_tag'となる
descriptionstring説明。現在は必ず''となる
parentint親タグID。現在は必ず0となる
countint投稿数

注意

特にありません。

使用例

  • すべてのタグ情報を取得する。
    <?php $tags = get_tags(); ?>

フィルター

get_terms関数にて投稿タグ情報を取得できた場合、get_tagsフィルターで処理を行いその戻り値を返している(なお投稿タグ情報を取得できなかった場合は、このフィルターは呼ばれない)。
$tags = apply_filters( 'get_tags', $tags, $args );

アクション

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

ソースファイル

/wp-includes/category.php

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



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。