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



お勧め

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張:エクスポートファイルに更新日時が追加ほか(2021年2月23日 更新)

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。