Merge branch 'master' into issue/doc-verbs

Author: danielbachhuber

README.md

@@ -10,7 +10,7 @@ Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contr
 ## Using
 
 ~~~
-wp search-replace <old> <new> [<table>...] [--dry-run] [--network] [--all-tables-with-prefix] [--all-tables] [--export[=<file>]] [--export_insert_size=<rows>] [--skip-columns=<columns>] [--include-columns=<columns>] [--precise] [--recurse-objects] [--verbose] [--regex] [--regex-flags=<regex-flags>] [--regex-delimiter=<regex-delimiter>] [--format=<format>] [--report] [--report-changed-only] [--log[=<file>]] [--before_context=<num>] [--after_context=<num>]
+wp search-replace <old> <new> [<table>...] [--dry-run] [--network] [--all-tables-with-prefix] [--all-tables] [--export[=<file>]] [--export_insert_size=<rows>] [--skip-tables=<tables>] [--skip-columns=<columns>] [--include-columns=<columns>] [--precise] [--recurse-objects] [--verbose] [--regex] [--regex-flags=<regex-flags>] [--regex-delimiter=<regex-delimiter>] [--format=<format>] [--report] [--report-changed-only] [--log[=<file>]] [--before_context=<num>] [--after_context=<num>]
 ~~~
 
 Searches through all rows in a selection of tables and replaces
@@ -61,6 +61,10 @@ change primary key values.
 		You might want to change this depending on your database configuration
 		(e.g. if you need to do fewer queries). Default: 50
 
+	[--skip-tables=<tables>]
+		Do not perform the replacement on specific tables. Use commas to
+		specify multiple tables.
+
 	[--skip-columns=<columns>]
 		Do not perform the replacement on specific columns. Use commas to
 		specify multiple columns.
@@ -135,9 +139,9 @@ change primary key values.
     # Bash script: Search/replace production to development url (multisite compatible)
     #!/bin/bash
     if $(wp --url=http://example.com core is-installed --network); then
-        wp search-replace --url=http://example.com 'http://example.com' 'http://example.dev' --recurse-objects --network --skip-columns=guid
+        wp search-replace --url=http://example.com 'http://example.com' 'http://example.dev' --recurse-objects --network --skip-columns=guid --skip-tables=wp_users
     else
-        wp search-replace 'http://example.com' 'http://example.dev' --recurse-objects --skip-columns=guid
+        wp search-replace 'http://example.com' 'http://example.dev' --recurse-objects --skip-columns=guid --skip-tables=wp_users
     fi
 
 ## Installing

features/search-replace-export.feature

@@ -20,6 +20,12 @@ Feature: Search / replace with file export
       http://example.com
       """
 
+    When I run `wp search-replace example.com example.net --skip-tables=wp_options --export`
+    Then STDOUT should not contain:
+      """
+      INSERT INTO `wp_options`
+      """
+
     When I run `wp search-replace example.com example.net --skip-columns=option_value --export`
     Then STDOUT should contain:
       """
@@ -33,7 +39,7 @@ Feature: Search / replace with file export
       ('1', 'siteurl', 'http://example.com', 'yes');
     INSERT INTO `wp_options` (`option_id`, `option_name`, `option_value`, `autoload`) VALUES 
       """
-          
+
     When I run `wp search-replace foo bar --export | tail -n 1`
     Then STDOUT should not contain:
       """

features/search-replace.feature

@@ -9,6 +9,12 @@ Feature: Do global search/replace
       guid
       """
 
+    When I run `wp search-replace foo bar --skip-tables=wp_posts`
+    Then STDOUT should not contain:
+      """
+      wp_posts
+      """
+
     When I run `wp search-replace foo bar --skip-columns=guid`
     Then STDOUT should not contain:
       """
@@ -657,7 +663,7 @@ Feature: Do global search/replace
     When I run `wp post create --post_title='Title_baz__baz_' --post_content='Content_baz_12345678901234567890_baz_12345678901234567890' --porcelain`
     Then save STDOUT as {POST_ID}
 
-    When I run `wp search-replace '_baz_' '_' --dry-run --log  --before_context=10 --after_context=10`
+    When I run `wp search-replace '_baz_' '_' wp_posts --dry-run --log  --before_context=10 --after_context=10`
     Then STDOUT should contain:
       """
       Success: 2 replacements to be made.
@@ -681,7 +687,7 @@ Feature: Do global search/replace
       """
     And STDERR should be empty
 
-    When I run `wp search-replace '_baz_' '' --dry-run --log=replace.log`
+    When I run `wp search-replace '_baz_' '' wp_posts --dry-run --log=replace.log`
     Then STDOUT should contain:
       """
       Success: 2 replacements to be made.
@@ -705,7 +711,7 @@ Feature: Do global search/replace
     And STDERR should be empty
 
     # kana with diacritic and decomposed "a" + umlaut.
-    When I run `wp search-replace '_baz_' '_バäz_' --log=- --before_context=10 --after_context=20`
+    When I run `wp search-replace '_baz_' '_バäz_' wp_posts --log=- --before_context=10 --after_context=20`
     Then STDOUT should contain:
       """
       Success: Made 2 replacements.
@@ -719,7 +725,7 @@ Feature: Do global search/replace
     And STDERR should be empty
 
     # Testing UTF-8 context
-    When I run `wp search-replace 'z_' 'zzzz_' --log --before_context=2 --after_context=1`
+    When I run `wp search-replace 'z_' 'zzzz_' wp_posts --log --before_context=2 --after_context=1`
     Then STDOUT should contain:
       """
       Success: Made 2 replacements.
@@ -810,7 +816,7 @@ Feature: Do global search/replace
     When I run `wp post create --post_title='Title_baz__boz_' --post_content='Content_baz_1234567890_bez_1234567890_biz_1234567890_boz_1234567890_buz_' --porcelain`
     Then save STDOUT as {POST_ID}
 
-    When I run `wp search-replace '_b[aeiou]z_' '_bz_' --regex --dry-run --log  --before_context=11 --after_context=11`
+    When I run `wp search-replace '_b[aeiou]z_' '_bz_' wp_posts --regex --dry-run --log  --before_context=11 --after_context=11`
     Then STDOUT should contain:
       """
       Success: 2 replacements to be made.
@@ -834,7 +840,7 @@ Feature: Do global search/replace
       """
     And STDERR should be empty
 
-    When I run `wp search-replace '_b([aeiou])z_' '_$1b\\1z_\0' --regex --log  --before_context=11 --after_context=11`
+    When I run `wp search-replace '_b([aeiou])z_' '_$1b\\1z_\0' wp_posts --regex --log  --before_context=11 --after_context=11`
     Then STDOUT should contain:
       """
       Success: Made 2 replacements.

src/Search_Replace_Command.php

@@ -9,6 +9,7 @@ class Search_Replace_Command extends WP_CLI_Command {
 	private $regex;
 	private $regex_flags;
 	private $regex_delimiter;
+	private $skip_tables;
 	private $skip_columns;
 	private $include_columns;
 	private $format;
@@ -74,6 +75,10 @@ class Search_Replace_Command extends WP_CLI_Command {
 	 * You might want to change this depending on your database configuration
 	 * (e.g. if you need to do fewer queries). Default: 50
 	 *
+	 * [--skip-tables=<tables>]
+	 * : Do not perform the replacement on specific tables. Use commas to
+	 * specify multiple tables.
+	 *
 	 * [--skip-columns=<columns>]
 	 * : Do not perform the replacement on specific columns. Use commas to
 	 * specify multiple columns.
@@ -148,9 +153,9 @@ class Search_Replace_Command extends WP_CLI_Command {
 	 *     # Bash script: Search/replace production to development url (multisite compatible)
 	 *     #!/bin/bash
 	 *     if $(wp --url=http://example.com core is-installed --network); then
-	 *         wp search-replace --url=http://example.com 'http://example.com' 'http://example.dev' --recurse-objects --network --skip-columns=guid
+	 *         wp search-replace --url=http://example.com 'http://example.com' 'http://example.dev' --recurse-objects --network --skip-columns=guid --skip-tables=wp_users
 	 *     else
-	 *         wp search-replace 'http://example.com' 'http://example.dev' --recurse-objects --skip-columns=guid
+	 *         wp search-replace 'http://example.com' 'http://example.dev' --recurse-objects --skip-columns=guid --skip-tables=wp_users
 	 *     fi
 	 */
 	public function __invoke( $args, $assoc_args ) {
@@ -195,6 +200,7 @@ public function __invoke( $args, $assoc_args ) {
 		}
 
 		$this->skip_columns = explode( ',', \WP_CLI\Utils\get_flag_value( $assoc_args, 'skip-columns' ) );
+		$this->skip_tables = explode( ',', \WP_CLI\Utils\get_flag_value( $assoc_args, 'skip-tables' ) );
 		$this->include_columns = array_filter( explode( ',', \WP_CLI\Utils\get_flag_value( $assoc_args, 'include-columns' ) ) );
 
 		if ( $old === $new && ! $this->regex ) {
@@ -269,8 +275,13 @@ public function __invoke( $args, $assoc_args ) {
 
 		// Get table names based on leftover $args or supplied $assoc_args
 		$tables = \WP_CLI\Utils\wp_get_table_names( $args, $assoc_args );
+
 		foreach ( $tables as $table ) {
 
+			if ( in_array( $table, $this->skip_tables ) ) {
+				continue;
+			}
+
 			$table_sql = self::esc_sql_ident( $table );
 
 			if ( $this->export_handle ) {