説明
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
お勧め
初期状態で「抜粋」ウィジェットを表示する（2014年1月7日 更新）
投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。
query_posts（WP_Queryクラス）で投稿タグを絞り込む（2011年9月14日 更新）
投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。カスタムフィールド関連関数のおさらい（2012年6月22日 更新）
カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。Align widgets horizontally：プラグイン作ってみました（2024年5月6日 更新）
ほぼ毎日何度も見ているダッシュボードページ。自分好みに各ウィジェットの場所を配置しているものの、何かすっきりしない。そこでふと思ったのが、ウィジェットを横並びにできれば隣り合うウィジェットの並びがガタガタしなくなるのでは！？
Contact Form 7に確認フェーズを（2012年12月16日 更新）
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。