説明
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
お勧め
6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo：プラグイン作ってみました（2019年9月19日 更新）
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。