get_avatar

説明

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'nullimg要素のclass属性値
'force_display'false強制的に取得する場合はtrueを指定
'loading'nullloading属性値を指定する場合は'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 );
[2.5.0]img要素の文字列を返す前に'get_avatar'フィルターを呼び出す。パラメータ$avatarにはimg要素の文字列が、$id_or_emailには本関数が受け取った内容が、$sizeには画像サイズが、$default_valueには画像タイプが、$altにはalt属性値が格納されている。 [4.2.0]パラメータ$argsが追加され、$argsにはデフォルト値とマージされた連想配列が格納されている。
return apply_filters( 'get_avatar', $avatar, $id_or_email, $size, $default_value, $alt, $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2023年04月11日 16:22


お勧め

スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2019年5月24日 更新)

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

5.3の機能強化:ユーザーパスワードの表示と非表示(2019年9月30日 更新)

WordPress 5.3 Beta 1」に記載されていた「Toggle password view」という項目。「Other Changes for Developers」の見出しの中ということもあり、ちょっと調べてみた。