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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(全体を和訳)
(en:Function Reference/get_tags 14:58, 16 June 2014 Katazina 版を反映して残りを和訳。)
3行目: 3行目:
 
</div>
 
</div>
  
この関数は、投稿タグの一覧を取得します。内部で [[関数リファレンス/get_terms|get_terms()]] を呼びだし、''post_tag'' タクソノミーのタームを取得しています。戻り値は <tt>get_tags</tt> フィルターフックで上書きできます。
+
この関数は、投稿タグの一覧を取得します。
 +
内部で <code>[[関数リファレンス/get terms|get_terms()]]</code> を呼び出し、<code>post_tag</code> タクソノミーのタームを取得しています。
 +
戻り値は <code>'get_tags'</code> フィルターフックで上書きできます。
  
 
<div id="Usage">
 
<div id="Usage">
9行目: 11行目:
 
</div>
 
</div>
  
  <?php $tags = &get_tags( $args ) ?>
+
  <?php $tags_array = get_tags( $args ); ?>
  
 
<div id="Parameters">
 
<div id="Parameters">
15行目: 17行目:
 
</div>
 
</div>
  
{{Parameter|$orderby|文字列|タグの並び順のキー。|オプション|'name'}}
+
<code>$args</code> に指定された条件に基づいて投稿タグのリストを取得します。
* ''count'' - タグの使用件数
+
以下に示す[[#引数|引数]]のリストを <code>$args</code> に入れるとデフォルトを上書きできます。
* ''name'' - タグ名
+
* ''slug'' - タグスラッグ名
+
* ''term_group'' - タームグループ名
+
* ''id'' または 空文字 - タグ ID
+
  
''注'':このパラメータは以下のフォルターフックで上書きできます。
+
=== 引数 ===
$orderby = apply_filters( 'get_terms_orderby', $orderby, $args );
+
  
{{Parameter|$order|文字列|タグの並び順。|オプション|'ASC'}}
+
{{Parameter|orderby|文字列|タグの並び順のキー。|オプション|'name'}}
* ''ASC'' - 昇順
+
:* ''count'' - タグの使用件数
* ''DESC'' - 降順
+
:* ''name'' - タグ名
 +
:* ''slug'' - タグスラッグ名
 +
:* ''term_group'' - タームグループ名
 +
:* ''id'' または 空文字 - タグ ID
  
{{Parameter|$hide_empty|真偽値|使用件数が0のタグを除くかどうか。|オプション|true}}
+
:'''''':このパラメータは下記のフィルターフックで上書きできます。
* ''true'' - 除く
+
$orderby = apply_filters( 'get_terms_orderby', $orderby, $args );
* ''false'' - 含める
+
  
{{Parameter|$exclude|文字列|コンマまたはスペース区切りの、一覧から除くタグ ID。|オプション|空文字}}
+
{{Parameter|order|文字列|タグの並び順。|オプション|'ASC'}}
 +
:* ''ASC'' - 昇順
 +
:* ''DESC'' - 降順
  
'''':<tt>include</tt> が指定されている場合は、この指定は無視されます。
+
{{Parameter|hide_empty|真偽値|使用件数が 0 のタグを除くかどうか。|オプション|true}}
 +
:* ''true'' - 除く
 +
:* ''false'' - 含める
  
{{Parameter|$include|文字列|コンマまたはスペース区切りの、一覧に含めるタグ ID。|オプション|空文字}}
+
{{Parameter|exclude|文字列|一覧から除くタグ ID をコンマまたはスペース区切りで指定。|オプション|空文字列}}
 +
:'''注''':<tt>include</tt> が指定されている場合、<tt>exclude</tt> の指定は無視されます。
  
{{Parameter|$number|整数または文字列|取得するタグの数。|オプション|空文字}}
+
{{Parameter|include|文字列|一覧に含めるタグ ID をコンマまたはスペース区切りで指定。|オプション|空文字列}}
  
{{Parameter|$offset|整数または文字列|取得するタグのクエリ順でのオフセット。|オプション|空文字}}
+
{{Parameter|number|整数&#124;文字列|取得するタグの数。|オプション|空文字列}}
  
''注'':タグ一覧の先頭から、指定した数をスキップします。
+
{{Parameter|offset|整数&#124;文字列|取得するタグのクエリ順でのオフセット。|オプション|空文字列}}
 +
:'''注''':タグ一覧の先頭から、指定した数をスキップします。
  
{{Parameter|$fields|文字列|戻り値のタイプ。|オプション|'all'}}
+
{{Parameter|fields|文字列|戻り値のタイプ。|オプション|'all'}}
* ''all'' - タグオブジェクトの配列。
+
:* ''all'' - タグオブジェクトの配列。
* ''ids'' - タグ ID(整数)の配列。
+
:* ''ids'' - タグ ID(整数)の配列。
* ''names'' - タグ名(文字列)の配列。
+
:* ''names'' - タグ名(文字列)の配列。
  
{{Parameter|$slug|文字列|取得するタグのスラッグ。|オプション|空文字}}
+
{{Parameter|slug|文字列|取得するタグのスラッグ。|オプション|空文字列}}
  
 
<!--カテゴリー「タクソノミー」についての記述
 
<!--カテゴリー「タクソノミー」についての記述
{{Parameter|$hierarchical|真偽値|階層ありのタクソノミーかどうか。|オプション|空文字}}
+
{{Parameter|hierarchical|真偽値|階層ありのターム(タクソノミー)かどうか。|オプション|空文字列}}
* ''true'' - 階層あり,<tt>hide_empty</tt> が <var>true</var> であっても取得します。  
+
* ''true'' - 階層あり;<tt>hide_empty</tt> が <var>true</var> であっても取得します。  
 
* ''false'' - 階層なし
 
* ''false'' - 階層なし
 
-->
 
-->
  
{{Parameter|$search|文字列|取得するタグ名に含まれる文字列。大文字/小文字を区別しない。|オプション|空文字}}
+
{{Parameter|search|文字列|取得するタグ名に含まれる文字列。大文字/小文字を区別しない。|オプション|空文字列}}
  
{{Parameter|$name__like|文字列|取得するタグ名の先頭から含まれる文字列。大文字/小文字を区別しない。|オプション|空文字}}
+
{{Parameter|name__like|文字列|取得するタグ名の先頭から含まれる文字列。大文字/小文字を区別しない。|オプション|空文字列}}
 +
 
 +
{{Parameter|description__like|文字列|取得するタグの「説明」に先頭から含まれる文字列。大文字/小文字を区別しない。|オプション|空文字列}}
  
 
<!--カテゴリー「タクソノミー」についての記述
 
<!--カテゴリー「タクソノミー」についての記述
{{Parameter|$pad_counts|真偽値|カテゴリー数に子カテゴリーの数を含むかどうか。|オプション|false}}
+
{{Parameter|pad_counts|真偽値|タームのカウント(付けられた投稿の数)に子タームのカウントを含むかどうか。|オプション|false}}
* ''true'' - 階層あり,<tt>hide_empty</tt> が <var>true</var> であっても取得する
+
* ''true'' - 含める
* ''false'' - 階層なし
+
* ''false'' - 含めない
 
-->
 
-->
  
 
<!--カテゴリー「タクソノミー」についての記述
 
<!--カテゴリー「タクソノミー」についての記述
{{Parameter|$get|文字列|カテゴリーまたは親カテゴリーの件数が0でも取得するかどうか。|オプション|空文字}}
+
{{Parameter|get|文字列|親タームであっても、またタームが空(付けられた投稿が無い)でも取得するかどうか。|オプション|空文字列}}
 
* ''all'' - 取得する  
 
* ''all'' - 取得する  
 
* 空文字 - 取得しない
 
* 空文字 - 取得しない
75行目: 82行目:
  
 
<!--カテゴリー「タクソノミー」についての記述
 
<!--カテゴリー「タクソノミー」についての記述
{{Parameter|$child_of|整数|先祖カテゴリーの ID。|オプション|0}}
+
{{Parameter|child_of|整数|先祖カテゴリーの ID。|オプション|0}}
 
-->
 
-->
  
 
<!--カテゴリー「タクソノミー」についての記述
 
<!--カテゴリー「タクソノミー」についての記述
{{Parameter|$parent|整数|親カテゴリーの ID。|オプション|0}}
+
{{Parameter|parent|整数|親カテゴリーの ID。|オプション|0}}
 
-->
 
-->
  
<div id="Filter_Hook">
+
<div id="Return_Values">
== フィルターフック ==
+
== 戻り値 ==
 
</div>
 
</div>
  
関数の最後で <tt>get_tags</tt> フィルターが実行されます。フィルターフック内で戻り値を上書きすることが可能です。
+
オブジェクトの配列(タグの配列)、または空の配列を返します。
$tags = apply_filters( 'get_tags', $tags, $args );
+
返される各オブジェクトは下記のプロパティを持ちます:
  
<div id="Examples">
+
;term_id : (''文字列'') タグの ID
 +
;name : (''文字列'') タグ名
 +
;slug : (''文字列'') タグのスラッグ
 +
<!--カテゴリー「タクソノミー」についての記述
 +
;term_group : (''文字列'')
 +
;term_taxonomy_id : (''文字列'')
 +
;taxonomy : (''文字列'')
 +
-->
 +
;description : (''文字列'') タグの説明
 +
<!--カテゴリー「タクソノミー」についての記述
 +
;parent : (''文字列'')
 +
-->
 +
;count : (''文字列'') タグが付けられた投稿の数
 +
 
 +
<div id="Example">
 
== 用例 ==
 
== 用例 ==
 
</div>
 
</div>
  
<!-- Need creative examples. Feel free to link to external examples. -->
+
タグの一覧を、タグアーカイブページへのリンクと(HTMLの)クラス指定を付けて表示します:
  
<div id="Notes">
+
<pre>
== ==
+
<?php
</div>
+
$tags = get_tags();
 
+
$html = '<div class="post_tags">';
<div id="Change_Log">
+
foreach ( $tags as $tag ) {
== 変更履歴 ==
+
$tag_link = get_tag_link( $tag->term_id );
</div>
+
 
+
$html .= "<a href='{$tag_link}' title='{$tag->name} Tag' class='{$tag->slug}'>";
* [[Version 2.3|2.3]] : 新規テンプレートタグ
+
$html .= "{$tag->name}</a>";
 +
}
 +
$html .= '</div>';
 +
echo $html;
 +
?>
 +
</pre>
  
 
<div id="Source_File">
 
<div id="Source_File">
109行目: 135行目:
 
</div>
 
</div>
  
<tt>&get_tags()</tt> は {{Trac|wp-includes/category.php}} にあります。
+
<tt>get_tags()</tt> は {{Trac|wp-includes/category.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">
== 関連資料 ==
+
== 関連項目 ==
 
</div>
 
</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|144298}} <!-- 14:58, 16 June 2014 Katazina 版 -->
[[en:Function Reference/get tags]]
+
 
 +
{{DEFAULTSORT:Get_tags}}
 +
[[Category:関数]]
 +
 
 +
[[en:Function Reference/get_tags]]

2014年8月10日 (日) 13:57時点における版

この関数は、投稿タグの一覧を取得します。 内部で 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 
(文字列) タグが付けられた投稿の数

用例

タグの一覧を、タグアーカイブページへのリンクと(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最新版との差分