From 6bf8783afdf6943afa2715fa8746a0a40c4a37ec Mon Sep 17 00:00:00 2001
From: Boone Gorges <boonebgorges@git.wordpress.org>
Date: Sat, 1 Jul 2017 14:21:50 +0000
Subject: [PATCH] Allow user searches to match the `display_name` field.

Props bcole808, pcarvalho.
Fixes #39643.

git-svn-id: https://develop.svn.wordpress.org/trunk@40982 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/class-wp-user-query.php |  5 +--
 tests/phpunit/tests/user/query.php      | 48 +++++++++++++++++++++++++
 2 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/src/wp-includes/class-wp-user-query.php b/src/wp-includes/class-wp-user-query.php
index 4522f7eead..9f8a9ddfcc 100644
--- a/src/wp-includes/class-wp-user-query.php
+++ b/src/wp-includes/class-wp-user-query.php
@@ -522,8 +522,9 @@ class WP_User_Query {
 				$search = trim($search, '*');
 
 			$search_columns = array();
-			if ( $qv['search_columns'] )
-				$search_columns = array_intersect( $qv['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename' ) );
+			if ( $qv['search_columns'] ) {
+				$search_columns = array_intersect( $qv['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', 'display_name' ) );
+			}
 			if ( ! $search_columns ) {
 				if ( false !== strpos( $search, '@') )
 					$search_columns = array('user_email');
diff --git a/tests/phpunit/tests/user/query.php b/tests/phpunit/tests/user/query.php
index ee2f3d8309..5212065d35 100644
--- a/tests/phpunit/tests/user/query.php
+++ b/tests/phpunit/tests/user/query.php
@@ -1386,4 +1386,52 @@ class Tests_User_Query extends WP_UnitTestCase {
 		$this->assertSame( $r1, $r2 );
 		$this->assertSame( $r1, $r3 );
 	}
+
+	/**
+	 * @ticket 39643
+	 */
+	public function test_search_by_display_name_only() {
+
+		$new_user1 = $this->factory->user->create( array(
+			'user_login'   => 'name1',
+			'display_name' => 'Sophia Andresen',
+		) );
+		self::$author_ids[] = $new_user1;
+
+		$q = new WP_User_Query( array(
+			'search' => '*Sophia*',
+			'fields' => '',
+			'search_columns' => array( 'display_name' ),
+			'include' => self::$author_ids,
+		) );
+
+		$ids = $q->get_results();
+
+		/* must include user that has same string in display_name */
+		$this->assertEquals( array( $new_user1 ), $ids );
+	}
+
+	/**
+	 * @ticket 39643
+	 */
+	public function test_search_by_display_name_only_ignore_others() {
+
+		$new_user1 = $this->factory->user->create( array(
+			'user_login'   => 'Sophia Andresen',
+			'display_name' => 'name1',
+		) );
+		self::$author_ids[] = $new_user1;
+
+		$q = new WP_User_Query( array(
+			'search' => '*Sophia*',
+			'fields' => '',
+			'search_columns' => array( 'display_name' ),
+			'include' => self::$author_ids,
+		) );
+
+		$ids = $q->get_results();
+
+		/* must not include user that has same string in other fields */
+		$this->assertEquals( array(), $ids );
+	}
 }