various fixes

Author: drzraf

features/search-replace-callback.feature

@@ -6,7 +6,11 @@ Feature: Test search-replace --callback option
     And a callback-function.php file:
       """
       <?php
-      function test_callback( $data, $replacement ) {
+      function test_callback( $data, $replacement, $search_regex ) {
+        // Assert that search_regex is null when not using --regex
+        if ( $search_regex !== null ) {
+          throw new Exception( 'Expected $search_regex to be null without --regex, got: ' . var_export( $search_regex, true ) );
+        }
         return str_replace( 'foo', strtoupper( $replacement ), $data );
       }
       """
@@ -42,6 +46,17 @@ Feature: Test search-replace --callback option
       """
       <?php
       function regex_callback( $data, $replacement, $search_regex ) {
+        // Assert that search_regex is provided when using --regex
+        if ( $search_regex === null ) {
+          throw new Exception( 'Expected $search_regex to be set with --regex, got null' );
+        }
+        if ( !is_string( $search_regex ) ) {
+          throw new Exception( 'Expected $search_regex to be a string, got: ' . gettype( $search_regex ) );
+        }
+        // Verify it's a valid regex pattern
+        if ( @preg_match( $search_regex, '' ) === false ) {
+          throw new Exception( '$search_regex is not a valid regex pattern: ' . $search_regex );
+        }
         // Replace matched digits with their square
         return preg_replace_callback( $search_regex, function( $matches ) {
           $num = (int)$matches[1];
@@ -127,3 +142,46 @@ Feature: Test search-replace --callback option
       """
       bar content
       """
+
+  @require-mysql
+  Scenario: Callback function receives opts parameter with table and column context
+    Given a WP install
+    And a callback-opts.php file:
+      """
+      <?php
+      function opts_callback( $data, $replacement, $search_regex, $opts ) {
+        // Only verify opts when we have a match for content columns
+        if ( strpos( $data, 'foo' ) !== false && isset( $opts['col'] ) && $opts['col'] === 'post_content' ) {
+          // Verify opts parameter exists and has expected structure
+          if ( !is_array( $opts ) ) {
+            throw new Exception( 'Expected $opts to be an array, got: ' . gettype( $opts ) );
+          }
+          if ( !isset( $opts['table'] ) ) {
+            throw new Exception( 'Expected $opts["table"] to be set' );
+          }
+          // Verify we're processing wp_posts table
+          if ( strpos( $opts['table'], 'posts' ) === false ) {
+            throw new Exception( 'Expected table to contain "posts", got: ' . $opts['table'] );
+          }
+          return str_replace( 'foo', $replacement, $data );
+        } elseif ( strpos( $data, 'foo' ) !== false ) {
+          // For other columns, just do the replacement without assertions
+          return str_replace( 'foo', $replacement, $data );
+        }
+        return $data;
+      }
+      """
+    And I run `wp post create --post_title='foo title' --post_content='foo content here' --porcelain`
+    And save STDOUT as {POST_ID}
+
+    When I run `wp search-replace 'foo' 'verified' wp_posts --include-columns=post_content --callback='opts_callback' --precise --require=callback-opts.php`
+    Then STDOUT should contain:
+      """
+      Success: Made 1 replacement.
+      """
+
+    When I run `wp post get {POST_ID} --field=content`
+    Then STDOUT should be:
+      """
+      verified content here
+      """

src/Search_Replace_Command.php

@@ -126,9 +126,9 @@ class Search_Replace_Command extends WP_CLI_Command {
 	 * table name maps to an array of column names, each of which maps to an array of
 	 * string values to match in the WHERE clause. If set to false, no filtering is applied.
 	 *
-	 * @var array<string, array<string, string[]>>|false
+	 * @var array<string, array<string, string[]>>
 	 */
-	private $where;
+	private $where = [];
 
 	/**
 	 * @var bool
@@ -219,7 +219,12 @@ class Search_Replace_Command extends WP_CLI_Command {
 	 * : Prints rows to the console as they're updated.
 	 *
 	 * [--callback=<user-function>]
-	 * : Runs a user-specified function on each string that contains <old>. <new> is passed as the second argument and the regex string as the third if it exists: call_user_func( 'callback', $data, $new, $search_regex ).
+	 * : Runs a user-specified function on each string that contains <old>. The callback is called as follows:
+	 *   call_user_func( 'callback', $data, $new, $search_regex, $opts )
+	 *   * $data is the matched string
+	 *   * $new is the replacement string
+	 *   * $search_regex is the regex pattern (if applicable, null otherwise)
+	 *   * $opts is an array of options.
 	 *
 	 * [--regex]
 	 * : Runs the search using a regular expression (without delimiters).

src/WP_CLI/SearchReplacer.php

@@ -97,6 +97,8 @@ public function __construct( $from, $to, $recurse_objects = false, $regex = fals
 	 * Ignores any serialized objects unless $recurse_objects is set to true.
 	 *
 	 * @param array|string $data            The data to operate on.
+	 * @param array        $opts            Additional options for the replacement passed through to the callback
+	 *  An array like: ['table' => $table, 'col' => $col, 'key' => $primary_keys]
 	 * @param bool         $serialised      Does the value of $data need to be unserialized?
 	 * @param array        $opts            Options for the callback.
 	 *