説明
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年6月9日 更新）
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）
5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。
HTML entities button：プラグイン作ってみました（2021年4月28日 更新）
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。更新ボタンの横にスピナーを実装する（2019年5月14日 更新）
WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。
「順序」をtextからnumberに変更してみた（2018年5月27日 更新）
固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。