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

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

「関数リファレンス/get categories」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(初版の翻訳原文はおそらく en:Function Reference/get_categories 18:49, 9 September 2010 Aesqe 版/差分表示リンク、ソートキーを挿入。英語版からもリンクしました。)
(テンプレートタグガイド挿入。 パラメータ: データ型を日本語に。)
1行目: 1行目:
 +
{{テンプレートタグガイド|クエリ}}
 +
 
== 説明 ==
 
== 説明 ==
  
27行目: 29行目:
 
== パラメータ ==
 
== パラメータ ==
  
; '''type''' : (''string'') 取得するカテゴリーの種別
+
; '''type''' : ''文字列''取得するカテゴリーの種別
 
:* <tt>post</tt> - 初期値
 
:* <tt>post</tt> - 初期値
 
:* <tt>link</tt>  
 
:* <tt>link</tt>  
  
; '''child_of''' : (''integer'') カテゴリーIDで指定されたカテゴリーの子孫カテゴリー(子カテゴリー、孫カテゴリー、…)を取得します。このパラメータには初期値はありません。このパラメータが指定された場合、'''hide_empty'''パラメータは自動的に''false''にセットされます。
+
; '''child_of''' : ''整数''カテゴリーIDで指定されたカテゴリーの子孫カテゴリー(子カテゴリー、孫カテゴリー、…)を取得します。このパラメータには初期値はありません。このパラメータが指定された場合、'''hide_empty'''パラメータは自動的に''false''にセットされます。
  
; '''parent''' : (''integer'') カテゴリーIDで指定されたカテゴリーの直接の子カテゴリーのみを取得します。このパラメータは'child_of'パラメータと同じように動作するものではありません。このパラメータには初期値はありません。
+
; '''parent''' : ''整数''カテゴリーIDで指定されたカテゴリーの直接の子カテゴリーのみを取得します。このパラメータは'child_of'パラメータと同じように動作するものではありません。このパラメータには初期値はありません。
  
; '''orderby''' : (''string'') カテゴリー名のアルファベット順またはカテゴリーIDによって並べ替えます。初期値は''カテゴリー名で並べ替え''です。有効値:
+
; '''orderby''' : ''文字列''カテゴリー名のアルファベット順またはカテゴリーIDによって並べ替えます。初期値は''カテゴリー名で並べ替え''です。有効値:
 
:* <tt>id</tt>
 
:* <tt>id</tt>
 
:* <tt>name</tt> - 初期値
 
:* <tt>name</tt> - 初期値
42行目: 44行目:
 
:* <tt>group</tt>
 
:* <tt>group</tt>
  
; '''order''' : (''string'') 並べ替えの種別(昇順または降順)を指定します。デフォルトでの動作は''昇順''です。有効値:
+
; '''order''' : ''文字列''並べ替えの種別(昇順または降順)を指定します。デフォルトでの動作は''昇順''です。有効値:
 
:* <tt>asc</tt> - 昇順:初期値
 
:* <tt>asc</tt> - 昇順:初期値
 
:* <tt>desc</tt> - 降順
 
:* <tt>desc</tt> - 降順
  
; '''hide_empty''' : (''boolean'') 記事のないカテゴリーを排除するかどうかを指定します。デフォルトでの動作はtrueを示す''1''で、falseを示す'0'を指定すると、記事のないカテゴリーも含まれるようになります。有効値:
+
; '''hide_empty''' : ''論理値''記事のないカテゴリーを排除するかどうかを指定します。デフォルトでの動作はtrueを示す''1''で、falseを示す'0'を指定すると、記事のないカテゴリーも含まれるようになります。有効値:
 
:* <tt>1</tt> - 初期値
 
:* <tt>1</tt> - 初期値
 
:* <tt>0</tt>
 
:* <tt>0</tt>
  
; '''hierarchical''' : (''boolean'') ''true''が指定された場合、記事のない空の子カテゴリーであっても、さらにその子カテゴリーが空カテゴリーでなければ問い合わせ結果に含まれるようになります。初期値は''true''です。有効値:
+
; '''hierarchical''' : ''論理値''''true''が指定された場合、記事のない空の子カテゴリーであっても、さらにその子カテゴリーが空カテゴリーでなければ問い合わせ結果に含まれるようになります。初期値は''true''です。有効値:
 
:* <tt>1 (true)</tt> - 初期値
 
:* <tt>1 (true)</tt> - 初期値
 
:* <tt>0 (false)</tt>
 
:* <tt>0 (false)</tt>
  
; '''exclude''' : (''string'') 一つまたは複数のカテゴリーを除外します。このパラメータは、コンマ「,」で区切られた昇順のカテゴリーIDのリストを指定します。[[テンプレートタグ/wp_list_categories#Include_or_Exclude_Categories|用例]]を参照してください。
+
; '''exclude''' : ''文字列''一つまたは複数のカテゴリーを除外します。このパラメータは、コンマ「,」で区切られた昇順のカテゴリーIDのリストを指定します。[[テンプレートタグ/wp_list_categories#Include_or_Exclude_Categories|用例]]を参照してください。
  
; '''include''' : (''string'') 含めたいカテゴリーだけを指定します。このパラメータは、コンマ「,」で区切られた昇順のカテゴリーIDのリストを指定します。[[テンプレートタグ/wp_list_categories#Include_or_Exclude_Categories|用例]]を参照してください。
+
; '''include''' : ''文字列''含めたいカテゴリーだけを指定します。このパラメータは、コンマ「,」で区切られた昇順のカテゴリーIDのリストを指定します。[[テンプレートタグ/wp_list_categories#Include_or_Exclude_Categories|用例]]を参照してください。
 
:* <tt>list</tt> - 初期値
 
:* <tt>list</tt> - 初期値
 
:* <tt>none</tt>
 
:* <tt>none</tt>
  
; '''number''' : (''string'') 問い合わせ結果として返すカテゴリーの数の上限を指定します。
+
; '''number''' : ''文字列''問い合わせ結果として返すカテゴリーの数の上限を指定します。
  
; '''pad_counts''' : (''boolean'') 子カテゴリーを含め、リンクまたは記事の数を計算します。有効値:
+
; '''pad_counts''' : ''論理値''子カテゴリーを含め、リンクまたは記事の数を計算します。有効値:
 
:* <tt>1 (true)</tt>  
 
:* <tt>1 (true)</tt>  
 
:* <tt>0 (false)</tt> - 初期値
 
:* <tt>0 (false)</tt> - 初期値

2010年9月15日 (水) 22:41時点における版

説明

問い合わせパラメータにマッチするカテゴリーのオブジェクトを配列として返します。

問い合わせパラメータの内容はwp_list_categoriesとほぼ同じで、クエリ文字列形式でも配列形式でも渡すことができます。

使い方

 <?php $categories = get_categories( $args ); ?>

パラメータの初期値

 <?php $args = array(
	'type'                     => 'post',
	'child_of'                 => 0,
	'parent'                   => '',
	'orderby'                  => 'name',
	'order'                    => 'ASC',
	'hide_empty'               => 1,
	'hierarchical'             => 1,
	'exclude'                  => '',
	'include'                  => '',
	'number'                   => '',
	'pad_counts'               => false );?>

パラメータ

type 
文字列) 取得するカテゴリーの種別
  • post - 初期値
  • link
child_of 
整数) カテゴリーIDで指定されたカテゴリーの子孫カテゴリー(子カテゴリー、孫カテゴリー、…)を取得します。このパラメータには初期値はありません。このパラメータが指定された場合、hide_emptyパラメータは自動的にfalseにセットされます。
parent 
整数) カテゴリーIDで指定されたカテゴリーの直接の子カテゴリーのみを取得します。このパラメータは'child_of'パラメータと同じように動作するものではありません。このパラメータには初期値はありません。
orderby 
文字列) カテゴリー名のアルファベット順またはカテゴリーIDによって並べ替えます。初期値はカテゴリー名で並べ替えです。有効値:
  • id
  • name - 初期値
  • slug
  • count
  • group
order 
文字列) 並べ替えの種別(昇順または降順)を指定します。デフォルトでの動作は昇順です。有効値:
  • asc - 昇順:初期値
  • desc - 降順
hide_empty 
論理値) 記事のないカテゴリーを排除するかどうかを指定します。デフォルトでの動作はtrueを示す1で、falseを示す'0'を指定すると、記事のないカテゴリーも含まれるようになります。有効値:
  • 1 - 初期値
  • 0
hierarchical 
論理値trueが指定された場合、記事のない空の子カテゴリーであっても、さらにその子カテゴリーが空カテゴリーでなければ問い合わせ結果に含まれるようになります。初期値はtrueです。有効値:
  • 1 (true) - 初期値
  • 0 (false)
exclude 
文字列) 一つまたは複数のカテゴリーを除外します。このパラメータは、コンマ「,」で区切られた昇順のカテゴリーIDのリストを指定します。用例を参照してください。
include 
文字列) 含めたいカテゴリーだけを指定します。このパラメータは、コンマ「,」で区切られた昇順のカテゴリーIDのリストを指定します。用例を参照してください。
  • list - 初期値
  • none
number 
文字列) 問い合わせ結果として返すカテゴリーの数の上限を指定します。
pad_counts 
論理値) 子カテゴリーを含め、リンクまたは記事の数を計算します。有効値:
  • 1 (true)
  • 0 (false) - 初期値

用例

ドロップダウンボックス

この例は、子カテゴリーへジャンプするドロップダウンボックスの作成の仕方を示しています。この例は wp_get_archivesの頁に示されている月別アーカイブのドロップダウンボックスの例と対比をなしています。

子カテゴリーのドロップダウンを表示したいカテゴリーは、『IDが10でスラッグが「archives」のカテゴリー』と仮定して例を読んでください。

<select name="event-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'> 
 <option value=""><?php echo attribute_escape(__('Select Event')); ?></option> 
 <?php 
  $categories=  get_categories('child_of=10'); 
  foreach ($categories as $category) {
  	$option = '<option value="/category/archives/'.$category->category_nicename.'">';
	$option .= $category->cat_name;
	$option .= ' ('.$category->category_count.')';
	$option .= '</option>';
	echo $option;
  }
 ?>
</select>

カテゴリーとその説明を一覧表示する

この例は、カテゴリーをアルファベット順にリンク形式で一覧表示します。各カテゴリーの説明と記事数がリンクの後に表示されます。

<?php
$args=array(
  'orderby' => 'name',
  'order' => 'ASC'
  );
$categories=get_categories($args);
  foreach($categories as $category) { 
    echo '<p>Category: <a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . '>' . $category->name.'</a> </p> ';
    echo '<p> Description:'. $category->description . '</p>';
    echo '<p> Post Count: '. $category->count . '</p>';  } 
?>

ソースファイル

get_categories() は、 wp-includes/category.php に含まれています。

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