Fix phar path resolution when WP_CLI_PHAR_PATH includes phar:// prefix

[Copilot]

The phar_safe_path() function fails when the phar is renamed (e.g., wp-cli.phar → wp) because it incorrectly handles the WP_CLI_PHAR_PATH constant. This constant is always defined in wp-cli-bundle as Phar::running(true), which includes the phar:// prefix. The original code didn't account for this prefix, causing it to be prepended twice and creating malformed paths like:

phar://wp-cli.phar/vendor/wp-cli/wp-cli/templates/phar://.local/bin/wp/vendor/wp-cli/config-command/templates/wp-config.mustache

This causes wp config create --path=subfolder to fail.

Changes

• php/WP_CLI/Path.php: Modified Path::phar_safe() to strip the phar:// prefix from WP_CLI_PHAR_PATH before using it in path replacement
• php/utils.php: Updated deprecated phar_safe_path() wrapper to delegate to Path::phar_safe()
• tests/PathTest.php: Added unit test covering non-phar execution path and the deprecated wrapper function

The function now correctly extracts internal phar paths regardless of the phar filename:

// Before: assumed WP_CLI_PHAR_PATH didn't include phar:// prefix
return str_replace(
    self::PHAR_STREAM_PREFIX . rtrim( WP_CLI_PHAR_PATH, '/' ) . '/',
    self::PHAR_STREAM_PREFIX,
    $path
);

// After: strips phar:// prefix if present
$phar_path = WP_CLI_PHAR_PATH;
if ( 0 === strpos( $phar_path, self::PHAR_STREAM_PREFIX ) ) {
    $phar_path = substr( $phar_path, strlen( self::PHAR_STREAM_PREFIX ) );
}
return str_replace(
    self::PHAR_STREAM_PREFIX . rtrim( $phar_path, '/' ) . '/',
    self::PHAR_STREAM_PREFIX,
    $path
);

Note: This PR has been updated to work with the refactored WP_CLI\Path class introduced in the main branch. The fix is now applied to Path::phar_safe() instead of the original phar_safe_path() function, which is now a deprecated wrapper.

See wp-cli/config-command#141

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[codecov]

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
php/WP_CLI/Path.php	0.00%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

[swissspidy]

@copilot merge in changes from main and resolve conflicts.

[Copilot]

@copilot merge in changes from main and resolve conflicts.

Done! Merged latest changes from main in commit b07e22e.

The merge conflict in php/utils.php was resolved by accepting the main branch's refactored version (which delegates to Path::phar_safe()), and I've applied the phar:// prefix stripping fix to the new Path::phar_safe() method in php/WP_CLI/Path.php.

All tests pass successfully.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• example.com
  • Triggering command: /usr/bin/php php vendor/bin/phpunit --color=always --bootstrap ./vendor/wp-cli/wp-cli-tests/tests/bootstrap.php get onfig-not-file /usr/local/bin/git http.https://gitbash (dns block)
• nosuchhost_asdf_asdf_asdf.com
  • Triggering command: /usr/bin/php php vendor/bin/phpunit --color=always --bootstrap ./vendor/wp-cli/wp-cli-tests/tests/bootstrap.php get onfig-not-file /usr/local/bin/git http.https://gitbash (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)