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



お勧め

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

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

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

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

購読者は管理者ページのアクセス禁止(2013年11月12日 更新)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。