wp_list_authors()
は、WordPress サイトに登録された投稿者(著者)の一覧を表示するためのテンプレートタグです。
機能の説明
wp_list_authors()
は、投稿があるすべてのユーザー(著者)を一覧表示します。このテンプレートタグを使うことで、ブログやウェブサイトに著者別のリストを簡単に追加できます。さまざまなオプションで表示のカスタマイズが可能です。
シンプルなコード例
<?php wp_list_authors(); ?>
このコードを使用すると、投稿しているすべての著者の名前がリストとして表示されます。
使い方の解説
wp_list_authors()
を使用すると、投稿者のリストを自動的に表示することができます。このリストは、投稿がある著者のみが表示されます。デフォルトではリンク形式で著者のアーカイブページへのリンクも設定されますが、オプションを使ってカスタマイズすることが可能です。
オプションの例
exclude_admin
: 管理者(admin)をリストから除外するかどうか。optioncount
: 投稿数を表示するかどうか。show_fullname
: フルネームを表示するかどうか。hide_empty
: 投稿がないユーザーを表示しないかどうか。
使用例
<?php
wp_list_authors( array(
'exclude_admin' => false,
'optioncount' => true,
'show_fullname' => true,
'hide_empty' => true
) );
?>
このコードでは、すべての著者(管理者も含む)を表示し、それぞれの著者の投稿数がリストに表示されます。また、ユーザーのフルネームを表示し、投稿のない著者はリストから除外されます。
一緒に使うことが多い関連タグ
get_the_author()
get_the_author()
は、著者の名前を取得して表示するためのテンプレートタグです。通常、投稿ページや著者ページなどで使用されます。
<?php
if ( have_posts() ) :
while ( have_posts() ) : the_post();
echo '<p>投稿者: ' . get_the_author() . '</p>';
endwhile;
endif;
?>
このコードは、現在の投稿の著者名を表示します。wp_list_authors()
と一緒に使うことで、個別投稿ページでも著者情報を表示することができます。
wp_dropdown_users()
wp_dropdown_users()
は、ユーザーのドロップダウンメニューを生成します。wp_list_authors()
と組み合わせることで、著者リストを別の形式で提供できます。
<?php
wp_dropdown_users( array(
'role' => 'author',
'name' => 'authors_dropdown'
) );
?>
このコードは、author
ロールを持つユーザーをドロップダウンメニューとして表示します。著者一覧を提供する別の方法として使用できます。
追加情報を取得したい場合
get_author_posts_url()
get_author_posts_url()
は、特定の著者の投稿一覧ページのURLを取得するためのテンプレートタグです。wp_list_authors()
でリスト表示される著者のリンクをカスタマイズしたい場合に使えます。
<?php
$author_id = 1; // 著者のIDを指定
echo get_author_posts_url( $author_id );
?>
このコードは、IDが1の著者の投稿一覧ページのURLを出力します。wp_list_authors()
と組み合わせて著者リンクをカスタマイズする際に便利です。
出力できる情報
- URL:著者の投稿一覧ページのURL
- author_id:著者のID
使用する事で想定されるトラブル
投稿がないユーザーも表示される
デフォルトでは、投稿があるユーザーだけが表示されますが、hide_empty
オプションを調整して投稿のないユーザーも表示することが可能です。
解決方法
投稿がないユーザーを表示したくない場合は、hide_empty
オプションを true
に設定します。
管理者がリストに表示されない
exclude_admin
オプションが true
になっている可能性があります。
解決方法
管理者をリストに表示するには、exclude_admin
オプションを false
に設定します。
Q&A
まとめ
wp_list_authors()
は、WordPress サイト内の投稿者(著者)をリスト形式で表示するのに非常に便利なテンプレートタグです。
表示するユーザーや投稿数の有無、リンクのカスタマイズなど、さまざまなオプションを使って柔軟にカスタマイズできます。他のテンプレートタグ(get_the_author()
や get_author_posts_url()
など)と組み合わせることで、さらに詳細で便利な著者リストを作成できます。
コメント