forumone/wp-cfm

Manage and deploy WordPress configuration changes.

2.0.1 2024-11-14 17:27 UTC

Requires

• php: >=7.4
• cweagans/composer-patches: ^1.7
• symfony/yaml: ^5.4

Requires (Dev)

• php: >=7.4
• brain/monkey: ^2.6
• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• johnpbloch/wordpress-core: ~6.4.0
• johnpbloch/wordpress-core-installer: ^2.0
• mockery/mockery: ^1.6
• php-stubs/wordpress-globals: ^0.2.0
• php-stubs/wordpress-stubs: ~6.4.0
• php-stubs/wp-cli-stubs: ^2.9
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.7
• szepeviktor/phpstan-wordpress: ^1.3
• wp-coding-standards/wpcs: ^3.0.0
• wp-phpunit/wp-phpunit: ~6.4.0
• wpackagist-plugin/debug-bar: *
• wpackagist-plugin/debug-bar-actions-and-filters-addon: *
• wpackagist-plugin/display-environment-type: *
• wpackagist-plugin/health-check: *
• wpackagist-plugin/query-monitor: *
• wpackagist-plugin/transients-manager: *
• wpackagist-theme/twentytwentythree: *
• yoast/phpunit-polyfills: ^2.0

GPL-2.0-only

• Forum One
• Matt Gibbs
• Tim Nolte
• Deanna Steers

• configuration
• plugin
• wordpress

README

Contributors: forum1, mgibbs189, elvismdev, mickaelperrin, alfreddatakillen, joshlevinson, jmslbam, gbeezus, tnolte, dsteersf1, jgleisner
Tags: configuration, settings, configuration management, features, wordpress, wp-cli
Donate link: http://forumone.com/
Requires at least: 4.7
Tested up to: 6.6.2
Requires PHP: 7.4
Stable tag: 2.0.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Manage and deploy WordPress configuration changes.

Description

WP-CFM lets you copy database configuration to / from the filesystem. Easily deploy configuration changes without needing to copy the entire database. WP-CFM is similar to Drupal's Features module.

How will WP-CFM benefit me?

• Less need to copy over the entire database.
• No more rushing to figure out which settings you forgot to change.
• Easily track and version configuration changes via git, subversion, etc.

Which data does WP-CFM support?

• WP settings (wp_options table)
• Multisite settings (wp_sitemeta table)
• Taxonomy terms
• Custom Field Suite field groups

Terminology

• Bundle - A group of (one or more) settings to track
• Push - Export database settings to the filesystem
• Pull - Import file-based settings into the database

WP-CLI

WP-CFM supports [pull / push / diff] of bundles from the command-line using WP-CLI:

wp config pull [bundle_name]
wp config push [bundle_name]
wp config diff [bundle_name]
wp config bundles
wp config show_bundle [bundle_name]

You can optionally set bundle_name to "all" to include all bundles.

Append the --network flag to include multisite bundles.

Filters

See the filters reference page at the GitHub Wiki.

Installation

Manual

1. Upload to the /wp-content/plugins/ directory.
2. Activate the plugin.
3. Browse to Settings > WP-CFM to configure.

Git Updater

1. Download the free version, or purchase the premium version, of the Git Updater plugin.
2. Upload to the /wp-content/plugins/ directory.
3. Activate the plugin.
4. Follow the plugin installation instructions on the Git Updater website.

Composer

1. Run composer require forumone/wp-cfm to add to your Composer-based site.

Frequently Asked Questions

Screenshots

1. The admin management interface
2. Editing a configuration "bundle"
3. Diff viewer to track changes within a bundle

Changelog

See the previous changelogs here