Gravatar の使い方

出典: WordPress Codex 日本語版

このページ「Gravatar の使い方」は 情報が古くなっている可能性があります。最新版（英語）も合わせてご覧ください。最新に更新してくださる協力者を求めています。

  • WordPress 2.7 に対応したテーマでは get_avatar() の追加は不要です（参照）。

目次

Gravatarとは？

Gravatar(Globally Recognized Avatar)とは、広い範囲で利用できるアバター（化身）です。アバターまたはGravatarはアイコンであり、フォーラム、チャット、ウェブサイトのような仮想現実上のオンライン・コミュニティの中で、そのユーザーの身代わりとなって、他のユーザーと自分自身を区別できるようにします。

トム・ワーナー（Tom Werner）によって開発されたGravatarは、ウェブ上の複数のサービスで、個人が共通するアバターを持つことができます。アバターは、通常、80×80ピクセルのユーザーが作成した画像です。

画像:gravatars-in-comments.png
コメント欄に表示されるGravatar

Gravatarは基本的にアバターと同じものですが、１つのサーバーで管理され、MD5アルゴリズムによって暗号化されたユーザーのメールアドレスによって呼び出されます。そのため、利用者は訪れたフォーラムやブログごとにアバターを設定する代わりに、どこでも同じアバターを利用できるようになります。

Gravatarは、Gravatar WordPress Pluginを利用するか、index.php、comments.php、comments-popup.phpといった template files に記述することで、簡単にWordPressの中で使うことができます。

Gravatarを作成する

Gravatarは、サーバーに動的にリクエストされるイメージ・リソースです。リクエストURLをセグメント別に、以下に示します。まず、URLは常に次のように始まります: 

http://www.gravatar.com/avatar.php?

さらに、gravatar_idというパラメータが必ず続きます。その値は、リクエストされたユーザーのメールアドレスを16進のMD5ハッシュで暗号化したもので、すべての空白文字は省かれ、大文字と小文字の区別されません。 

gravatar_id=279aa12c3326f87c460aa4f31d18a065

An optional rating parameter may follow with a value of [ G | PG | R | X ] which determines the highest rating (inclusive) that will be returned. ［G | PG | R | X］というレーティングの最高値を示すオプションのratingパラメータが、さらに付け加わることもあります。 

&rating=R

Gravatarは、利用者がレーティングを決めることができるように、rate checking service も提供しています。

オプションのsizeパラメータには、Gravatarの幅と高さを指定します。有効な値の範囲は1から80です。オリジナルのGravatarの画像が80を超えている場合は、表示される画像がバイキュービック（bicubic）方式で、再サンプリングされて解像度が下げられます。 

&size=40

オプションのdefaultパラメータには、リクエストされたメールアドレスがgravatarと連携していない場合やGravatarがratingパラメータよりも高いレーティングの場合に返される特定のフルURL、コード化されたURL、またはGIF、JPEGやPNGイメージなどが含まれるプロトコルを指定します。 

&default=http%3A%2F%2Fwww.somesite.com%2Fsomeimage.jpg

オプションのborderパラメータには、Gravatarに描かれる1ピクセルの境界線を16進数の値で指定します。指定される値は、6文字の16進文字列（例：赤の場合はFF0000）か、省略形の3文字の16進文字（例えば赤のためのF00）のどちらかになります。 

&border=FF0000

WordPressでGravatarsを使う

画像:gravatarCWE.gif
Gravatarの例
一般の人にとって、メールアドレスをMD5で暗号化することは容易ではありません。また、作業のほとんどはPHPや他のスクリプトで書かれたフォームで行われます。Gravatar.com Pluginや Gravatars2 Enhanced Caching Pluginなど、いくつかの WordPress Pluginsは、この作業のために作成されました。詳細情報は、これらのプラグインをインストールして、各プラグインのドキュメントテーションを参照してください。

なお、WordPress 2.5には、Gravatar機能が内蔵されているので、使用したり管理するためにプラグインは必要ありません。

WordPress 2.5では、管理画面でGravatarの設定ができるようになり、テーマ作者と一般のWordPressユーザーのどちらもGravatarが利用しやすくなりました。テーマ作者はGravatarをテーマのデザインに組み込むことができるようになったので、今後はより多くのテーマで組み込まれるべきです。WordPressユーザーは、Settings > Discussion Administration PanelでGravatarをより簡単に設定できるようになります。


WordPressユーザーは、以下の設定ができます:

  • アバター（別名Gravatar）を表示したり表示しないようにしたりできる。
  • アバターの閲覧制限のレーティングを設定できる。


WordPress 2.5に対応したテーマ

Gravatarをテーマに加えるには、get_avatarと呼ばれる関数を利用します。この関数は、アバターの完全なイメージHTMLタグを返します。

この関数は、以下のように呼び出されます： 

  <?php 
   echo get_avatar( $id_or_email, $size = '96', $default = '<path_to_url>' ); 
   ?>

パラメータは以下の通りです:

  • id_or_email（必須）：作成者のUser ID（整数または文字列）、メールアドレス（文字列）またはコメント・ループのコメント・オブジェクト。注：ほとんどのコメントテンプレートでは、コメントを付けた人のgravatarを示すために、$commentを使うことができます。他のテンプレートでは、get_the_author_id()を使うことができます。
  • size（オプション）：アバターの表示サイズ（最大512）。
  • default（オプション）：アバターの標準として利用されるロケーション（アバターと関連する電子メールアドレスがない利用者に適用される）。空白のままの場合は、次のようなgravatarが標準として適用されます。


若干の注意事項:

  • sizeパラメータでアバターのサイズが指定されない場合は、アバターの標準サイズは96x96になります。
  • デフォルトのアバターは、Gravatarです。
  • アバターは、ユーザーが管理画面で［アバターを表示する］と設定されている時だけ表示されます（デフォルトの設定では表示）。
  • アバターは、ユーザーが管理画面で設定したレーティングだけに基づいて表示されます。


コード出力:

デフォルトの設定では、上記の関数を使用した出力は以下のようなリストになります。さまざまなクラスが、要素のスタイル付けをするために、img要素に適用されます。 

<img alt='' src='http://gravatarurl_or_default'
class='avatar avatar-$size' height='$size' width='$size' />

メールアドレスがないため、gravatarがデフォルトのイメージに戻ると（例：ピンバックまたはトラックバックの場合）、デフォルトの設定が指定されたかどうかに関わらず、img要素にはavatar-defaultのCSSクラスが適用されます。

Gravatarを使ったテーマ

WordPress2.5のアバター機能を使ったWordPress Themeを開発したい場合は、以下のGravatar関数をチェックするコードを加えてください： 

   if (function_exists('get_avatar')) {
      echo get_avatar($email);
   } else {
      //alternate gravatar code for < 2.5
      $grav_url = "http://www.gravatar.com/avatar.php?gravatar_id=
         " . md5($email) . "&default=" . urlencode($default) . "&size=" . $size;
      echo "<img src='$grav_url'/>";
   }

Gravatar.comプラグイン

Gravatar.comから提供されているGravatar.com Pluginは、Gravatarsを取り扱うための公式Pluginです。

使用方法：

  1. プラグインをインストールして、使用中にしてください。
  2. <?php gravatar(); ?>ファンクションタグを、WordPressテンプレートファイルのWordPress Loopの中のHTML imgタグに記述します： 
 <img src="<?php gravatar(); ?>" alt="Gravatar" />

Gravatars.com WordPress Pluginの使用法とインストールについての詳細は、Gravatars siteを参照してください。

Gravatarをカスタマイズする

Gravatarをカスタマイズするためのいくつかの設定があります。設定するパラメータは以下の通りです: 

<?php gravatar("rating", size, "default", "border"); ?>
rating 
Gravatarが表示される最も高いレーティングを指定します。レーティングには、G、PG、R、Xがあります。PGよりも高いレーティングだけが表示するには、以下のようなコードになります: 
<?php gravatar("PG"); ?>
size 
Gravatarのサイズは、デフォルトの設定では80×80ピクセルです。サイズを変更するには、sizeの値を変更します。80×80プクセルで四角形に設定するには、次のような値に設定します: 
<?php gravatar("PG", 80); ?>
default 
ユーザーがGravatarや互換性のある他のアバターサービスに未登録の場合は、デフォルト設定のイメージが表示されます。利用者は、標準の設定のイメージをPNG、JPGまたはGIF形式の画像に変更できます。 
<?php gravatar("PG",40,"/images/no_gravatar.gif"); ?>
border 
境界線を引くには、border関数を使用します。境界線は選択した色でGravatarの周囲に、幅1ピクセルで描かれます。標準の設定では境界線はなしです。以下の例は、レーティングがPG以下で、サイズが40×40ピクセル、Gravatarがない場合にはデフォルト設定のイメージを表示し、1ピクセルの赤い境界線を引くという場合の設定です: 
<?php gravatar("PG",40,"/images/no_gravatar.gif","FF0000"); ?>

資料

変更履歴

  • 2.7 : コメントループとして新規テンプレートタグ wp_list_comments() を用いると、get_avatar() を使わずに Gravatar を表示できます。
  • 2.5 : WordPress 標準機能として組み込まれました。

関連ページ

原文・最新版： WordPress Codex » Using Gravatars （最新版との差分）

"http://wpdocs.sourceforge.jp/Gravatar_%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9" より作成
他の言語