概要
wp_dropdown_categories関数は、ドロップダウン形式のカテゴリーリストを表示または取得するために使用されるWordPressの関数です。この関数は、主に以下のような機能を実装する際によく使われます。
- 投稿やページにカテゴリー選択機能を追加
- カスタムメニューを作成する際のカテゴリー選択
- カテゴリーフィルタリング機能の実装
- ウィジェットでのカテゴリー選択
- フロントエンドのフォームでのカテゴリー指定
- カテゴリーに基づくコンテンツ表示を動的に生成
- 管理画面でのカスタム入力フィールドの作成
- プラグインやテーマでの設定フィールドの作成
構文
wp_dropdown_categories( $args );
パラメータ
$args: 配列または連想配列で、ドロップダウンの設定を含むオプションを指定します。以下は代表的なオプションです。show_option_none: デフォルトで表示するオプション（例: “選択してください”）option_none_value:show_option_noneが選択された場合の値orderby: 並べ替えの基準（例: ‘name’, ‘id’）order: 昇順 (‘ASC’) または降順 (‘DESC’)hierarchical: 階層表示の有無（trueまたはfalse）
戻り値
wp_dropdown_categories関数は、HTMLのドロップダウンリストを生成し、直接出力します。戻り値はありませんが、ドロップダウンリストのHTMLが出力されます。
関連する関数
使用可能なバージョン
wp_dropdown_categoriesは、WordPress 2.1.0以降で使用可能です。この関数は現在もサポートされており、特定のバージョンで非推奨または削除されていません。
コアファイルのパス
この関数は、WordPressのコアファイル wp-includes/category-template.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 |
サンプルコード
サンプルコード1: 基本的なドロップダウン
<?php
wp_dropdown_categories(); // 基本的なドロップダウンを表示
?>
このコードは、デフォルトのオプションを持つ基本的なカテゴリー選択のドロップダウンリストを表示します。
サンプルコード2: 特定のオプションを含むドロップダウン
<?php
wp_dropdown_categories( array(
'show_option_none' => '選択してください',
'orderby' => 'name',
'order' => 'ASC',
) ); // カテゴリーを名前で昇順に表示
?>
このコードは、’選択してください’というテキストを持つオプションを最初に表示し、他のカテゴリーを名前順に並べます。
サンプルコード3: 階層の表示
<?php
wp_dropdown_categories( array(
'hierarchical' => true,
) ); // 階層を考慮したカテゴリーリストを表示
?>
このコードは、親子関係を持つカテゴリーを階層的に表示します。
サンプルコード4: 特定のカテゴリーを除外する
<?php
wp_dropdown_categories( array(
'exclude' => '5,7', // ID 5 と 7 のカテゴリーを除外
) );
?>
このコードは、特定のカテゴリーIDを除外したドロップダウンリストを生成します。
サンプルコード5: 種類のカスタマイズ
<?php
$args = array(
'show_option_none' => 'カテゴリーを選択',
'option_none_value' => '',
'orderby' => 'count',
'order' => 'DESC',
'name' => 'custom-category',
);
wp_dropdown_categories( $args ); // 設定されたオプションでカテゴリーリストを表示
?>
このコードは、指定されたオプションを持つカスタム名のドロップダウンを作成します。