get_avatar_data()


WordPressのget_avatar_data()関数は、ユーザーのアバター画像に関するデータを取得するために使用されます。この関数は、アバターのURL、サイズ、デフォルト画像などの情報を配列として返します。

構文

get_avatar_data( int|string|object $id_or_email, array $args = array() );

引数の説明:

  • $id_or_email (int|string|object) — ユーザーID、メールアドレス、またはユーザーオブジェクトを指定します。
  • $args (array) — アバターの設定を指定する配列。以下のキーを含むことができます:
    • size — アバターのサイズ（ピクセル単位）。デフォルトは96。
    • height — アバターの高さ（ピクセル単位）。指定しない場合はsizeが使用されます。
    • width — アバターの幅（ピクセル単位）。指定しない場合はsizeが使用されます。
    • default — アバターが存在しない場合に使用するデフォルト画像のURL。
    • force_default — デフォルト画像を強制的に使用するかどうか（真偽値）。
    • rating — 表示するアバターの評価（G、PG、R、X）。
    • scheme — URLスキーム（http、httpsなど）。
    • processed_args — 処理された引数を返すかどうか（真偽値）。

例1: 基本的なアバターデータの取得

この例では、現在のユーザーのアバターデータを取得します。

$avatar_data = get_avatar_data(get_current_user_id()); print_r($avatar_data);

例2: アバターのサイズを指定して取得

この例では、アバターのサイズを128ピクセルに指定してデータを取得します。

$avatar_data = get_avatar_data(get_current_user_id(), array('size' => 128)); print_r($avatar_data);

例3: デフォルト画像を指定して取得

この例では、アバターが存在しない場合に表示するデフォルト画像を指定します。

$avatar_data = get_avatar_data(get_current_user_id(), array('default' => 'https://example.com/default.png')); print_r($avatar_data);

例4: 評価を指定してアバターデータを取得

この例では、アバターの評価を「G」に指定してデータを取得します。

$avatar_data = get_avatar_data(get_current_user_id(), array('rating' => 'G')); print_r($avatar_data);

例5: 強制的にデフォルト画像を使用

この例では、強制的にデフォルト画像を使用するように設定します。

$avatar_data = get_avatar_data(get_current_user_id(), array('force_default' => true)); print_r($avatar_data);

例6: HTTPSスキームでアバターデータを取得

この例では、HTTPSスキームを使用してアバターデータを取得します。

$avatar_data = get_avatar_data(get_current_user_id(), array('scheme' => 'https')); print_r($avatar_data);

例7: 処理された引数を取得

この例では、処理された引数を取得します。

$avatar_data = get_avatar_data(get_current_user_id(), array('processed_args' => true)); print_r($avatar_data);

例8: メールアドレスを使用してアバターデータを取得

この例では、メールアドレスを使用してアバターデータを取得します。

$avatar_data = get_avatar_data('user@example.com'); print_r($avatar_data);

注意点

  • アバターデータを取得する際に、ユーザーIDやメールアドレスが正しく指定されていることを確認してください。
  • デフォルト画像のURLが有効であることを確認してください。
  • アバターの評価を指定する場合、適切な評価を選択してください。

関連機能：