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

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

テンプレートタグ/get the category list

提供: WordPress Codex 日本語版
移動先: 案内検索

カテゴリーのリストを 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最新版との差分