<!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][12906] trunk/src: Replace the `bp_core_avatar_default` filter with 2 new filters</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 { white-space: pre-line; 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/12906">12906</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/12906","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-04-27 04:11:45 +0000 (Tue, 27 Apr 2021)</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'>Replace the `bp_core_avatar_default` filter with 2 new filters
The `bp_core_avatar_default` filter was used for two different purposes:
1. to edit the default BuddyPress avatar <a href="http://buddypress.trac.wordpress.org/changeset/7769">[7769]</a>.
2. to edit the default Gravatar <a href="http://buddypress.trac.wordpress.org/changeset/10688">[10688]</a>.
To avoid confusion or generate misleading behaviors, we are deprecating this filter in favor of 2 new filters :
1. Use `bp_core_default_avatar` to edit the default BuddyPress avatar.
2. Use `bp_core_avatar_gravatar_default` to edit the default Gravatar.
Props r-a-y
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8437">#8437</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpblogsbpblogsfiltersphp">trunk/src/bp-blogs/bp-blogs-filters.php</a></li>
<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.php</a></li>
<li><a href="#trunksrcbpgroupsbpgroupsfiltersphp">trunk/src/bp-groups/bp-groups-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpblogsbpblogsfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/bp-blogs-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/bp-blogs-filters.php 2021-04-23 17:17:02 UTC (rev 12905)
+++ trunk/src/bp-blogs/bp-blogs-filters.php 2021-04-27 04:11:45 UTC (rev 12906)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,7 +158,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $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">-add_filter( 'bp_core_avatar_default', 'bp_blogs_default_avatar', 10, 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'bp_core_default_avatar', 'bp_blogs_default_avatar', 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_core_avatar_default_thumb', 'bp_blogs_default_avatar', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<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 2021-04-23 17:17:02 UTC (rev 12905)
+++ trunk/src/bp-core/bp-core-avatars.php 2021-04-27 04:11:45 UTC (rev 12906)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,6 +96,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_setup_globals', 'bp_core_set_avatar_globals' );
</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">+ * Checks whether a given gravatar is one of the default ones.
+ *
+ * @since 8.0.0
+ *
+ * @param string $d The name of the default gravatar.
+ * @return bool True if it's a default gravatar. False otherwise.
+ */
+function bp_core_is_default_gravatar( $d = '' ) {
+ if ( ! $d ) {
+ return false;
+ }
+
+ /** this filter is documented in wp-admin/options-discussion.php */
+ $gravatar_defaults = apply_filters(
+ 'avatar_defaults',
+ array_fill_keys(
+ array(
+ 'mystery',
+ 'blank',
+ 'gravatar_default',
+ 'identicon',
+ 'wavatar',
+ 'monsterid',
+ 'retro',
+ ),
+ ''
+ )
+ );
+
+ return isset( $gravatar_defaults[ $d ] );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get an avatar for a BuddyPress object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Supports avatars for users, groups, and blogs by default, but can be
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -644,15 +677,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $url_args['r'] = strtolower( $params['rating'] );
</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">+ /** This filter is documented in wp-includes/deprecated.php */
+ $d = apply_filters_deprecated(
+ 'bp_core_avatar_default',
+ array( $default_grav, $params ),
+ '8.0.0',
+ 'bp_core_avatar_gravatar_default||bp_core_default_avatar',
+ __( 'This filter was used for 2 different purposes. If your goal was to filter the default *Gravatar*, please use `bp_core_avatar_gravatar_default` instead. Otherwise, please use `bp_core_default_avatar` instead.', 'buddypress' )
+ );
+
+ if ( bp_core_is_default_gravatar( $d ) ) {
+ $default_grav = $d;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the Gravatar "d" parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 8.0.0 The name of the filter was changed to `bp_core_avatar_gravatar_default`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $default_grav The avatar default.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $params The avatar's data.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $default_grav = apply_filters( 'bp_core_avatar_default', $default_grav, $params );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $default_grav = apply_filters( 'bp_core_avatar_gravatar_default', $default_grav, $params );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Only set default image if 'Gravatar Logo' is not requested.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $params['force_default'] && 'gravatar_default' !== $default_grav ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1841,16 +1888,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $avatar = '//www.gravatar.com/avatar/00000000000000000000000000000000?d=mm&s=' . $size;
</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">+ /** This filter is documented in wp-includes/deprecated.php */
+ $a = apply_filters_deprecated(
+ 'bp_core_avatar_default',
+ array( $avatar, $params ),
+ '8.0.0',
+ 'bp_core_avatar_gravatar_default||bp_core_default_avatar',
+ __( 'This filter was used for 2 different purposes. If your goal was to filter the default *Gravatar*, please use `bp_core_avatar_gravatar_default` instead. Otherwise, please use `bp_core_default_avatar` instead.', 'buddypress' )
+ );
+
+ if ( ! bp_core_is_default_gravatar( $a ) && false !== strpos( $avatar, '//' ) ) {
+ $avatar = $a;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the URL of the 'full' default avatar.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Added `$params`.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 8.0.0 The name of the filter was changed to `bp_core_default_avatar`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $avatar URL of the default avatar.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $params Params provided to bp_core_fetch_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">- return apply_filters( 'bp_core_avatar_default', $avatar, $params );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'bp_core_default_avatar', $avatar, $params );
</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>
<a id="trunksrcbpgroupsbpgroupsfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-filters.php 2021-04-23 17:17:02 UTC (rev 12905)
+++ trunk/src/bp-groups/bp-groups-filters.php 2021-04-27 04:11:45 UTC (rev 12906)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,7 +69,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_activity_at_name_do_notifications', 'bp_groups_disable_at_mention_notification_for_non_public_groups', 10, 4 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Default group avatar.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_filter( 'bp_core_avatar_default', 'bp_groups_default_avatar', 10, 3 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'bp_core_default_avatar', 'bp_groups_default_avatar', 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_core_avatar_default_thumb', 'bp_groups_default_avatar', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Personal data export.
</span></span></pre>
</div>
</div>
</body>
</html>