Skip to content

Add unit tests for got_url_rewrite() in src/wp-admin/includes/misc.php#11657

Open
pbearne wants to merge 3 commits intoWordPress:trunkfrom
pbearne:65135-misc-got_url_rewrite
Open

Add unit tests for got_url_rewrite() in src/wp-admin/includes/misc.php#11657
pbearne wants to merge 3 commits intoWordPress:trunkfrom
pbearne:65135-misc-got_url_rewrite

Conversation

@pbearne
Copy link
Copy Markdown

@pbearne pbearne commented Apr 27, 2026

Reference: https://core.trac.wordpress.org/ticket/65135
This PR adds comprehensive unit tests for the got_url_rewrite() function in src/wp-admin/includes/misc.php.
The tests verify detection across different server environments:

  • Apache (via got_mod_rewrite)
  • Nginx (via $is_nginx global)
  • Caddy (via $is_caddy global)
  • Overriding via the got_url_rewrite filter.

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

Use of AI Tools

AI assistance: Yes
Tool(s): Junie (JetBrains)
Model(s): gemini-3-flash-preview
Used for: Test structure generation, global variable mocking strategy, and dataProvider implementation.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 27, 2026

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @pbearne@git.wordpress.org.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Props pbearne.

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

@github-actions
Copy link
Copy Markdown

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

  • 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.

@pbearne pbearne force-pushed the 65135-misc-got_url_rewrite branch 2 times, most recently from 1c85965 to e1a086d Compare April 27, 2026 18:31
@pbearne pbearne force-pushed the 65135-misc-got_url_rewrite branch from 1177e68 to 30e825d Compare April 27, 2026 18:46
@pbearne pbearne force-pushed the 65135-misc-got_url_rewrite branch from e181fb8 to ec4b3ac Compare April 27, 2026 20:05
Comment on lines +64 to +71
* @return array[] {
* @type bool $expected The expected result.
* @type bool $mod_rewrite Whether mod_rewrite is supported.
* @type bool $is_nginx Whether server is nginx.
* @type bool $is_caddy Whether server is Caddy.
* @type bool $iis7_perm Whether IIS7 supports permalinks.
* @type bool|null $filter_val Optional filter value.
* }
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's use PHPStan array shapes since there's no need to target WP Developer Docs

* @type bool|null $filter_val Optional filter value.
* }
*/
public function data_got_url_rewrite() {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
public function data_got_url_rewrite() {
public function data_got_url_rewrite(): array {

* @param bool $iis7_perm Whether IIS7 supports permalinks (simulated).
* @param bool|null $filter_val Optional value for the 'got_url_rewrite' filter.
*/
public function test_got_url_rewrite( $expected, $mod_rewrite, $is_nginx_val, $is_caddy_val, $iis7_perm, $filter_val = null ) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
public function test_got_url_rewrite( $expected, $mod_rewrite, $is_nginx_val, $is_caddy_val, $iis7_perm, $filter_val = null ) {
public function test_got_url_rewrite( bool $expected, bool $mod_rewrite, bool $is_nginx_val, bool $is_caddy_val, bool $iis7_perm, ?bool $filter_val = null ): void {

Comment on lines +30 to +35
// Backup globals.
$prev_nginx = $is_nginx;
$prev_caddy = $is_caddy;

$is_nginx = $is_nginx_val;
$is_caddy = $is_caddy_val;
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The backup should be done in set_up.

Comment on lines +57 to +58
$is_nginx = $prev_nginx;
$is_caddy = $prev_caddy;
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should be done in tear_down.

Comment on lines +53 to +56
remove_filter( 'got_rewrite', $mod_rewrite ? '__return_true' : '__return_false' );
if ( null !== $filter_val ) {
remove_filter( 'got_url_rewrite', $filter_val ? '__return_true' : '__return_false' );
}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Filters are automatically removed after tests run.

Suggested change
remove_filter( 'got_rewrite', $mod_rewrite ? '__return_true' : '__return_false' );
if ( null !== $filter_val ) {
remove_filter( 'got_url_rewrite', $filter_val ? '__return_true' : '__return_false' );
}

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