<!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>[BuddyPress][11614] trunk/src: Filter WP avatars at `get_avatar_url` instead of `get_avatar`.</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="http://buddypress.trac.wordpress.org/changeset/11614">11614</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/11614","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-06-23 17:58:21 +0000 (Fri, 23 Jun 2017)</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'>Filter WP avatars at `get_avatar_url` instead of `get_avatar`.
The `get_avatar_url` filter, introduced in WP 4.2, is a more general
point for filtering avatar URLs than the legacy `get_avatar`. The
URL-specific filter allows us to simplify our filter logic, and
ensures that developers fetching avatar data with `get_avatar_data()`
get BP avatars when appropriate.
Props elhardoum, r-a-y.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7424">#7424</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.php</a></li>
<li><a href="#trunksrcclassbuddypressphp">trunk/src/class-buddypress.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcbpcoredeprecated29php">trunk/src/bp-core/deprecated/2.9.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreavatarsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-avatars.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-avatars.php 2017-06-23 17:44:46 UTC (rev 11613)
+++ trunk/src/bp-core/bp-core-avatars.php 2017-06-23 17:58:21 UTC (rev 11614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1361,104 +1361,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_ajax_bp_avatar_set', 'bp_avatar_ajax_set' );
</span><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">- * Replace default WordPress avatars with BP avatars, if available.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@link get_avatar_url()} to use the BuddyPress user avatar URL.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * See 'get_avatar' filter description in wp-includes/pluggable.php.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.9.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 1.1.0
- * @since 2.4.0 Added $args parameter to coincide with WordPress 4.2.0.
- *
- * @param string $avatar The avatar path passed to 'get_avatar'.
- * @param int|string|object $user A user ID, email address, or comment object.
- * @param int $size Size of the avatar image ('thumb' or 'full').
- * @param string $default URL to a default image to use if no avatar is available.
- * @param string $alt Alternate text to use in image tag. Default: ''.
- * @param array $args Arguments passed to get_avatar_data(), after processing.
- * @return string BP avatar path, if found; else the original avatar path.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $retval The URL of the avatar.
+ * @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 WP_Comment object.
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @return string
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '', $args = array() ) {
- global $pagenow;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_core_get_avatar_data_url_filter( $retval, $id_or_email, $args ) {
+ $user = null;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Don't filter if inside WordPress options page and force_default is true.
- if ( 'options-discussion.php' === $pagenow && true === $args['force_default'] ) {
- return $avatar;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ugh, hate duplicating code; process the user identifier.
+ if ( is_numeric( $id_or_email ) ) {
+ $user = get_user_by( 'id', absint( $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 ( $id_or_email instanceof WP_Comment && ! empty( $id_or_email->user_id ) ) {
+ $user = get_user_by( 'id', (int) $id_or_email->user_id );
</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 passed an object, assume $user->user_id.
- if ( is_object( $user ) ) {
- if ( isset( $user->user_id ) ) {
- $id = $user->user_id;
- } else {
- $id = $user->ID;
- }
-
- // If passed a number, assume it was a $user_id.
- } elseif ( is_numeric( $user ) ) {
- $id = $user;
-
- // If passed a string and that string returns a user, get the $id.
- } elseif ( is_string( $user ) && ( $user_by_email = get_user_by( 'email', $user ) ) ) {
- $id = $user_by_email->ID;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No user, so bail.
+ if ( null === $user ) {
+ return $retval;
</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 somehow $id hasn't been assigned, return the result of get_avatar.
- if ( empty( $id ) ) {
- return !empty( $avatar ) ? $avatar : $default;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set BuddyPress-specific avatar args.
+ $args['item_id'] = $user->ID;
+ $args['html'] = 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">- // Image alt tag.
- if ( empty( $alt ) ) {
- $alt = sprintf( __( 'Profile photo of %s', 'buddypress' ), bp_core_get_user_displayname( $id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get the BuddyPress avatar URL.
+ if ( $bp_avatar = bp_core_fetch_avatar( $args ) ) {
+ return $bp_avatar;
</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">- // Use the 'thumb' type, unless the requested width is bigger than
- // BP's thumb width.
- $type = 'thumb';
- if ( (int) $size > bp_core_avatar_thumb_width() ) {
- $type = 'full';
- }
-
- $avatar_args = array(
- 'item_id' => $id,
- 'type' => $type,
- 'width' => $size,
- 'height' => $size,
- 'alt' => $alt,
- );
-
- // Support new arguments as of WordPress 4.2.0.
- if ( ! empty( $args['width'] ) ) {
- $avatar_args['width'] = $args['width'];
- }
- if ( ! empty( $args['height'] ) ) {
- $avatar_args['height'] = $args['height'];
- }
- if ( ! empty( $args['class'] ) ) {
- $avatar_args['class'] = $args['class'];
- }
- if ( ! empty( $args['class'] ) ) {
- $avatar_args['class'] = $args['class'];
- }
- if ( ! empty( $args['extra_attr'] ) ) {
- $avatar_args['extra_attr'] = $args['extra_attr'];
- }
- if ( ! empty( $args['scheme'] ) ) {
- $avatar_args['scheme'] = $args['scheme'];
- }
- if ( ! empty( $args['force_default'] ) ) {
- $avatar_args['force_default'] = $args['force_default'];
- }
- if ( ! empty( $args['rating'] ) ) {
- $avatar_args['rating'] = $args['rating'];
- }
-
- // Let BuddyPress handle the fetching of the avatar.
- $bp_avatar = bp_core_fetch_avatar( $avatar_args );
-
- // If BuddyPress found an avatar, use it. If not, use the result of get_avatar.
- return ( !$bp_avatar ) ? $avatar : $bp_avatar;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $retval;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_filter( 'get_avatar', 'bp_core_fetch_avatar_filter', 10, 6 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'get_avatar_url', 'bp_core_get_avatar_data_url_filter', 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Is the current avatar upload error-free?
</span></span></pre></div>
<a id="trunksrcbpcoredeprecated29php"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-core/deprecated/2.9.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/deprecated/2.9.php (rev 0)
+++ trunk/src/bp-core/deprecated/2.9.php 2017-06-23 17:58:21 UTC (rev 11614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,30 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Deprecated functions.
+ *
+ * @deprecated 2.9.0
+ */
+
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Replace default WordPress avatars with BP avatars, if available.
+ *
+ * See 'get_avatar' filter description in wp-includes/pluggable.php.
+ *
+ * @since 1.1.0
+ * @since 2.4.0 Added $args parameter to coincide with WordPress 4.2.0.
+ *
+ * @param string $avatar The avatar path passed to 'get_avatar'.
+ * @param int|string|object $user A user ID, email address, or comment object.
+ * @param int $size Size of the avatar image ('thumb' or 'full').
+ * @param string $default URL to a default image to use if no avatar is available.
+ * @param string $alt Alternate text to use in image tag. Default: ''.
+ * @param array $args Arguments passed to get_avatar_data(), after processing.
+ * @return string BP avatar path, if found; else the original avatar path.
+ */
+function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '', $args = array() ) {
+ _deprecated_function( __FUNCTION__, '2.9' );
+ return $avatar;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre></div>
<a id="trunksrcclassbuddypressphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/class-buddypress.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/class-buddypress.php 2017-06-23 17:44:46 UTC (rev 11613)
+++ trunk/src/class-buddypress.php 2017-06-23 17:58:21 UTC (rev 11614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -477,6 +477,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require( $this->plugin_dir . 'bp-core/deprecated/2.5.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( $this->plugin_dir . 'bp-core/deprecated/2.6.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> require( $this->plugin_dir . 'bp-core/deprecated/2.7.php' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ require( $this->plugin_dir . 'bp-core/deprecated/2.8.php' );
+ require( $this->plugin_dir . 'bp-core/deprecated/2.9.php' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>