Fix output formats for the theme mod get command

features/theme-mod.feature

@@ -7,6 +7,22 @@ Feature: Manage WordPress theme mods
     Then STDOUT should be a table containing rows:
       | key  | value   |
 
+    When I run `wp theme mod get --all --format=csv`
+    Then STDOUT should be CSV containing:
+      | key  | value   |
+
+    When I run `wp theme mod get --all --format=json`
+    Then STDOUT should be:
+      """
+      []
+      """
+
+    When I run `wp theme mod get --all --format=yaml`
+    Then STDOUT should be:
+      """
+      ---
+      """
+
     When I try `wp theme mod get`
     Then STDERR should contain:
       """
@@ -21,19 +37,119 @@ Feature: Manage WordPress theme mods
       | key               | value    |
       | background_color  | 123456   |
 
+    When I run `wp theme mod get --all --format=csv`
+    Then STDOUT should be CSV containing:
+      | key               | value    |
+      | background_color  | 123456   |
+
+
+    When I run `wp theme mod get --all --format=json`
+    Then STDOUT should be JSON containing:
+      """
+      [{"key":"background_color","value":"123456"}]
+      """
+
+    When I run `wp theme mod get --all --format=yaml`
+    Then STDOUT should be YAML containing:
+      """
+      ---
+      --
+        key: background_color
+        value: "123456"
+      """
+
     When I run `wp theme mod get background_color --field=value`
     Then STDOUT should be:
       """
       123456
       """
 
+    When I run `wp theme mod get background_color --field=value --format=csv`
+    Then STDOUT should be:
+      """
+      123456
+      """
+
+    When I run `wp theme mod get background_color --field=value --format=json`
+    Then STDOUT should be:
+      """
+      ["123456"]
+      """
+
+    When I run `wp theme mod get background_color --field=value --format=yaml`
+    Then STDOUT should be YAML containing:
+      """
+      ---
+      - "123456"
+      """
+
     When I run `wp theme mod set background_color 123456`
     And I run `wp theme mod get background_color header_textcolor`
     Then STDOUT should be a table containing rows:
       | key               | value    |
       | background_color  | 123456   |
       | header_textcolor  |          |
 
+    When I run `wp theme mod get background_color header_textcolor --format=csv`
+    Then STDOUT should be CSV containing:
+      | key               | value    |
+      | background_color  | 123456   |
+      | header_textcolor  |          |
+
+    When I run `wp theme mod get background_color header_textcolor --format=json`
+    Then STDOUT should be JSON containing:
+      """
+      [{"key":"background_color","value":"123456"},{"key":"header_textcolor","value":null}]
+      """
+
+    When I run `wp theme mod get background_color header_textcolor --format=yaml`
+    Then STDOUT should be YAML containing:
+      """
+      ---
+      --
+        key: background_color
+        value: "123456"
+      --
+        key: header_textcolor
+        value: null
+      """
+
+  Scenario: Getting theme mods keeps native value types for machine-readable formats
+    Given a WP install
+    And a set-mods.php file:
+      """
+      <?php
+      set_theme_mod( 'flag_off', false );
+      set_theme_mod( 'flag_on', true );
+      set_theme_mod( 'empty_thing', [] );
+      set_theme_mod( 'nested', [ 'child' => 'x' ] );
+      """
+
+    When I run `wp eval-file set-mods.php`
+
+    # The table format is for humans, so types are shown as readable placeholders.
+    And I run `wp theme mod get --all`
+    Then STDOUT should be a table containing rows:
+      | key         | value         |
+      | flag_off    | [false]       |
+      | flag_on     | [true]        |
+      | empty_thing | [empty array] |
+
+    # Machine-readable formats keep the native value types.
+    When I run `wp theme mod get --all --format=json`
+    Then STDOUT should be JSON containing:
+      """
+      [{"key":"flag_off","value":false},{"key":"flag_on","value":true},{"key":"empty_thing","value":[]},{"key":"nested","value":""},{"key":"nested.child","value":"x"}]
+      """
+
+    When I run `wp theme mod get --all --format=csv`
+    Then STDOUT should be CSV containing:
+      | key          | value |
+      | flag_off     | false |
+      | flag_on      | true  |
+      | empty_thing  | []    |
+      | nested.child | x     |
+
   Scenario: Setting theme mods
     Given a WP install
 

src/Theme_Mod_Command.php

@@ -1,5 +1,7 @@
 <?php
 
+use WP_CLI\Utils;
+
 /**
  * Sets, gets, and removes theme mods.
  *
@@ -80,57 +82,143 @@ class Theme_Mod_Command extends WP_CLI_Command {
 	 */
 	public function get( $args, $assoc_args ) {
 
-		if ( ! \WP_CLI\Utils\get_flag_value( $assoc_args, 'all' ) && empty( $args ) ) {
+		if ( ! Utils\get_flag_value( $assoc_args, 'all' ) && empty( $args ) ) {
 			WP_CLI::error( 'You must specify at least one mod or use --all.' );
 		}
 
-		if ( \WP_CLI\Utils\get_flag_value( $assoc_args, 'all' ) ) {
-			$args = array();
+		if ( Utils\get_flag_value( $assoc_args, 'all' ) ) {
+			$args = [];
 		}
 
-		$list = array();
-		$mods = get_theme_mods();
-		if ( ! is_array( $mods ) ) {
-			// If no mods are set (perhaps new theme), make sure foreach still works.
-			$mods = array();
+		// This array will hold the list of theme mods in a format suitable for the WP CLI Formatter.
+		$mod_list = [];
+
+		// If specific mods are requested, fetch only those, setting missing mods to null. Otherwise, fetch all mods.
+		$mods = [];
+		if ( ! empty( $args ) ) {
+			foreach ( $args as $mod ) {
+				$mods[ $mod ] = get_theme_mod( $mod, null );
+			}
+		} else {
+			$mods = get_theme_mods();
+
+			// A theme with no mods set returns false rather than an empty array.
+			if ( ! is_array( $mods ) ) {
+				$mods = [];
+			}
 		}
-		foreach ( $mods as $k => $v ) {
+
+		// Generate the list of items ready for output. We use an actual tab as an
+		// initial separator that we can replace later depending on format.
+		$separator = "\t";
+		foreach ( $mods as $key => $value ) {
 			// If mods were given, skip the others.
-			if ( ! empty( $args ) && ! in_array( $k, $args, true ) ) {
+			if ( ! empty( $args ) && ! in_array( $key, $args, true ) ) {
 				continue;
 			}
 
-			if ( is_array( $v ) ) {
-				$list[] = [
-					'key'   => $k,
-					'value' => '=>',
-				];
-				foreach ( $v as $_k => $_v ) {
-					$list[] = [
-						'key'   => "    $_k",
-						'value' => $_v,
-					];
-				}
-			} else {
-				$list[] = [
-					'key'   => $k,
-					'value' => $v,
-				];
-			}
+			$this->mod_to_string( $key, $value, $mod_list, $separator );
 		}
 
-		// For unset mods, show blank value.
-		foreach ( $args as $mod ) {
-			if ( ! isset( $mods[ $mod ] ) ) {
-				$list[] = [
-					'key'   => $mod,
-					'value' => '',
-				];
-			}
+		// Take our Formatter-friendly list and adjust it according to the requested format.
+		$format = Utils\get_flag_value( $assoc_args, 'format', 'table' );
+		switch ( $format ) {
+			// For tables we use a double space to indent child items, and render
+			// types like booleans and empty arrays as readable placeholders.
+			case 'table':
+				$mod_list = array_map(
+					static function ( $item ) use ( $separator ) {
+						$parts   = explode( $separator, $item['key'] );
+						$new_key = array_pop( $parts );
+						if ( ! empty( $parts ) ) {
+							$new_key = str_repeat( '  ', count( $parts ) ) . $new_key;
+						}
+
+						$value = $item['value'];
+						if ( is_bool( $value ) ) {
+							$value = $value ? '[true]' : '[false]';
+						} elseif ( is_array( $value ) ) {
+							$value = '[empty array]';
+						}
+
+						return [
+							'key'   => $new_key,
+							'value' => $value,
+						];
+					},
+					$mod_list
+				);
+				break;
+
+			// For JSON, CSV, and YAML formats we use dot notation to show the
+			// hierarchy and keep the native value types. CSV is a flat format
+			// that cannot represent an array, so those are JSON-encoded.
+			case 'csv':
+			case 'yaml':
+			case 'json':
+				$mod_list = array_map(
+					static function ( $item ) use ( $separator, $format ) {
+						$value = $item['value'];
+						if ( 'csv' === $format && is_array( $value ) ) {
+							$value = (string) wp_json_encode( $value );
+						}
+
+						return [
+							'key'   => str_replace( $separator, '.', $item['key'] ),
+							'value' => $value,
+						];
+					},
+					$mod_list
+				);
+				break;
 		}
 
+		// Output the list using the WP CLI Formatter.
 		$formatter = new \WP_CLI\Formatter( $assoc_args, $this->fields, 'thememods' );
-		$formatter->display_items( $list );
+		$formatter->display_items( $mod_list );
+	}
+
+	/**
+	 * Convert the theme mods to a flattened array with a string representation of the keys.
+	 *
+	 * @param string $key       The mod key
+	 * @param mixed  $value     The value of the mod.
+	 * @param array  $mod_list  The list so far, passed by reference.
+	 * @param string $separator A string to separate keys to denote their place in the tree.
+	 */
+	private function mod_to_string( $key, $value, &$mod_list, $separator ) {
+		if ( is_array( $value ) || is_object( $value ) ) {
+			// Convert objects to arrays for easier handling.
+			$value = (array) $value;
+
+			// Explicitly handle empty arrays to ensure they are displayed. The
+			// value is kept native here and only rendered as a placeholder for
+			// the table format.
+			if ( empty( $value ) ) {
+				$mod_list[] = [
+					'key'   => $key,
+					'value' => [],
+				];
+				return;
+			}
+
+			// Arrays get their own entry in the list to allow for sensible table output.
+			$mod_list[] = [
+				'key'   => $key,
+				'value' => '',
+			];
+
+			foreach ( $value as $child_key => $child_value ) {
+				$this->mod_to_string( $key . $separator . $child_key, $child_value, $mod_list, $separator );
+			}
+		} else {
+			// Scalars (including booleans) are kept as their native type here.
+			// The table format renders booleans as readable placeholders later.
+			$mod_list[] = [
+				'key'   => $key,
+				'value' => $value,
+			];
+		}
 	}
 
 	/**
@@ -206,11 +294,11 @@ public function list_( $args, $assoc_args ) {
 	 */
 	public function remove( $args, $assoc_args ) {
 
-		if ( ! \WP_CLI\Utils\get_flag_value( $assoc_args, 'all' ) && empty( $args ) ) {
+		if ( ! Utils\get_flag_value( $assoc_args, 'all' ) && empty( $args ) ) {
 			WP_CLI::error( 'You must specify at least one mod or use --all.' );
 		}
 
-		if ( \WP_CLI\Utils\get_flag_value( $assoc_args, 'all' ) ) {
+		if ( Utils\get_flag_value( $assoc_args, 'all' ) ) {
 			remove_theme_mods();
 			WP_CLI::success( 'Theme mods removed.' );
 			return;