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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(カテゴリー名修正。)
(説明: get_users のリンク先を修正。)
 
(3人の利用者による、間の4版が非表示)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
 +
サイトの投稿の作成者(ユーザー)の一覧を表示します。
 +
ユーザーが投稿を済ませていれば、作成者の名前は(そのユーザーの投稿一覧ページへの)リンクとして表示されます。
 +
オプションとして、各ユーザーの投稿数と [[用語集#RSS|RSS]] フィードへのリンクを表示することもできます。
  
<!--Displays a list of the blog's authors (users), and if the user has authored any posts, the author name is displayed as a link to their posts.  Optionally this tag displays each author's post count and [[Glossary#RSS|RSS]] feed link. -->
+
表示ではなく、配列の形で取得したい場合は [[関数リファレンス/get_users|get_users()]] のほうが使いやすいかもしれません。
ブログの著者(ユーザー)の一覧を表示し、ユーザーが投稿していれば、著者名が投稿へのリンクとして表示されます。オプションとしてこのタグで各著者の投稿数と[[用語集#RSS|RSS]]フィードのリンクを表示することもできます。
+
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
 
 
  <?php wp_list_authors( $args ); ?>
 
  <?php wp_list_authors( $args ); ?>
  
<div id="Default Usage">
+
<div id="Default_Usage">
=== デフォルト ===
+
=== デフォルトの使い方 ===
 
</div>
 
</div>
 
+
<pre>
<?php $args = array(
+
<?php $args = array(
'optioncount'  => false,  
+
'orderby'      => 'name',
'exclude_admin' => true,  
+
'order'        => 'ASC',
'show_fullname' => false,
+
'number'        => null,
'hide_empty'    => true,
+
'optioncount'  => false,  
'echo'          => true,
+
'exclude_admin' => true,  
'feed'          => [empty string],  
+
'show_fullname' => false,
'feed_image'    => [empty string],
+
'hide_empty'    => true,
'style'        => list,
+
'echo'          => true,
'html'          => [empty string] ); ?>
+
'feed'          => [empty string],  
<!--
+
'feed_image'    => [empty string],
By default, the usage shows:
+
'feed_type'    => [empty string],
* Does not display the count of the number of posts
+
'style'        => 'list',
* Excludes the 'admin' author from the list
+
'html'          => true,
* Displays the author "Display name publicly as"
+
'exclude'      => [empty string],
* Excludes users with no posts
+
'include'      => [empty string] ); ?>
* Display the results
+
</pre>
* No author feed text or image is displayed
+
* The style is in list format
+
* Items are returned with valid HTML
+
-->
+
 
デフォルトでは以下のようになります。
 
デフォルトでは以下のようになります。
 +
* display_name の昇順に表示
 +
* 表示する作成者の数を制限しない
 
* 投稿数を表示しない
 
* 投稿数を表示しない
* リストから'管理者'の著者を除く
+
* デフォルトで登録済みの 'admin' ユーザーを除く
* 著者の"公的な表示名"を表示
+
* 作成者の display_name を表示する(フルネームを表示しない)
* 投稿のない著者を除く
+
* 一つも投稿していないユーザーを除く
* 結果を(HTML形式で)表示
+
* 結果を表示(PHP の echo で出力)
* 著者のフィードテキスト・画像は非表示
+
* 作成者のフィードテキスト、画像、フィードタイプを指定しない(表示しない)
* スタイルは一覧形式
+
* スタイルは一覧形式(HTML の <code><nowiki><li></li></nowiki></code>)
* リストを有効なHTMLで返す
+
* リストの項目を有効な HTML 形式で返す
 +
* 特定の作成者を除外したり含めたりしない
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
; optioncount : (''真偽値'')<!-- Display number of published posts by each author. Options are:-->各著者によって公開された投稿の数を表示するかしないか。
+
; orderby : (''文字列'') 指定したフィールドを使ってソートする。[[Version 3.1|バージョン 3.1]] 以降で利用可能。有効な値は:
:* <tt>1</tt> (true)
+
:* <tt>name</tt> - users テーブルの display_name - デフォルト
:* <tt>0</tt> (false) - デフォルト
+
:* <tt>email</tt> - users テーブルの user_email (メール)
; exclude_admin : (''真偽値'') <!--Exclude the 'admin' (login is admin) account from authors list. Options are:-->'管理者'アカウントを除くか否か。
+
:* <tt>url</tt> - users テーブルの user_url (ウェブサイト)
:* <tt>1</tt> (true) - デフォルト
+
:* <tt>registered</tt> - users テーブルの user_registered (登録日)
:* <code>0</code> (false)  
+
:* <tt>id</tt> - users テーブルの ID
; show_fullname : (''真偽値'') <!--Display the full (first and last) name of the authors. If false, the "Display name publicly as" is displayed. Options are:-->著者のフルネームを表示するか否か。falseであれば、"公的な表示名"が表示されます。
+
:* <tt>user_login</tt> - users テーブルの user_login (ユーザー名)
:* <tt>1</tt> (true)
+
:* <tt>post_count</tt> - ユーザーの投稿数
:* <tt>0</tt> (false) - デフォルト
+
 
; hide_empty : (''真偽値'') <!--Do not display authors with 0 posts. Options are:--> 投稿のない著者を表示させないか否か。
+
; order : (''文字列'') 結果を昇順にするか降順にするか。[[Version 3.1|バージョン 3.1]] 以降で利用可能。有効な値は:
:* <tt>1</tt> (true) - デフォルト
+
:* <tt>ASC</tt> - 昇順 - デフォルト
:* <tt>0</tt> (false)  
+
:* <tt>DESC</tt> - 降順
; echo : (''真偽値'') <!--Display the results. Options are:-->結果を表示するか否か。
+
 
:* <tt>1</tt> (true) - デフォルト
+
; number : (''整数'') 表示するユーザーの最大数。デフォルトは無制限。[[Version 3.1|バージョン 3.1]] 以降で利用可能。
:* <tt>0</tt> (false)  
+
 
; feed : (''文字列'') <!--Text to display for a link to each author's RSS feed. Default is no text, and no feed displayed.-->各著者のRSSフィードへのリンク文字列を設定します。デフォルトではテキストはなく、表示されません。
+
; optioncount : (''真偽値'') 公開済み投稿の数を各ユーザーに表示するかどうか。有効な値は:
; feed_image : (''文字列'') <!--Path/filename for a graphic. This acts as a link to each author's RSS feed, and overrides the '''feed''' parameter.-->画像へのパス・ファイル名を指定します。各著者のRSSフィードへのリンクとなり、'''feed'''パラメータを上書きします。
+
:* <tt>1</tt> (true) - 表示する
; style : (''文字列'') <!--Style in which to display the author list.  A value of ''list'', the default, displays the authors as an unordered list, while ''none'' generates no special display method (the list items are separated by comma).  If '''html''' is false, this option is ignored.  This option was added with [[Version 2.8]].  Valid values:-->著者リストを表示するスタイルを指定します。デフォルトでは''list''で、非序列リストで表示します。''none''ではカンマ区切りのみの表示です。'''html'''パラメータがfalseの場合はこのオプションは無視されます。このオプションは[[Version 2.8]]で導入されました。有効な文字列は次の通りです。
+
:* <tt>0</tt> (false) - 表示しない - デフォルト
 +
 
 +
; exclude_admin : (''真偽値'') 'admin' アカウント(ログイン名が <tt>admin</tt>)を一覧から除外するかどうか。有効な値は:
 +
:* <tt>1</tt> (true) - 除外する - デフォルト
 +
:* <code>0</code> (false) - 除外しない
 +
 
 +
; show_fullname : (''真偽値'') 作成者のフルネーム(名と姓)を表示するかどうか。false の場合は「ブログ上の表示名」を表示する。有効な値は:
 +
:* <tt>1</tt> (true) - フルネーム
 +
:* <tt>0</tt> (false) - ブログ上の表示名 - デフォルト  
 +
 
 +
; hide_empty : (''真偽値'') 投稿数がゼロのユーザーを非表示にするかどうか。有効な値は:
 +
:* <tt>1</tt> (true) - 非表示 - デフォルト
 +
:* <tt>0</tt> (false) - 表示する
 +
 
 +
; echo : (''真偽値'') 結果を表示するかどうか。有効な値は:
 +
:* <tt>1</tt> (true) - 表示する - デフォルト
 +
:* <tt>0</tt> (false) - 表示せず、値として返す
 +
 
 +
; feed : (''文字列'') 各作成者の RSS フィードへのリンク文字列。デフォルトはテキスト無しで、リンクを表示しない。
 +
 
 +
; feed_image : (''文字列'') 画像のパス/ファイル名。これは各作成者の RSS フィードへのリンク画像になり、'''feed''' パラメータより優先する。
 +
 
 +
; feed_type : (''文字列'') フィードの種類。テキスト無しがデフォルト。有効な値は:
 +
<!-- :* <tt></tt> - デフォルト -->
 +
:* <tt>rss2</tt>
 +
:* <tt>atom</tt>
 +
:* <tt>rss</tt>
 +
:* <tt>rdf</tt>
 +
 
 +
; style : (''文字列'') 作成者リストを表示するスタイル。デフォルトの ''list'' であれば、非序列リストで表示する。''none'' であれば、シンプルに項目をコンマ区切りで表示する。'''html''' が false なら、このオプションは無視される。有効な値は:
 
:* <tt>list</tt> - デフォルト
 
:* <tt>list</tt> - デフォルト
 
:* <tt>none</tt>
 
:* <tt>none</tt>
; html : (''真偽値'') <!--Whether to list the items in html or plaintext. The default setting is ''true''.  If '''html''' is false, the '''style''' setting is ignored and the items are returned, separated by comma.  This option was added with [[Version 2.8]].  Valid values:-->リストをHTMLで表示するかプレーンテキストで表示するかを選択します。デフォルトでは''true''です。もし''false''の場合は、'''style'''パラメータは無視され、リストはカンマ区切りで返されます。このオプションは[[Version 2.8]]で導入されました。
+
 
:* <tt>1</tt> (true) - デフォルト
+
; html : (''真偽値'') リストを HTML で表示するかどうか。デフォルトは ''true'' (HTML 表示)。'''html''' false なら '''style''' 指定は無視され、項目をコンマで区切った文字列になる。有効な値は:
:* <tt>0</tt> (false)
+
:* <tt>1</tt> (true) - HTML 表示 - デフォルト
 +
:* <tt>0</tt> (false) - プレーンテキスト表示
 +
 
 +
; exclude : (''配列'') 指定した作成者を結果から除く。作成者 ID のコンマ区切りリストを入れる。[[Version 3.9|バージョン 3.9]] 以降で利用可能。
 +
 
 +
; include : (''配列'') 指定した作成者を結果に含める。作成者 ID のコンマ区切りリストを入れる。[[Version 3.9|バージョン 3.9]] 以降で利用可能。
  
 
<div id="Examples">
 
<div id="Examples">
78行目: 112行目:
 
</div>
 
</div>
  
<div id="Authors Full Names and Number of Posts">
+
<div id="Authors_Full_Names_and_Number_of_Posts">
=== 著者のフルネームと投稿数を表示 ===
+
=== 作成者のフルネームと投稿数を表示 ===
 
</div>
 
</div>
  
<!--This example displays a list of the site's authors with the full name (first and last name) plus the number of posts for each author.  Also, and by default, it excludes the admin author, hides authors with no posts, and does not display the RSS feed or image.-->
+
この例は、サイトの作成者リストをフルネーム(名と姓)で表示し、さらに各作成者の投稿数を表示します。
この例ではサイトの著者リストをフルネーム(姓名)で表示し、さらに各著者の投稿数を表示しています。さらに、デフォルトで、管理者を除き、投稿のない著者を隠し、RSSフィードや画像は表示しません。
+
投稿数の降順に、上位 3 人までの作成者を表示します。
 +
またデフォルトにより、'admin' ユーザーを除き、投稿のないユーザーを隠し、RSS のフィードや画像を表示しません。
  
  <?php wp_list_authors('show_fullname=1&optioncount=1'); ?>
+
  <?php wp_list_authors( 'show_fullname=1&optioncount=1&orderby=post_count&order=DESC&number=3' ); ?>
  
<div style="border:1px solid blue; width:50%; padding:10px">Harriett Smith (42)<br />
+
<div style="border:1px solid blue; width:50%; padding:10px">Andrew Anderson (48)<br />
Sally Smith (29)<br />
+
Harriett Smith (42)<br />
Andrew Anderson (48)</div>
+
Sally Smith (29)</div>
  
<div id="Change Log">
+
 
 +
<div id="Change_Log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 
</div>
 
</div>
  
* [[Version 2.8|2.8.0]] : '<code>style</code>''<code>html</code>'パラメータが追加されました。
+
* 1.2.0 : 新規テンプレートタグ
* [[Version 1.2|1.2.0]] : 新規テンプレートタグ
+
* [[Version 2.8|2.8.0]] : パラメータ '<code>style</code>' '<code>html</code>' が追加されました。
 +
* [[Version 3.1|3.1]] : パラメータ '<code>orderby</code>', '<code>order</code>' と '<code>number</code>' が追加されました。
 +
* [[Version 3.9|3.9]] : パラメータ '<code>include</code>' と '<code>exclude</code>' が追加されました。
  
<div id="Source File">
+
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
 
</div>
 
</div>
  
<tt>wp_list_authors()</tt>は{{Trac|wp-includes/author-template.php}}に書かれています。
+
<tt>wp_list_authors()</tt> は {{Trac|wp-includes/author-template.php}} にあります。
{{原文|Function_Reference/wp_list_authors|90605}}<!-- 2010-06-21T07:23:21 Ramiy版 -->
+
  
 
<div id="Related">
 
<div id="Related">
== 関連 ==
+
== 関連資料 ==
 
</div>
 
</div>
 
 
{{Tag Author Tags}}
 
{{Tag Author Tags}}
  
115行目: 151行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
 +
{{原文|Function_Reference/wp_list_authors|141524}} <!-- 15:30, 27 February 2014 Ramiy 版 -->
  
 +
{{DEFAULTSORT:Wp_list_authors}}
 
[[Category:テンプレートタグ]]
 
[[Category:テンプレートタグ]]
 +
[[Category:wp2.8]]
 +
[[Category:wp3.1]]
  
[[en:Function Reference/wp list authors]]
+
[[en:Template Tags/wp_list_authors]]
 +
[[tr:Tema_Etiketleri/wp_list_authors]]

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

サイトの投稿の作成者(ユーザー)の一覧を表示します。 ユーザーが投稿を済ませていれば、作成者の名前は(そのユーザーの投稿一覧ページへの)リンクとして表示されます。 オプションとして、各ユーザーの投稿数と RSS フィードへのリンクを表示することもできます。

表示ではなく、配列の形で取得したい場合は get_users() のほうが使いやすいかもしれません。

使い方

<?php wp_list_authors( $args ); ?>

デフォルトの使い方

<?php $args = array(
	'orderby'       => 'name', 
	'order'         => 'ASC', 
	'number'        => null,
	'optioncount'   => false, 
	'exclude_admin' => true, 
	'show_fullname' => false,
	'hide_empty'    => true,
	'echo'          => true,
	'feed'          => [empty string], 
	'feed_image'    => [empty string],
	'feed_type'     => [empty string],
	'style'         => 'list',
	'html'          => true,
	'exclude'       => [empty string],
	'include'       => [empty string] ); ?>

デフォルトでは以下のようになります。

  • display_name の昇順に表示
  • 表示する作成者の数を制限しない
  • 投稿数を表示しない
  • デフォルトで登録済みの 'admin' ユーザーを除く
  • 作成者の display_name を表示する(フルネームを表示しない)
  • 一つも投稿していないユーザーを除く
  • 結果を表示(PHP の echo で出力)
  • 作成者のフィードテキスト、画像、フィードタイプを指定しない(表示しない)
  • スタイルは一覧形式(HTML の <li></li>
  • リストの項目を有効な HTML 形式で返す
  • 特定の作成者を除外したり含めたりしない

パラメータ

orderby 
(文字列) 指定したフィールドを使ってソートする。バージョン 3.1 以降で利用可能。有効な値は:
  • name - users テーブルの display_name - デフォルト
  • email - users テーブルの user_email (メール)
  • url - users テーブルの user_url (ウェブサイト)
  • registered - users テーブルの user_registered (登録日)
  • id - users テーブルの ID
  • user_login - users テーブルの user_login (ユーザー名)
  • post_count - ユーザーの投稿数
order 
(文字列) 結果を昇順にするか降順にするか。バージョン 3.1 以降で利用可能。有効な値は:
  • ASC - 昇順 - デフォルト
  • DESC - 降順
number 
(整数) 表示するユーザーの最大数。デフォルトは無制限。バージョン 3.1 以降で利用可能。
optioncount 
(真偽値) 公開済み投稿の数を各ユーザーに表示するかどうか。有効な値は:
  • 1 (true) - 表示する
  • 0 (false) - 表示しない - デフォルト
exclude_admin 
(真偽値) 'admin' アカウント(ログイン名が admin)を一覧から除外するかどうか。有効な値は:
  • 1 (true) - 除外する - デフォルト
  • 0 (false) - 除外しない
show_fullname 
(真偽値) 作成者のフルネーム(名と姓)を表示するかどうか。false の場合は「ブログ上の表示名」を表示する。有効な値は:
  • 1 (true) - フルネーム
  • 0 (false) - ブログ上の表示名 - デフォルト
hide_empty 
(真偽値) 投稿数がゼロのユーザーを非表示にするかどうか。有効な値は:
  • 1 (true) - 非表示 - デフォルト
  • 0 (false) - 表示する
echo 
(真偽値) 結果を表示するかどうか。有効な値は:
  • 1 (true) - 表示する - デフォルト
  • 0 (false) - 表示せず、値として返す
feed 
(文字列) 各作成者の RSS フィードへのリンク文字列。デフォルトはテキスト無しで、リンクを表示しない。
feed_image 
(文字列) 画像のパス/ファイル名。これは各作成者の RSS フィードへのリンク画像になり、feed パラメータより優先する。
feed_type 
(文字列) フィードの種類。テキスト無しがデフォルト。有効な値は:
  • rss2
  • atom
  • rss
  • rdf
style 
(文字列) 作成者リストを表示するスタイル。デフォルトの list であれば、非序列リストで表示する。none であれば、シンプルに項目をコンマ区切りで表示する。html が false なら、このオプションは無視される。有効な値は:
  • list - デフォルト
  • none
html 
(真偽値) リストを HTML で表示するかどうか。デフォルトは true (HTML 表示)。html が false なら style 指定は無視され、項目をコンマで区切った文字列になる。有効な値は:
  • 1 (true) - HTML 表示 - デフォルト
  • 0 (false) - プレーンテキスト表示
exclude 
(配列) 指定した作成者を結果から除く。作成者 ID のコンマ区切りリストを入れる。バージョン 3.9 以降で利用可能。
include 
(配列) 指定した作成者を結果に含める。作成者 ID のコンマ区切りリストを入れる。バージョン 3.9 以降で利用可能。

用例

作成者のフルネームと投稿数を表示

この例は、サイトの作成者リストをフルネーム(名と姓)で表示し、さらに各作成者の投稿数を表示します。 投稿数の降順に、上位 3 人までの作成者を表示します。 またデフォルトにより、'admin' ユーザーを除き、投稿のないユーザーを隠し、RSS のフィードや画像を表示しません。

<?php wp_list_authors( 'show_fullname=1&optioncount=1&orderby=post_count&order=DESC&number=3' ); ?>
Andrew Anderson (48)

Harriett Smith (42)

Sally Smith (29)


変更履歴

  • 1.2.0 : 新規テンプレートタグ
  • 2.8.0 : パラメータ 'style' と 'html' が追加されました。
  • 3.1 : パラメータ 'orderby', 'order' と 'number' が追加されました。
  • 3.9 : パラメータ 'include' と 'exclude' が追加されました。

ソースファイル

wp_list_authors()wp-includes/author-template.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_list_authors最新版との差分