(2.1.0以降)
get_categories - カテゴリー情報を取得する

説明

条件を指定してカテゴリー情報を検索し、マッチしたすべてのデータを取得する。

パラメータ

• $args
  検索条件を指定する文字列または連想配列。主なキーワードは次の通り。

  キーワード	意味
  orderby	ソート対象を示すcount、name、slug、term_group、none、idなど（省略時は'name'）
  order	ソート順を示すASCかDESC（省略時はDESC）
  hide_empty	投稿記事がないカテゴリーを取得しない場合はtrue(1)、投稿記事がないカテゴリーも取得する場合はfalse(0)を指定（省略時はtrue）
  exclude	取得したくないカテゴリーのID（複数指定する場合は,で区切る）
  exclude_tree	取得したくないカテゴリーのID（複数指定する場合は,で区切る）。指定されたIDのカテゴリーが子カテゴリーを持っている場合、それらの子カテゴリーも除外される。
  include	取得したいカテゴリーのID（複数指定する場合は,で区切る）
  number	取得件数（省略時は条件にマッチするすべてを取得する）
  offset	取得開始位置（省略時は0：先頭）
  fields	情報項目を示すall、count、ids、namesなどを指定（省略時はall）
  slug	取得したいカテゴリーのスラッグを指定
  hierarchical	true(1)またはfalse(0)を指定（省略時はtrue）
  search	取得したいカテゴリーの名前（その一部）を指定
  name__like	取得したいカテゴリーの名前の先頭部分を指定
  pad_counts	子カテゴリーの投稿件数を親カテゴリーに加算する場合はtrue(1)を指定（省略時はfalse）
  get	すべてのカテゴリー情報を取得する場合にallを指定
  child_of	カテゴリーのIDを指定（そのIDのカテゴリーの子孫がすべて対象となる）
  parent	カテゴリーのIDを指定（そのIDのカテゴリーの子カテゴリーのみが対象となる）

返り値

マッチしたすべてのデータが格納された配列を返す。カテゴリー情報のメンバー変数は次の通り。

注意

デフォルトでは'hide_empty'がtrueのため、投稿のないカテゴリーは取得できない。投稿数に関係なくすべてのカテゴリー情報を取得する場合は、'get=all'を指定するのが便利。
なお'parent'が指定された場合は、'child_of=0'、'hierarchical=false'、'pad_counts=false'へと強制的に変更される。
また'get=all'が指定された場合は、'child_of=0'、'hide_empty=0'、'hierarchical=false'、'pad_counts=false'へと強制的に変更される。

使用例

• すべてのカテゴリー情報を取得する。
  <?php $categories = get_categories( 'get=all' ) ); ?>

フィルター

get_categories_taxonomyフィルターを実行し、パラメータ$args['taxonomy']の値が適切なものなのかを調べ、有効なタクソノミー名を返す。ただし、通常は$args['taxonomy']を指定することはなく、この関数の冒頭で'category'が格納されている。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/category.php

関連

• get_category_by_slug - カテゴリー情報を取得する
• get_terms - タクソノミー情報を取得する
• get_the_category - 投稿データのカテゴリー情報を取得する
• get_the_category_list - カテゴリー別アーカイブのリンクリストを取得する
• wp_list_categories - カテゴリーリストを表示または取得する

お勧めコンテンツ