• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/wp dropdown users

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「テンプレートタグ/wp dropdown users」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

送信ボタンのないセレクトボックス(ドロップダウンメニューなど)を使ったユーザーリストを表示、または HTML 文字列として返します。

使い方

<?php wp_dropdown_users( $args ); ?>

デフォルトの使い方

<?php
$args = array(
	'show_option_all'         => null, // 文字列
	'show_option_none'        => null, // 文字列
	'option_none_value'       => -1, // 整数
	'hide_if_only_one_author' => null, // 文字列
	'orderby'                 => 'display_name',
	'order'                   => 'ASC',
	'include'                 => null, // 文字列
	'exclude'                 => null, // 文字列
	'multi'                   => false,
	'show'                    => 'display_name',
	'echo'                    => true,
	'selected'                => false,
	'include_selected'        => false,
	'name'                    => 'user', // 文字列
	'id'                      => null, // 整数
	'class'                   => null, // 文字列 
	'blog_id'                 => $GLOBALS['blog_id'],
	'who'                     => null // 文字列
);
wp_dropdown_users( $args );
?>

デフォルトでは次のように表示します:

  • すべてのユーザーを選択するための項目を表示しない
  • すべてのユーザーを非選択とするための項目を表示しない
  • ユーザーが一人しか登録されていなくても表示する
  • ブログ上の表示名の昇順にソートする
  • 強制して含めるユーザーなし(すべてのユーザーを対象にする)
  • 除外ユーザーなし
  • ユーザーのブログ上の表示名を表示する
  • 結果を表示する(表示するか値として返すか選べるので)
  • フォームの 'selected'(初期選択値)とするユーザーなし
  • フォーム(select 要素)に name 属性を付けて値を 'user' とする
  • フォーム(select 要素)に id 属性を付けて値を 'user' とする
  • フォーム(select 要素)に class 属性を付けない(値を '' とする)
  • 現在のブログのユーザーを対象にする(マルチサイトの場合のみ)
  • すべての権限のユーザーを対象にする

パラメータ

show_option_all 
(文字列) すべてのユーザーを選択できるドロップダウン項目を HTML に含めます。このパラメータの値は実際に表示するテキストにします。(例えば、このパラメータを真偽値の true にすると、ドロップダウンリストの先頭に "1" が表示されます)
show_option_none 
(文字列) すべてのユーザーを非選択とする追加の <OPTION> タグを <SELECT> の先頭に入れます。このパラメータの値は実際に表示するテキストにします。(例えば、このパラメータを真偽値の true にすると、ドロップダウンリストの先頭に "1" が表示されます)
option_none_value 
(整数) すべてのユーザーを非選択とするドロップダウン項目の値。デフォルトは -1 です。show_option_none パラメータが空文字列の場合、このパラメータは無視されます。
orderby 
(文字列) ソートのキーにする項目。有効な値は:
  • 'ID'
  • 'user_nicename' - スラッグ
  • 'display_name' - ブログ上の表示名 - デフォルト
order 
(文字列) ソートの方向。有効な値は:
  • 'ASC' - 昇順 - デフォルト
  • 'DESC' - 降順
include 
(文字列) 出力に含めるユーザーの ID をコンマ区切りのリストで指定します。例えば 'include=4,12' を指定すると、ID が 4 と 12 のユーザーが表示または返されます。デフォルトではすべてのユーザーを含めます。
exclude 
(文字列) 除外するユーザーの ID をコンマ区切りのリストで指定します。例えば 'exclude=4,12' を指定すると、ID が 4 と 12 のユーザーを除いて表示または返されます。もし include パラメータがセットされると、このパラメータは無視されます。
multi 
(真偽値) フォーム(select 要素)に ID 属性を付けないか、付けるか。
  • 1 (True) - 付けない
  • 0 (False) - 付ける - デフォルト
show 
(文字列) User テーブルから表示する項目(フィールド)を指定します。指定した項目が空のときは、user_login の値を括弧で括って表示します。
  • 'ID'
  • 'user_login'
  • 'display_name' - ブログ上の表示名 - Default
echo 
(真偽値) ユーザーを表示するか、PHP で使うために返すか。
  • 1 (True) - 表示する - デフォルト
  • 0 (False) - 値として返す
selected 
(整数) フォームの 'selected'(初期選択値)とするユーザーを ID で指定します。デフォルトではどのユーザーも選択しません。
include_selected 
(真偽値) 初期選択値としたユーザーを常にドロップダウンに含めるかどうか。
  • 1 (True) - 含める
  • 0 (False) - 含めない - デフォルト
name 
(文字列) ドロップダウンのフォームに付ける名前。デフォルトは 'user' です。
参考:フォーム(select 要素)の name 属性の値になります。
id 
(文字列) ドロップダウンのフォームに付ける ID。デフォルトは name パラメータの値です。
参考:フォーム(select 要素)の id 属性の値になります。
class 
(文字列) ドロップダウンのフォームに付けるクラス。デフォルトは '' です。
参考:フォーム(select 要素)の class 属性の値になります。
blog_id 
マルチサイトの場合にブログの ID を指定します。デフォルトは現在のブログです。
who 
対象とするユーザーの権限を指定します。指定できるのは 'authors' のみです。デフォルトではすべてのユーザーを対象とします。バージョン 3.1 で導入されました。

戻り値

(文字列) 
ドロップダウンメニューの HTML 文字列。

用例

WordPress サイドバーの箇条書きリスト内に、送信ボタン付きの HTML フォームとして、ユーザーのドロップダウンリストを表示します。

 <li id="users">
  <h2><?php _e( 'users:' ); ?></h2>
    <form action="<?php bloginfo( 'url' ); ?>" method="get">
    <?php wp_dropdown_users( array( 'name' => 'author' ) ); ?>
    <input type="submit" name="submit" value="view" />
    </form>
 </li>

変更履歴

  • 3.1 : who パラメータが追加されました。
  • 2.3 : 新規テンプレートタグ。

ソースファイル

wp_dropdown_users()wp-includes/user.php にあります。

作成者タグ: the_author(), get_the_author(), the_author_link(), get_the_author_link(), the_author_meta(), get_the_author_meta(), the_author_posts(), get_the_author_posts(), the_author_posts_link(), get_author_posts_url(), get_the_modified_author(), the_modified_author(), wp_dropdown_users(), wp_list_authors()


リスト・ドロップダウン関数: wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_dropdown_users最新版との差分