Skip to content

Add --unserialize flag to 'option list' command #156

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

Merged
danielbachhuber merged 4 commits into from
Mar 20, 2018
Merged

Add --unserialize flag to 'option list' command #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ebca9a9
Add --unserialize flag to 'option list' command
pjeby Mar 18, 2018
6092dd7
Forgot --unserialize in the test
pjeby Mar 18, 2018
15d249b
Test output needs trailing space
pjeby Mar 18, 2018
7c85e42
Format according to WPCS
danielbachhuber Mar 20, 2018
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1719,6 +1719,9 @@ wp option list [--search=<pattern>] [--exclude=<pattern>] [--autoload=<value>] [
[--transients]
List only transients. Use `--no-transients` to ignore all transients.

[--unserialize]
Unserialize option values in output.

[--field=<field>]
Prints the value of a single field.

Expand Down
13 changes: 13 additions & 0 deletions features/option-list.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,16 @@ Feature: List WordPress options
siteurl
"""

Scenario: Using the `--unserialize` flag
Given a WP install

When I run `wp option add --format=json sample_test_field_one '{"value": 1}'`
And I run `wp option list --search="sample_test_field_*" --format=yaml --unserialize`
Then STDOUT should be:
"""
---
-
option_name: sample_test_field_one
option_value:
value: 1
"""
11 changes: 11 additions & 0 deletions src/Option_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,9 @@ public function add( $args, $assoc_args ) {
* [--transients]
* : List only transients. Use `--no-transients` to ignore all transients.
*
* [--unserialize]
* : Unserialize option values in output.
*
* [--field=<field>]
* : Prints the value of a single field.
*
Expand Down Expand Up @@ -317,6 +320,14 @@ public function list_( $args, $assoc_args ) {
krsort( $results );
}

if ( true === Utils\get_flag_value( $assoc_args, 'unserialize', null ) ) {
foreach ( $results as $k => &$v ) {
if ( ! empty( $v->option_value ) ) {
$v->option_value = maybe_unserialize( $v->option_value );
}
}
}

if ( \WP_CLI\Utils\get_flag_value( $assoc_args, 'format' ) === 'total_bytes' ) {
WP_CLI::line( $results[0]->size_bytes );
} else {
Expand Down