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

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

「関数リファレンス/get tags」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get tags 22:09, 30 June 2009 Ramiy)
 
(全体を和訳)
1行目: 1行目:
Taken and slightly altered from the notes in the taxonomy.php file for get_terms, on which this function relies:
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
Retrieves a list of post tags based on the criteria provided in $args.  The list of arguments that $args can contain, which will overwrite the defaults:
+
この関数は、投稿タグの一覧を取得します。内部で [[関数リファレンス/get_terms|get_terms()]] を呼びだし、''post_tag'' タクソノミーのタームを取得しています。戻り値は <tt>get_tags</tt> フィルターフックで上書きできます。
  
orderby - Default is 'name'. Can be name, count, or nothing (will use term_id).
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
order - Default is ASC. Can use DESC.
+
<?php $tags = &get_tags( $args ) ?>
  
hide_empty - Default is true. Will not return empty terms, which means terms whose count is 0 according to the given taxonomy.
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
exclude - Default is an empty string.  A comma- or space-delimited string of term ids to exclude from the return array.  If 'include' is non-empty, 'exclude' is ignored.
+
{{Parameter|$orderby|文字列|タグの並び順のキー。|オプション|'name'}}
 +
* ''count'' - タグの使用件数
 +
* ''name'' - タグ名
 +
* ''slug'' - タグスラッグ名
 +
* ''term_group'' - タームグループ名
 +
* ''id'' または 空文字 - タグ ID
  
include - Default is an empty string. A comma- or space-delimited string of term ids to include in the return array.
+
''注'':このパラメータは以下のフォルターフックで上書きできます。
 +
  $orderby = apply_filters( 'get_terms_orderby', $orderby, $args );
  
number - The maximum number of terms to return.  Default is empty.
+
{{Parameter|$order|文字列|タグの並び順。|オプション|'ASC'}}
 +
* ''ASC'' - 昇順
 +
* ''DESC'' - 降順
  
offset - The number by which to offset the terms query.
+
{{Parameter|$hide_empty|真偽値|使用件数が0のタグを除くかどうか。|オプション|true}}
 +
* ''true'' - 除く
 +
* ''false'' - 含める
  
fields - Default is 'all', which returns an array of term objects.  If 'fields' is 'ids' or 'names', returns an array of integers or strings, respectively.
+
{{Parameter|$exclude|文字列|コンマまたはスペース区切りの、一覧から除くタグ ID。|オプション|空文字}}
  
slug - Returns terms whose "slug" matches this value. Default is empty string.
+
''注'':<tt>include</tt> が指定されている場合は、この指定は無視されます。
  
hierarchical - Whether to include terms that have non-empty descendants (even if 'hide_empty' is set to true).
+
{{Parameter|$include|文字列|コンマまたはスペース区切りの、一覧に含めるタグ ID。|オプション|空文字}}
  
search - Returned terms' names will contain the value of 'search', case-insensitive.  Default is an empty string.
+
{{Parameter|$number|整数または文字列|取得するタグの数。|オプション|空文字}}
  
name__like - Returned terms' names will begin with the value of 'name__like', case-insensitive. Default is empty string.
+
{{Parameter|$offset|整数または文字列|取得するタグのクエリ順でのオフセット。|オプション|空文字}}
  
The argument 'pad_counts', if set to true will include the quantity of a term's children in the quantity of each term's "count" object variable.
+
'''':タグ一覧の先頭から、指定した数をスキップします。
  
The 'get' argument, if set to 'all' instead of its default empty string, returns terms regardless of ancestry or whether the terms are empty.
+
{{Parameter|$fields|文字列|戻り値のタイプ。|オプション|'all'}}
 +
* ''all'' - タグオブジェクトの配列。
 +
* ''ids'' - タグ ID(整数)の配列。
 +
* ''names'' - タグ名(文字列)の配列。
  
The 'child_of' argument, when used, should be set to the integer of a term ID.  Its default is 0.  If set to a non-zero value, all returned terms will be descendants of that term according to the given taxonomy.  Hence 'child_of' is set to 0 if more than one taxonomy is passed in $taxonomies, because multiple taxonomies make term ancestry ambiguous.
+
{{Parameter|$slug|文字列|取得するタグのスラッグ。|オプション|空文字}}
  
The 'parent' argument, when used, should be set to the integer of a term ID.  Its default is the empty string, which has a different meaning from the integer 0. If set to an integer value, all returned terms will have as an immediate ancestor the term whose ID is specified by that integer according to the given taxonomy. The 'parent' argument is different from 'child_of' in that a term X is considered a 'parent' of term Y only if term X is the father of term Y, not its grandfather or great-grandfather, etc.
+
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|$hierarchical|真偽値|階層ありのタクソノミーかどうか。|オプション|空文字}}
 +
* ''true'' - 階層あり,<tt>hide_empty</tt> が <var>true</var> であっても取得します。
 +
* ''false'' - 階層なし
 +
-->
  
== Related ==
+
{{Parameter|$search|文字列|取得するタグ名に含まれる文字列。大文字/小文字を区別しない。|オプション|空文字}}
 +
 
 +
{{Parameter|$name__like|文字列|取得するタグ名の先頭から含まれる文字列。大文字/小文字を区別しない。|オプション|空文字}}
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|$pad_counts|真偽値|カテゴリー数に子カテゴリーの数を含むかどうか。|オプション|false}}
 +
* ''true'' - 階層あり,<tt>hide_empty</tt> が <var>true</var> であっても取得する
 +
* ''false'' - 階層なし
 +
-->
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|$get|文字列|カテゴリーまたは親カテゴリーの件数が0でも取得するかどうか。|オプション|空文字}}
 +
* ''all'' - 取得する
 +
* 空文字 - 取得しない
 +
-->
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|$child_of|整数|先祖カテゴリーの ID。|オプション|0}}
 +
-->
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|$parent|整数|親カテゴリーの ID。|オプション|0}}
 +
-->
 +
 
 +
<div id="Filter_Hook">
 +
== フィルターフック ==
 +
</div>
 +
 
 +
関数の最後で <tt>get_tags</tt> フィルターが実行されます。フィルターフック内で戻り値を上書きすることが可能です。
 +
$tags = apply_filters( 'get_tags', $tags, $args );
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
 
 +
<!-- Need creative examples. Feel free to link to external examples. -->
 +
 
 +
<div id="Notes">
 +
== 注 ==
 +
</div>
 +
 
 +
<div id="Change_Log">
 +
== 変更履歴 ==
 +
</div>
 +
 
 +
* [[Version 2.3|2.3]] : 新規テンプレートタグ
 +
 
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>&get_tags()</tt> は {{Trac|wp-includes/category.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
  
 
{{Tag Tag Tags}}
 
{{Tag Tag Tags}}

2010年4月25日 (日) 05:11時点における版

この関数は、投稿タグの一覧を取得します。内部で 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最新版との差分