説明
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 取得したいカテゴリーのスラッグを指定 hierarchical true(1)またはfalse(0)を指定（省略時はtrue） search 取得したいカテゴリーの名前（その一部）を指定 name__like 取得したいカテゴリーの名前の先頭部分を指定 pad_counts 子カテゴリーの投稿件数を親カテゴリーに加算する場合はtrue(1)を指定（省略時はfalse） get すべてのカテゴリー情報を取得する場合にallを指定 child_of カテゴリーのIDを指定（そのIDのカテゴリーの子孫がすべて対象となる） parent カテゴリーのIDを指定（そのIDのカテゴリーの子カテゴリーのみが対象となる）
返り値
マッチしたすべてのデータが格納された配列を返す。カテゴリー情報のメンバー変数は次の通り。| プロパティ名 | データ型 | 意味 |
|---|---|---|
| term_id | int | ID |
| name | string | 名前 |
| slug | string | スラッグ |
| term_group | int | グループID |
| term_taxonomy_id | int | タクソノミーID |
| taxonomy | string | タクソノミー名。カテゴリーの場合は必ず'category'となる |
| description | string | 説明 |
| parent | int | 親カテゴリーID。親カテゴリーがない場合は0となる |
| count | int | 投稿数 |
| cat_ID | int | カテゴリーID（term_idのエイリアス） |
| category_count | int | 投稿数（countのエイリアス） |
| category_description | string | 説明（descriptionのエイリアス） |
| cat_name | string | カテゴリー名（nameのエイリアス） |
| category_nicename | string | ナイスネーム（slugのエイリアス） |
| category_parent | int | 親カテゴリー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
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する（2022年4月6日 更新）
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ（2011年7月8日 更新）
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する（管理者権限）。投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）
WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。
さくらのVPSでKUSANAGI#2（2018年5月27日 更新）
今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。