Fix PHP notice that showed when orderby query parameter was an array (With Unit tests)

[Rajinsharwar]

This is a followup to the #5404, with unit tests.

Trac ticket: https://core.trac.wordpress.org/ticket/59494

---

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props rajinsharwar, peterwilsoncc, swissspidy.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• The Plugin and Theme Directories cannot be accessed within Playground.
• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[swissspidy]

Using wp_remote_* is not really the right approach here. If you want to test the frontend output like this, you would write an e2e test. However, this change here does not really warrant an e2e test. A simple unit test that tests the method is good enough. Doing an HTTP call is not really a unit test.

Look at the other unit tests in tests/phpunit/tests/admin/wpListTable.php and how they're written.

You'll want a simple test that calls the search_box() method and verifies the output is as expected.

The structure could look like this:

	/**
	 * Tests that `WP_List_Table::search_box()` supports multiple orderby fields.
	 *
	 * @ticket 59494
	 *
	 * @covers WP_List_Table::search_box
	 */
	public function test_search_box_supports_multiple_orderby() {
		$_REQUEST['s'] = 'search term';

		$output = get_echo( array( $this->list_table, 'search_box' ), array( 'foo', 'bar' ) );

		$this->assertStringContainsString( 'Write your expected string here', $output );
	}

[Rajinsharwar]

Thank you so much @swissspidy. I was specifically looking for a function like get_echo(), which I was unaware of its existence. If you can take a look at my changed tests, please. 🙂. Thanks again!

[peterwilsoncc]

Thanks for adding the unit test.

I think it would be helpful to include one for orderby set to a string to ensure that both behaviours are working as expected.

It would be similar to your existing test but start with:

$_REQUEST['s']       = 'search term';
$_REQUEST['orderby'] = 'title';

[Rajinsharwar]

Thanks for your suggestion @peterwilsoncc. I have added another test for the single orderby. Let me know if it fits right.

[peterwilsoncc]

I might have been unclear in my earlier comment.

I was thinking of a test case in which the orderby parameter is set to a string. I've put a suggestion inline.

I've moved the test to another method as the two tests are for different circumstances and should therefore be tested independently.

[Rajinsharwar]

@peterwilsoncc I see. I have committed to the changes. Also, I kept the test for one element array as well. Let me know if this looks good to you. :)

[peterwilsoncc]

Thanks @Rajinsharwar, these tests look good to me.

I took the liberty of pushing a few modifications to the tests:

• splitting out the test for an array of single and multiple values
• renamed $output to $actual as the latter is more commonly used in the test suite.

Thanks so much for your patience during the review process, I really appreciate the time you took to add the tests.

[peterwilsoncc]

Committed in r58379 / 8cd24bc