get_categories()

get_categories() 関数の概要

get_categories()関数は、WordPressのデータベースからカテゴリの一覧を取得するための関数です。この関数を使用することで、サイトに登録されているすべてのカテゴリ情報を配列として取得することができます。取得したカテゴリ情報には、カテゴリID、名前、スラッグ、説明などが含まれます。get_categories()は、特定の条件に基づいてカテゴリをフィルタリングしたり、カスタム分類を扱ったりする際にも便利です。

パラメータの説明

get_categories()関数には、いくつかのオプションパラメータを設定することができます。主なパラメータは以下の通りです:

  • type (string): 投稿タイプを指定します。デフォルトは ‘post’ です。
  • child_of (int): 特定の親カテゴリIDを指定します。このカテゴリの子カテゴリのみを取得します。
  • orderby (string): カテゴリの並び替え基準を指定します。’name’、’count’、’ID’などを指定できます。デフォルトは ‘name’ です。
  • order (string): 昇順(’ASC’)または降順(’DESC’)を指定します。デフォルトは ‘ASC’ です。
  • hide_empty (bool): 投稿が含まれていない空のカテゴリを非表示にするかどうかを指定します。デフォルトは true です。
  • hierarchical (bool): 階層構造でカテゴリを表示するかどうかを指定します。デフォルトは true です。
  • exclude (array): 除外したいカテゴリIDのリストを指定します。
  • include (array): 含めたいカテゴリIDのリストを指定します。

使用例

以下は、get_categories()関数を使用してカテゴリのリストを取得し、それをループで出力する例です:

<?php
$args = array(
    'orderby' => 'name',
    'order'   => 'ASC'
);
$categories = get_categories($args);

foreach($categories as $category) {
    echo '<li>' . $category->name . '</li>';
}
?>

この例では、カテゴリ名をアルファベット順に並べてリスト表示しています。

関連する関数

  • wp_list_categories(): カテゴリをリスト形式で出力するための関数です。
  • get_category(): 特定のカテゴリ情報を取得するための関数です。
  • get_the_category(): 現在の投稿に関連付けられたカテゴリを取得するための関数です。
  • the_category(): 現在の投稿に関連付けられたカテゴリを表示するための関数です。