- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/get avatar
ユーザー ID もしくはメールアドレスからユーザーのアバターを取得します。一般的にコメント欄で使われます。
この関数はプラガブルです。しかしグラバターの出力を変更したいプラグイン作者は、互換性のために get_avatar /en フィルターを代わりに使うべきです。
この関数は 設定 > ディスカッション設定 の「アバターを表示する」にチェックがなければアバターを返しません。
使い方
<?php echo get_avatar( $id_or_email, $size, $default, $alt, $args ); ?>
パラメータ
- $id_or_email
- (整数/文字列/オブジェクト) (必須) 作成者のユーザー ID(整数または文字列)、メールアドレス(文字列)、またはコメントループによるコメントオブジェクト。
- 初期値: なし
- 参考: ほとんどのコメントテンプレートでは、コメント投稿者のグラバターを表示するために
$comment
をここに使えます。ループ内の他のテンプレート(WordPress 2.7 以前)ではget_the_author_id()
が使えました(WordPress 2.8 で非推奨になりました)。WordPress 2.8 以降ではget_the_author_meta( 'ID' )
を使ってください。 - $size
- (整数) (オプション) 返すグラバターの大きさ(最大 512)。
- 初期値: 96
- $default
- (文字列) (オプション) デフォルト画像の URL。省略すると「Mystery Man」。
- 初期値:
- $alt
- (文字列) (オプション) アバターの代替テキスト。
- 初期値: false
- $args
- (配列) (オプション) 返すアバターをデフォルト引数の代わりに指定する引数。
- 初期値: null
$args
$args はアバターを取得するとき追加の引数として使われます。
- size
- (整数) (オプション) アバター画像ファイルの高さと幅。単位はピクセル。
- 初期値: 96
- height
- (整数) (オプション) アバターを表示するときの高さ。単位はピクセル。
- 初期値: size の値。
- width
- (整数) (オプション) アバターを表示するときの幅。単位はピクセル。
- 初期値: size の値。
- default
- (文字列) (オプション) デフォルト画像の URL またはデフォルトのタイプ。
- 初期値: 'avatar_default' オプションの値。それもなければ 'mystery' へフォールバック。
-
'404'
(デフォルト画像の代わりに 404 を返す) -
'retro'
(8ビット) -
'monsterid'
(モンスター) -
'wavatar'
(マンガ顔) -
'indenticon'
(キルト柄) -
'mystery'
、'mm'
、または'mysteryman'
(The Oyster Man) -
'blank'
(透過 GIF) -
'gravatar_default'
(Gravatar ロゴ)
- force_default
- (真偽値) (オプション) いつも Gravatar ではなくデフォルト画像を表示するかどうか。
- 初期値: false
- rating
- (文字列) (オプション) 表示するアバターの評価による制限。'G', 'PG', 'R', 'X' の順に緩くなる。
- 初期値: 'avatar_rating' オプションの値。
-
'G'
— あらゆる人に適切 -
'PG'
— 不快感を与える恐れ — 13歳以上の人向き -
'R'
— 18歳以上の成人向き -
'X'
— 最高レベルの制限
- scheme
- (文字列) (オプション) 使用する URL スキーム。指定可能な値は set_url_scheme() を参照。
- 初期値:
- class
- (配列|文字列) (オプション)
<img>
要素へ追加するクラスの配列または文字列。- 初期値: null
- force_display
- (真偽値) (オプション) アバターを常に表示するかどうか。'show_avatars' オプションを無視する。
- 初期値: false
- extra_attr
- (文字列) (オプション)
<img>
要素へ挿入する HTML 属性。無害化されない。- 初期値: 空文字列
戻り値
- 文字列|false
- ユーザーのアバターを表示する img 要素。失敗すると false。
- 注意: この関数は何も出力しません。表示するには戻り値を echo する必要があります。
用例
コメントに表示するには:
<?php echo get_avatar( $comment, 32 ); ?>
ループ内で投稿の作成者に表示するには:
<?php echo get_avatar( get_the_author_meta( 'ID' ), 32 ); ?>
メールアドレスで表示するには:
<?php echo get_avatar( 'email@example.com', 32 ); ?>
参考
- 返す文字列をフィルターするために get_avatar /enフィルターを使用します。
- この関数はプラガブルなのでプラグインやテーマによって再定義できます。その場合、デフォルトの機能に依存することはできません。
変更履歴
ソースファイル
get_avatar() は wp-includes/pluggable.php
にあります。
関連項目
コメント関数: cancel_comment_reply_link(), comment_author(), comment_author_email(), comment_author_email_link(), comment_author_IP(), comment_author_link(), comment_author_rss(), comment_author_url(), comment_author_url_link(), comment_class(), comment_date(), comment_excerpt(), comment_form_title(), comment_form(), comment_ID(), comment_id_fields() / en, comment_reply_link(), comment_text(), comment_text_rss(), comment_time(), comment_type(), comments_link, comments_number(), comments_open(), comments_popup_link(), comments_popup_script(), comments_rss_link(), get_avatar(), next_comments_link(), paginate_comments_links(), permalink_comments_rss(), previous_comments_link(), wp_list_comments()
最新英語版: WordPress Codex » Function Reference/get_avatar (最新版との差分)