<!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][13121] trunk: xProfile: prevent the Name field to override WP Field Types on signup</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/13121">13121</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/13121","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-10-09 17:13:00 +0000 (Sat, 09 Oct 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'>xProfile: prevent the Name field to override WP Field Types on signup
When the BP xProfile Base Name field synchronization with the WordPress Display Name field is on, we need to make sure values of potential first and/or last name fields using the xProfile WP Field Type are not overridden by this synchronization.
Props needle
See <a href="http://buddypress.trac.wordpress.org/ticket/8568">#8568</a> (trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesxprofilefunctionsphp">trunk/tests/phpunit/testcases/xprofile/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-functions.php 2021-10-08 20:37:03 UTC (rev 13120)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php 2021-10-09 17:13:00 UTC (rev 13121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -815,11 +815,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Syncs Xprofile data to the standard built in WordPress profile data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 9.2.0 Adds the $args arguments to catch hook's additional arguments.
</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 $user_id ID of the user to sync.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $user_id ID of the user to sync.
+ * @param array $args Hook's additional arguments.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function xprofile_sync_wp_profile( $user_id = 0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function xprofile_sync_wp_profile( $user_id = 0, ...$args ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail if profile syncing is disabled.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_disable_profile_sync() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -834,25 +836,59 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- $fullname = xprofile_get_field_data( bp_xprofile_fullname_field_id(), $user_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fullname_field_id = (int) bp_xprofile_fullname_field_id();
+ $usermeta = array();
+ $userdata = array();
+
+ if ( isset( $args[1]['meta'] ) ) {
+ $usermeta = $args[1]['meta'];
+ } elseif ( isset( $args[3] ) ) {
+ $usermeta = $args[3];
+ }
+
+ if ( isset( $usermeta['profile_field_ids'] ) ) {
+ $xprofile_fields = wp_parse_id_list( $usermeta['profile_field_ids'] );
+ $xprofile_fields = array_diff( $xprofile_fields, array( $fullname_field_id ) );
+
+ foreach ( $xprofile_fields as $xprofile_field_id ) {
+ $field_type = bp_xprofile_get_field_type( $xprofile_field_id );
+
+ $field_key = 'field_' . $xprofile_field_id;
+ if ( isset( $field_type->wp_user_key ) && isset( $usermeta[ $field_key ] ) && $usermeta[ $field_key ] ) {
+ $userdata[ $field_type->wp_user_key ] = $usermeta[ $field_key ];
+ }
+ }
+ }
+
+ $fullname = xprofile_get_field_data( $fullname_field_id, $user_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $space = strpos( $fullname, ' ' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $space ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $firstname = $fullname;
- $lastname = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $userdata['first_name'] ) ) {
+ $userdata['first_name'] = $fullname;
+ }
+
+ if ( ! isset( $userdata['last_name'] ) ) {
+ $userdata['last_name'] = '';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $firstname = substr( $fullname, 0, $space );
- $lastname = trim( substr( $fullname, $space, strlen( $fullname ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $userdata['first_name'] ) ) {
+ $userdata['first_name'] = substr( $fullname, 0, $space );
+ }
+
+ if ( ! isset( $userdata['last_name'] ) ) {
+ $userdata['last_name'] = trim( substr( $fullname, $space, strlen( $fullname ) ) );
+ }
</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"> bp_update_user_meta( $user_id, 'nickname', $fullname );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_update_user_meta( $user_id, 'first_name', $firstname );
- bp_update_user_meta( $user_id, 'last_name', $lastname );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_update_user_meta( $user_id, 'first_name', $userdata['first_name'] );
+ bp_update_user_meta( $user_id, 'last_name', $userdata['last_name'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_user( array( 'ID' => $user_id, 'display_name' => $fullname ) );
</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_action( 'bp_core_signup_user', 'xprofile_sync_wp_profile' );
-add_action( 'bp_core_activated_user', 'xprofile_sync_wp_profile' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'bp_core_signup_user', 'xprofile_sync_wp_profile', 10, 5 );
+add_action( 'bp_core_activated_user', 'xprofile_sync_wp_profile', 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"> * Syncs the standard built in WordPress profile data to XProfile.
</span></span></pre></div>
<a id="trunktestsphpunittestcasesxprofilefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/xprofile/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/xprofile/functions.php 2021-10-08 20:37:03 UTC (rev 13120)
+++ trunk/tests/phpunit/testcases/xprofile/functions.php 2021-10-09 17:13:00 UTC (rev 13121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1206,4 +1206,182 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'foo', xprofile_get_field_data( $f1, $u ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket BP8568
+ */
+ public function test_xprofile_sync_wp_profile_signup_with_wp_first_and_last_name_fields() {
+ add_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ $u = self::factory()->user->create_and_get(
+ array(
+ 'user_login' => 'foobar',
+ 'user_email' => 'foo@bar.email',
+ )
+ );
+
+ $field_fn = self::factory()->xprofile_field->create(
+ array(
+ 'field_group_id' => 1,
+ 'type' => 'wp-textbox',
+ 'name' => 'WP First Name',
+ )
+ );
+
+ // Set the WP User Key.
+ bp_xprofile_update_meta( $field_fn, 'field', 'wp_user_key', 'first_name' );
+
+ $field_ln = self::factory()->xprofile_field->create(
+ array(
+ 'field_group_id' => 1,
+ 'type' => 'wp-textbox',
+ 'name' => 'WP Last Name',
+ )
+ );
+
+ // Set the WP User Key.
+ bp_xprofile_update_meta( $field_ln, 'field', 'wp_user_key', 'last_name' );
+
+ $field_n = bp_xprofile_fullname_field_id();
+ $usermeta = array(
+ 'field_' . $field_n => 'foobar',
+ 'field_' . $field_fn => 'Foo',
+ 'field_' . $field_ln => 'Bar',
+ 'profile_field_ids' => $field_n . ',' . $field_fn . ',' . $field_ln,
+ );
+
+ remove_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ // simulates do_action( 'bp_core_signup_user', $user_id, $user_login, $user_password, $user_email, $usermeta );
+ xprofile_sync_wp_profile( $u->ID, $u->user_login, $u->user_pass, $u->user_email, $usermeta );
+
+ $updated_u = get_user_by( 'id', $u->ID );
+
+ $this->assertEquals( 'Foo', $updated_u->first_name );
+ $this->assertEquals( 'Bar', $updated_u->last_name );
+ }
+
+ /**
+ * @ticket BP8568
+ */
+ public function test_xprofile_sync_wp_profile_signup_without_wp_first_and_last_name_fields() {
+ add_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ $u = self::factory()->user->create_and_get(
+ array(
+ 'user_login' => 'foobar',
+ 'user_email' => 'foo@bar.email',
+ )
+ );
+
+ $field_n = bp_xprofile_fullname_field_id();
+ $usermeta = array(
+ 'field_' . $field_n => 'foobar',
+ 'profile_field_ids' => $field_n,
+ );
+
+ remove_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ // simulates do_action( 'bp_core_signup_user', $user_id, $user_login, $user_password, $user_email, $usermeta );
+ xprofile_sync_wp_profile( $u->ID, $u->user_login, $u->user_pass, $u->user_email, $usermeta );
+
+ $updated_u = get_user_by( 'id', $u->ID );
+
+ $this->assertEquals( 'foobar', $updated_u->first_name );
+ $this->assertEquals( '', $updated_u->last_name );
+ }
+
+ /**
+ * @ticket BP8568
+ */
+ public function test_xprofile_sync_wp_profile_activate_signup_with_wp_first_and_last_name_fields() {
+ add_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ $u = self::factory()->user->create_and_get(
+ array(
+ 'user_login' => 'barfoo',
+ 'user_email' => 'bar@foo.email',
+ )
+ );
+
+ $field_fn = self::factory()->xprofile_field->create(
+ array(
+ 'field_group_id' => 1,
+ 'type' => 'wp-textbox',
+ 'name' => 'WP First Name',
+ )
+ );
+
+ // Set the WP User Key.
+ bp_xprofile_update_meta( $field_fn, 'field', 'wp_user_key', 'first_name' );
+
+ $field_ln = self::factory()->xprofile_field->create(
+ array(
+ 'field_group_id' => 1,
+ 'type' => 'wp-textbox',
+ 'name' => 'WP Last Name',
+ )
+ );
+
+ // Set the WP User Key.
+ bp_xprofile_update_meta( $field_ln, 'field', 'wp_user_key', 'last_name' );
+
+ $field_n = bp_xprofile_fullname_field_id();
+
+ $user = array(
+ 'user_id' => $u->ID,
+ 'password' => $u->user_pass,
+ 'meta' => array(
+ 'field_' . $field_n => 'barfoo',
+ 'field_' . $field_fn => 'Bar',
+ 'field_' . $field_ln => 'Foo',
+ 'profile_field_ids' => $field_n . ',' . $field_fn . ',' . $field_ln,
+ ),
+ );
+
+ remove_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ // simulates do_action( 'bp_core_activated_user', $user_id, $key, $user );
+ xprofile_sync_wp_profile( $u->ID, 'randomkey', $user );
+
+ $updated_u = get_user_by( 'id', $u->ID );
+
+ $this->assertEquals( 'Bar', $updated_u->first_name );
+ $this->assertEquals( 'Foo', $updated_u->last_name );
+ }
+
+ /**
+ * @ticket BP8568
+ */
+ public function test_xprofile_sync_wp_profile_activate_signup_without_wp_first_and_last_name_fields() {
+ add_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ $u = self::factory()->user->create_and_get(
+ array(
+ 'user_login' => 'barfoo',
+ 'user_email' => 'bar@foo.email',
+ )
+ );
+
+ $field_n = bp_xprofile_fullname_field_id();
+
+ $user = array(
+ 'user_id' => $u->ID,
+ 'password' => $u->user_pass,
+ 'meta' => array(
+ 'field_' . $field_n => 'barfoo',
+ 'profile_field_ids' => $field_n,
+ ),
+ );
+
+ remove_filter( 'bp_disable_profile_sync', '__return_true' );
+
+ // simulates do_action( 'bp_core_activated_user', $user_id, $key, $user );
+ xprofile_sync_wp_profile( $u->ID, 'randomkey', $user );
+
+ $updated_u = get_user_by( 'id', $u->ID );
+
+ $this->assertEquals( 'barfoo', $updated_u->first_name );
+ $this->assertEquals( '', $updated_u->last_name );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>