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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get_the_category_list 05:25, 16 May 2014 Mauryaratan 版を反映して和訳。)
 
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
{{Old}}
+
== 説明 ==
 +
</div>
  
== 概要 ==
+
カテゴリーのリストを HTML 形式またはカスタムフォーマットで取得します。
 +
普通は、投稿のエントリーメタ情報の一部として、カテゴリーの簡単なコンマ区切りリストを取得するために使います。
 +
もっと強力なリスト取得用関数として [[テンプレートタグ/wp_list_categories|wp_list_categories()]] があります。
  
Retrieve category list in either HTML list or custom format. Generally used for quick, delimited (eg: comma-separated) lists of categories, as part of a post's entry meta. For a more powerful, list-based function, see [[Function_Reference/wp_list_categories|wp_list_categories()]].
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
== 用例 ==
+
<?php get_the_category_list( $separator, $parents, $post_id ); ?>
  
<pre>
+
<div id="Parameters">
<?php get_the_category_list( $separator, $parents, $post_id ); ?>
+
== パラメータ ==
</pre>
+
</div>
  
== 引数 ==
+
{{Parameter|$separator|文字列|カテゴリーの区切り文字列。|オプション|空の文字列}}
  
{{Parameter|$separator|string|Optional, default is empty string. Separator for between the categories.|optional|empty string}}
+
{{Parameter|$parents|文字列|親カテゴリーの表示方法を指定する。有効な値は:<ul><li>'multiple'</li><li>'single'</li><li>空の文字列</li></ul>|オプション|空の文字列}}
  
{{Parameter|$parents|string|Optional. How to display the parents. Values: 'multiple', 'single', empty string|optional|empty string}}
+
{{Parameter|$post_id|整数|カテゴリーを取得する投稿の ID|オプション|false}}
 
+
{{Parameter|$post_id|int|Optional. Post ID to retrieve categories.|optional|false}}
+
  
 +
<div id="Return Values">
 
== 戻り値 ==
 
== 戻り値 ==
 +
</div>
 +
 +
{{Return||文字列|}}
  
{{Return||string|}}
+
<div id="Notes">
 +
== 参考 ==
 +
</div>
  
== Notes ==
+
カテゴリーは、親子関係に依らず、名前順に出力されます。
Categories are ordered by name regardless of the parent-child category relationship. See [[Template_Tags/wp_list_categories#Display_Categories_Assigned_to_a_Post|this example]] from [[Function_Reference/wp_list_categories|wp_list_categories()]] to display the Post categories with the category relationship intact.
+
カテゴリーの関係を保って投稿カテゴリーを表示するには、[[テンプレートタグ/wp list categories|wp_list_categories()]] を使います。
 +
その「[[テンプレートタグ/wp list categories#Display_Categories_Assigned_to_a_Post|投稿に付けられたカテゴリーを表示]]」セクションを参照してください。
  
 +
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
=== Implementation in WordPress default Twenty Eleven theme ===
+
</div>
  
In content-single.php:
+
<div id="Implementation_in_WordPress_default_Twenty_Eleven_theme">
 +
=== WordPress デフォルトの Twenty Eleven テーマでの利用例 ===
 +
</div>
 +
 
 +
テンプレート content-single.php の中で:
  
 
<pre>
 
<pre>
 
<?php
 
<?php
/* translators: used between list items, there is a space after the comma */
+
/* 翻訳者へ:リスト項目を区切るため、コンマの後にスペースがある */
 
$categories_list = get_the_category_list( __( ', ', 'twentyeleven' ) );
 
$categories_list = get_the_category_list( __( ', ', 'twentyeleven' ) );
  
/* translators: used between list items, there is a space after the comma */
+
/* 翻訳者へ:リスト項目を区切るため、コンマの後にスペースがある */
 
$tag_list = get_the_tag_list( '', __( ', ', 'twentyeleven' ) );
 
$tag_list = get_the_tag_list( '', __( ', ', 'twentyeleven' ) );
 
if ( '' != $tag_list ) {
 
if ( '' != $tag_list ) {
59行目: 74行目:
 
</pre>
 
</pre>
  
=== Display as List Items ===
+
<div id="Display_as_List_Items">
 +
=== リスト項目として表示する ===
 +
</div>
  
By leaving the $separator value empty, it will generate an unordered list instead, complete with classes.
+
<code>$separator</code> を空にすると、クラス指定を含む、順序なし箇条書きリストを生成します。
  
 
<pre>
 
<pre>
67行目: 84行目:
 
</pre>
 
</pre>
  
Result:
+
結果は次のようになります:
 +
 
 
<pre>
 
<pre>
 
<ul class="post-categories">
 
<ul class="post-categories">
 
<li>
 
<li>
<a href="http:myblog.com/category/business" title="View all posts in Business" rel="category tag">Business</a>
+
<a href="http://myblog.com/category/business" title="ビジネスの投稿をすべて見る" rel="category tag">ビジネス</a>
 
</li>
 
</li>
 
</ul>
 
</ul>
 
</pre>
 
</pre>
  
 +
<div id="Change Log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 +
</div>
  
[[Version 1.5.1|1.5.1]]以降
+
[[Version 1.5.1|バージョン 1.5.1]] にて導入されました。
  
 +
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
 +
</div>
  
<tt>get_the_category_list()</tt> is located in {{Trac|wp-includes/category-template.php}}
+
<tt>get_the_category_list()</tt> {{Trac|wp-includes/category-template.php}} にあります。
  
== 関連 ==
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
 
{{Tag Category Tags}}
 
{{Tag Category Tags}}
90行目: 114行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
[[Category:Functions]]
+
{{原文|Function Reference/get_the_category_list|143601}} <!-- 05:25, 16 May 2014 Mauryaratan 版 -->
 +
 
 +
{{DEFAULTSORT:Get_the_category_list}}
 +
[[Category:関数]]
 +
 
 +
[[en:Function Reference/get_the_category_list]]

2014年8月9日 (土) 23:18時点における最新版

カテゴリーのリストを HTML 形式またはカスタムフォーマットで取得します。 普通は、投稿のエントリーメタ情報の一部として、カテゴリーの簡単なコンマ区切りリストを取得するために使います。 もっと強力なリスト取得用関数として wp_list_categories() があります。

使い方

<?php get_the_category_list( $separator, $parents, $post_id ); ?>

パラメータ

$separator
文字列) (オプション) カテゴリーの区切り文字列。
初期値: 空の文字列
$parents
文字列) (オプション) 親カテゴリーの表示方法を指定する。有効な値は:
  • 'multiple'
  • 'single'
  • 空の文字列
初期値: 空の文字列
$post_id
整数) (オプション) カテゴリーを取得する投稿の ID
初期値: false

戻り値

(文字列) 

参考

カテゴリーは、親子関係に依らず、名前順に出力されます。 カテゴリーの関係を保って投稿カテゴリーを表示するには、wp_list_categories() を使います。 その「投稿に付けられたカテゴリーを表示」セクションを参照してください。

用例

WordPress デフォルトの Twenty Eleven テーマでの利用例

テンプレート content-single.php の中で:

<?php
	/* 翻訳者へ:リスト項目を区切るため、コンマの後にスペースがある */
	$categories_list = get_the_category_list( __( ', ', 'twentyeleven' ) );

	/* 翻訳者へ:リスト項目を区切るため、コンマの後にスペースがある */
	$tag_list = get_the_tag_list( '', __( ', ', 'twentyeleven' ) );
	if ( '' != $tag_list ) {
		$utility_text = __( 'This entry was posted in %1$s and tagged %2$s by <a href="%6$s">%5$s</a>. Bookmark the <a href="%3$s" title="Permalink to %4$s" rel="bookmark">permalink</a>.', 'twentyeleven' );
	} elseif ( '' != $categories_list ) {
		$utility_text = __( 'This entry was posted in %1$s by <a href="%6$s">%5$s</a>. Bookmark the <a href="%3$s" title="Permalink to %4$s" rel="bookmark">permalink</a>.', 'twentyeleven' );
	} else {
		$utility_text = __( 'This entry was posted by <a href="%6$s">%5$s</a>. Bookmark the <a href="%3$s" title="Permalink to %4$s" rel="bookmark">permalink</a>.', 'twentyeleven' );
	}

	printf(
		$utility_text,
		$categories_list,
		$tag_list,
		esc_url( get_permalink() ),
		the_title_attribute( 'echo=0' ),
		get_the_author(),
		esc_url( get_author_posts_url( get_the_author_meta( 'ID' ) ) )
	);
?>

リスト項目として表示する

$separator を空にすると、クラス指定を含む、順序なし箇条書きリストを生成します。

<?php echo get_the_category_list(); ?>

結果は次のようになります:

<ul class="post-categories">
	<li>
		<a href="http://myblog.com/category/business" title="ビジネスの投稿をすべて見る" rel="category tag">ビジネス</a>
	</li>
</ul>

変更履歴

バージョン 1.5.1 にて導入されました。

ソースファイル

get_the_category_list()wp-includes/category-template.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()


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


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