説明
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
関連
お勧め
ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）
PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。
投稿情報を連想配列で参照する（2018年5月27日 更新）
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。
段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）
ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。
ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。