Introduce a list command to list all transients

Author: ocean90

features/transient.feature

@@ -27,6 +27,29 @@ Feature: Manage WordPress transient cache
       Success: Transient deleted.
       """
 
+  Scenario: List transients
+    Given a WP install
+    And I run `wp transient set foo bar`
+    And I run `wp transient set foo2 bar2 610`
+    And I run `wp transient set foo3 bar3 --network`
+    And I run `wp transient set foo4 bar4 610 --network`
+
+    When I run `wp transient list --format=csv`
+    Then STDOUT should be:
+      """
+      name,value,expiration
+      foo,bar,"no expiration"
+      foo2,bar2,"10 mins"
+      """
+
+    When I run `wp transient list --network --format=csv`
+    Then STDOUT should be:
+      """
+      name,value,expiration
+      foo3,bar3,"no expiration"
+      foo4,bar4,"10 mins"
+      """
+
   Scenario: Network transient CRUD
     Given a WP multisite install
     And I run `wp site create --slug=foo`
@@ -55,6 +78,29 @@ Feature: Manage WordPress transient cache
       Success: Transient deleted.
       """
 
+  Scenario: List network transients
+    Given a WP multisite install
+    And I run `wp transient set foo bar`
+    And I run `wp transient set foo2 bar2 610`
+    And I run `wp transient set foo3 bar3 --network`
+    And I run `wp transient set foo4 bar4 610 --network`
+
+    When I run `wp transient list --format=csv`
+    Then STDOUT should be:
+      """
+      name,value,expiration
+      foo,bar,"no expiration"
+      foo2,bar2,"10 mins"
+      """
+
+    When I run `wp transient list --network --format=csv`
+    Then STDOUT should be:
+      """
+      name,value,expiration
+      foo3,bar3,"no expiration"
+      foo4,bar4,"10 mins"
+      """
+
   Scenario: Transient delete and other flags
     Given a WP install
 

src/Transient_Command.php

@@ -220,6 +220,139 @@ public function type() {
 		WP_CLI::line( $message );
 	}
 
+	/**
+	 * Lists transients and their values.
+	 *
+	 * ## OPTIONS
+	 *
+	 * [--network]
+	 * : Get the values of network|site transients. On single site, this is
+	 * is a specially-named cache key. On multisite, this is a global cache
+	 * (instead of local to the site).
+	 *
+	 * [--unserialize]
+	 * : Unserialize transient values in output.
+	 *
+	 * [--fields=<fields>]
+	 * : Limit the output to specific object fields.
+	 *
+	 * [--format=<format>]
+	 * : The serialization format for the value.
+	 * ---
+	 * default: table
+	 * options:
+	 *   - table
+	 *   - json
+	 *   - csv
+	 *   - count
+	 *   - yaml
+	 * ---
+	 *
+	 * ## AVAILABLE FIELDS
+	 *
+	 * This field will be displayed by default for each matching option:
+	 *
+	 * * name
+	 * * value
+	 * * expiration
+	 *
+	 * ## EXAMPLES
+	 *
+	 *     # List all transients
+	 *     $ wp transient list
+	*      +------+-------+---------------+
+	*      | name | value | expiration    |
+	*      +------+-------+---------------+
+	*      | foo  | bar   | 39 mins       |
+	*      | foo2 | bar2  | no expiration |
+	*      | foo3 | bar2  | expired       |
+	*      | foo4 | bar4  | 4 hours       |
+	*      +------+-------+---------------+
+	 *
+	 * @subcommand list
+	 */
+	public function _list( $args, $assoc_args ) {
+		global $wpdb;
+
+		$fields      = array( 'name', 'value', 'expiration' );
+		$network     = \WP_CLI\Utils\get_flag_value( $assoc_args, 'network', false );
+		$unserialize = \WP_CLI\Utils\get_flag_value( $assoc_args, 'unserialize', false );
+
+		if ( isset( $assoc_args['fields'] ) ) {
+			$fields = explode( ',', $assoc_args['fields'] );
+		}
+
+		if ( $network ) {
+			if ( is_multisite() ) {
+				$query = $wpdb->prepare(
+					"SELECT `meta_key` as `name`, `meta_value` as `value` FROM {$wpdb->sitemeta} WHERE meta_key LIKE %s AND meta_key NOT LIKE %s",
+					\WP_CLI\Utils\esc_like( '_site_transient_' ) . '%',
+					\WP_CLI\Utils\esc_like( '_site_transient_timeout_' ) . '%'
+				);
+			} else {
+				$query = $wpdb->prepare(
+					"SELECT `option_name` as `name`, `option_value` as `value` FROM {$wpdb->options} WHERE option_name LIKE %s AND option_name NOT LIKE %s",
+					\WP_CLI\Utils\esc_like( '_site_transient_' ) . '%',
+					\WP_CLI\Utils\esc_like( '_site_transient_timeout_' ) . '%'
+				);
+			}
+		} else {
+			$query = $wpdb->prepare(
+				"SELECT `option_name` as `name`, `option_value` as `value` FROM {$wpdb->options} WHERE option_name LIKE %s AND option_name NOT LIKE %s",
+				\WP_CLI\Utils\esc_like( '_transient_' ) . '%',
+				\WP_CLI\Utils\esc_like( '_transient_timeout_' ) . '%'
+			);
+		}
+
+		$results = $wpdb->get_results( $query );
+
+		foreach ( $results as $result ) {
+			$result->name       = str_replace( array( '_site_transient_', '_transient_' ), '', $result->name );
+			$result->expiration = $this->get_transient_expiration( $result->name, $network );
+
+			if ( $unserialize ) {
+				$result->value = maybe_unserialize( $result->value );
+			}
+		}
+
+		$formatter = new \WP_CLI\Formatter(
+			$assoc_args,
+			$fields
+		);
+		$formatter->display_items( $results );
+	}
+
+	/**
+	 * Retrieves the human-friendly expiration time.
+	 *
+	 * @param string $name              Transient name.
+	 * @param bool   $is_site_transient Optional. Whether this is a site transient. Default false.
+	 * @return string Expiration time string.
+	 */
+	private function get_transient_expiration( $name, $is_site_transient = false ) {
+		if ( $is_site_transient ) {
+			if ( is_multisite() ) {
+				$expiration = (int) get_site_option( '_site_transient_timeout_' . $name );
+			} else {
+				$expiration = (int) get_option( '_site_transient_timeout_' . $name );
+			}
+		} else {
+			$expiration = (int) get_option( '_transient_timeout_' . $name );
+		}
+
+		if ( 0 === $expiration ) {
+			return 'no expiration';
+		}
+
+		$now = time();
+
+		if ( $now > $expiration ) {
+			return 'expired';
+		}
+
+		return human_time_diff( $now, $expiration );
+	}
+
 	/**
 	 * Deletes all expired transients.
 	 */