Merge pull request #159 from spacedmonkey/master

Add wp site meta sub-command

entity-command.php

@@ -27,6 +27,16 @@
 WP_CLI::add_command( 'post term', 'Post_Term_Command' );
 WP_CLI::add_command( 'post-type', 'Post_Type_Command' );
 WP_CLI::add_command( 'site', 'Site_Command' );
+WP_CLI::add_command( 'site meta', 'Site_Meta_Command', array(
+	'before_invoke' => function() {
+		if ( !is_multisite() ) {
+			WP_CLI::error( 'This is not a multisite installation.' );
+		}
+		if( function_exists('is_site_meta_supported') && !is_site_meta_supported() ){
+			WP_CLI::error( sprintf( 'The %s table is not installed. Please run the network database upgrade.', $GLOBALS['wpdb']->blogmeta ) );
+		}
+	}
+) );
 WP_CLI::add_command( 'site option', 'Site_Option_Command', array(
 	'before_invoke' => function() {
 		if ( !is_multisite() ) {

features/site-meta.feature

@@ -0,0 +1,36 @@
+Feature: Manage site custom fields
+
+  @require-wp-5.0
+  Scenario: Site meta CRUD
+    Given a WP multisite installation
+
+    When I run `wp site meta add 1 foo 'bar'`
+    Then STDOUT should not be empty
+
+    When I run `wp site meta get 1 foo`
+    Then STDOUT should be:
+      """
+      bar
+      """
+
+    When I try `wp site meta get 999999 foo`
+    Then STDERR should be:
+      """
+      Error: Could not find the site with ID 999999.
+      """
+    And the return code should be 1
+
+    When I run `wp site meta set 1 foo '[ "1", "2" ]' --format=json`
+    Then STDOUT should not be empty
+
+    When I run `wp site meta get 1 foo --format=json`
+    Then STDOUT should be:
+      """
+      ["1","2"]
+      """
+
+    When I run `wp site meta delete 1 foo`
+    Then STDOUT should not be empty
+
+    When I try `wp site meta get 1 foo`
+    Then the return code should be 1

src/Site_Meta_Command.php

@@ -0,0 +1,112 @@
+<?php
+
+/**
+ * Adds, updates, deletes, and lists site custom fields.
+ *
+ * ## EXAMPLES
+ *
+ *     # Set site meta
+ *     $ wp site meta set 123 bio "Mary is a WordPress developer."
+ *     Success: Updated custom field 'bio'.
+ *
+ *     # Get site meta
+ *     $ wp site meta get 123 bio
+ *     Mary is a WordPress developer.
+ *
+ *     # Update site meta
+ *     $ wp site meta update 123 bio "Mary is an awesome WordPress developer."
+ *     Success: Updated custom field 'bio'.
+ *
+ *     # Delete site meta
+ *     $ wp site meta delete 123 bio
+ *     Success: Deleted custom field.
+ */
+class Site_Meta_Command extends \WP_CLI\CommandWithMeta {
+	protected $meta_type = 'blog';
+
+	/**
+	 * Check that the site ID exists
+	 *
+	 * @param int
+	 */
+	protected function check_object_id( $object_id ) {
+		$fetcher = new \WP_CLI\Fetchers\Site;
+		$site = $fetcher->get_check( $object_id );
+		return $site->blog_id;
+	}
+
+	/**
+	 * Wrapper method for add_metadata that can be overridden in sub classes.
+	 *
+	 * @param int    $object_id  ID of the object the metadata is for.
+	 * @param string $meta_key   Metadata key to use.
+	 * @param mixed  $meta_value Metadata value. Must be serializable if
+	 *                           non-scalar.
+	 * @param bool   $unique     Optional, default is false. Whether the
+	 *                           specified metadata key should be unique for the
+	 *                           object. If true, and the object already has a
+	 *                           value for the specified metadata key, no change
+	 *                           will be made.
+	 *
+	 * @return int|false The meta ID on success, false on failure.
+	 */
+	protected function add_metadata( $object_id, $meta_key, $meta_value, $unique = false ) {
+		return add_site_meta( $object_id, $meta_key, $meta_value, $unique );
+	}
+
+	/**
+	 * Wrapper method for update_metadata that can be overridden in sub classes.
+	 *
+	 * @param int    $object_id  ID of the object the metadata is for.
+	 * @param string $meta_key   Metadata key to use.
+	 * @param mixed  $meta_value Metadata value. Must be serializable if
+	 *                           non-scalar.
+	 * @param mixed  $prev_value Optional. If specified, only update existing
+	 *                           metadata entries with the specified value.
+	 *                           Otherwise, update all entries.
+	 *
+	 * @return int|bool Meta ID if the key didn't exist, true on successful
+	 *                  update, false on failure.
+	 */
+	protected function update_metadata( $object_id, $meta_key, $meta_value, $prev_value = '' ) {
+		return update_site_meta( $object_id, $meta_key, $meta_value, $prev_value );
+	}
+
+	/**
+	 * Wrapper method for get_metadata that can be overridden in sub classes.
+	 *
+	 * @param int    $object_id ID of the object the metadata is for.
+	 * @param string $meta_key  Optional. Metadata key. If not specified,
+	 *                          retrieve all metadata for the specified object.
+	 * @param bool   $single    Optional, default is false. If true, return only
+	 *                          the first value of the specified meta_key. This
+	 *                          parameter has no effect if meta_key is not
+	 *                          specified.
+	 *
+	 * @return mixed Single metadata value, or array of values.
+	 */
+	protected function get_metadata( $object_id, $meta_key = '', $single = false ) {
+		return get_site_meta( $object_id, $meta_key, $single );
+	}
+
+	/**
+	 * Wrapper method for delete_metadata that can be overridden in sub classes.
+	 *
+	 * @param int    $object_id  ID of the object metadata is for
+	 * @param string $meta_key   Metadata key
+	 * @param mixed $meta_value  Optional. Metadata value. Must be serializable
+	 *                           if non-scalar. If specified, only delete
+	 *                           metadata entries with this value. Otherwise,
+	 *                           delete all entries with the specified meta_key.
+	 *                           Pass `null, `false`, or an empty string to skip
+	 *                           this check. For backward compatibility, it is
+	 *                           not possible to pass an empty string to delete
+	 *                           those entries with an empty string for a value.
+	 *
+	 * @return bool True on successful delete, false on failure.
+	 */
+	protected function delete_metadata( $object_id, $meta_key, $meta_value = '' ) {
+		return delete_site_meta( $object_id, $meta_key, $meta_value );
+	}
+
+}