First pass at constant/variable transformation by frankiejarrett · Pull Request #1 · wp-cli/wp-config-transformer

frankiejarrett · 2017-12-20T08:36:01Z

@danielbachhuber API here is pretty self-explanatory. So far it seems to work pretty well.

Going continue to poke at it and get a test framework in place so we can throw in a ton of scenarios.

Examples:

$config_transformer = new WPConfigTransformer( '/path/to/wp-config.php' );
$config_transformer->exists( 'constant', 'DB_HOST' );              // Returns true
$config_transformer->add( 'constant', 'DB_HOST', 'localhost' );    // Returns false
$config_transformer->update( 'constant', 'DB_HOST', 'localhost' ); // Returns true
$config_transformer->remove( 'constant', 'DB_HOST' );              // Returns true

Examples using raw values:

$config_transformer->update( 'constant', 'FS_CHMOD_DIR', '(0755 & ~ umask())', [ 'raw' => true ] );
$config_transformer->update( 'constant', 'ABSPATH', "dirname( __FILE__ ) . '/somewhere/else/'", [ 'raw' => true ] );
$config_transformer->update( 'constant', 'WP_DEBUG', 'true', [ 'raw' => true ] );
$config_transformer->update( 'constant', 'FOO', "array( 'baz', 'qux' )", [ 'raw' => true ] );
$config_transformer->update( 'constant', 'BAR', 'null', [ 'raw' => true ] );

Variables also work:

$config_transformer->update( 'variable', 'table_prefix', 'wp_foo_' );

danielbachhuber · 2017-12-20T13:06:32Z

💯 so cool!

frankiejarrett · 2017-12-20T23:56:52Z

Added a bunch of thoughts to the README to explain how this all works.

schlessera · 2017-12-23T07:01:10Z

@fjarrett Looks great so far!

This will obviously need a robust set of unit tests to make sure we can rely on these changes to work across the board. You've mentioned in the description that you'll take care of tests as well, but feel free to ping me when you need help with anything!

schlessera · 2017-12-27T09:49:58Z

Travis is missing a composer install step. That's why you're getting the error that the vendor/autoload.php file is missing.

frankiejarrett · 2017-12-29T16:48:46Z

Thanks @schlessera! First round of changes pushed based on your feedback.

schlessera · 2017-12-29T17:02:43Z

@fjarrett Looks good.
I think you misinterpreted my comment about the short description, though. If you click through the link I provided to WPCS, you can see that it requires the third person singular form.

So, instead of this:

Apply formatting to a config value.

WPCS requires this:

Applies formatting to a config value.

You write the short description as if the sentence would start with the pronoun it, referring to the function/method:

[It] Applies formatting to a config value.

frankiejarrett · 2018-01-01T20:23:21Z

Travis is throwing disk quota exceeded errors - hoping that will clear up on its own...

schlessera · 2018-01-02T12:47:25Z

Seems to have been a temporary issue, a restart got us through successfully.

schlessera · 2018-01-24T15:37:56Z

Merging this as is so it can more easily be used and tested. Any improvements/fixes will be separate PRs.

gitlost · 2018-01-26T12:02:42Z

@schlessera so the thing to do here first is to review wp-cli/wp-config-transformer for bundling? Or has it been sufficiently reviewed and we just need to do a PR on wp-cli/wp-cli to bundle it?

(Am reviewing this PR anyway...)

Edit: meant to do this and following comment on wp-cli/config-command#44.

gitlost · 2018-01-26T12:09:16Z

As it's just one file and phpunit tests I'm wondering if it wouldn't be best/simplest to merge wp-cli/wp-config-transformer into this repo.....?

schlessera · 2018-01-26T16:30:47Z

One of the original goals was to create a stand-alone library to deal with wp-config.php modifications, as having a WP-CLI command to do it is just one individual use case. There are other instances where such a library can be useful as well.

gitlost · 2018-01-26T17:15:10Z

Hmm, okay, but having all these separate repos is a logistical nightmare to be honest.

So this repo is reviewed and just needs to be bundled then?

Edit: And released.

(Unfortunately I'm very stuck for time today and won't get back to doing WP-CLI stuff until tonight.)

gitlost · 2018-01-27T02:08:19Z

Oh okay I see it's already released. And will be "bundled" with config-command as soon as wp-cli/config-command#44 is merged.

So the only (but big) to-do item is to change make-phar.php to include it?

Edit: turns out no change needed for make-phar.php.

frankiejarrett added 5 commits December 20, 2017 01:27

First pass

26aebcd

Remove get method

adbd2e3

Add example for remove

f52008f

Improve docs for raw

f729094

Update throw docs

3a6e202

frankiejarrett added 13 commits December 20, 2017 10:29

Fix regex for config remove

9a00e7d

Whitespace already in config src

907ec27

Minor code format tweak

5801527

Support case arg in define, only replace value part

ba9eb06

Fix remove regex match

ebf4168

Ignore dup variables, last one wins

01b761b

Use delimiter in preg_quote

1f11410

Throw exception to prevent empty save

0996210

Use exact regex match for update/remove

30002f6

Support options array for special behavior

5f339b8

Update README

943c05e

Remove line from README

b7666b7

Add more sections to README

3e255d0

frankiejarrett added 2 commits December 20, 2017 18:08

README update

ec79b5a

README update

0e3aa93

Add tests, improve targeting

77b7a04

frankiejarrett added 5 commits December 28, 2017 11:24

Update travis config

7237cbe

Remove file after test

82fedfb

Add composer.json

daf92bb

Test with many php versions

586ac89

Autoload

efa383e

schlessera mentioned this pull request Dec 29, 2017

Document licensing expectations wp-cli/handbook#188

Closed

frankiejarrett added 8 commits December 29, 2017 10:05

MIT license

360b394

Tweak doc block short descriptions

fb7bae0

Change some test terminology

62d47e4

Support for php53

308433c

Use precise for php53

c2b1c59

Remove php53 from main list

69c448b

Add license file

b7686cc

Update README and add CONTRIBUTING

4e05195

frankiejarrett added 7 commits December 29, 2017 11:15

Use singular third person descriptions

1dcd870

Use matrix for php versions

3a19180

Support sniffs

92c9748

Run tests in stages

61ea68e

Skip PHP comments, support multiple per line

6e26840

Update readme

73fa619

Support short tags

0066bb5

danielbachhuber mentioned this pull request Jan 2, 2018

WP-CLI v1.5.0 release checklist wp-cli/wp-cli#4512

Closed

9 tasks

schlessera merged commit 8afcc5a into wp-cli:master Jan 24, 2018

gitlost mentioned this pull request Jan 27, 2018

Adjust make-phar.php to include wp-config-transformer wp-cli/wp-cli#4640

Closed

Copilot AI mentioned this pull request Nov 2, 2025

Document licensing requirements for third-party code wp-cli/handbook#583

Merged

Conversation

frankiejarrett commented Dec 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danielbachhuber commented Dec 20, 2017

Uh oh!

frankiejarrett commented Dec 20, 2017

Uh oh!

schlessera commented Dec 23, 2017

Uh oh!

schlessera commented Dec 27, 2017

Uh oh!

frankiejarrett commented Dec 29, 2017

Uh oh!

schlessera commented Dec 29, 2017

Uh oh!

frankiejarrett commented Jan 1, 2018

Uh oh!

schlessera commented Jan 2, 2018

Uh oh!

schlessera commented Jan 24, 2018

Uh oh!

gitlost commented Jan 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gitlost commented Jan 26, 2018

Uh oh!

schlessera commented Jan 26, 2018

Uh oh!

gitlost commented Jan 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gitlost commented Jan 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

frankiejarrett commented Dec 20, 2017 •

edited

Loading

gitlost commented Jan 26, 2018 •

edited

Loading

gitlost commented Jan 26, 2018 •

edited

Loading

gitlost commented Jan 27, 2018 •

edited

Loading