• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「関数リファレンス/get avatar」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(翻訳済み)
(en:Function Reference/get_avatar 18:19, 13 August 2015 Etorba 版を反映。)
1行目: 1行目:
 
+
<div id="Description">
 
== 説明 ==
 
== 説明 ==
 +
</div>
  
ユーザーID もしくは 電子メールアドレス から ユーザー の アバター を取得します。一般的に コメント欄 で使われます。<!--Retrieve the avatar for a user who provided a user ID or email address. Most commonly used in the comments section.-->
+
ユーザー ID もしくはメールアドレスからユーザーの[[用語集#Avater|アバター]]を取得します。一般的にコメント欄で使われます。
  
この関数は [[Pluggable Functions|pluggable]]/[[:en:Pluggable Functions|en]] です。しかしながら、グラバターの出力を変更したいプラグインの作成者は、互換性のため、代わりにget_avatarフィルタを使用する必要があります。<!--
+
この関数は[[プラガブル関数|プラガブル]]です。しかし[[用語集#Gravatar|グラバター]]の出力を変更したいプラグイン作者は、互換性のために <tt>[[プラグイン API/フィルターフック一覧/get_avatar | get_avatar]]</tt> /[[:en:Plugin_API/Filter_Reference/get_avatar|en]] フィルターを代わりに使うべきです。
This function is [[Pluggable Functions|pluggable]]/[[:en:Pluggable Functions|en]], however plugin authors wishing to change the gravatar output should use the get_avatar filter instead, for compatibility purposes.-->
+
  
== 使い方 ==<!-- Usage -->
+
この関数は 設定 &gt; ディスカッション設定 の「アバターを表示する」にチェックがなければアバターを返しません。
  
<?php echo get_avatar( $id_or_email, $size, $default, $alt ); ?>
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
== パラメータ ==<!-- Parameters -->
+
<?php echo get_avatar( $id_or_email, $size, $default, $alt, $args ); ?>
  
{{Parameter|id_or_email|int/string/object|作者の ユーザーID (int/string) か 電子メールアドレス (string) か コメント ループ での コメント オブジェクト. ''ノート: コメント投稿者のグラバターを表示するために、多くの コメント テンプレート において <code>$comment</code> をここで使うことが出来ます。ループ内の他のテンプレートでは(WordPress 2.7 以下)、<code>get_the_author_id()</code> が使用できます(WordPress 2.8では非推奨)。WordPress 2.8では、<code>get_the_author_meta('user_email')</code> を使用してください。''<!--Author’s User ID (an integer or string), an E-mail Address (a string) or the comment object from the comment loop. ''Note: with most comment templates you can use <code>$comment</code> here, in order to display the gravatar of the commenter. In other templates within The Loop (for WordPress 2.7 and lower), you can use <code>get_the_author_id()</code> (deprecated in WordPress 2.8). For WordPress 2.8, please use <code>get_the_author_meta('user_email')</code>.''-->}}
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|size|integer|グラバターのサイズを指定します (最大 512)<!--Size of Gravatar to return (max is 512).-->|オプション|96}}
+
{{Parameter|$id_or_email|整数/文字列/オブジェクト|作成者のユーザー ID(整数または文字列)、メールアドレス(文字列)、またはコメントループによるコメントオブジェクト。}}
{{Parameter|default|string|画像へのURL, デフォルト: "Mystery Man"<!--url for an image, defaults to the "Mystery Man".-->|オプション}}
+
: '''参考:''' ほとんどのコメントテンプレートでは、コメント投稿者のグラバターを表示するために <code>$comment</code> をここに使えます。[[ループ]]内の他のテンプレート(WordPress 2.7 以前)では <code>get_the_author_id()</code> が使えました(WordPress 2.8 で非推奨になりました)。[[Version 2.8|WordPress 2.8]] 以降では  <code>[[関数リファレンス/get_the_author_meta|get_the_author_meta]]( 'ID' )</code> を使ってください。
{{Parameter|alt|string|画像の代替テキストを指定します|オプション}}
+
{{Parameter|$size|整数|返すグラバターの大きさ(最大 512)。|オプション|96}}
 +
{{Parameter|$default|文字列|デフォルト画像の URL。省略すると「Mystery Man」。|オプション|''}}
 +
{{Parameter|$alt|文字列|アバターの代替テキスト。|オプション|false}}
 +
{{Parameter|$args|配列|返すアバターをデフォルト引数の代わりに指定する引数。|オプション|null}}
  
==戻り値==
+
<div id=".24args">
; <tt>文字列</tt> : img 要素。 この関数は何も出力しません。戻り値をエコーする必要があります。
+
=== $args ===
 +
</div>
 +
$args はアバターを取得するとき追加の引数として使われます。<!-- '''Note:''' If you change the $defaults in your get_avatar using $new_defaults, you must declare the $new_defaults BEFORE you call get_avatar, otherwise, they won't take effect.
  
== 用例 ==<!-- Examples -->
+
Default values: -->
 +
{{Parameter|size|整数|アバター画像ファイルの高さと幅。単位はピクセル。|オプション|96}}
 +
{{Parameter|height|整数|アバターを表示するときの高さ。単位はピクセル。|オプション|size の値。}}
 +
{{Parameter|width|整数|アバターを表示するときの幅。単位はピクセル。|オプション|size の値。}}
 +
{{Parameter|default|文字列|デフォルト画像の URL またはデフォルトのタイプ。|オプション|'avatar_default' オプションの値。それもなければ 'mystery' へフォールバック。}}
 +
:* <code>'404'</code> (デフォルト画像の代わりに 404 を返す)
 +
:* <code>'retro'</code> (8ビット)
 +
:* <code>'monsterid'</code> (モンスター)
 +
:* <code>'wavatar'</code> (マンガ顔)
 +
:* <code>'indenticon'</code> (キルト柄)
 +
:* <code>'mystery'</code>、<code>'mm'</code>、または <code>'mysterman'</code> (The Oyster Man)
 +
:* <code>'blank'</code> (透過 GIF)
 +
:* <code>'gravatar_default'</code> (Gravatar ロゴ)
 +
{{Parameter|force_default|真偽値|いつも Gravatar ではなくデフォルト画像を表示するかどうか。|オプション|false}}
 +
{{Parameter|rating|文字列|表示するアバターの評価による制限。'G', 'PG', 'R', 'X' の順に緩くなる。|オプション|'avatar_rating' オプションの値。}}
 +
:* <code>'G'</code> &mdash; あらゆる人に適切
 +
:* <code>'PG'</code> &mdash; 不快感を与える恐れ &mdash; 13歳以上の人向き
 +
:* <code>'R'</code> &mdash; 18歳以上の成人向き
 +
:* <code>'X'</code> &mdash; 最高レベルの制限
 +
{{Parameter|scheme|文字列|使用する URL スキーム。指定可能な値は set_url_scheme() を参照。|オプション|''}}
 +
{{Parameter|class|配列&#124;文字列|<code>&lt;img&gt;</code> 要素へ追加するクラスの配列または文字列。|オプション|null}}
 +
{{Parameter|force_display|真偽値|アバターを常に表示するかどうか。'show_avatars' オプションを無視する。|オプション|false}}
 +
{{Parameter|extra_attr|文字列|<code>&lt;img&gt;</code> 要素へ挿入する HTML 属性。無害化されない。|オプション|空文字列}}
  
コメント
+
 
 +
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
; <tt>文字列|false</tt> : ユーザーのアバターを表示する img 要素。失敗すると false。
 +
: '''注意:''' この関数は何も出力しません。表示するには戻り値を echo する必要があります。
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
 
 +
コメントに表示するには:
  
 
  <?php echo get_avatar( $comment, 32 ); ?>
 
  <?php echo get_avatar( $comment, 32 ); ?>
  
ループ内のユーザーID
+
ループ内で投稿の作成者に表示するには:
  
 
  <?php echo get_avatar( get_the_author_meta( 'ID' ), 32 ); ?>
 
  <?php echo get_avatar( get_the_author_meta( 'ID' ), 32 ); ?>
  
メールアドレス
+
メールアドレスで表示するには:
  
 
  <?php echo get_avatar( 'email@example.com', 32 ); ?>
 
  <?php echo get_avatar( 'email@example.com', 32 ); ?>
  
====
+
<div id="Notes">
* 返された文字列をフィルタリングする為に、<tt>[[Plugin_API/Filter_Reference/get_avatar | get_avatar]]</tt> フィルターを使用します。
+
== 参考 ==
* [[Pluggable_Functions | pluggable]] 関数とプラグインやテーマによってオーバーライドすることができます。デフォルトの機能は、依拠することはできません。
+
</div>
 +
 
 +
* 返す文字列をフィルターするために <tt>[[プラグイン API/フィルターフック一覧/get_avatar | get_avatar]]</tt> /[[:en:Plugin_API/Filter_Reference/get_avatar|en]]フィルターを使用します。
 +
* この関数は[[プラガブル関数|プラガブル]]なのでプラグインやテーマによって再定義できます。その場合、デフォルトの機能に依存することはできません。
 +
 
 +
<div id="Changelog">
 +
== 変更履歴 ==
 +
</div>
  
== 変更履歴 ==<!-- Changelog -->
+
* [[Version_4.2 | 4.2.0]] : オプションの `$args` パラメーターを追加。
 +
* [[Version_2.5 | 2.5.0]] : 新規導入。
  
* [[Version 2.5|2.5.0]] : 新規テンプレートタグ
+
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
  
== ソースファイル ==<!-- Source File -->
+
<tt>get_avatar()</tt> は {{Trac|wp-includes/pluggable.php}} にあります。
  
<tt>get_avatar()</tt> は{{Trac|wp-includes/pluggable.php}}にあります。
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
{{原文|Function Reference/get_avatar|132837}}<!--  21:32, 4 July 2013‎ Obenland  版 -->
+
* [[Gravatar の使い方]]
  
== 関連 ==<!-- Related -->
 
 
{{Tag Comments Tags}}
 
{{Tag Comments Tags}}
  
<!-- {{Tag Footer}} -->
+
{{原文|Function Reference/get_avatar|153403}} <!-- 18:19, 13 August 2015 Etorba 版 -->
{{PHP Function Tag Footer}}
+
  
 
{{DEFAULTSORT:Get_avatar}}
 
{{DEFAULTSORT:Get_avatar}}

2016年1月30日 (土) 21:38時点における版

ユーザー ID もしくはメールアドレスからユーザーのアバターを取得します。一般的にコメント欄で使われます。

この関数はプラガブルです。しかしグラバターの出力を変更したいプラグイン作者は、互換性のために get_avatar /en フィルターを代わりに使うべきです。

この関数は 設定 > ディスカッション設定 の「アバターを表示する」にチェックがなければアバターを返しません。

使い方

<?php echo get_avatar( $id_or_email, $size, $default, $alt, $args ); ?>

パラメータ

$id_or_email
整数/文字列/オブジェクト) (必須) 作成者のユーザー ID(整数または文字列)、メールアドレス(文字列)、またはコメントループによるコメントオブジェクト。
初期値: なし
参考: ほとんどのコメントテンプレートでは、コメント投稿者のグラバターを表示するために $comment をここに使えます。ループ内の他のテンプレート(WordPress 2.7 以前)では get_the_author_id() が使えました(WordPress 2.8 で非推奨になりました)。WordPress 2.8 以降では get_the_author_meta( 'ID' ) を使ってください。
$size
整数) (オプション) 返すグラバターの大きさ(最大 512)。
初期値: 96
$default
文字列) (オプション) デフォルト画像の URL。省略すると「Mystery Man」。
初期値:
$alt
文字列) (オプション) アバターの代替テキスト。
初期値: false
$args
配列) (オプション) 返すアバターをデフォルト引数の代わりに指定する引数。
初期値: null

$args

$args はアバターを取得するとき追加の引数として使われます。

size
整数) (オプション) アバター画像ファイルの高さと幅。単位はピクセル。
初期値: 96
height
整数) (オプション) アバターを表示するときの高さ。単位はピクセル。
初期値: size の値。
width
整数) (オプション) アバターを表示するときの幅。単位はピクセル。
初期値: size の値。
default
文字列) (オプション) デフォルト画像の URL またはデフォルトのタイプ。
初期値: 'avatar_default' オプションの値。それもなければ 'mystery' へフォールバック。
  • '404' (デフォルト画像の代わりに 404 を返す)
  • 'retro' (8ビット)
  • 'monsterid' (モンスター)
  • 'wavatar' (マンガ顔)
  • 'indenticon' (キルト柄)
  • 'mystery''mm'、または 'mysterman' (The Oyster Man)
  • 'blank' (透過 GIF)
  • 'gravatar_default' (Gravatar ロゴ)
force_default
真偽値) (オプション) いつも Gravatar ではなくデフォルト画像を表示するかどうか。
初期値: false
rating
文字列) (オプション) 表示するアバターの評価による制限。'G', 'PG', 'R', 'X' の順に緩くなる。
初期値: 'avatar_rating' オプションの値。
  • 'G' — あらゆる人に適切
  • 'PG' — 不快感を与える恐れ — 13歳以上の人向き
  • 'R' — 18歳以上の成人向き
  • 'X' — 最高レベルの制限
scheme
文字列) (オプション) 使用する URL スキーム。指定可能な値は set_url_scheme() を参照。
初期値:
class
配列|文字列) (オプション<img> 要素へ追加するクラスの配列または文字列。
初期値: null
force_display
真偽値) (オプション) アバターを常に表示するかどうか。'show_avatars' オプションを無視する。
初期値: false
extra_attr
文字列) (オプション<img> 要素へ挿入する HTML 属性。無害化されない。
初期値: 空文字列


戻り値

文字列|false 
ユーザーのアバターを表示する img 要素。失敗すると false。
注意: この関数は何も出力しません。表示するには戻り値を echo する必要があります。

用例

コメントに表示するには:

<?php echo get_avatar( $comment, 32 ); ?>

ループ内で投稿の作成者に表示するには:

<?php echo get_avatar( get_the_author_meta( 'ID' ), 32 ); ?>

メールアドレスで表示するには:

<?php echo get_avatar( 'email@example.com', 32 ); ?>

参考

  • 返す文字列をフィルターするために get_avatar /enフィルターを使用します。
  • この関数はプラガブルなのでプラグインやテーマによって再定義できます。その場合、デフォルトの機能に依存することはできません。

変更履歴

  • 4.2.0 : オプションの `$args` パラメーターを追加。
  • 2.5.0 : 新規導入。

ソースファイル

get_avatar()wp-includes/pluggable.php にあります。

コメント関数: cancel_comment_reply_link(), comment_author(), comment_author_email(), comment_author_email_link(), comment_author_IP(), comment_author_link(), comment_author_rss(), comment_author_url(), comment_author_url_link(), comment_class(), comment_date(), comment_excerpt(), comment_form_title(), comment_form(), comment_ID(), comment_id_fields() / en, comment_reply_link(), comment_text(), comment_text_rss(), comment_time(), comment_type(), comments_link, comments_number(), comments_open(), comments_popup_link(), comments_popup_script(), comments_rss_link(), get_avatar(), next_comments_link(), paginate_comments_links(), permalink_comments_rss(), previous_comments_link(), wp_list_comments()


最新英語版: WordPress Codex » Function Reference/get_avatar最新版との差分