• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get tags

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年4月25日 (日) 05:11時点におけるKz (トーク | 投稿記録)による版 (全体を和訳)

移動先: 案内検索

この関数は、投稿タグの一覧を取得します。内部で get_terms() を呼びだし、post_tag タクソノミーのタームを取得しています。戻り値は get_tags フィルターフックで上書きできます。

使い方

<?php $tags = &get_tags( $args ) ?>

パラメータ

$orderby
文字列) (オプション) タグの並び順のキー。
初期値: 'name'
  • count - タグの使用件数
  • name - タグ名
  • slug - タグスラッグ名
  • term_group - タームグループ名
  • id または 空文字 - タグ ID

:このパラメータは以下のフォルターフックで上書きできます。

$orderby = apply_filters( 'get_terms_orderby', $orderby, $args );
$order
文字列) (オプション) タグの並び順。
初期値: 'ASC'
  • ASC - 昇順
  • DESC - 降順
$hide_empty
真偽値) (オプション) 使用件数が0のタグを除くかどうか。
初期値: true
  • true - 除く
  • false - 含める
$exclude
文字列) (オプション) コンマまたはスペース区切りの、一覧から除くタグ ID。
初期値: 空文字

include が指定されている場合は、この指定は無視されます。

$include
文字列) (オプション) コンマまたはスペース区切りの、一覧に含めるタグ ID。
初期値: 空文字
$number
整数または文字列) (オプション) 取得するタグの数。
初期値: 空文字
$offset
整数または文字列) (オプション) 取得するタグのクエリ順でのオフセット。
初期値: 空文字

:タグ一覧の先頭から、指定した数をスキップします。

$fields
文字列) (オプション) 戻り値のタイプ。
初期値: 'all'
  • all - タグオブジェクトの配列。
  • ids - タグ ID(整数)の配列。
  • names - タグ名(文字列)の配列。
$slug
文字列) (オプション) 取得するタグのスラッグ。
初期値: 空文字


$search
文字列) (オプション) 取得するタグ名に含まれる文字列。大文字/小文字を区別しない。
初期値: 空文字
$name__like
文字列) (オプション) 取得するタグ名の先頭から含まれる文字列。大文字/小文字を区別しない。
初期値: 空文字



フィルターフック

関数の最後で get_tags フィルターが実行されます。フィルターフック内で戻り値を上書きすることが可能です。

$tags = apply_filters( 'get_tags', $tags, $args );

用例


変更履歴

  • 2.3 : 新規テンプレートタグ

ソースファイル

&get_tags()wp-includes/category.php にあります。


タグ: get_tag(), get_tag_link(), get_tags(), get_the_tag_list(), get_the_tags(), is_tag(), the_tags(), single_tag_title(), tag_description(), wp_generate_tag_cloud(), wp_tag_cloud()


テンプレートタグへの PHP 関数型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。

最新英語版: WordPress Codex » Function Reference/get tags最新版との差分