当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get tags 22:09, 30 June 2009 Ramiy)
 
(参考: セクションの内容が誤っていた為、削除。sanitize関数を呼び出していないのが正しい。)
 
(2人の利用者による、間の4版が非表示)
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:
+
この関数は、投稿タグの一覧を取得します。
 +
内部で <code>[[関数リファレンス/get terms|get_terms()]]</code> を呼び出し、<code>post_tag</code> タクソノミーのタームを取得しています。
 +
戻り値は <code>'get_tags'</code> フィルターフックで上書きできます。
  
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_array = 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.
+
<code>$args</code> に指定された条件に基づいて投稿タグのリストを取得します。
 +
以下に示す[[#引数|引数]]のリストを <code>$args</code> に入れるとデフォルトを上書きできます。
  
include - Default is an empty string.  A comma- or space-delimited string of term ids to include in the return array.
+
=== 引数 ===
  
number - The maximum number of terms to return.  Default is empty.
+
{{Parameter|orderby|文字列|タグの並び順のキー。|オプション|'name'}}
 +
:* ''count'' - タグの使用件数
 +
:* ''name'' - タグ名
 +
:* ''slug'' - タグスラッグ名
 +
:* ''term_group'' - タームグループ名
 +
:* ''id'' または 空文字 - タグ ID
  
offset - The number by which to offset the terms query.
+
:'''注''':このパラメータは下記のフィルターフックで上書きできます。
 +
$orderby = apply_filters( 'get_terms_orderby', $orderby, $args );
  
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|order|文字列|タグの並び順。|オプション|'ASC'}}
 +
:* ''ASC'' - 昇順
 +
:* ''DESC'' - 降順
  
slug - Returns terms whose "slug" matches this value. Default is empty string.
+
{{Parameter|hide_empty|真偽値|使用件数が 0 のタグを除くかどうか。|オプション|true}}
 +
:* ''true'' - 除く
 +
:* ''false'' - 含める
  
hierarchical - Whether to include terms that have non-empty descendants (even if 'hide_empty' is set to true).
+
{{Parameter|exclude|文字列|一覧から除くタグ ID をコンマまたはスペース区切りで指定。|オプション|空文字列}}
 +
:'''注''':<tt>include</tt> が指定されている場合、<tt>exclude</tt> の指定は無視されます。
  
search - Returned terms' names will contain the value of 'search', case-insensitive.  Default is an empty string.
+
{{Parameter|include|文字列|一覧に含めるタグ ID をコンマまたはスペース区切りで指定。|オプション|空文字列}}
  
name__like - Returned terms' names will begin with the value of 'name__like', case-insensitive. Default is empty string.
+
{{Parameter|number|整数&#124;文字列|取得するタグの数。|オプション|空文字列}}
  
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.
+
{{Parameter|offset|整数&#124;文字列|取得するタグのクエリ順でのオフセット。|オプション|空文字列}}
 +
:'''''':タグ一覧の先頭から、指定した数をスキップします。
  
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|description__like|文字列|取得するタグの「説明」に含まれる文字列。大文字/小文字を区別しない。|オプション|空文字列}}
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|pad_counts|真偽値|タームのカウント(付けられた投稿の数)に子タームのカウントを含むかどうか。|オプション|false}}
 +
* ''true'' - 含める
 +
* ''false'' - 含めない
 +
-->
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|get|文字列|親タームであっても、またタームが空(付けられた投稿が無い)でも取得するかどうか。|オプション|空文字列}}
 +
* ''all'' - 取得する
 +
* 空文字 - 取得しない
 +
-->
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|child_of|整数|先祖カテゴリーの ID。|オプション|0}}
 +
-->
 +
 
 +
<!--カテゴリー「タクソノミー」についての記述
 +
{{Parameter|parent|整数|親カテゴリーの ID。|オプション|0}}
 +
-->
 +
 
 +
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
オブジェクトの配列(タグの配列)、または空の配列を返します。
 +
返される各オブジェクトは下記のプロパティを持ちます:
 +
 
 +
;term_id : (''整数'') タグの ID
 +
;name : (''文字列'') タグ名
 +
;slug : (''文字列'') タグのスラッグ
 +
<!--カテゴリー「タクソノミー」についての記述
 +
;term_group : (''整数'')
 +
;term_taxonomy_id : (''整数'')
 +
;taxonomy : (''文字列'')
 +
-->
 +
;description : (''文字列'') タグの説明
 +
<!--カテゴリー「タクソノミー」についての記述
 +
;parent : (''整数'')
 +
-->
 +
;count : (''整数'') タグが付けられた投稿の数
 +
 
 +
<div id="Filter_Hook">
 +
=== フィルターフック ===
 +
</div>
 +
 
 +
関数の最後で <tt>'get_tags'</tt> フィルターが実行されます。フィルターフック内で戻り値を上書きすることが可能です。
 +
$tags = apply_filters( 'get_tags', $tags, $args );
 +
 
 +
<div id="Example">
 +
 
 +
== 用例 ==
 +
</div>
 +
 
 +
タグの一覧を、タグアーカイブページへのリンクと(HTMLの)クラス指定を付けて表示します:
 +
 
 +
<pre>
 +
<?php
 +
$tags = get_tags();
 +
$html = '<div class="post_tags">';
 +
foreach ( $tags as $tag ) {
 +
$tag_link = get_tag_link( $tag->term_id );
 +
 +
$html .= "<a href='{$tag_link}' title='{$tag->name} Tag' class='{$tag->slug}'>";
 +
$html .= "{$tag->name}</a>";
 +
}
 +
$html .= '</div>';
 +
echo $html;
 +
?>
 +
</pre>
 +
 
 +
== 変更履歴 ==
 +
 
 +
* [[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}}
{{PHP Function Tag Footer}}
+
 
{{原文|Function Reference/get tags|75071}}<!-- 22:09, 30 June 2009 Ramiy -->
+
{{Tag Footer}}
[[Category:Functions]]
+
 
{{DEFAULTSORT:get_tags}}
+
{{原文|Function_Reference/get_tags|145530}} <!-- 08:11, 12 August 2014 Iworks 版 -->
[[en:Function Reference/get tags]]
+
 
 +
{{DEFAULTSORT:Get_tags}}
 +
[[Category:関数]]
 +
 
 +
[[en:Function Reference/get_tags]]

2014年9月6日 (土) 16:54時点における最新版

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

使い方

<?php $tags_array = get_tags( $args ); ?>

パラメータ

$args に指定された条件に基づいて投稿タグのリストを取得します。 以下に示す引数のリストを $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 が指定されている場合、exclude の指定は無視されます。
include
文字列) (オプション) 一覧に含めるタグ ID をコンマまたはスペース区切りで指定。
初期値: 空文字列
number
整数|文字列) (オプション) 取得するタグの数。
初期値: 空文字列
offset
整数|文字列) (オプション) 取得するタグのクエリ順でのオフセット。
初期値: 空文字列
:タグ一覧の先頭から、指定した数をスキップします。
fields
文字列) (オプション) 戻り値のタイプ。
初期値: 'all'
  • all - タグオブジェクトの配列。
  • ids - タグ ID(整数)の配列。
  • names - タグ名(文字列)の配列。
slug
文字列) (オプション) 取得するタグのスラッグ。
初期値: 空文字列


search
文字列) (オプション) 取得するタグ名に含まれる文字列。大文字/小文字を区別しない。
初期値: 空文字列
name__like
文字列) (オプション) 取得するタグ名に含まれる文字列。大文字/小文字を区別する。
初期値: 空文字列
description__like
文字列) (オプション) 取得するタグの「説明」に含まれる文字列。大文字/小文字を区別しない。
初期値: 空文字列



戻り値

オブジェクトの配列(タグの配列)、または空の配列を返します。 返される各オブジェクトは下記のプロパティを持ちます:

term_id 
(整数) タグの ID
name 
(文字列) タグ名
slug 
(文字列) タグのスラッグ
description 
(文字列) タグの説明
count 
(整数) タグが付けられた投稿の数

フィルターフック

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

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

用例

タグの一覧を、タグアーカイブページへのリンクと(HTMLの)クラス指定を付けて表示します:

<?php
$tags = get_tags();
$html = '<div class="post_tags">';
foreach ( $tags as $tag ) {
	$tag_link = get_tag_link( $tag->term_id );
			
	$html .= "<a href='{$tag_link}' title='{$tag->name} Tag' class='{$tag->slug}'>";
	$html .= "{$tag->name}</a>";
}
$html .= '</div>';
echo $html;
?>

変更履歴

ソースファイル

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()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_tags最新版との差分