Feature: Call user function with --callback flag #104

brandonkal · 2018-12-15T04:49:30Z

This PR adds the ability to run a user function on search results if a match is found.
In my case, I needed this to change image src urls based on attachment id and size where a hash is a required part of the url.

Abstract `wp export` to wp-cli/export-command

``` Loading composer repositories with package information Updating dependencies (including require-dev) Package operations: 0 installs, 14 updates, 0 removals - Updating symfony/yaml (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/filesystem (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/config (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/debug (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/dependency-injection (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/event-dispatcher (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/translation (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/process (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/finder (v2.8.17 => v2.8.18): Loading from cache - Updating symfony/console (v2.8.17 => v2.8.18): Loading from cache - Updating seld/jsonlint (1.5.0 => 1.6.0): Loading from cache - Updating justinrainbow/json-schema (4.1.0 => 5.1.0): Loading from cache - Updating composer/ca-bundle (1.0.6 => 1.0.7): Loading from cache - Updating composer/composer (1.3.2 => 1.4.1): Loading from cache Writing lock file Generating autoload files ```

Update Composer dependencies (3/10/2017)

This reverts commit 749466f.

5c6823a

Transform sub/sub directories into a proper dbprefix

Abstract `wp package *` to a separate wp-cli/package-command package

Doing so ensures tests run against local copy of command, instead of Phar bundled version.

Use Composer to install WP-CLI in tests

Include `"prefer-stable": true,` to always prefer stability

Require any WP-CLI, but install dev-master for tests

To allow for versions like 1.2.0 as well, the branch alias for `dev-master` needs to be changed from `1.0.x-dev` to `1.x-dev`.

Correct `dev-master` alias.

Update testing framework.

Fix Travis CI caching for composer

brandonkal · 2018-12-15T09:02:25Z

I am hoping someone is willing and able to test this out and release it in or let me know what needs to change. I am glad the CI tests are passing now. I am not able to test this locally because it appears to have conflicts with the search-replace that is installed by default.

So I am seeing this even though I am passing 9 args in the new version:

Uncaught ArgumentCountError: Too few arguments to function WP_CLI\SearchReplacer::__construct(),
8 passed in phar:///usr/local/bin/wp/vendor/wp-cli/search-replace-command/src/Search_Replace_Command.php on line 489
and exactly 9 expected in
/home/brandonkal/.wp-cli/packages/vendor/wp-cli/search-replace-command/src/WP_CLI/SearchReplacer.php:31

I installed my fork as explained in the README:

wp package install [email protected]:brandonkal/search-replace-command.git

Thanks

swissspidy · 2018-12-15T10:30:56Z

Try updating to WP-CLI nightly

brandonkal · 2018-12-15T10:50:42Z

Installing the nightly version fixed the issue. Everything looks good so far but I will report back after some more thorough testing.

brandonkal · 2018-12-15T14:33:39Z

Tested thoroughly and everything looks good to go!

.editorconfig

src/Search_Replace_Command.php

src/WP_CLI/SearchReplacer.php

schlessera · 2019-02-21T08:21:06Z

@brandonkal The PR looks good at first glance. We still need to add functional tests through Behat. Are you able to add these?

schlessera · 2019-04-01T12:54:34Z

@brandonkal Are you interested in providing the required Behat tests to move this over the finish line?

schlessera · 2019-07-24T21:43:30Z

@brandonkal Gentle ping to see if you are up for adding the needed tests...?

brandonkal · 2019-07-25T00:37:54Z

Thank you for the reminder @schlessera. I forgot about this. I am not very familiar with Behat and my WordPress projects are currently on hold so I expect it will be a few months before I can look into this again.
If anyone is willing to add the tests in the meantime, I've allowed edits on this PR.

drzraf · 2019-09-11T18:16:34Z

src/WP_CLI/SearchReplacer.php

+					$check = true; // Set to avoid bogus error on strpos
+
+					if ( $this->callback ) {
+						if ( $check = strpos( $data, $this->from ) !== false ) {


Given that we are if ( $this->regex ) { , what's the purpose of this strpos() check? Shoudn't we just proceed with call_user_func ?

drzraf · 2019-09-11T19:21:10Z

src/WP_CLI/SearchReplacer.php

+
+					if ( $this->callback ) {
+						if ( $check = strpos( $data, $this->from ) !== false ) {
+							$result = \call_user_func( $this->callback, $data, $this->to, $search_regex );


Would passing $this->form (or $this) makes more sense thant $search_regex

Because callback may need raw $from

Because callback does replace which may rely on regex_limit / flags individually

danielbachhuber · 2022-07-07T15:21:07Z

@wp-cli/committers There might be a much easier approach here: call apply_filters() if it exists. What do you think?

drzraf · 2022-07-11T02:32:43Z

I implemented callback support within #128
It relies upon callback's name being passed as an option, rely upon call_user_func and should easily made a filter.

From a quick look, a filter sounds better because:

Multiple callbacks can be run
It allows plugin's own code to rely upon this very filter to implement "built-in / handy / predefined callbacks"
It avoids passing callback's name down the function stack
It does not require the user to write more boilerplate code to implement such a callback than to define a top-level function.

danielbachhuber · 2022-11-18T17:07:27Z

Proceeding with wp-cli/wp-cli#5594 for this repository. I've captured this PR to https://gist.github.com/danielbachhuber/f4bb0f6caaebc2c8a6390adc19cd1f50 in case this PR is auto-closed or broken in some way.

Added --revision / --no-revision Added --callback Reroll wp-cli#104, wp-cli#128 Fixes wp-cli#125, wp-cli#127, wp-cli#142

danielbachhuber and others added 30 commits March 10, 2017 08:39

Merge pull request #3887 from wp-cli/3728-export-command

09dee0d

Abstract `wp export` to wp-cli/export-command

Merge branch 'master' into sub-sub-directories

87c695e

Clearly specify what this is about

d9f1aad

Merge pull request #3894 from wp-cli/update-deps-2017-03-10

8439893

Update Composer dependencies (3/10/2017)

Remove WP-CLI files unrelated to wp package *

749466f

Revert "Remove WP-CLI files unrelated to wp package *"

68f685a

This reverts commit 749466f.

Abstract wp package * to a separate wp-cli/package-command package

5c6823a

Require the actual package, which was missed in

bc78b8d

5c6823a

wp package needs to be run after packages are loaded

0ab1d7a

Remove command tests, which are now covered in the subpackage

1da363f

Merge pull request #3889 from wp-cli/sub-sub-directories

f2280c8

Transform sub/sub directories into a proper dbprefix

Merge pull request #3895 from wp-cli/3728-package-command

f8d3ed8

Abstract `wp package *` to a separate wp-cli/package-command package

Remove WP-CLI files unrelated to wp search-replace

c0ae01d

Use PSR-4 autoloading of existing classes; add remaining test files

9d354ae

Don't unnecessarily register the command twice

28841da

Use Composer to install WP-CLI in tests

bd2fd7f

Doing so ensures tests run against local copy of command, instead of Phar bundled version.

Remove unnecessary class_exists() check

d6fff6e

Merge pull request wp-cli#2 from wp-cli/composer-tests

48d4d9a

Use Composer to install WP-CLI in tests

Include "prefer-stable": true, to always prefer stability

ae03a50

Merge pull request wp-cli#3 from wp-cli/prefer-stable

556a7bb

Include `"prefer-stable": true,` to always prefer stability

Require any WP-CLI, but install dev-master for tests

469306a

Merge pull request wp-cli#5 from wp-cli/require-any

878a6c0

Require any WP-CLI, but install dev-master for tests

Correct dev-master alias.

a173e1f

To allow for versions like 1.2.0 as well, the branch alias for `dev-master` needs to be changed from `1.0.x-dev` to `1.x-dev`.

Merge pull request wp-cli#6 from wp-cli/correct-dev-master-alias

b41ee0e

Correct `dev-master` alias.

Update testing framework.

e1a29e3

Merge pull request wp-cli#7 from wp-cli/update-testing-framework

b02e02d

Update testing framework.

Fix Travis CI caching for composer

d7b162a

Merge pull request wp-cli#9 from ntwb/patch-1

dc4be1b

Fix Travis CI caching for composer

Clarify this command as a bundled command

92ffcbf

brandonkal added 3 commits December 15, 2018 00:08

fixes

f9c9123

pass callback

4e170cd

callback prop is now false by default

758cd16

brandonkal added 2 commits December 15, 2018 03:20

load WP

7b5e9a3

set result when skipping function call

6f3fa7e

schlessera requested changes Dec 17, 2018

View reviewed changes

schlessera added the command:search-replace label Dec 17, 2018

brandonkal added 3 commits December 17, 2018 01:36

suggested changes

f51ae66

resolve PHP only and fix original code to use error over warning

1ef372a

back to warning and exit for tests

bdcd47d

danielbachhuber requested a review from schlessera February 18, 2019 14:46

drzraf reviewed Sep 11, 2019

View reviewed changes

drzraf mentioned this pull request Sep 18, 2019

Replacement callback & row-based filtering #128

Closed

danielbachhuber closed this Nov 18, 2022

danielbachhuber force-pushed the master branch from 288c656 to fa755eb Compare November 18, 2022 17:08

danielbachhuber requested a review from a team as a code owner November 18, 2022 17:08

drzraf added a commit to drzraf/search-replace-command that referenced this pull request Jun 12, 2023

Added --where flag to finely select rows aimed for replacement

5c40a62

Added --revision / --no-revision Added --callback Reroll wp-cli#104, wp-cli#128 Fixes wp-cli#125, wp-cli#127, wp-cli#142

drzraf mentioned this pull request Jun 12, 2023

skip-revisions, select columns, callbacks = The forever reroll #184

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Call user function with --callback flag #104

Feature: Call user function with --callback flag #104

brandonkal commented Dec 15, 2018

brandonkal commented Dec 15, 2018

swissspidy commented Dec 15, 2018

brandonkal commented Dec 15, 2018

brandonkal commented Dec 15, 2018

schlessera commented Feb 21, 2019

schlessera commented Apr 1, 2019

schlessera commented Jul 24, 2019

brandonkal commented Jul 25, 2019

drzraf Sep 11, 2019

drzraf Sep 11, 2019

danielbachhuber commented Jul 7, 2022

drzraf commented Jul 11, 2022

danielbachhuber commented Nov 18, 2022

Feature: Call user function with --callback flag #104

Feature: Call user function with --callback flag #104

Conversation

brandonkal commented Dec 15, 2018

brandonkal commented Dec 15, 2018

swissspidy commented Dec 15, 2018

brandonkal commented Dec 15, 2018

brandonkal commented Dec 15, 2018

schlessera commented Feb 21, 2019

schlessera commented Apr 1, 2019

schlessera commented Jul 24, 2019

brandonkal commented Jul 25, 2019

drzraf Sep 11, 2019

Choose a reason for hiding this comment

drzraf Sep 11, 2019

Choose a reason for hiding this comment

danielbachhuber commented Jul 7, 2022

drzraf commented Jul 11, 2022

danielbachhuber commented Nov 18, 2022