Administration: Prevent an orderby array throwing a notice.

peterwilsoncc · peterwilsoncc · commit 8cd24bc12c7a · 2024-06-11T02:12:52.000Z
Prevent `WP_List_Table::search_box()` from throwing an array to string conversion notice when post list tables are loaded with an array of orderby parameters in the URL, eg: `/wp-admin/edit.php?post_type=page&orderby[menu_order]=ASC&orderby[title]=ASC`. Follow up to [29027]. Props leonidasmilossis, rajinsharwar, swissspidy, NomNom99, pls78, SergeyBiryukov. Fixes #59494. See #17065. git-svn-id: https://develop.svn.wordpress.org/trunk@58379 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/includes/class-wp-list-table.php b/src/wp-admin/includes/class-wp-list-table.php
@@ -388,7 +388,18 @@ public function search_box( $text, $input_id ) {
 		$input_id = $input_id . '-search-input';
 
 		if ( ! empty( $_REQUEST['orderby'] ) ) {
-			echo '<input type="hidden" name="orderby" value="' . esc_attr( $_REQUEST['orderby'] ) . '" />';
+			if ( is_array( $_REQUEST['orderby'] ) ) {
+				foreach ( $_REQUEST['orderby'] as $key => $value ) {
+					/*
+					 * Orderby can be either an associative array or non-associative array.
+					 * In the latter case, this makes sure the key is a string before calling esc_attr().
+					 */
+					$key = (string) $key;
+					echo '<input type="hidden" name="orderby[' . esc_attr( $key ) . ']" value="' . esc_attr( $value ) . '" />';
+				}
+			} else {
+				echo '<input type="hidden" name="orderby" value="' . esc_attr( $_REQUEST['orderby'] ) . '" />';
+			}
 		}
 		if ( ! empty( $_REQUEST['order'] ) ) {
 			echo '<input type="hidden" name="order" value="' . esc_attr( $_REQUEST['order'] ) . '" />';
diff --git a/tests/phpunit/tests/admin/wpListTable.php b/tests/phpunit/tests/admin/wpListTable.php
@@ -521,4 +521,61 @@ public function data_compat_fields() {
 			),
 		);
 	}
+
+	/**
+	 * Tests that "search_box()" works correctly with an orderby array with multiple values.
+	 *
+	 * @ticket 59494
+	 */
+	public function test_search_box_working_with_array_of_orderby_multiple_values() {
+		$_REQUEST['s']       = 'search term';
+		$_REQUEST['orderby'] = array(
+			'menu_order' => 'ASC',
+			'title'      => 'ASC',
+		);
+
+		$actual = get_echo( array( $this->list_table, 'search_box' ), array( 'Search Posts', 'post' ) );
+
+		$expected_html1 = '<input type="hidden" name="orderby[menu_order]" value="ASC" />';
+		$expected_html2 = '<input type="hidden" name="orderby[title]" value="ASC" />';
+
+		$this->assertStringContainsString( $expected_html1, $actual );
+		$this->assertStringContainsString( $expected_html2, $actual );
+	}
+
+	/**
+	 * Tests that "search_box()" works correctly with an orderby array with a single value.
+	 *
+	 * @ticket 59494
+	 */
+	public function test_search_box_working_with_array_of_orderby_single_value() {
+		// Test with one 'orderby' element.
+		$_REQUEST['s']       = 'search term';
+		$_REQUEST['orderby'] = array(
+			'title' => 'ASC',
+		);
+
+		$actual = get_echo( array( $this->list_table, 'search_box' ), array( 'Search Posts', 'post' ) );
+
+		$expected_html = '<input type="hidden" name="orderby[title]" value="ASC" />';
+
+		$this->assertStringContainsString( $expected_html, $actual );
+	}
+
+	/**
+	 * Tests that "search_box()" works correctly with orderby set to a string.
+	 *
+	 * @ticket 59494
+	 */
+	public function test_search_box_works_with_orderby_string() {
+		// Test with one 'orderby' element.
+		$_REQUEST['s']       = 'search term';
+		$_REQUEST['orderby'] = 'title';
+
+		$actual = get_echo( array( $this->list_table, 'search_box' ), array( 'Search Posts', 'post' ) );
+
+		$expected_html = '<input type="hidden" name="orderby" value="title" />';
+
+		$this->assertStringContainsString( $expected_html, $actual );
+	}
 }
