wp_list_authors()

wp_list_authors()
目次

wp_list_authors()の用途

wp_list_authors() は、WordPress で投稿者(ユーザー)一覧をリスト表示するテンプレートタグです。特に「複数の著者がいるブログ」で、著者一覧ページサイドバーウィジェットなどに使われます。

wp_list_authors()の基本構文

wp_list_authors( $args );
  • $args は配列またはクエリ文字列形式で渡すオプション指定。

wp_list_authors()は何をする関数?

  • 投稿のあるユーザー(デフォルト)を一覧で表示
  • 各著者の名前と著者アーカイブページへのリンクを <li> タグで出力
  • 投稿数や RSS リンクなどもオプションで表示可能

wp_list_authors()の出力例(初期状態)

<ul>
  <li><a href="https://example.com/author/yamada/">Yamada</a></li>
  <li><a href="https://example.com/author/sato/">Sato</a></li>
</ul>

wp_list_authors()の主な引数一覧($args

パラメータ説明
orderby文字列並び順。例:'name', 'post_count'
order文字列'ASC' または 'DESC'
exclude文字列除外するユーザーIDのカンマ区切り(例:'1,2'
include文字列含めるユーザーIDのカンマ区切り(例:'3,5'
show_fullnameboolフルネーム表示(姓+名)にするか。デフォルトは false
hide_emptybool投稿のない著者を非表示にする。デフォルトは true
echobooltrue:出力 / false:文字列として返す
style文字列出力形式。'list'<li>)か 'none'(区切りなし)
htmlboolHTMLで出力するか。falseにするとプレーンテキストのみ
optioncountbool投稿数をカッコ付きで表示(例:Yamada (12)
feed文字列RSSリンクのラベルを表示する(例:'RSS'
feed_imageURLRSSアイコン画像のURLを指定
feed_type文字列RSSのタイプ(rss2, atom など)
exclude_adminbool管理者ユーザー(ID=1)を除外する。デフォルトは true

wp_list_authors()のシンプルな使用例

<?php wp_list_authors(); ?>

※投稿のあるユーザーのみを、著者名とリンク付きで表示

投稿数も表示する例

<?php
wp_list_authors( array(
  'optioncount' => true,
  'hide_empty' => false
) );
?>

出力例:

<ul>
  <li><a href="...">Yamada</a> (5)</li>
  <li><a href="...">Sato</a> (0)</li>
</ul>

RSSリンク付きの例

wp_list_authors( array(
  'feed' => 'RSS',
  'optioncount' => true
) );

出力例:

<li><a href="...">Yamada</a> (10) <a href=".../feed/" title="Yamada RSS">RSS</a></li>

echo => false で文字列として取得

$list = wp_list_authors( array(
  'echo' => false,
  'hide_empty' => false
) );
echo '<div class="author-list">' . $list . '</div>';

wp_list_authors()の注意点

  • デフォルトでは投稿のないユーザーは非表示です(hide_empty => true)。
  • 「姓+名(first_name + last_name)」で表示したいときは、show_fullname => true だが、未設定のユーザーがいると空白になることがあるため注意。
  • exclude_adminID=1 の管理者が除外されるため、必要なら false を明示。

関連関数との比較

関数名概要
wp_list_authors()投稿者一覧を <li> 形式で出力
get_users()任意の条件でユーザー一覧を取得(出力しない)
wp_dropdown_users()<select>形式でユーザー一覧を出力

wp_list_authors()のまとめ

特徴内容
用途投稿者一覧のリンク付きリストを表示したいとき
出力形式<ul><li>、もしくはカスタマイズ可能
投稿数やRSS対応optioncount, feed, feed_image などで制御
非表示制御hide_empty, exclude, exclude_admin などで絞り込み
よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

初めてホームページを作成したのは1996年。
2000年よりフリーランスで主に中小企業、学校、各種公的団体、個人事業主のWordPressを活用したホームページ制作を行っています。WordPressテーマはそれぞれのクライアントに合わせて作成しています。
WordPressを活用したサイト運営のための情報発信をしていきます。

目次