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


お勧め

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

PHPとMySQLのバージョンを確認(2013年9月11日 更新)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

ACF(Advanced Custom Fields)向けにデータをインポートした時のメモ(2023年7月11日 更新)

ACFを採用するサイトにデータをインポートする際、ほとんどのことはwww.advancedcustomfields.comに記載されていたのだが、いくつかわからないことがあった。ここでは、その時に調べたことをメモしておく。

不要なプラグインを読み込まない(2023年6月2日 更新)

稼働中のサーバーにてバックグラウンドで何か処理しようとコマンドラインのプログラムを作る際、効率化や誤動作のリスクを考えると不要なプラグインはロードしないようにしたい。そんなわけで設定内容(データベース)は変更せず、特定のプラグインをロードしないようにできないか考えてみた。

Align widgets horizontally:プラグイン作ってみました(2024年2月28日 更新)

ほぼ毎日何度も見ているダッシュボードページ。自分好みに各ウィジェットの場所を配置しているものの、何かすっきりしない。そこでふと思ったのが、ウィジェットを横並びにできれば隣り合うウィジェットの並びがガタガタしなくなるのでは!?