関数リファレンス/get category

目次 1 説明 2 使い方 3 パラメータ 4 戻り値 5 用例 5.1 カテゴリーデータを表示する 6 注 7 変更履歴 8 ソースファイル

説明

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

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

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

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

カテゴリーは後方互換性のための変換がおこなわれます。

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

使い方

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

パラメータ

$category

（integer|object） （必須） カテゴリーIDまたはカテゴリー行オブジェクト

初期値： なし

$output

（string） （optional） 定数 OBJECT, ARRAY_A または ARRAY_N

初期値： OBJECT

$filter

（string） （optional） デフォルト('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に含まれています。