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

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

「テンプレートタグ/wp dropdown users」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(整形、試験的にテンプレートタグガイドを挿入、未翻訳)
(en:Template Tags/wp_dropdown_users 21:44, 11 October 2013 Helen 版を反映して和訳。)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
{{テンプレートタグガイド|クエリ}}
+
 
 +
<div id="Description">
 
== 説明 ==
 
== 説明 ==
 +
</div>
  
Create dropdown HTML content of users.
+
送信ボタンのないセレクトボックス(ドロップダウンメニューなど)を使ったユーザーリストを表示、または HTML 文字列として返します。
 +
<!-- Create dropdown HTML content of users. -->
  
== 使い方 ==<!-- Usage -->
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
%%% <?php wp_dropdown_users( $args ); ?> %%%
+
<?php wp_dropdown_users( $args ); ?>
  
=== Default Usage ===<!-- Default Usage -->
+
<div id="Default_Usage">
 +
=== デフォルトの使い方 ===
 +
</div>
  
%%% <?php $args = array(
+
<pre>
'show_option_all' => '',
+
<?php
'show_option_none' => '',
+
$args = array(
'orderby'         => 'display_name',
+
'show_option_all'         => null, // 文字列
'order'           => 'ASC',
+
'show_option_none'       => null, // 文字列
'include'         => '',
+
'option_none_value'       => -1, // 整数
'exclude'         => '',
+
'hide_if_only_one_author' => null, // 文字列
'multi'           => 0,
+
'orderby'                 => 'display_name',
'show'             => 'display_name',
+
'order'                   => 'ASC',
'echo'             => 1,
+
'include'                 => null, // 文字列
'selected'         => 0,
+
'exclude'                 => null, // 文字列
'name'             => 'user',
+
'multi'                   => false,
'class'           => '' ); ?> %%%
+
'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 );
 +
?>
 +
</pre>
  
== パラメータ ==<!-- Parameters -->
+
デフォルトでは次のように表示します:
 +
* すべてのユーザーを選択するための項目を表示しない
 +
* すべてのユーザーを非選択とするための項目を表示しない
 +
* ユーザーが一人しか登録されていなくても表示する
 +
* ''ブログ上の表示名''の昇順にソートする
 +
* 強制して含めるユーザーなし(すべてのユーザーを対象にする)
 +
* 除外ユーザーなし
 +
<!-- multi は id と一緒に説明 2014/09/08 gblsm -->
 +
* ユーザーの''ブログ上の表示名''を表示する
 +
* 結果を表示する(表示するか値として返すか選べるので)
 +
* フォームの <code>'selected'</code>(初期選択値)とするユーザーなし
 +
<!-- include_selected は説明を省略 2014/09/08 gblsm -->
 +
* フォーム(<code>select</code> 要素)に name 属性を付けて値を <code>'user'</code> とする
 +
* フォーム(<code>select</code> 要素)に id 属性を付けて値を <code>'user'</code> とする
 +
* フォーム(<code>select</code> 要素)に class 属性を付けない(値を <code><nowiki>''</nowiki></code> とする)
 +
* 現在のブログのユーザーを対象にする(マルチサイトの場合のみ)
 +
* すべての権限のユーザーを対象にする
  
; show_option_all : (''string'') Causes the HTML for the dropdown to allow you to select All of the users.
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
; show_option_none : (''string'') Causes the HTML for the dropdown to allow you to select NONE of the users.
+
; show_option_all : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) すべてのユーザーを選択できるドロップダウン項目を HTML に含めます。このパラメータの値は実際に表示するテキストにします。(例えば、このパラメータを真偽値の <tt>true</tt> にすると、ドロップダウンリストの先頭に "1" が表示されます)
  
; orderby : (''string'') Key to sort options by. Valid values:
+
; show_option_none : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) すべてのユーザーを非選択とする追加の <code><nowiki><OPTION></nowiki></code> タグを <code><nowiki><SELECT></nowiki></code> の先頭に入れます。このパラメータの値は実際に表示するテキストにします。(例えば、このパラメータを真偽値の <tt>true</tt> にすると、ドロップダウンリストの先頭に "1" が表示されます)
 +
 
 +
; option_none_value : ([[テンプレートタグ/タグパラメータの渡し方#Integer|''整数'']]) すべてのユーザーを非選択とするドロップダウン項目の値。デフォルトは <code>-1</code> です。<code>show_option_none</code> パラメータが空文字列の場合、このパラメータは無視されます。
 +
 
 +
; orderby : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) ソートのキーにする項目。有効な値は:
 
:* <tt>'ID'</tt>
 
:* <tt>'ID'</tt>
:* <tt>'user_nicename'</tt>
+
:* <tt>'user_nicename'</tt> - スラッグ
:* <tt>'display_name'</tt> - Default
+
:* <tt>'display_name'</tt> - ブログ上の表示名 - デフォルト
  
; order : (''string'') Sort order for options. Valid values:
+
; order : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) ソートの方向。有効な値は:
:* <tt>'ASC'</tt> - Default
+
:* <tt>'ASC'</tt> - 昇順 - デフォルト
:* <tt>'DESC'</tt>
+
:* <tt>'DESC'</tt> - 降順
  
; include : (''string'') Comma separated list of users IDs to include. For example, 'include=4,12' means users IDs 4 and 12 will be displayed/echoed or returned. Defaults to exclude all.
+
; include : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) 出力に含めるユーザーの ID をコンマ区切りのリストで指定します。例えば <code>'include=4,12'</code> を指定すると、ID が 4 12 のユーザーが表示または返されます。デフォルトではすべてのユーザーを含めます。
  
; exclude : (''string'') Comma separated list of users IDs to exclude. For example, 'exclude=4,12' means users IDs 4 and 12 will NOT be displayed/echoed or returned. Defaults to exclude nothing.
+
; exclude : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) 除外するユーザーの ID をコンマ区切りのリストで指定します。例えば <code>'exclude=4,12'</code> を指定すると、ID が 4 12 のユーザー'''を除いて'''表示または返されます。もし <tt>include</tt> パラメータがセットされると、このパラメータは無視されます。
  
; multi : (''boolean'') Whether to skip the ID attribute on the 'select' element.
+
; multi : ([[テンプレートタグ/タグパラメータの渡し方#Boolean|''真偽値'']]) フォーム(<code>select</code> 要素)に ID 属性を付けないか、付けるか。
:* <tt>1 (True)</tt>
+
:* <tt>1 (True)</tt> - 付けない
:* <tt>0 (False)</tt> - Default
+
:* <tt>0 (False)</tt> - 付ける - デフォルト
  
; show : (''string'') User table column to display. If the selected item is empty then the user_login will be displayed in parentesis.
+
; show : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) User テーブルから表示する項目(フィールド)を指定します。指定した項目が空のときは、<code>user_login</code> の値を括弧で括って表示します。
 
:* <tt>'ID'</tt>
 
:* <tt>'ID'</tt>
 
:* <tt>'user_login'</tt>
 
:* <tt>'user_login'</tt>
:* <tt>'display_name'</tt> - Default
+
:* <tt>'display_name'</tt> - ブログ上の表示名 - Default
  
; echo : (''boolean'') Display bookmarks (<tt>TRUE</tt>) or return them for use by PHP (<tt>FALSE</tt>).
+
; echo : ([[テンプレートタグ/タグパラメータの渡し方#Boolean|''真偽値'']]) ユーザーを表示するか、PHP で使うために返すか。
:* <tt>1 (True)</tt> - Default
+
:* <tt>1 (True)</tt> - 表示する - デフォルト
:* <tt>0 (False)</tt>
+
:* <tt>0 (False)</tt> - 値として返す
  
; selected : (''integer'') User ID of the user to be 'selected' or presented in the display box. Defaults to no user selected.
+
; selected : ([[テンプレートタグ/タグパラメータの渡し方#Integer|''整数'']]) フォームの <code>'selected'</code>(初期選択値)とするユーザーを ID で指定します。デフォルトではどのユーザーも選択しません。
  
; name : (''string'') Name assigned to the dropdown form. Defaults to 'user'.
+
; include_selected : ([[テンプレートタグ/タグパラメータの渡し方#Integer|''真偽値'']]) 初期選択値としたユーザーを常にドロップダウンに含めるかどうか。
 +
:* <tt>1 (True)</tt> - 含める
 +
:* <tt>0 (False)</tt> - 含めない - デフォルト
  
; class : (''string'') Class assinged to the dropdown form.
+
; name : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) ドロップダウンのフォームに付ける名前。デフォルトは <code>'user'</code> です。
 +
: 参考:フォーム(<code>select</code> 要素)の name 属性の値になります。
  
== 用例 ==<!-- Examples -->
+
; id : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) ドロップダウンのフォームに付ける ID。デフォルトは <code>name</code> パラメータの値です。
 +
: 参考:フォーム(<code>select</code> 要素)の id 属性の値になります。
  
=== Dropdown with Submit Button ===<!-- Dropdown with Submit Button -->
+
; class : ([[テンプレートタグ/タグパラメータの渡し方#String|''文字列'']]) ドロップダウンのフォームに付けるクラス。デフォルトは <code><nowiki>''</nowiki></code> です。
 +
: 参考:フォーム(<code>select</code> 要素)の class 属性の値になります。
  
Displays a users dropdown list in HTML form with a submit button.
+
; blog_id : マルチサイトの場合にブログの ID を指定します。デフォルトは現在のブログです。
  
&lt;li id="users"&gt;
+
; who : 対象とするユーザーの権限を指定します。指定できるのは <code>'authors'</code> のみです。デフォルトではすべてのユーザーを対象とします。[[Version 3.1|バージョン 3.1]] で導入されました。
  &lt;h2&gt;<?php _e('users:'); ?>&lt;/h2&gt;
+
    &lt;form action="<?php bloginfo('url'); ?>" method="get"&gt;
+
    <?php wp_dropdown_users(''); ?>
+
    &lt;input type="submit" name="submit" value="view" /&gt;
+
    &lt;/form&gt;
+
&lt;/li&gt;
+
  
== 変更履歴 ==<!-- Changelog -->
+
== 戻り値 ==
  
Since: 2.3.0
+
{{Return||文字列|ドロップダウンメニューの HTML 文字列。}}
  
== ソースファイル ==<!-- Source File -->
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
<tt>wp_dropdown_users()</tt> is located in {{Trac|wp-includes/user.php}}.
+
<div id="Dropdown_with_Submit_Button">
 +
=== 送信ボタン付きドロップダウンメニュー ===
 +
</div>
  
{{原文|Template Tags/wp_dropdown_users|76652}}<!-- 13:44, 4 August 2009 Benoithubert 版 -->
+
WordPress サイドバーの箇条書きリスト内に、送信ボタン付きの HTML フォームとして、ユーザーのドロップダウンリストを表示します。<!-- Displays a users dropdown list in HTML form with a submit button. -->
  
== 関連 ==<!-- Related -->
+
<pre>
 +
<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>
 +
</pre>
  
 +
<div id="Change_Log">
 +
== 変更履歴 ==
 +
</div>
 +
 +
* [[Version 3.1|3.1]] : <code>who</code> パラメータが追加されました。
 +
* [[Version 2.3|2.3]] : 新規テンプレートタグ。
 +
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 +
<tt>wp_dropdown_users()</tt> は {{Trac|wp-includes/user.php}} にあります。
 +
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 
{{Lists Tags}}
 
{{Lists Tags}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}
  
{{DEFAULTSORT:Wp_dropdown_users}}
+
{{原文|Function Reference/wp_dropdown_users|136989}} <!-- 21:44, 11 October 2013 Helen 版 -->
 +
 
 +
{{DEFAULTSORT:Wp_dropdown_users}}  
 
[[Category:テンプレートタグ]]
 
[[Category:テンプレートタグ]]
 +
[[Category:wp3.1]]
 
[[Category:wp2.3]]
 
[[Category:wp2.3]]
  
 
[[en:Template Tags/wp_dropdown_users]]
 
[[en:Template Tags/wp_dropdown_users]]
[[tr:Tema Etiketleri/wp_dropdown_users]]
+
[[tr:Tema_Etiketleri/wp_dropdown_users]]

2014年9月8日 (月) 20:14時点における版

この項目「テンプレートタグ/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 にあります。

リスト・ドロップダウン関数: 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最新版との差分