get_tags

(2.3.0以降)
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

関連

  • get_tag - 投稿タグ情報を取得する
  • get_terms - タクソノミー情報を取得する
  • get_the_tags - 投稿データのタグ情報を取得する
  • the_tags - リンク付きの投稿タグを表示する

お勧めコンテンツ

Slightly troublesome permalink:プラグイン作ってみました(2012年2月9日 登録)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

もうquery_postsは呼ばない(2011年9月27日 登録)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭でquery_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

常時SSL接続に変更しました(2017年3月3日 登録)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 登録)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

Contact Form 7に確認フェーズを(2011年12月12日 登録)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

最終更新日時 : 2011-12-12 11:32