Add optional `$newline` parameter to `WP_CLI::log()` and `WP_CLI::line()` by Copilot · Pull Request #6276 · wp-cli/wp-cli

Copilot · 2026-03-15T22:12:25Z

The logging API always appended a newline to every message, making it impossible to implement inline progress patterns (e.g., print a prefix, do work, then append a result on the same line).

Changes

WP_CLI::log( $message, $newline = true ) — new optional $newline parameter passed through to the logger
WP_CLI::line( $message, $newline = true ) — same treatment for the legacy alias
Loggers\Base::info() — updated abstract signature to info( $message, $newline = true )
Loggers\Regular::info() — conditionally appends "\n" based on $newline
Loggers\Quiet::info() — updated signature for compatibility (still a no-op)

Example

WP_CLI::log( '- Doing the first thing...', false );
// ... do work ...
WP_CLI::log( WP_CLI::colorize( '%gOK%n' ) );
// Output: - Doing the first thing...OK

All changes are backwards-compatible — $newline defaults to true, preserving existing behaviour.

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 (dns block)
- Triggering command: /usr/bin/php php vendor/bin/phpunit --color=always --filter LoggingTest --bootstrap ./vendor/wp-cli/wp-cli-tests/tests/bootstrap.php (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 (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)

Original prompt

This section details on the original issue you should resolve

<issue_title>Optionally omit the trailing newline when writing output</issue_title>
<issue_description>## Feature Request

Yes, I reviewed the contribution guidelines.

Describe your use case and the problem you are facing

At times, it's useful to be able to not automatically append newlines to every line being written to STDOUT/STDERR. For example:
$ wp do-something
Preparing to do something
- Doing the first thing...OK
- Doing the second thing...OK

All things have been completed successfully!
While the first or second steps are executing, it would be nice to be able to effectively leave the cursor at the end of the ellipsis (...):
WP_CLI::line('- Doing the first thing...');
// Do the thing.
WP_CLI::line(WP_CLI::colorize('%gOK%n'));
Unfortunately, the current logging API will result in something like:
- Doing the first thing...
OK
Describe the solution you'd like

It would be nice if the logging API (even just WP_CLI::log()) had an optional $newline argument, which would default to true, e.g.:
WP_CLI::line('- Doing the first thing...', false);
// Do the thing.
WP_CLI::line(WP_CLI::colorize('%gOK%n'));
This would eventually come down to a conditional in WP_CLI\Loggers\Base::_line(), determining whether or not the \n character (which, separately, would probably be better served by PHP_EOL) is appended to the $message.

Since this would be a change to the public-facing API (albeit adding a new, optional argument with no backwards-compatibility breaks), I wanted to propose it first before spending time preparing a PR.</issue_description>

Comments on the Issue (you are @copilot in this section)
@danielbachhuber Thanks for the suggestion, @stevegrunwell.
I'm generally open to the idea. Adding a $newline = true argument to WP_CLI::log() seems most appropriate to me, but it would be good to look around the PHP world to see if there's prior art we should follow.</comment_new>

Fixes Optionally omit the trailing newline when writing output #5400

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

codecov · 2026-03-15T22:14:46Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

… logger info() methods Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot

Pull request overview

This PR extends WP-CLI’s output/logging API to optionally omit the trailing newline, enabling inline/progress-style output while preserving existing default behavior.

Changes:

Add optional $newline = true parameter to WP_CLI::log() and legacy WP_CLI::line().
Update logger info() API and implement conditional newline handling in Loggers\Regular.
Add tests covering Regular::info() with and without newline.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/LoggingTest.php	Adds unit tests validating `info()` newline behavior.
php/class-wp-cli.php	Adds `$newline` to `WP_CLI::log()`/`line()` and passes it through to the logger.
php/WP_CLI/Loggers/Regular.php	Implements conditional newline appending for `info()`.
php/WP_CLI/Loggers/Quiet.php	Updates `info()` signature for compatibility (still no-op).
php/WP_CLI/Loggers/Base.php	Updates abstract `info()` signature to include `$newline`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

php/class-wp-cli.php

php/WP_CLI/Loggers/Base.php

…e()` (wp-cli#6276) * Initial plan * Add optional $newline parameter to WP_CLI::log(), WP_CLI::line(), and logger info() methods Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> * Undo Base class change --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com>

@swissspidy

…6270) * fix(context): resolve admin user dynamically Replace hardcoded user ID 1 fallback in Admin context with smart user resolution. On multisite, queries get_super_admins() to find a valid super admin. On single site, queries for the first user with the administrator role. Emits a clear error if no suitable user is found. Fixes #6269 * fix(context): optimize query and add test cases Use get_users() with login__in for single DB query instead of looping get_user_by(). Add single-site error case test. Replace wp super-admin commands with direct option manipulation in tests. * fix(context): fix linting issues Use single quotes for strings per PHPCS rules. Fix gherkin use-and lint violations by replacing consecutive When steps with And. * fix(context): address review feedback Revert multisite super admin lookup from get_users() back to foreach + get_user_by('login') loop because get_users() only fetches users on the current site but a super admin might not be a member of any site. Add debug logging after resolving admin user ID. * fix(context): use instanceof for type safety * Fix autoloader priority: locally installed packages now fully override phar-bundled versions (#6218) Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com> * Add environment variable configuration support to wp-cli.yml (#6169) Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com> * Autocomplete `--url` (#5704) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com> Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com> * Add WP-CLI handbook link to `wp help` output (#6273) * Initial plan * Add WP-CLI handbook URL reference to wp help output Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> * Update file(s) from wp-cli/.github * Update file(s) from wp-cli/.github * Fix SSH alias path not forwarded to remote when defined as a separate config key (#6274) * Initial plan * Fix SSH alias path not forwarded to remote when path is a separate config key Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> * Fix: forward active alias to runcommand subprocess (#6272) Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> * Fix vagrant SSH strict host key checking failure (#6275) * Initial plan * Fix vagrant SSH strict host key checking failure When ssh: vagrant is configured and vagrant ssh-config is parsed, add -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null to the SSH command to match what vagrant itself sets. This prevents failures when the vagrant VM has been recreated and has a different host key than what is stored in ~/.ssh/known_hosts. Adds a Behat test scenario to verify the fix. Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @swissspidy --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Add optional `$newline` parameter to `WP_CLI::log()` and `WP_CLI::line()` (#6276) * Initial plan * Add optional $newline parameter to WP_CLI::log(), WP_CLI::line(), and logger info() methods Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> * Undo Base class change --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com> * Refactor: remove unused imports (#6277) * Harden some tests on macOS * Update tests --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Pascal Birchler <pascalb@google.com> Co-authored-by: Ian Dunn <ian@iandunn.name> Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com> Co-authored-by: swissspidy <swissspidy@users.noreply.github.com> Co-authored-by: Sören Wünsch <soerenwrede@gmail.com>

Initial plan

3d8533f

Copilot AI assigned Copilot and swissspidy Mar 15, 2026

Copilot started work on behalf of swissspidy March 15, 2026 22:12 View session

github-actions bot added command:cli Related to 'cli' command command:cli-utils labels Mar 15, 2026

Add optional $newline parameter to WP_CLI::log(), WP_CLI::line(), and…

6797b30

… logger info() methods Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add option to omit trailing newline in output~~ Add optional $newline parameter to WP_CLI::log() and WP_CLI::line() Mar 15, 2026

Copilot AI requested a review from swissspidy March 15, 2026 22:17

Copilot finished work on behalf of swissspidy March 15, 2026 22:17

swissspidy marked this pull request as ready for review March 16, 2026 10:09

swissspidy requested a review from a team as a code owner March 16, 2026 10:09

Copilot AI review requested due to automatic review settings March 16, 2026 10:09

Copilot started reviewing on behalf of swissspidy March 16, 2026 10:10 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

php/class-wp-cli.php Show resolved Hide resolved

php/WP_CLI/Loggers/Base.php Outdated Show resolved Hide resolved

Undo Base class change

082e444

swissspidy added this to the 3.0.0 milestone Mar 16, 2026

swissspidy approved these changes Mar 16, 2026

View reviewed changes

swissspidy merged commit 2d6bcdd into main Mar 16, 2026
69 checks passed

swissspidy deleted the copilot/add-optionally-omit-trailing-newline branch March 16, 2026 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add optional `$newline` parameter to `WP_CLI::log()` and `WP_CLI::line()`#6276

Add optional `$newline` parameter to `WP_CLI::log()` and `WP_CLI::line()`#6276
swissspidy merged 3 commits intomainfrom
copilot/add-optionally-omit-trailing-newline

Copilot AI commented Mar 15, 2026 •

edited

Loading

Uh oh!

codecov bot commented Mar 15, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Mar 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Example

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

Comments on the Issue (you are @copilot in this section)

Uh oh!

codecov bot commented Mar 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Mar 15, 2026 •

edited

Loading

codecov bot commented Mar 15, 2026 •

edited

Loading