wp_dropdown_users()


wp_dropdown_users()は、WordPressでユーザーのドロップダウンリストを生成するための関数です。この関数を使用することで、ユーザーIDやユーザー名を選択するためのドロップダウンリストを簡単に作成できます。

構文

wp_dropdown_users( array $args = '' );

引数の説明:

  • $args(array) — ドロップダウンリストの設定を指定するための配列。以下のキーを使用できます:
    • 'show_option_all'(string) — すべてのユーザーを表示するオプションのテキスト。
    • 'show_option_none'(string) — ユーザーを選択しない場合のテキスト。
    • 'hide_if_only_one_author'(bool) — ユーザーが1人しかいない場合にドロップダウンを非表示にするかどうか。
    • 'orderby'(string) — ユーザーを並べ替える基準（例: ‘display_name’, ‘ID’）。
    • 'order'(string) — 並べ替え順序（’ASC’ または ‘DESC’）。
    • 'include'(array) — ドロップダウンに含めるユーザーIDの配列。
    • 'exclude'(array) — ドロップダウンから除外するユーザーIDの配列。
    • 'name'(string) — ドロップダウンのname属性。
    • 'id'(string) — ドロップダウンのid属性。
    • 'class'(string) — ドロップダウンのクラス名。
    • 'selected'(int) — デフォルトで選択されるユーザーID。
    • 'include_selected'(bool) — 選択されたユーザーが除外リストにあっても含めるかどうか。
    • 'multi'(bool) — 複数選択を許可するかどうか。

例1: 基本的なドロップダウンリストの作成

この例では、すべてのユーザーを表示するドロップダウンリストを作成します。

<?php wp_dropdown_users(); ?>

例2: 特定のユーザーを除外する

この例では、IDが1と2のユーザーを除外したドロップダウンリストを作成します。

<?php wp_dropdown_users( array( 'exclude' => array( 1, 2 ) ) ); ?>

例3: デフォルトで選択されるユーザーを指定する

この例では、デフォルトでIDが3のユーザーが選択されるドロップダウンリストを作成します。

<?php wp_dropdown_users( array( 'selected' => 3 ) ); ?>

例4: ドロップダウンの名前とIDを指定する

この例では、ドロップダウンのname属性とid属性を指定します。

<?php wp_dropdown_users( array( 'name' => 'user_id', 'id' => 'user_dropdown' ) ); ?>

例5: 並べ替え順序を指定する

この例では、ユーザーを表示名で昇順に並べ替えたドロップダウンリストを作成します。

<?php wp_dropdown_users( array( 'orderby' => 'display_name', 'order' => 'ASC' ) ); ?>

例6: 複数選択を許可する

この例では、複数のユーザーを選択できるドロップダウンリストを作成します。

<?php wp_dropdown_users( array( 'multi' => true ) ); ?>

注意点

  • ドロップダウンリストは、管理者画面だけでなくフロントエンドでも使用できます。
  • ユーザーが1人しかいない場合、デフォルトではドロップダウンが表示されません。'hide_if_only_one_author'をfalseに設定することで表示できます。
  • カスタムクエリを使用してユーザーをフィルタリングする場合は、'include'や'exclude'を活用してください。

関連機能：