ワードプレスのget_categories関数の使用方法・解説

概要

get_categories関数は、WordPressのカテゴリー情報を取得するための関数です。この関数は、サイト内で利用可能なすべてのカテゴリーのリストを取得したり、特定の条件に基づいたカテゴリーの一覧を取得するのに非常に有用です。以下のような機能実装の際によく使われます。

1. サイトのサイドバーにカテゴリーリストを表示する
2. 投稿やページに関連するカテゴリーをリスト表示する
3. カテゴリー別のアーカイブページを作成する
4. 特定の条件に基づいてカテゴリーをフィルタリングする
5. カテゴリーの階層構造を表示する
6. カテゴリーの選択肢を持つカスタムフォームを作成する
7. カテゴリーによるコンテンツの分類を行う
8. APIレスポンスとしてカテゴリーを提供する

構文

get_categories( $args = '' );

パラメータ

• $args (配列または文字列): 取得するカテゴリーに関するオプションを指定します。デフォルトは空です。主なキーには次のものがあります。
  • taxonomy：表示するタクソノミー（デフォルトは ‘category’）。
  • orderby：カテゴリーの並び順（’name’, ‘slug’, ‘term_order’など）。
  • order：並び順の方向（’ASC’または ‘DESC’）。
  • hide_empty：アイテムがないカテゴリーを非表示にするかどうか（デフォルトはtrue）。
  • number：取得するカテゴリー数。

戻り値

• カテゴリーのオブジェクトの配列。条件に合致するカテゴリーが存在しない場合は空の配列を返します。

関連する関数

• get_terms
• get_category
• wp_insert_category

使用可能なバージョン

• WordPress 1.5以降

コアファイルのパス

• wp-includes/taxonomy.php

この関数のアクションでの使用可能性

アクション	使用可否
mu_plugin_loaded	〇
registered_post_type	〇
plugins_loaded	〇
wp_roles_init
setup_theme	〇
after_setup_theme	〇
set_current_user
init	〇
register_sidebar	〇
wp_loaded	〇
send_headers
parse_query	〇
pre_get_posts	〇
wp	〇
template_redirect	〇
get_header	〇
wp_head	〇

非推奨または削除されたバージョン

• 現在、get_categories関数は非推奨または削除されていません。