「テンプレートタグ/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' ); ?>

• 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 （最新版との差分）