Skip to content

Conversation

@mukeshpanchal27
Copy link
Member

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

This PR improves the documentation and structure of test cases related to post date handling in tests/phpunit/tests/post.php. The main focus is on updating docblocks for clarity and converting data provider methods to static methods, which is a best practice in PHPUnit.

  • Updated the docblocks for test_wp_insert_post_handle_malformed_post_date() and test_wp_resolve_post_date_regex() to clearly describe the parameters and expected behavior of each test, making the intent and usage of the tests more understandable.
  • Converted the data provider methods data_wp_insert_post_handle_malformed_post_date() and data_wp_resolve_post_date_regex() to static methods and enhanced their docblocks to specify the structure of the returned data, aligning with PHPUnit best practices.

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.

@mukeshpanchal27 mukeshpanchal27 self-assigned this Nov 7, 2025
@mukeshpanchal27 mukeshpanchal27 marked this pull request as ready for review November 7, 2025 04:33
@github-actions
Copy link

github-actions bot commented Nov 7, 2025

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 mukesh27, westonruter.

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

@github-actions
Copy link

github-actions bot commented Nov 7, 2025

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.

* @ticket 26798
* Data provider for test_wp_insert_post_handle_malformed_post_date().
*
* @return array<array{ date: string, expected: bool }>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally this would be:

Suggested change
* @return array<array{ date: string, expected: bool }>
* @return array<string, array{ date: string, expected: bool }>

Where the array keys in the data provider below are strings in an associative array. What are currently comments like "24-hour time format" should rather be part of the array key. This would make it much easier to locate the data set for a failing test.

* @ticket 26798
* Data provider for test_wp_resolve_post_date_regex().
*
* @return array<array{ date: string, expected: string|false }>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto above:

Suggested change
* @return array<array{ date: string, expected: string|false }>
* @return array<string, array{ date: string, expected: string|false }>

But this would require coming up with names for all of the tests to use in the keys.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants