get_categories

説明

array get_categories( [ mixed $args = '' ] )
条件を指定してカテゴリー情報を検索し、マッチしたすべてのデータを取得する。

パラメータ

  • $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取得したいカテゴリーのスラッグを指定
    hierarchicaltrue(1)またはfalse(0)を指定(省略時はtrue)
    search取得したいカテゴリーの名前(その一部)を指定
    name__like取得したいカテゴリーの名前の先頭部分を指定
    pad_counts子カテゴリーの投稿件数を親カテゴリーに加算する場合はtrue(1)を指定(省略時はfalse)
    getすべてのカテゴリー情報を取得する場合にallを指定
    child_ofカテゴリーのIDを指定(そのIDのカテゴリーの子孫がすべて対象となる)
    parentカテゴリーのIDを指定(そのIDのカテゴリーの子カテゴリーのみが対象となる)

返り値

マッチしたすべてのデータが格納された配列を返す。カテゴリー情報のメンバー変数は次の通り。
プロパティ名データ型意味
term_idintID
namestring名前
slugstringスラッグ
term_groupintグループID
term_taxonomy_idintタクソノミーID
taxonomystringタクソノミー名。カテゴリーの場合は必ず'category'となる
descriptionstring説明
parentint親カテゴリーID。親カテゴリーがない場合は0となる
countint投稿数
cat_IDintカテゴリーID(term_idのエイリアス)
category_countint投稿数(countのエイリアス)
category_descriptionstring説明(descriptionのエイリアス)
cat_namestringカテゴリー名(nameのエイリアス)
category_nicenamestringナイスネーム(slugのエイリアス)
category_parentint親カテゴリーID(parentのエイリアス)

注意

デフォルトでは'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'が格納されている。
$taxonomy = apply_filters( 'get_categories_taxonomy', $args['taxonomy'], $args );

アクション

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

ソースファイル

/wp-includes/category.php

最終更新 : 2018年05月27日 10:51



お勧め

スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。