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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function_Reference/get_category 16:48, 23 March 2011 MichaelH 版と比較。原文テンプレート等を追加。)
1行目: 1行目:
 +
<div id="Description">
 
== 説明 ==
 
== 説明 ==
カテゴリーIDまたはカテゴリーオブジェクトによって、カテゴリーの詳細データを取得します。
+
</div>
 +
カテゴリー ID またはカテゴリーオブジェクトを指定して、カテゴリーの詳細データを取得します。
  
<tt>$category</tt>パラメータにオブジェクトを指定すると、それはデータベースから取得されたカテゴリー行オブジェクトと判断されます。その場合、カテゴリーの詳細データはキャッシュされます。
+
<tt>$category</tt> パラメータにオブジェクトを指定すると、それはデータベースから取得されたカテゴリー行オブジェクトと判断されます。その場合、カテゴリーの詳細データはキャッシュされます。
  
<tt>$category</tt>パラメータに整数を指定するとカテゴリーIDと判断されます。もしカテゴリーがキャッシュされていなかった場合、カテゴリーはデータベースから取得されて、戻り値として返されます。
+
<tt>$category</tt> パラメータに整数を指定するとカテゴリー ID と判断されます。もしカテゴリーがキャッシュされていなかった場合、カテゴリーはデータベースから取得されて、戻り値として返されます。
  
[[Function_Reference/get_term|<tt>get_term()</tt>]]を見ると、どちらの場合もいくつかのフィルターを通ったのち、最終的にパラメータ<tt>$filter</tt>で指定されたフィルターによってサニタイズされることがわかります。
+
[[関数リファレンス/get_term|<tt>get_term()</tt>]] を見ると、どちらの場合もいくつかのフィルターを通された後、最終的にパラメータ <tt>$filter</tt> で指定されたフィルターによって無害化(サニタイズ)されることがわかります。
  
カテゴリーは後方互換性のための変換がおこなわれます。
+
カテゴリーの詳細データは後方互換性を保つため変換されます。
  
<b>注意</b>: IDからリンクカテゴリーを取得するには[[Function_Reference/get_term|<tt>get_term()</tt>]]を使用してください。<tt>get_category</tt>は、記事カテゴリーしか返しません。
+
<b>注意</b>:ID からリンクカテゴリーを取得するには [[関数リファレンス/get_term|<tt>get_term()</tt>]] を使用してください。<tt>get_category()</tt>は、投稿カテゴリーしか返しません。
  
 +
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 +
</div>
 
  <?php get_category( $category, $output, $filter ) ?>
 
  <?php get_category( $category, $output, $filter ) ?>
  
 +
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
{{Parameter|$category|integer&#124;object|カテゴリーIDまたはカテゴリー行オブジェクト}}
+
</div>
{{Parameter|$output|string|定数 OBJECT, ARRAY_A または ARRAY_N|optional|OBJECT}}
+
{{Parameter|$category|整数&#124;オブジェクト|カテゴリー ID またはカテゴリー行オブジェクト}}
{{Parameter|$filter|string|デフォルト('raw')ではWordPress定義フィルターは適用されません。|optional|'raw'}}
+
{{Parameter|$output|文字列|定数 OBJECT, ARRAY_A または ARRAY_N|オプション|OBJECT}}
 +
{{Parameter|$filter|文字列|デフォルト(<code>'raw'</code>)では WordPress が予め定義したフィルターはどれも適用されません。|オプション|'raw'}}
  
 +
<div id="Return_Values">
 
== 戻り値 ==
 
== 戻り値 ==
; (mixed) : パラメータ<tt>$output</tt>で指定された型で、カテゴリー詳細データを返します
+
</div>
 +
; (mixed) : <tt>$output</tt> パラメータで指定された型で、カテゴリー詳細データを返します。
  
 +
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 +
</div>
  
 +
<div id="Print_category_data">
 
=== カテゴリーデータを表示する ===
 
=== カテゴリーデータを表示する ===
<pre>$thisCat = get_category(get_query_var('cat'),false);
+
</div>
 +
<pre>
 +
$thisCat = get_category( get_query_var( 'cat' ), false );
 +
print_r( $thisCat );
 +
</pre>
  
print_r($thisCat);</pre>
+
上のコードにより、例えば下記のように表示されます。
  
上のコードにより、下記が表示されます
+
<pre>
 
+
stdClass Object
<pre>stdClass Object
+
 
(
 
(
 
     [term_id] => 85
 
     [term_id] => 85
49行目: 63行目:
 
     [category_nicename] => category-name
 
     [category_nicename] => category-name
 
     [category_parent] => 70
 
     [category_parent] => 70
)</pre>
+
)
 +
</pre>
  
== ==
+
<div id="Notes">
* 使用: タクソノミーからカテゴリーデータを取得する際に[[Function_Reference/get_term|<tt>get_term()</tt>]]が使われています。
+
== 参考 ==
* <code>count</code>値は、カスタムの記事タイプを含んだ数値が返されます(カスタムの記事タイプが標準的なカテゴリーを使っていた場合)。
+
</div>
 +
* タクソノミーからカテゴリーデータを取得する際に [[関数リファレンス/get_term|<tt>get_term()</tt>]] が使われています。
 +
* カスタム投稿タイプが標準のカテゴリーを使っている場合、<code>count</code> 値はカスタム投稿タイプの投稿を含んだ数値になります。
  
 +
<div id="Change_Log">
 
== 変更履歴 ==
 
== 変更履歴 ==
* [[Version 1.5.1|1.5.1]]より
+
</div>
 +
* [[Version 1.5.1|1.5.1]] にて導入されました。
  
 +
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
<tt>get_category()</tt> は {{Trac|wp-includes/category.php}}に含まれています。
+
</div>
 +
<tt>get_category()</tt> は {{Trac|wp-includes/category.php}} に含まれています。
 +
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
 
 +
{{Tag Category Tags}}, [[関数リファレンス/get_term|get_term()]]
  
 
{{Tag Footer}}
 
{{Tag Footer}}
 +
 +
{{原文|Function Reference/get_category|102595}} <!-- 16:48, 23 March 2011 MichaelH 版 -->
 +
 +
{{DEFAULTSORT:Get_category}}
 +
[[Category:関数]]
  
 
[[en:Function_Reference/get_category]]
 
[[en:Function_Reference/get_category]]

2014年8月17日 (日) 00:53時点における版

カテゴリー ID またはカテゴリーオブジェクトを指定して、カテゴリーの詳細データを取得します。

$category パラメータにオブジェクトを指定すると、それはデータベースから取得されたカテゴリー行オブジェクトと判断されます。その場合、カテゴリーの詳細データはキャッシュされます。

$category パラメータに整数を指定するとカテゴリー ID と判断されます。もしカテゴリーがキャッシュされていなかった場合、カテゴリーはデータベースから取得されて、戻り値として返されます。

get_term() を見ると、どちらの場合もいくつかのフィルターを通された後、最終的にパラメータ $filter で指定されたフィルターによって無害化(サニタイズ)されることがわかります。

カテゴリーの詳細データは後方互換性を保つため変換されます。

注意:ID からリンクカテゴリーを取得するには get_term() を使用してください。get_category()は、投稿カテゴリーしか返しません。

使い方

<?php get_category( $category, $output, $filter ) ?>

パラメータ

$category
整数|オブジェクト) (必須) カテゴリー ID またはカテゴリー行オブジェクト
初期値: なし
$output
文字列) (オプション) 定数 OBJECT, ARRAY_A または ARRAY_N
初期値: OBJECT
$filter
文字列) (オプション) デフォルト('raw')では WordPress が予め定義したフィルターはどれも適用されません。
初期値: 'raw'

戻り値

(mixed) 
$output パラメータで指定された型で、カテゴリー詳細データを返します。

用例

$thisCat = get_category( get_query_var( 'cat' ), false );
print_r( $thisCat );

上のコードにより、例えば下記のように表示されます。

stdClass Object
(
    [term_id] => 85
    [name] => Category Name
    [slug] => category-name
    [term_group] => 0
    [term_taxonomy_id] => 85
    [taxonomy] => category
    [description] => 
    [parent] => 70
    [count] => 0
    [cat_ID] => 85
    [category_count] => 0
    [category_description] => 
    [cat_name] => Category Name
    [category_nicename] => category-name
    [category_parent] => 70
)

参考

  • タクソノミーからカテゴリーデータを取得する際に get_term() が使われています。
  • カスタム投稿タイプが標準のカテゴリーを使っている場合、count 値はカスタム投稿タイプの投稿を含んだ数値になります。

変更履歴

  • 1.5.1 にて導入されました。

ソースファイル

get_category()wp-includes/category.php に含まれています。


カテゴリータグ: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category() , get_term()


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


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