説明
string get_avatar( mixed $id_or_email [ , int $size = 96 [ , string $default = '' [ , mixed $alt = false [ , array $args = null ] ] ] ] )
アバターの画像タグを取得する。
パラメータ
- $id_or_emailユーザーID、メールアドレス、コメント情報のいずれか。
- $sizeサイズを指定（省略時は96）。
- $defaultデフォルトのアバター画像タグ（省略時は''）。
- $altイメージタグのalt属性（省略時はfalseとなり、''が適用される）。
- $args[4.2.0]img要素向けのパラメータを連想配列で指定（省略時はnull）。
返り値
アバター画像タグを返す。注意
「設定」-「ディスカッション」で「アバターを表示しない」を選択している場合は、文字列ではなくfalseが返る。
またパラメータ$default省略時のアバター画像は、「設定」-「ディスカッション」で設定されている「デフォルトアバター」となる。
[4.2.0]パラメータ$argsが追加され、連想配列が指定できるようになった。$argsがnullの場合は次の内容が適用される。
| キー | デフォルト値 | 内容 |
| 'size' | 96 | 画像サイズ |
|---|---|---|
| 'height' | null | 画像の幅 |
| 'width' | null | 画像の高さ |
| 'default' | get_option( 'avatar_default', 'mystery' ) | デフォルトのアバタータイプ |
| 'force_default' | false | 強制的にデフォルトを適用する場合はtrueを指定 |
| 'rating' | get_option( 'avatar_rating' ) | アバターのレイティング |
| 'scheme' | null | スキーマ |
| 'alt' | '' | img要素のalt属性値 |
| 'class' | null | img要素のclass属性値 |
| 'force_display' | false | 強制的に取得する場合はtrueを指定 |
| 'loading' | null | loading属性値を指定する場合は'lazy'または'eager'を指定 |
| 'extra_attr' | '' | 任意の属性値を指定 |
| 'decoding' | 'async' | decoding属性値を指定する場合は'async'、'sync'、'auto'を指定 |
[4.2.0]'pre_get_avatar'フィルターが追加され、このフィルターのコールバック関数でimg要素の文字列を返すと、以降の処理は行わず、それが本関数の返り値となる。
使用例
- アバター画像タグを取得する。<?php $avatar = get_avatar( 'admin@thissite.jp' ); ?>
フィルター
[4.2.0]最新のリビジョン情報がある場合に'pre_get_avatar'フィルターを呼び出す。パラメータ$avatarにはデフォルトでnullが、$id_or_emailには本関数が受け取った内容が、$argsにはデフォルト値とマージされた連想配列が格納されている。$avatar = apply_filters( 'pre_get_avatar', $avatar, $id_or_email, $args );return apply_filters( 'get_avatar', $avatar, $id_or_email, $size, $default_value, $alt, $args );アクション
実行するアクションはありません。ソースファイル
/wp-includes/pluggable.php最終更新 : 2023年04月11日 16:22
お勧め
ブロックエディターをちょっとだけカスタマイズしてみる（2021年11月3日 更新）
ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか（自分好みに）調整してみた。
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。プラグインのロード順を制御する（2014年6月9日 更新）
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目（2011年7月6日 更新）
新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。プラグインのヘッダー情報を国際化対応しよう（2018年5月27日 更新）
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。