Recommended releases

Download Released

State Override

When implementing the move to configuration in core (CMI) some of the variables were found
as not actually configuration,
and as such they are stored in special states storage system. Unlike configuration variables
the "state" variables are used for saving long-term values in the database that are
environment-specific. Examples of some "state" variables are:

cron_key
cron_last
css_js_query_string
install_task
install_time
maintenance_mode

While it is possible to override most of the configuration variables in the settings.php file using
the configuration overrides
method, you can not override "state" variables or module states.

This small utility module makes it possible to override the "state" variables or keep modules
enabled or disabled in the same manner the configuration variables can be overriden using the
settings.php file. It is especially useful, for example, if you need to sync databases between
environments which at the same time must be in different maintenance modes, or if you need to
keep some modules enabled only in your development branch.

Installation

  • Install and enable State Override module using the official Backdrop CMS instructions at
    https://backdropcms.org/user-guide/modules;
  • Alternatively use Brush and get it downloaded,
    installed and enabled with a single CLI command brush -y en state_override.

Usage

Open the file settings.php and add your state overrides like so:

$config['state']['maintenance_mode'] = TRUE;
$config['state']['cron_key'] = 'w5AXKo9UdkoVRp9rT_0gqtdG2h322LGJ_sYuJN6aWpk1';
$config['module']['devel'] = TRUE;

Credits and current Maintainers

License

This project is GPL v3 software.
See the LICENSE.txt file in this directory for the complete text.