• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「テンプレートタグ/get the category」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(1 版)
(引数と返り値についての情報追加、及び表示の整理)
1行目: 1行目:
* 書式: <?php get_the_category(); ?>
+
== 説明 ==
* 説明: 記事のカテゴリー名、ID、カテゴリースラッグ、説明、親カテゴリーなどの情報をPHPの配列として返す。コード記述例のような形式で変数を使う。
+
* 位置: ループ内
+
* 引数: なし
+
* 変数:
+
** cat_ID - 記事のカテゴリーID。
+
** cat_name - 記事のカテゴリー名。
+
** category_nicename - 記事カテゴリーのカテゴリースラッグ。
+
** category_description - 記事のカテゴリー説明文。
+
** category_parent - 記事の親カテゴリーにあたるカテゴリーのID。親カテゴリーがない場合は「0」を返す。
+
** category_count -カテゴリーが使われている回数。
+
* コード記述例:
+
<pre><nowiki><?php $cat = get_the_category(); $cat = $cat[0]; {
+
  
  echo '<img src="http://example.com/images/' . $cat->category_nicename . '.jpg" alt="' . $cat->cat_name . '" />';
+
このテンプレートタグ '''<code>get_the_category</code>''' は、現在の記事が属するカテゴリをオブジェクト形式で返します。このタグはパラメータとして投稿IDを渡すことで、[[The Loop|ループ]]の外でも使うことが出来ます。
  
} ?></nowiki></pre>
+
<div id="Usage">
* 出力例:<code><nowiki><img src="http://example.com/images/plugin.jpg" alt="プラグイン" /></nowiki></code>
+
== 使い方 ==
 +
</div>
 +
 
 +
<?php get_the_category( $post_id ); ?>
 +
 
 +
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
 
 +
{{Parameter|$post_id|整数|投稿 ID。|オプション|$post->ID(現在の投稿ID)}}
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
 
 +
<div id="Show_All_Categories_as_Links">
 +
=== 全てのカテゴリをリンクで表示 ===
 +
</div>
 +
 
 +
ポストに登録された全てのカテゴリをリンクで表示します。これは[[get_the_category_list|get_the_category_list()]]と同様の動きです。
 +
 
 +
<?php
 +
$categories = get_the_category();
 +
$separator = ' ';
 +
$output = '';
 +
if($categories){
 +
foreach($categories as $category) {
 +
$output .= '<a href="'.get_category_link( $category->term_id ).'" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '">'.$category->cat_name.'</a>'.$separator;
 +
}
 +
echo trim($output, $separator);
 +
}
 +
?>
 +
 
 +
<div id="Return_Values">
 +
== 返り値 ==
 +
</div>
 +
 
 +
;(配列)
 +
:カテゴリオブジェクトの配列
 +
 
 +
<div id="Member_Variables_in_Returned_Objects">
 +
==== 返す配列内のメンバ変数 ====
 +
</div>
 +
 
 +
;term_id
 +
:(文字列)カテゴリID
 +
 
 +
;name
 +
:(文字列)カテゴリ名
 +
 
 +
;slug
 +
:(文字列)カテゴリスラッグ名
 +
 
 +
;term_group
 +
:(文字列)カテゴリグループ
 +
 
 +
;term_taxonomy_id
 +
:(文字列)カテゴリタクソノミーID
 +
 
 +
;taxonomy
 +
:(文字列)タクソノミー名
 +
 
 +
;description
 +
:(文字列)カテゴリの説明
 +
 
 +
;parent
 +
:(文字列)親カテゴリ
 +
 
 +
;count
 +
:(文字列)カテゴリに登録されている記事数
 +
 
 +
;filter
 +
:(文字列)
 +
 
 +
;cat_ID
 +
:(文字列)カテゴリID
 +
 
 +
;category_count
 +
:(文字列)カテゴリに登録されている記事数
 +
 
 +
;category_description
 +
:(文字列)カテゴリの説明
 +
 
 +
;cat_name
 +
:(文字列)カテゴリ名
 +
 
 +
;category_nicename
 +
:(文字列)カテゴリスラッグ名
 +
 
 +
;category_parent
 +
:(文字列)親カテゴリ
 +
 
 +
<div id="Related">
 +
== 関連 ==
 +
</div>
 +
 
 +
{{Tag Category Tags}}
 +
{{PHP Function Tag Footer}}
 +
 
 +
{{DEFAULTSORT:The_category}}
  
 
[[en:Template Tags/get_the_category]]
 
[[en:Template Tags/get_the_category]]

2014年2月13日 (木) 21:26時点における版

説明

このテンプレートタグ get_the_category は、現在の記事が属するカテゴリをオブジェクト形式で返します。このタグはパラメータとして投稿IDを渡すことで、ループの外でも使うことが出来ます。

使い方

<?php get_the_category( $post_id ); ?>

パラメータ

$post_id
整数) (オプション) 投稿 ID。
初期値: $post->ID(現在の投稿ID)

用例

ポストに登録された全てのカテゴリをリンクで表示します。これはget_the_category_list()と同様の動きです。

<?php
$categories = get_the_category();
$separator = ' ';
$output = ;
if($categories){
	foreach($categories as $category) {
		$output .= '<a href="'.get_category_link( $category->term_id ).'" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $category->name ) ) . '">'.$category->cat_name.'</a>'.$separator;
	}
echo trim($output, $separator);
}
?>

返り値

(配列)
カテゴリオブジェクトの配列

返す配列内のメンバ変数

term_id
(文字列)カテゴリID
name
(文字列)カテゴリ名
slug
(文字列)カテゴリスラッグ名
term_group
(文字列)カテゴリグループ
term_taxonomy_id
(文字列)カテゴリタクソノミーID
taxonomy
(文字列)タクソノミー名
description
(文字列)カテゴリの説明
parent
(文字列)親カテゴリ
count
(文字列)カテゴリに登録されている記事数
filter
(文字列)
cat_ID
(文字列)カテゴリID
category_count
(文字列)カテゴリに登録されている記事数
category_description
(文字列)カテゴリの説明
cat_name
(文字列)カテゴリ名
category_nicename
(文字列)カテゴリスラッグ名
category_parent
(文字列)親カテゴリ


カテゴリータグ: 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()


テンプレートタグへの PHP 関数型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。