(→Checking for the Existence of a Gravatar) |
m (→Resources) |
||
(18 intermediate revisions by 12 users not shown) | |||
Line 2: | Line 2: | ||
{{en|Using Gravatars}} |
{{en|Using Gravatars}} |
||
{{ja|Gravatar の使い方}} |
{{ja|Gravatar の使い方}} |
||
+ | {{pt-br|Usando o Gravatar}} |
||
+ | {{zh-tw|使用Gravatar}} |
||
}} |
}} |
||
+ | Gravatars are '''Globally Recognized Avatars'''. Integrated into WordPress, Gravatars are an avatar or gravatar is an icon, or representation, of a user in a shared virtual reality, such as a forum, chat, website, or any other form of online community in which the user(s) wish to have something to distinguish themselves from other users. |
||
− | ==What is a Gravatar?== |
||
− | Gravatars |
+ | [[Image:gravatars-in-comments.png|frame|right|Gravatars in blog post comments]]Created by Tom Werner, gravatars make it possible for a person to have one avatar across the entire web. Avatars are usually an 80px by 80px image that the user will create themselves. |
− | + | A Gravatar is essentially the same thing, but they are all hosted on a single server and are called up by encrypting the users' email address via the MD5 algorithm. So instead of having one avatar on one forum you visit, and another at a blog you visit, you could have the same avatar at both. |
|
+ | Gravatars are now integrated into WordPress. The following is a historical reference for Gravatars in WordPress. For information on how to use and customize gravatars, see [[How to Use Gravatars in WordPress]]. |
||
− | Gravatars can easily be used within WordPress with the Gravatar WordPress Plugin or added manually in the <tt>index.php</tt>, <tt>comments.php</tt> and <tt>comments-popup.php</tt> [[Templates|template files]]. |
||
==How a Gravatar is Constructed== |
==How a Gravatar is Constructed== |
||
A Gravatar is a dynamic image resource that is requested from a server. The request URL is presented here, broken into its segments. The URL always begins with: |
A Gravatar is a dynamic image resource that is requested from a server. The request URL is presented here, broken into its segments. The URL always begins with: |
||
− | <nowiki>http://www.gravatar.com/avatar |
+ | <nowiki>http://www.gravatar.com/avatar/</nowiki> |
+ | The next part is a hashed version of the user's email address. The email address MUST be lower-cased first, then have all whitespace removed, before md5 hashing it. |
||
− | A mandatory parameter named <tt>gravatar_id</tt> follows this. Its value is the hexadecimal MD5 hash of the requested users' email address with all whitespace trimmed. The value is case insensitive. |
||
− | + | 279aa12c3326f87c460aa4f31d18a065 |
|
− | An optional <tt>rating</tt> parameter may follow with a value of <tt>[ G | PG | R | X ]</tt> which determines the highest rating (inclusive) that will be returned. |
+ | An optional <tt>rating</tt> (or <tt>r</tt>) parameter may follow with a value of <tt>[ G | PG | R | X ]</tt> which determines the highest rating (inclusive) that will be returned. |
− | + | ?r=R |
|
⚫ | |||
− | Gravatar offers a [http://gravatar.com/rating.php rate checking service] so you can determine your rate. |
||
+ | &s=120 |
||
⚫ | |||
⚫ | An optional <tt>default</tt> (or <tt>d</tt>) parameter may follow that specifies the full [[Glossary#URL|URL]], encoded URL, protocol included, of a GIF, JPEG, or PNG image that should be returned if either the requested email address has no associated gravatar, or that Gravatar has a rating higher than is allowed by the <tt>rating</tt> parameter. It may also contain one of the following options: |
||
− | &size=40 |
||
+ | * '404' (return a 404) |
||
⚫ | An optional <tt>default</tt> parameter may follow that specifies the full [[Glossary#URL|URL]], encoded URL, protocol included, of a GIF, JPEG, or PNG image that should be returned if either the requested email address has no associated gravatar, or that Gravatar has a rating higher than is allowed by the <tt>rating</tt> parameter. |
||
+ | * 'mm' (mysteryman) |
||
+ | * 'identicon' (unique, generated image) |
||
+ | * 'monsterid' (unique, generated image) |
||
+ | * 'wavatar' (unique, generated image) |
||
− | & |
+ | &d=http%3A%2F%2Fwww.somesite.com%2Fsomeimage.jpg |
⚫ | |||
− | An optional <tt>border</tt> parameter may follow that specifies the hexadecimal value of a 1px border to be overlaid on the Gravatar. The supplied value may be either the full six character hex string (e.g. <tt>FF0000</tt> for red) or the abbreviated three character hex string (e.g. <tt>F00</tt> for red). |
||
⚫ | |||
− | |||
− | &border=FF0000 |
||
− | |||
⚫ | |||
− | [[Image:gravatarCWE.gif|frame|right|An example of a Gravatar]]For most people, encrypting an email address with MD5 is no easy task, most of the time requiring [http://www.php.net/ PHP] or other form of scripting. Several [[Plugins|WordPress Plugins]] have been created to help with this task, such as the [http://www.gravatar.com/implement.php#section_2_2 Gravatar.com Plugin] and [http://zenpax.com/gravatars2/ Gravatars2 Enhanced Caching Plugin]. For information on using and installing those WordPress Plugins, see the Plugin's documentation. |
||
− | |||
⚫ | |||
WordPress 2.5 marries theme authors and casual WordPress users together with support for Gravatars in the WordPress Administration Panels. Theme authors have an option to include Gravatars in their designs, and are recommended to do so. WordPress users can easily control their Gravatar usage in the '''Settings > Discussion''' Administration Panel. |
WordPress 2.5 marries theme authors and casual WordPress users together with support for Gravatars in the WordPress Administration Panels. Theme authors have an option to include Gravatars in their designs, and are recommended to do so. WordPress users can easily control their Gravatar usage in the '''Settings > Discussion''' Administration Panel. |
||
Line 50: | Line 50: | ||
* Which rating of Avatars are shown. |
* Which rating of Avatars are shown. |
||
− | === Theme Support for WordPress 2.5 === |
+ | === Theme Support for WordPress 2.5+ === |
− | The function to add Gravatars to your theme is called: <code>get_avatar</code>. The function returns a complete image HTML tag of the Avatar. |
+ | The function to add Gravatars to your theme is called: <code>[[Function_Reference/get_avatar|get_avatar]]</code>. The function returns a complete image HTML tag of the Avatar. |
The function is called as follows: |
The function is called as follows: |
||
Line 88: | Line 88: | ||
} else { |
} else { |
||
//alternate gravatar code for < 2.5 |
//alternate gravatar code for < 2.5 |
||
− | $grav_url = "http://www.gravatar.com/avatar |
+ | $grav_url = "http://www.gravatar.com/avatar/" . |
− | md5($email) . " |
+ | md5(strtolower($email)) . "?d=" . urlencode($default) . "&s=" . $size; |
echo "<img src='$grav_url'/>"; |
echo "<img src='$grav_url'/>"; |
||
}</nowiki> |
}</nowiki> |
||
Line 106: | Line 106: | ||
The trick to do this is to specify "404" as the default. In this case, the gravatar service will return a 404 error if no gravatar exists, instead of returning some default image. A real image will get a 200 code. It is best to check for 200, as some other errors might be returned as well, for other cases. |
The trick to do this is to specify "404" as the default. In this case, the gravatar service will return a 404 error if no gravatar exists, instead of returning some default image. A real image will get a 200 code. It is best to check for 200, as some other errors might be returned as well, for other cases. |
||
− | Here is an example validation function using HTTP headers. You will need to modify it for your needs: |
+ | Here is an simple example validation function using HTTP headers. You will need to modify it for your needs: |
function validate_gravatar($email) { |
function validate_gravatar($email) { |
||
// Craft a potential url and test its headers |
// Craft a potential url and test its headers |
||
− | $hash = md5($email); |
+ | $hash = md5(strtolower(trim($email))); |
$uri = 'http://www.gravatar.com/avatar/' . $hash . '?d=404'; |
$uri = 'http://www.gravatar.com/avatar/' . $hash . '?d=404'; |
||
$headers = @get_headers($uri); |
$headers = @get_headers($uri); |
||
Line 120: | Line 120: | ||
return $has_valid_avatar; |
return $has_valid_avatar; |
||
} |
} |
||
+ | |||
+ | A more full featured validation function that uses the [[HTTP API]] and [[Class_Reference/WP_Object_Cache|Object Cache]] can be found [https://gist.github.com/justinph/5197810 here]. |
||
==Resources== |
==Resources== |
||
* [http://www.gravatar.com/ Gravatar] |
* [http://www.gravatar.com/ Gravatar] |
||
+ | * [[How to Use Gravatars in WordPress]] |
||
− | * [[Plugins|WordPress Plugins]] |
||
* [http://www.gravatar.com/implement.php Gravatars Implement Page] |
* [http://www.gravatar.com/implement.php Gravatars Implement Page] |
||
+ | * [http://wpsites.net/wordpress-tips/how-to-get-the-url-to-a-gravatar-image/ Get The URL To a Gravatar Image] |
||
* [http://txfx.net/code/wordpress/gravatar-signup/ Gravatar Signup Plugin] |
* [http://txfx.net/code/wordpress/gravatar-signup/ Gravatar Signup Plugin] |
||
* [http://weblogtoolscollection.com/archives/2008/03/03/gravatars-and-wordpress-25/ Gravatars & WordPress 2.5] |
* [http://weblogtoolscollection.com/archives/2008/03/03/gravatars-and-wordpress-25/ Gravatars & WordPress 2.5] |
||
* [http://www.themelab.com/2008/05/09/add-gravatar-support-to-your-wordpress-comments/ Add Gravatar Support to Your WordPress Comments] |
* [http://www.themelab.com/2008/05/09/add-gravatar-support-to-your-wordpress-comments/ Add Gravatar Support to Your WordPress Comments] |
||
* [http://wordpress.org/support/topic/190660?replies=13 WP Forum post about checking for existence of Gravatars] |
* [http://wordpress.org/support/topic/190660?replies=13 WP Forum post about checking for existence of Gravatars] |
||
+ | |||
+ | ==See Also== |
||
+ | [[Function_Reference/get_avatar|get_avatar]] |
||
[[Category:Design and Layout]] |
[[Category:Design and Layout]] |
Languages: English • の使い方 日本語 Português do Brasil • 中文(繁體) • (Add your language)
Gravatars are Globally Recognized Avatars. Integrated into WordPress, Gravatars are an avatar or gravatar is an icon, or representation, of a user in a shared virtual reality, such as a forum, chat, website, or any other form of online community in which the user(s) wish to have something to distinguish themselves from other users.
Created by Tom Werner, gravatars make it possible for a person to have one avatar across the entire web. Avatars are usually an 80px by 80px image that the user will create themselves.A Gravatar is essentially the same thing, but they are all hosted on a single server and are called up by encrypting the users' email address via the MD5 algorithm. So instead of having one avatar on one forum you visit, and another at a blog you visit, you could have the same avatar at both.
Gravatars are now integrated into WordPress. The following is a historical reference for Gravatars in WordPress. For information on how to use and customize gravatars, see How to Use Gravatars in WordPress.
A Gravatar is a dynamic image resource that is requested from a server. The request URL is presented here, broken into its segments. The URL always begins with:
http://www.gravatar.com/avatar/
The next part is a hashed version of the user's email address. The email address MUST be lower-cased first, then have all whitespace removed, before md5 hashing it.
279aa12c3326f87c460aa4f31d18a065
An optional rating (or r) parameter may follow with a value of [ G | PG | R | X ] which determines the highest rating (inclusive) that will be returned.
?r=R
An optional size (or s) parameter may follow that specifies the desired width and height of the Gravatar. Valid values are from 1 to 512 inclusive. Any size other than 80 will cause the original Gravatar image to be resampled using bicubic resampling before output.
&s=120
An optional default (or d) parameter may follow that specifies the full URL, encoded URL, protocol included, of a GIF, JPEG, or PNG image that should be returned if either the requested email address has no associated gravatar, or that Gravatar has a rating higher than is allowed by the rating parameter. It may also contain one of the following options:
&d=http%3A%2F%2Fwww.somesite.com%2Fsomeimage.jpg
WordPress 2.5 marries theme authors and casual WordPress users together with support for Gravatars in the WordPress Administration Panels. Theme authors have an option to include Gravatars in their designs, and are recommended to do so. WordPress users can easily control their Gravatar usage in the Settings > Discussion Administration Panel.
WordPress users can change:
The function to add Gravatars to your theme is called: get_avatar
. The function returns a complete image HTML tag of the Avatar.
The function is called as follows:
<?php echo get_avatar( $id_or_email, $size = '96', $default = '<path_to_url>' ); ?>
The parameters are:
$comment
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 get_the_author_id()
(deprecated in WordPress 2.8). For WordPress 2.8, please use get_the_author_meta('user_email')
.Some things to note here:
Code output:
The default output is when using the above function is listed below. Various classes are applied to img element to help you with element styling.
<img alt='' src='http://gravatarurl_or_default' class='avatar avatar-$size' height='$size' width='$size' />
If the gravatar reverts to the default image due to a lack of an e-mail address (i.e. a pingback or trackback), whether you have specified a default or not, the img
element will also be given a CSS class of avatar-default
.
If you wish to develop a WordPress Theme with Avatars for 2.5 and below, add a check for the Gravatar function to the code:
if (function_exists('get_avatar')) { echo get_avatar($email); } else { //alternate gravatar code for < 2.5 $grav_url = "http://www.gravatar.com/avatar/" . md5(strtolower($email)) . "?d=" . urlencode($default) . "&s=" . $size; echo "<img src='$grav_url'/>"; }
If you request a Gravatar image and the email you request doesn't have an account in the Gravatar system it returns a default image to you.
In some cases this might not be what you want, instead, you might want to know whether you will get back a real gravatar or if it will just be the default.
Example situations:
WARNING: You need to understand PHP to make use of the information below.
The trick to do this is to specify "404" as the default. In this case, the gravatar service will return a 404 error if no gravatar exists, instead of returning some default image. A real image will get a 200 code. It is best to check for 200, as some other errors might be returned as well, for other cases.
Here is an simple example validation function using HTTP headers. You will need to modify it for your needs:
function validate_gravatar($email) { // Craft a potential url and test its headers $hash = md5(strtolower(trim($email))); $uri = 'http://www.gravatar.com/avatar/' . $hash . '?d=404'; $headers = @get_headers($uri); if (!preg_match("|200|", $headers[0])) { $has_valid_avatar = FALSE; } else { $has_valid_avatar = TRUE; } return $has_valid_avatar; }
A more full featured validation function that uses the HTTP API and Object Cache can be found here.