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


お勧め

自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。