2022年04月25日

WP関数:get_category()

この関数の説明

WP関数の get_category() は、カテゴリIDから、カテゴリの情報を取得する関数です。

 


関数

get_category( $category, $output, $filter )

 


パラメータ

$category(整数)(必須)

カテゴリーIDを指定します。

 

$output(文字列) (オプション)

どの様な形式で取り出すのか?を指定します。

'OBJECT'   :オブジェクト形式(デフォルト)

'ARRAY_A' :連想配列形式

'ARRAY_N' :添字形式

 

$filter(文字列) (オプション)

デフォルト('raw')では WordPress が予め定義したフィルターはどれも適用されません。
初期値: 'raw'

 


戻り値

カテゴリ情報が指定した形式で返されます。

下記はオブジェクト形式又は連想配列形式の主要プロパティ又はキーです。

プロパティ 名前 解説
cat_ID カテゴリID 文書を抽出するWP_Query($args)で利用できるキーになります

例)'cat' => XX

slug カテゴリのスラッグ名 文書を抽出するWP_Query($args)で利用できるキー

例)'category_name' => XX

name カテゴリ名 表示されるカテゴリ名
category_parent 親のカテゴリID 親カテゴリを調べる時に利用します

0:親はありません

n:親のカテゴリIDです

category_count カテゴリの投稿数 このカテゴリの投稿数を表示する時に利用します

 


事例

①投稿に設定されている親カテゴリの情報を取得します(オブジェクト形式)

<?php 
    $cat = get_the_category();                    // 投稿のカテゴリ情報を取得
    $p_cat_id = $cat[0] -> category_parent; // 親のカテゴリIDの取得
    $p_cat = get_category($p_cat_id);         // カテゴリ情報の取得
    echo 'スラッグ名='.$p_cat -> slug.'<br>';  // カテゴリのスラッグ名 
    echo 'カテゴリ名='.$p_cat -> name.'<br>'; // カテゴリ名
?>
<pre>
   <?php print_r($p_cat);?>
</pre>

■2~3行目:投稿に設定されている親カテゴリのIDを所得します。

■4~6行目:親カテゴリの情報を取得して表示します。

■下記が表示されます(参考)

スラッグ名=html
カテゴリ名=HTML言語

   WP_Term Object
(
    [term_id] => 9
    [name] => HTML言語
    [slug] => html
    [term_group] => 0
    [term_taxonomy_id] => 9
    [taxonomy] => category
    [description] => 
    [parent] => 0
    [count] => 0
    [filter] => raw
    [cat_ID] => 9
    [category_count] => 0
    [category_description] => 
    [cat_name] => HTML言語
    [category_nicename] => html
    [category_parent] => 0
)

 

②投稿に設定されている親カテゴリの情報を取得します(連想配列形式)

<?php 
    $cat = get_the_category();                   // 投稿のカテゴリ情報を取得
    $p_cat_id = $cat[0] -> category_parent; // 親のカテゴリIDの取得
    $p_cat = get_category($p_cat_id,'ARRAY_A'); // カテゴリ情報の取得
    echo 'スラッグ名='.$p_cat['slug'].'<br>';  // カテゴリのスラッグ名 
    echo 'カテゴリ名='.$p_cat['name'].'<br>'; // カテゴリ名
?>
<pre>
   <?php print_r($p_cat);?>
</pre>

■4行目:連想配列形式で情報を取得しています。

■5~6行目:連想配列なので呼び出し方がオブジェクトとは異なります。

■下記が表示されます(参考)

スラッグ名=html
カテゴリ名=HTML言語

   Array
(
    [term_id] => 9
    [name] => HTML言語
    [slug] => html
    [term_group] => 0
    [term_taxonomy_id] => 9
    [taxonomy] => category
    [description] => 
    [parent] => 0
    [count] => 0
    [filter] => raw
    [cat_ID] => 9
    [category_count] => 0
    [category_description] => 
    [cat_name] => HTML言語
    [category_nicename] => html
    [category_parent] => 0
)

 


関連情報

関連関数は カテゴリ関連関数 を参照してください。

 

関数一覧
  • 1.WPのエスケープ処理
  • 2.WPプログラムの基本
  • 3.ヘッダ/フッタ/サイドバで使われる関数
  • 4.DBからの読込関数
  • 5.一般テンプレートの中で使われる関数
  • 6.その他のWP関数
  • add_shortcode()
  • bloginfo()
  • body_class()
  • date_i18n()
  • dynamic_sidebar()
  • edit_post_link()
  • esc_attr()
  • esc_html_e()
  • esc_html()
  • esc_url()
  • get_ancestors()
  • get_cat_ID()
  • get_cat_name()
  • get_category_link()
  • get_category_parents()
  • get_category()
  • get_footer()
  • get_header()
  • get_home_url()
  • get_post_format()
  • get_post_meta()
  • get_post_thumbnail_id()
  • get_query_var()
  • get_search_query()
  • get_sidebar()
  • get_site_url()
  • get_stylesheet_directory_uri()
  • get_stylesheet_uri()
  • get_template_directory_uri()
  • get_template_part()
  • get_the_category()
  • get_the_content()
  • get_the_date()
  • get_the_excerpt()
  • get_the_ID()
  • get_the_modified_date()
  • get_the_modified_time()
  • get_the_permalink()
  • get_the_post_thumbnail()
  • get_the_tags()
  • get_the_time()
  • get_the_title()
  • get_uploaded_header_images()
  • get_year_link()
  • has_category()
  • has_custom_logo()
  • has_header_image()
  • has_header_video()
  • has_nav_menu()
  • has_post_thumbnail()
  • has_tag()
  • header_image()
  • home_url()
  • is_admin()
  • is_category()
  • is_date()
  • is_front_page()
  • is_home()
  • is_main_query()
  • is_page()
  • is_search()
  • is_single()
  • language_attributes()
  • the_category()
  • the_content()
  • the_custom_header_markup()
  • the_custom_logo()
  • the_date()
  • the_excerpt()
  • the_ID()
  • the_modified_date()
  • the_modified_time()
  • the_permalink()
  • the_post_thumbnail()
  • the_search_query()
  • the_tags()
  • the_time()
  • the_title()
  • update_post_meta()
  • wp_get_attachment_image_src()
  • wp_nav_menu()
  • WP_Query()