<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[31107] trunk: Add `get_avatar_url()`, for retrieving just the URL of an avatar, rather than the entire `<img>` tag that `get_avatar()` produces.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/31107">31107</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/31107","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-01-09 04:42:48 +0000 (Fri, 09 Jan 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add `get_avatar_url()`, for retrieving just the URL of an avatar, rather than the entire `<img>` tag that `get_avatar()` produces.
Unlike `get_avatar()`, `get_avatar_url()` is not pluggable. It can be extended/or modified through the new filters included.
Fixes <a href="https://core.trac.wordpress.org/ticket/21195">#21195</a>.
Props mdawaffe, pento, pathawks, DrewAPicture</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsavatarphp">trunk/tests/phpunit/tests/avatar.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2015-01-08 22:51:30 UTC (rev 31106)
+++ trunk/src/wp-includes/link-template.php 2015-01-09 04:42:48 UTC (rev 31107)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3324,3 +3324,235 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo $before, $link, $after;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+
+/**
+ * Retrieve the avatar URL.
+ *
+ * @since 4.2.0
+ *
+ * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or comment object.
+ * @param array $args {
+ * Optional. Arguments to return instead of the default arguments.
+ *
+ * @type int $size Height and width of the avatar in pixels. Default 96.
+ * @type string $default URL for the default image or a default type. Accepts '404' (return
+ * a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster),
+ * 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm',
+ * or 'mysterman' (The Oyster Man), 'blank' (transparent GIF), or
+ * 'gravatar_default' (the Gravatar logo). Default is the value of the
+ * 'avatar_default' option, with a fallback of 'mystery'.
+ * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
+ * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ * judged in that order. Default is the value of the 'avatar_rating' option.
+ * @type string $scheme URL scheme to use. See {@see set_url_scheme()} for accepted values.
+ * Default null.
+ * @type array $processed_args When the function returns, the value will be the processed/sanitized $args
+ * plus a "found_avatar" guess. Pass as a reference. Default null.
+ * }
+ *
+ * @return false|string The URL of the avatar we found, or false if we couldn't find an avatar.
+ */
+function get_avatar_url( $id_or_email, $args = null ) {
+ $args = get_avatar_data( $id_or_email, $args );
+ return $args['url'];
+}
+
+/**
+ * Retrieve default data about the avatar.
+ *
+ * @since 4.2.0
+ *
+ * @param mixed $id_or_email The Gravatar to check the data against. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or comment object.
+ * @param array $args {
+ * Optional. Arguments to return instead of the default arguments.
+ *
+ * @type int $size Height and width of the avatar in pixels. Default 96.
+ * @type string $default URL for the default image or a default type. Accepts '404' (return
+ * a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster),
+ * 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm',
+ * or 'mysterman' (The Oyster Man), 'blank' (transparent GIF), or
+ * 'gravatar_default' (the Gravatar logo). Default is the value of the
+ * 'avatar_default' option, with a fallback of 'mystery'.
+ * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
+ * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ * judged in that order. Default is the value of the 'avatar_rating' option.
+ * @type string $scheme URL scheme to use. See {@see set_url_scheme()} for accepted values.
+ * Default null.
+ * @type array $processed_args When the function returns, the value will be the processed/sanitized $args
+ * plus a "found_avatar" guess. Pass as a reference. Default null.
+ * }
+ *
+ * @return array $processed_args {
+ * Along with the arguments passed in $args, this will contain a couple of extra arguments.
+ *
+ * @type bool $found_avatar True if we were able to find an avatar for this user,
+ * false or not set if we couldn't.
+ * @type false|string $url The URL of the avatar we found, or false if we couldn't find an avatar.
+ * }
+ */
+function get_avatar_data( $id_or_email, $args = null ) {
+ $args = wp_parse_args( $args, array(
+ 'size' => 96,
+ 'default' => get_option( 'avatar_default', 'mystery' ),
+ 'force_default' => false,
+ 'rating' => get_option( 'avatar_rating' ),
+ 'scheme' => null,
+ 'processed_args' => null, // if used, should be a reference
+ ) );
+
+ if ( is_numeric( $args['size'] ) ) {
+ $args['size'] = absint( $args['size'] );
+ if ( ! $args['size'] ) {
+ $args['size'] = 96;
+ }
+ } else {
+ $args['size'] = 96;
+ }
+
+ if ( empty( $args['default'] ) ) {
+ $args['default'] = 'mystery';
+ }
+
+ switch ( $args['default'] ) {
+ case 'mm' :
+ case 'mystery' :
+ case 'mysteryman' :
+ $args['default'] = 'mm';
+ break;
+ case 'gravatar_default' :
+ $args['default'] = false;
+ break;
+ }
+
+ $args['force_default'] = (bool) $args['force_default'];
+
+ $args['rating'] = strtolower( $args['rating'] );
+
+ $args['found_avatar'] = false;
+
+ /**
+ * Filter whether to retrieve the avatar URL early.
+ *
+ * Passing a non-null value in the 'url' member of the return array will
+ * effectively short circuit {@see get_avatar_data()}, passing the value
+ * through the 'get_avatar_data' filter and returning early.
+ *
+ * @since 4.2.0
+ *
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ */
+ $args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
+
+ if ( isset( $args['url'] ) && ! is_null( $args['url'] ) ) {
+ /** This filter is documented in src/wp-includes/link-template.php */
+ return apply_filters( 'get_avatar_data', $args, $id_or_email );
+ }
+
+ $email_hash = '';
+ $user = $email = false;
+
+ // Process the user identifier.
+ if ( is_numeric( $id_or_email ) ) {
+ $user = get_user_by( 'id', absint( $id_or_email ) );
+ } elseif ( is_string( $id_or_email ) ) {
+ if ( strpos( $id_or_email, '@md5.gravatar.com' ) ) {
+ // md5 hash
+ list( $email_hash ) = explode( '@', $id_or_email );
+ } else {
+ // email address
+ $email = $id_or_email;
+ }
+ } elseif ( $id_or_email instanceof WP_User ) {
+ // User Object
+ $user = $id_or_email;
+ } elseif ( $id_or_email instanceof WP_Post ) {
+ // Post Object
+ $user = get_user_by( 'id', (int) $id_or_email->post_author );
+ } elseif ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
+ // Comment Object
+
+ /**
+ * Filter the list of allowed comment types for retrieving avatars.
+ *
+ * @since 3.0.0
+ *
+ * @param array $types An array of content types. Default only contains 'comment'.
+ */
+ $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
+ if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) {
+ $args['url'] = false;
+ /** This filter is documented in src/wp-includes/link-template.php */
+ return apply_filters( 'get_avatar_data', $args, $id_or_email );
+ }
+
+ if ( ! empty( $id_or_email->user_id ) ) {
+ $user = get_user_by( 'id', (int) $id_or_email->user_id );
+ }
+ if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) {
+ $email = $id_or_email->comment_author_email;
+ }
+ }
+
+ if ( ! $email_hash ) {
+ if ( $user ) {
+ $email = $user->user_email;
+ }
+
+ if ( $email ) {
+ $email_hash = md5( strtolower( trim( $email ) ) );
+ }
+ }
+
+ if ( $email_hash ) {
+ $args['found_avatar'] = true;
+ $gravatar_server = hexdec( $email_hash[0] ) % 3;
+ } else {
+ $gravatar_server = rand( 0, 2 );
+ }
+
+ $url_args = array(
+ 's' => $args['size'],
+ 'd' => $args['default'],
+ 'f' => $args['force_default'] ? 'y' : false,
+ 'r' => $args['rating'],
+ );
+
+ $url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash );
+
+ $url = add_query_arg(
+ rawurlencode_deep( array_filter( $url_args ) ),
+ set_url_scheme( $url, $args['scheme'] )
+ );
+
+ /**
+ * Filter the avatar URL.
+ *
+ * @since 4.2.0
+ *
+ * @param string $url The URL of the avatar.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ */
+ $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
+
+ /**
+ * Filter the avatar data.
+ *
+ * @since 4.2.0
+ *
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ */
+ $args = apply_filters( 'get_avatar_data', $args, $id_or_email );
+
+ // Don't return a broken URL if we couldn't find the email hash, and none of the filters returned a different URL.
+ if ( ! $email_hash && $url === $args['url'] ) {
+ $args['url'] = false;
+ }
+
+ return $args;
+}
</ins></span></pre></div>
<a id="trunksrcwpincludespluggablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/pluggable.php 2015-01-08 22:51:30 UTC (rev 31106)
+++ trunk/src/wp-includes/pluggable.php 2015-01-09 04:42:48 UTC (rev 31107)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2082,123 +2082,127 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !function_exists( 'get_avatar' ) ) :
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve the avatar for a user who provided a user ID or email address.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0 Optional $args parameter added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|string|object $id_or_email A user ID, email address, or comment object
- * @param int $size Size of the avatar image
- * @param string $default URL to a default image to use if no avatar is available
- * @param string $alt Alternative text to use in image tag. Defaults to blank
- * @return false|string `<img>` tag for the user's avatar.
-*/
-function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
- if ( ! get_option('show_avatars') )
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ * user email, WP_User object, WP_Post object, or comment object.
+ * @param int $size Optional. Height and width of the avatar in pixels. Default 96.
+ * @param string $default Optional. URL for the default image or a default type. Accepts '404'
+ * (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
+ * (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
+ * 'mystery', 'mm', or 'mysterman' (The Oyster Man), 'blank' (transparent GIF),
+ * or 'gravatar_default' (the Gravatar logo). Default is the value of the
+ * 'avatar_default' option, with a fallback of 'mystery'.
+ * @param string $alt Optional. Alternative text to use in <img> tag. Default empty.
+ * @param array $args {
+ * Optional. Extra arguments to retrieve the avatar.
+ *
+ * @type bool $force_default Whether to always show the default image, never the Gravatar. Default false.
+ * @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
+ * judged in that order. Default is the value of the 'avatar_rating' option.
+ * @type string $scheme URL scheme to use. See {@see set_url_scheme()} for accepted values.
+ * Default null.
+ * @type array|string $class Array or string of additional classes to add to the <img> element.
+ * Default null.
+ * @type bool $force_display Whether to always show the avatar - ignores the show_avatars option.
+ * Default false.
+ * }
+ *
+ * @return false|string `<img>` tag for the user's avatar. False on failure.
+ */
+function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
+ $defaults = array(
+ // get_avatar_data() args.
+ 'size' => 96,
+ 'default' => get_option( 'avatar_default', 'mystery' ),
+ 'force_default' => false,
+ 'rating' => get_option( 'avatar_rating' ),
+ 'scheme' => null,
+ 'alt' => '',
+ 'class' => null,
+ 'force_display' => false,
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( false === $alt)
- $safe_alt = '';
- else
- $safe_alt = esc_attr( $alt );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $args ) ) {
+ $args = array();
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !is_numeric($size) )
- $size = '96';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['size'] = $size;
+ $args['default'] = $default;
+ $args['alt'] = $alt;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $email = '';
- if ( is_numeric($id_or_email) ) {
- $id = (int) $id_or_email;
- $user = get_userdata($id);
- if ( $user )
- $email = $user->user_email;
- } elseif ( is_object($id_or_email) ) {
- // No avatar for pingbacks or trackbacks
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = wp_parse_args( $args, $defaults );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Filter the list of allowed comment types for retrieving avatars.
- *
- * @since 3.0.0
- *
- * @param array $types An array of content types. Default only contains 'comment'.
- */
- $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
- if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) )
- return false;
-
- if ( ! empty( $id_or_email->user_id ) ) {
- $id = (int) $id_or_email->user_id;
- $user = get_userdata($id);
- if ( $user )
- $email = $user->user_email;
- }
-
- if ( ! $email && ! empty( $id_or_email->comment_author_email ) )
- $email = $id_or_email->comment_author_email;
- } else {
- $email = $id_or_email;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filter whether to retrieve the avatar URL early.
+ *
+ * Passing a non-null value will effectively short-circuit {@see get_avatar()},
+ * passing the value through the 'pre_get_avatar' filter and returning early.
+ *
+ * @since 4.2.0
+ *
+ * @param string $avatar HTML for the user's avatar. Default null.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @param array $args Arguments passed to get_avatar_url(), after processing.
+ */
+ $avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );
+ if ( ! is_null( $avatar ) ) {
+ /** This filter is documented in src/wp-include/pluggable.php */
+ return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty($default) ) {
- $avatar_default = get_option('avatar_default');
- if ( empty($avatar_default) )
- $default = 'mystery';
- else
- $default = $avatar_default;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $args['force_display'] && ! get_option( 'show_avatars' ) ) {
+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty($email) )
- $email_hash = md5( strtolower( trim( $email ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = get_avatar_data( $id_or_email, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_ssl() ) {
- $host = 'https://secure.gravatar.com';
- } else {
- if ( !empty($email) )
- $host = sprintf( "http://%d.gravatar.com", ( hexdec( $email_hash[0] ) % 2 ) );
- else
- $host = 'http://0.gravatar.com';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = $args['url'];
+
+ if ( ! $url || is_wp_error( $url ) ) {
+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'mystery' == $default )
- $default = "$host/avatar/ad516503a11cd5ca435acc9bb6523536?s={$size}"; // ad516503a11cd5ca435acc9bb6523536 == md5('unknown@gravatar.com')
- elseif ( 'blank' == $default )
- $default = $email ? 'blank' : includes_url( 'images/blank.gif' );
- elseif ( !empty($email) && 'gravatar_default' == $default )
- $default = '';
- elseif ( 'gravatar_default' == $default )
- $default = "$host/avatar/?s={$size}";
- elseif ( empty($email) )
- $default = "$host/avatar/?d=$default&s={$size}";
- elseif ( strpos($default, 'http://') === 0 )
- $default = add_query_arg( 's', $size, $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $class = array( 'avatar', 'avatar-' . (int) $args['size'], 'photo' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty($email) ) {
- $out = "$host/avatar/";
- $out .= $email_hash;
- $out .= '?s='.$size;
- $out .= '&d=' . urlencode( $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $args['found_avatar'] || $args['force_default'] ) {
+ $class[] = 'avatar-default';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $rating = get_option('avatar_rating');
- if ( !empty( $rating ) )
- $out .= "&r={$rating}";
-
- $out = str_replace( '&', '&', esc_url( $out ) );
- $avatar = "<img alt='{$safe_alt}' src='{$out}' class='avatar avatar-{$size} photo' height='{$size}' width='{$size}' />";
- } else {
- $out = esc_url( $default );
- $avatar = "<img alt='{$safe_alt}' src='{$out}' class='avatar avatar-{$size} photo avatar-default' height='{$size}' width='{$size}' />";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $args['class'] ) {
+ if ( is_array( $args['class'] ) ) {
+ $class = array_merge( $class, $args['class'] );
+ } else {
+ $class[] = $args['class'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $avatar = sprintf(
+ '<img alt="%s" src="%s" class="%s" height="%d" width="%d" />',
+ esc_attr( $args['alt'] ),
+ esc_url( $url ),
+ esc_attr( join( ' ', $class ) ),
+ (int) $args['size'],
+ (int) $args['size']
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter the avatar to retrieve.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0 $args parameter added
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $avatar Image tag for the user's avatar.
- * @param int|object|string $id_or_email A user ID, email address, or comment object.
- * @param int $size Square avatar width and height in pixels to retrieve.
- * @param string $alt Alternative text to use in the avatar image tag.
- * Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $avatar <img> tag for the user's avatar.
+ * @param int|object|string $id_or_email A user ID, email address, or comment object.
+ * @param int $size Square avatar width and height in pixels to retrieve.
+ * @param string $alt Alternative text to use in the avatar image tag.
+ * Default empty.
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'get_avatar', $avatar, $id_or_email, $size, $default, $alt );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> endif;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsavatarphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/avatar.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/avatar.php (rev 0)
+++ trunk/tests/phpunit/tests/avatar.php 2015-01-09 04:42:48 UTC (rev 31107)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,240 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Test avatar related functions
+ *
+ * @group avatar
+ */
+class Tests_Avatar extends WP_UnitTestCase {
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_gravatar_url() {
+ $url = get_avatar_url( 1 );
+ $this->assertEquals( preg_match( '|^http?://[0-9]+.gravatar.com/avatar/[0-9a-f]{32}\?|', $url ), 1 );
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_size() {
+ $url = get_avatar_url( 1 );
+ $this->assertEquals( preg_match( '|\?.*s=96|', $url ), 1 );
+
+ $args = array( 'size' => 100 );
+ $url = get_avatar_url( 1, $args );
+ $this->assertEquals( preg_match( '|\?.*s=100|', $url ), 1 );
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_default() {
+ $url = get_avatar_url( 1 );
+ $this->assertEquals( preg_match( '|\?.*d=mm|', $url ), 1 );
+
+ $args = array( 'default' => 'wavatar' );
+ $url = get_avatar_url( 1, $args );
+ $this->assertEquals( preg_match( '|\?.*d=wavatar|', $url ), 1 );
+
+ $this->assertEquals( preg_match( '|\?.*f=y|', $url ), 0 );
+ $args = array( 'force_default' => true );
+ $url = get_avatar_url( 1, $args );
+ $this->assertEquals( preg_match( '|\?.*f=y|', $url ), 1 );
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_rating() {
+ $url = get_avatar_url( 1 );
+ $this->assertEquals( preg_match( '|\?.*r=g|', $url ), 1 );
+
+ $args = array( 'rating' => 'M' );
+ $url = get_avatar_url( 1, $args );
+ $this->assertEquals( preg_match( '|\?.*r=m|', $url ), 1 );
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_scheme() {
+ $url = get_avatar_url( 1 );
+ $this->assertEquals( preg_match( '|^http://|', $url ), 1 );
+
+ $args = array( 'scheme' => 'https' );
+ $url = get_avatar_url( 1, $args );
+ $this->assertEquals( preg_match( '|^https://|', $url ), 1 );
+
+ $args = array( 'scheme' => 'lolcat' );
+ $url = get_avatar_url( 1, $args );
+ $this->assertEquals( preg_match( '|^lolcat://|', $url ), 0 );
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_user() {
+ $url = get_avatar_url( 1 );
+
+ $url2 = get_avatar_url( WP_TESTS_EMAIL );
+ $this->assertEquals( $url, $url2 );
+
+ $url2 = get_avatar_url( md5( WP_TESTS_EMAIL ) . '@md5.gravatar.com' );
+ $this->assertEquals( $url, $url2 );
+
+ $user = get_user_by( 'id', 1 );
+ $url2 = get_avatar_url( $user );
+ $this->assertEquals( $url, $url2 );
+
+ $post_id = $this->factory->post->create( array( 'post_author' => 1 ) );
+ $post = get_post( $post_id );
+ $url2 = get_avatar_url( $post );
+ $this->assertEquals( $url, $url2 );
+
+ $comment_id = $this->factory->comment->create( array( 'comment_post_ID' => $post_id, 'user_id' => 1 ) );
+ $comment = get_comment( $comment_id );
+ $url2 = get_avatar_url( $comment );
+ $this->assertEquals( $url, $url2 );
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_bad_id() {
+ $this->assertFalse( get_avatar_url( false ) );
+ $this->assertFalse( get_avatar_url( 100000 ) );
+ }
+
+ protected $fakeURL;
+ /**
+ * @ticket 21195
+ */
+ public function test_pre_get_avatar_url_filter() {
+ $this->fakeURL = 'haha wat';
+
+ add_filter( 'pre_get_avatar_data', array( $this, 'pre_get_avatar_url_filter' ), 10, 1 );
+ $url = get_avatar_url( 1 );
+ remove_filter( 'pre_get_avatar_data', array( $this, 'pre_get_avatar_url_filter' ), 10 );
+
+ $this->assertEquals( $url, $this->fakeURL );
+ }
+ public function pre_get_avatar_url_filter( $args ) {
+ $args['url'] = $this->fakeURL;
+ return $args;
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_url_filter() {
+ $this->fakeURL = 'omg lol';
+
+ add_filter( 'get_avatar_url', array( $this, 'get_avatar_url_filter' ), 10, 1 );
+ $url = get_avatar_url( 1 );
+ remove_filter( 'get_avatar_url', array( $this, 'get_avatar_url_filter' ), 10 );
+
+ $this->assertEquals( $url, $this->fakeURL );
+ }
+ public function get_avatar_url_filter( $url ) {
+ return $this->fakeURL;
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_comment_types_filter() {
+ $url = get_avatar_url( 1 );
+
+ $post_id = $this->factory->post->create( array( 'post_author' => 1 ) );
+ $comment_id = $this->factory->comment->create( array( 'comment_post_ID' => $post_id, 'user_id' => 1, 'comment_type' => 'pingback' ) );
+ $comment = get_comment( $comment_id );
+
+ $url2 = get_avatar_url( $comment );
+ $this->assertFalse( $url2 );
+
+ add_filter( 'get_avatar_comment_types', array( $this, 'get_avatar_comment_types_filter' ), 10, 1 );
+ $url2 = get_avatar_url( $comment );
+ remove_filter( 'get_avatar_comment_types', array( $this, 'get_avatar_comment_types_filter' ), 10 );
+
+ $this->assertEquals( $url, $url2 );
+ }
+ public function get_avatar_comment_types_filter( $comment_types ) {
+ $comment_types[] = 'pingback';
+ return $comment_types;
+ }
+
+ public function test_get_avatar() {
+ $img = get_avatar( 1 );
+ $this->assertEquals( preg_match( '|^<img alt="[^"]*" src="[^"]*" class="[^"]*" height="[^"]*" width="[^"]*" />$|', $img ), 1 );
+ }
+
+ public function test_get_avatar_size() {
+ $size = '100';
+ $img = get_avatar( 1, $size );
+ $this->assertEquals( preg_match( '|^<img .*height="' . $size . '".*width="' . $size . '"|', $img ), 1 );
+ }
+
+ public function test_get_avatar_alt() {
+ $alt = 'Mr Hyde';
+ $img = get_avatar( 1, 96, '', $alt );
+ $this->assertEquals( preg_match( '|^<img alt="' . $alt . '"|', $img ), 1 );
+ }
+
+ public function test_get_avatar_class() {
+ $class = 'first';
+ $img = get_avatar( 1, 96, '', '', array( 'class' => $class ) );
+ $this->assertEquals( preg_match( '|^<img .*class="[^"]*' . $class . '[^"]*"|', $img ), 1 );
+ }
+
+ public function test_get_avatar_default_class() {
+ $img = get_avatar( 1, 96, '', '', array( 'force_default' => true ) );
+ $this->assertEquals( preg_match( '|^<img .*class="[^"]*avatar-default[^"]*"|', $img ), 1 );
+ }
+
+ public function test_get_avatar_force_display() {
+ $old = get_option( 'show_avatars' );
+ update_option( 'show_avatars', false );
+
+ $this->assertFalse( get_avatar( 1 ) );
+
+ $this->assertNotEmpty( get_avatar( 1, 96, '', '', array( 'force_display' => true ) ) );
+
+ update_option( 'show_avatars', $old );
+ }
+
+
+ protected $fakeIMG;
+ /**
+ * @ticket 21195
+ */
+ public function test_pre_get_avatar_filter() {
+ $this->fakeIMG = 'YOU TOO?!';
+
+ add_filter( 'pre_get_avatar', array( $this, 'pre_get_avatar_filter' ), 10, 1 );
+ $img = get_avatar( 1 );
+ remove_filter( 'pre_get_avatar', array( $this, 'pre_get_avatar_filter' ), 10 );
+
+ $this->assertEquals( $img, $this->fakeIMG );
+ }
+ public function pre_get_avatar_filter( $img ) {
+ return $this->fakeIMG;
+ }
+
+ /**
+ * @ticket 21195
+ */
+ public function test_get_avatar_filter() {
+ $this->fakeURL = 'YA RLY';
+
+ add_filter( 'get_avatar', array( $this, 'get_avatar_filter' ), 10, 1 );
+ $img = get_avatar( 1 );
+ remove_filter( 'get_avatar', array( $this, 'get_avatar_filter' ), 10 );
+
+ $this->assertEquals( $img, $this->fakeURL );
+ }
+ public function get_avatar_filter( $img ) {
+ return $this->fakeURL;
+ }
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/avatar.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svnexecutable"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:executable</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+*
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>