当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「プラグイン API/フィルターフック一覧/get avatar」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Plugin API/Filter Reference/get_avatar 07:27, 12:35, 14 February 2018 Stiofansisland 版を流し込み。)
 
(和訳完了。)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
 
== 説明<span id="Description"></span> ==
 
== 説明<span id="Description"></span> ==
  
The "get_avatar" filter can be used to alter the avatar image returned by the [[関数リファレンス/get_avatar|get_avatar()]] function.
+
フィルター <code>get_avatar</code> を使うと、関数 [[関数リファレンス/get_avatar|get_avatar()]] が返すアバター画像を変えられます。
  
The Filter is used at the very end of the get_avatar() function, like this:
+
このフィルターは関数 get_avatar() の最後の最後で次のように呼び出されます:
  
 
<pre>
 
<pre>
13行目: 13行目:
 
== パラメータ<span id="Parameters"></span> ==
 
== パラメータ<span id="Parameters"></span> ==
  
* $avatar           Image tag for the user's avatar.
+
{{Parameter|$avatar|文字列|ユーザーのアバターを表す <code>&lt;img&gt;</code> タグ。}}
* $id_or_email  A user ID, email address, or comment object.
+
{{Parameter|$id_or_email|mixed|取得する Gravatar を指定するキー。指定可能なのはユーザー ID, Gravater の md5 ハッシュ, ユーザーのメールアドレス, WP_User オブジェクト, WP_Post オブジェクト, または WP_Comment オブジェクト。}}
* $size              Square avatar width and height in pixels to retrieve.
+
{{Parameter|$size|整数|取得するアバター画像(正方形)の幅および高さ。単位はピクセル。}}
* $default          (Optional) URL for the default image or a default type.
+
{{Parameter|$default|文字列|デフォルトのイメージまたはタイプの URL。指定可能なのは <code>'404'</code>, <code>'retro'</code>, <code>'monsterid'</code>, <code>'wavatar'</code>, <code>'indenticon'</code>, <code>'mystery'</code> (または <code>'mm'</code> や <code>'mysteryman'</code>), <code>'blank'</code>, および <code>'gravatar_default'</code>。|オプション|デフォルトはオプション <tt>'avatar_default'</tt> の値で、 フォールバックは <code>'mystery'</code> です。}}
* $alt                Alternative text to use in the avatar image tag.
+
{{Parameter|$alt|文字列|アバターの <code>&lt;img&gt;</code> タグに使う代わりの文字列。|オプション|空文字列。}}
* $args            @since 4.2.0 (Optional) Extra arguments to retrieve the avatar.
+
{{Parameter|$args|配列|関数 [https://developer.wordpress.org/reference/functions/get_avatar_data/ get_avatar_data()] へ渡された引数の配列。get_avatar_data() は実行済みです。|オプション}}
 
+
<!--
+
$avatar
+
(string) <img> tag for the user's avatar.
+
$id_or_email
+
(mixed) The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.
+
$size
+
(int) Square avatar width and height in pixels to retrieve.
+
$default
+
(string) URL for the default image or a default type. Accepts '404', 'retro', 'monsterid', 'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'. Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
+
$alt
+
(string) Alternative text to use in the avatar image tag. Default empty.
+
$args
+
(array) Arguments passed to get_avatar_data(), after processing.
+
-->
+
  
 
== 用例<span id="Example"></span> ==
 
== 用例<span id="Example"></span> ==
  
In this example, I am looking for user with an id of 1 and sending back a custom image.
+
この例は、指定されたユーザーを取得して ID が 1 ならカスタム画像を返します。
  
 
<pre>
 
<pre>
65行目: 50行目:
  
 
         if ( $user->data->ID == '1' ) {
 
         if ( $user->data->ID == '1' ) {
             $avatar = 'YOUR_NEW_IMAGE_URL';
+
             $avatar = 'YOUR_NEW_IMAGE_URL'; // カスタム画像の URL
 
             $avatar = "<img alt='{$alt}' src='{$avatar}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
 
             $avatar = "<img alt='{$alt}' src='{$avatar}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
 
         }
 
         }
77行目: 62行目:
 
== 参考<span id="Notes"></span> ==
 
== 参考<span id="Notes"></span> ==
  
There are two tricky parts to using this filter:
+
このフィルターを使うときトリッキーな部分が2ヵ所あります:
  
# get_avatar() can be passed a user ID, user object or email address. So we will not know what we are looking at and will need to check for them all.
+
# 関数 get_avatar() はユーザーの ID またはオブジェクトまたはメールアドレスを渡されます。探しているキーがどれなのかわからないので、すべてチェックする必要があります。
# It returns the entire image html string with classes, alt, and src. So you need to recreate the entire thing, not just send back the image url.
+
# html の <code>&lt;img&gt;</code> タグ全体を返します。これにはクラス、alt 属性、src 属性を含みます。そのため画像の URL だけでなく全体を再生成する必要があります。
  
 
== 変更履歴<span id="Change_Log"></span> ==
 
== 変更履歴<span id="Change_Log"></span> ==
  
* 4.2.0 : The $args parameter was added.
+
* 4.2.0 : パラメータ <tt>$args</tt> が追加された。
* 2.5.0 : Introduced.
+
* 2.5.0 : 新規導入。
  
 
== 関連項目<span id="Related"></span> ==
 
== 関連項目<span id="Related"></span> ==

2018年5月20日 (日) 22:03時点における版

この項目「プラグイン API/フィルターフック一覧/get avatar」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

フィルター get_avatar を使うと、関数 get_avatar() が返すアバター画像を変えられます。

このフィルターは関数 get_avatar() の最後の最後で次のように呼び出されます:

    return apply_filters( 'get_avatar', $avatar, $id_or_email, $size, $default, $alt, $args );

パラメータ

$avatar
文字列) (必須) ユーザーのアバターを表す <img> タグ。
初期値: なし
$id_or_email
mixed) (必須) 取得する Gravatar を指定するキー。指定可能なのはユーザー ID, Gravater の md5 ハッシュ, ユーザーのメールアドレス, WP_User オブジェクト, WP_Post オブジェクト, または WP_Comment オブジェクト。
初期値: なし
$size
整数) (必須) 取得するアバター画像(正方形)の幅および高さ。単位はピクセル。
初期値: なし
$default
文字列) (オプション) デフォルトのイメージまたはタイプの URL。指定可能なのは '404', 'retro', 'monsterid', 'wavatar', 'indenticon', 'mystery' (または 'mm''mysteryman'), 'blank', および 'gravatar_default'
初期値: デフォルトはオプション 'avatar_default' の値で、 フォールバックは 'mystery' です。
$alt
文字列) (オプション) アバターの <img> タグに使う代わりの文字列。
初期値: 空文字列。
$args
配列) (オプション) 関数 get_avatar_data() へ渡された引数の配列。get_avatar_data() は実行済みです。
初期値: なし

用例

この例は、指定されたユーザーを取得して ID が 1 ならカスタム画像を返します。

// Apply filter
add_filter( 'get_avatar' , 'my_custom_avatar' , 1 , 5 );

function my_custom_avatar( $avatar, $id_or_email, $size, $default, $alt ) {
    $user = false;

    if ( is_numeric( $id_or_email ) ) {

        $id = (int) $id_or_email;
        $user = get_user_by( 'id' , $id );

    } elseif ( is_object( $id_or_email ) ) {

        if ( ! empty( $id_or_email->user_id ) ) {
            $id = (int) $id_or_email->user_id;
            $user = get_user_by( 'id' , $id );
        }

    } else {
        $user = get_user_by( 'email', $id_or_email );	
    }

    if ( $user && is_object( $user ) ) {

        if ( $user->data->ID == '1' ) {
            $avatar = 'YOUR_NEW_IMAGE_URL';  // カスタム画像の URL
            $avatar = "<img alt='{$alt}' src='{$avatar}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
        }

    }

    return $avatar;
}

参考

このフィルターを使うときトリッキーな部分が2ヵ所あります:

  1. 関数 get_avatar() はユーザーの ID またはオブジェクトまたはメールアドレスを渡されます。探しているキーがどれなのかわからないので、すべてチェックする必要があります。
  2. html の <img> タグ全体を返します。これにはクラス、alt 属性、src 属性を含みます。そのため画像の URL だけでなく全体を再生成する必要があります。

変更履歴

  • 4.2.0 : パラメータ $args が追加された。
  • 2.5.0 : 新規導入。

関連項目

最新英語版: WordPress Codex » Plugin API/Filter Reference/get avatar最新版との差分