Skip to content

Accept plaintext as an alias of var_export in cli param-dump #6339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thisismyurl wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

Accept plaintext as an alias of var_export in cli param-dump #6339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions features/cli.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ Feature: `wp cli` tasks
And STDERR should be empty
And the return code should be 0

Scenario: Dump the list of global parameters in plaintext format
Given a WP installation

# `plaintext` is an accepted alias of `var_export` for this command (see #4774),
# so it must emit the var_export representation, not JSON.
When I run `wp cli param-dump --format=plaintext`
Then STDOUT should contain:
"""
'path' =>
"""
And STDERR should be empty
And the return code should be 0

Scenario: Checking whether a global configuration parameter exists or not
Given a WP installation
And a custom-cmd.php file:
Expand Down
7 changes: 6 additions & 1 deletion php/commands/src/CLI_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -853,6 +853,7 @@ private function array_find( $arr, $callback ) {
* default: json
* options:
* - var_export
* - plaintext
* - json
* ---
*
Expand Down Expand Up @@ -890,7 +891,11 @@ public function param_dump( $_, $assoc_args ) {
}
}

if ( 'var_export' === Utils\get_flag_value( $assoc_args, 'format' ) ) {
// `plaintext` and `var_export` are the same format under two names; accept both
// so the format name is consistent with other commands. See
// https://github.com/wp-cli/wp-cli/issues/4774
$format = Utils\get_flag_value( $assoc_args, 'format' );
if ( 'var_export' === $format || 'plaintext' === $format ) {
var_export( $spec );
} else {
echo json_encode( $spec );
Expand Down
Loading