Ivaylo Draganov

<p>Adds a menu to the admin bar to quickly identify different environments for a site (e.g. production and development) and easily switch to the same URL on other environments. Multi-site compatible for both sub-domain and sub-directory installations.</p>
<h3>Configuration</h3>
<p>The plugin has a convenient settings page but can also be configured programatically via a filter hook.</p>
<h4>Setting environments via the WordPress admin interface</h4>
<p>Navigate to “Settings > Set the Stage” in the WordPress admin to review and edit the configuration.</p>
<h4>Setting environments via a WordPress filter hook</h4>
<p>Hook to <code>drgnff_wp_stage_switcher__environments</code> and return an array with environments. Here’s an example filter function:</p>
<pre><code>add_filter( 'drgnff_wp_stage_switcher__environments', function ($envs) {
    return [
        [
            'url' => 'https://example.com', // home url
            'title' => 'LIVE', // display name
            'color' => '#ffffff', // hex color (optional)
            'background_color' => '#ff0000', // hex color (optional)
        ],
        [
            'url' => 'https://example.com',
            'title' => 'DEVELOPMENT',
            'color' => '#ffffff',
            'background_color' => '#228b22',
        ],
    ];
});
</code></pre>
<h4>Controlling visibility of the switcher</h4>
<p>By default the switcher menu is displayed to all logged in users. By hooking to <code>drgnff_wp_stage_switcher__should_display_switcher</code> and returning a boolean you can control whether the switcher should be displayed.</p>
<h4>Overriding the default environment</h4>
<p>The default environment is used for the current site if it’s not in the list of environments. By hooking to <code>drgnff_wp_stage_switcher__default_environment</code> you can control the title and colors for the default environment.</p>
<h4>A few notes on configuration</h4>
<ul>
<li>Filters have a precedence over manual configuration made in the settings page. If filters are used then relevant sections on the settings page are rendered as read-only.</li>
<li>For multi-site installations use the URLs of the main site.</li>
<li>The plugin initiates its logic on the <code>plugins_loaded</code> hook with priority <code>11</code>. Thus filter hooks that affect the plugin must be added before that.</li>
</ul>


Set the Stage

Quickly switch between environments (live, test, dev) from the admin bar.

Andrés Villarreal

<p>If you develop in a local machine, at some point you’ll have some active plugins there that you don’t need in the servers that you’re deploying to. Sure, you can deactivate them in your local machine before deploying, or after deploying in the remote ones, but you’re gonna need them again to be active if you want to perform local work in the future, specially when you update your local database from a remote one. On such kind of scenarios, the whole process of manually activating and deactivating plugins for each stage can be really frustrating, sometimes even taking a lot of your time.</p>
<p>Stage WP Plugin Manager is meant to solve that problem in an quick and elegant way, by doing an automatic “fake”  activation of the plugins you select for each stage: every plugin you attach to a stage will be immediatly treated as an active plugin on that stage, no matter what its previous status was, or its current status on the other stages. Since the list of active plugins is just filtered instead of rewritten, you can restore the previous status of a plugin by detaching it, and go back to your original setup by deactivating Stage WP Plugin Manager.</p>
<p><strong>Please read the following instructions very carefully.</strong></p>
<h4>Getting Started</h4>
<p>Stage WP Plugin Manager works on some assumptions about your workflow:</p>
<ul>
<li>You have a constant named <code>WP_STAGE</code> defined in your WordPress configuration file (often <code>wp-config.php</code>).</li>
<li>The value of <code>WP_STAGE</code> is one of the supported stages. The default supported stages are <code>local</code>, <code>staging</code> and <code>production</code>.</li>
<li>The value of <code>WP_STAGE</code> is different in each of your stages.</li>
</ul>
<p>Some developers prefer to keep different configuration files for each one of their stages, or change the values of their constants based on some evaluation. For example, you could have something like this in your <code>wp-config.php</code> file:</p>
<pre><code>if ( file_exists( dirname( __FILE__ ) . '/local-config.php' ) ) {
    define( 'WP_STAGE', 'local' );
} elseif ( file_exists( dirname( __FILE__ ) . '/staging-config.php' ) ) {
    define( 'WP_STAGE', 'staging' );
} else {
    define( 'WP_STAGE', 'production' );
}
</code></pre>
<p>If you follow this example, note that <code>local-config.php</code> should not be included in your deployments to staging and production, and both <code>local-config.php</code> and <code>staging-config.php</code> should not exist in your production stage.</p>
<h4>Attach & Detach</h4>
<p>Once you have installed this plugin, you will notice that a new link appears under each active plugin of the list, which reads “Attach to [your-stage] stage”. By clicking that link, you are setting a plugin to be always active in the stage you’re working at, and not active on the other stages (unless you attach the plugin to the other stages too).</p>
<p>In case you want to remove a plugin from the list of active plugins for a stage, you just need to click the “Detach from [your-stage] stage”.</p>
<p>Additionally, you can make bulk selections of plugins to be attached or detached for each stage by going to <em>Plugins > Stage Management</em>.</p>
<h4>Add & Extend Functionality</h4>
<p>Stage WP Plugin Manager allows you to extend its functionality by offering hooks for filters and actions.</p>
<p>For example, you can add your custom stages or even remove the default ones by hooking in the <code>stage_wp_plugin_manager_stages</code> filter, having something like this in your plugin:</p>
<pre><code>function add_stages( $stages ) {
    $stages[] = 'other';
    return $stages;
}
add_filter( 'stage_wp_plugin_manager_stages', 'add_stages' );
</code></pre>
<p>Additionally, you can give a nicer name to your new stage by hooking in the <code>stage_wp_plugin_manager_stages_txt</code> filter:</p>
<pre><code>function add_stages_txt( $stages_txt ) {
    $stages_txt['other'] = __( 'Other stage' );
    return $stages_txt;
}
add_filter( 'stage_wp_plugin_manager_stages_txt', 'add_stages_txt' );
</code></pre>
<p>Here’s the complete list of actions and filters that Stage WP Plugin Manager offers:</p>
<p>Action hooks</p>
<ul>
<li><code>stage_wp_plugin_manager_before_init</code>: Perform some process before Stage WP Plugin Manager initializes.</li>
<li><code>stage_wp_plugin_manager_init</code>: Perform some process after Stage WP Plugin Manager initializes.</li>
</ul>
<p>Filter hooks</p>
<ul>
<li><code>stage_wp_plugin_manager_stages</code>: Modifiy the current supported stages.</li>
<li><code>stage_wp_plugin_manager_default_stage</code>: Modify the default stage.</li>
<li><code>stage_wp_plugin_manager_managed_plugins</code>: Modify the list of plugins managed by Stage WP Plugin Manager.</li>
<li><code>stage_wp_plugin_manager_stage_plugins</code>: Modify the list of plugins attached to the current stage.</li>
<li><code>stage_wp_plugin_manager_non_stage_plugins</code>: Modify the list of managed plugins that are not attached to the current stage.</li>
<li><code>stage_wp_plugin_manager_nonce_key</code>: Modify the nonce key used for data validation.</li>
<li><code>stage_wp_plugin_manager_help_description</code>: Modify contents of “Description” help tab.</li>
<li><code>stage_wp_plugin_manager_help_getting_started</code>: Modify contents of “Getting Started” help tab</li>
<li><code>stage_wp_plugin_manager_help_attach_detach</code>: Modify contents of “Attach & Detach Plugins” help tab</li>
<li><code>stage_wp_plugin_manager_help_add_extend</code>: Modify contents of “Adding Stages & Extending” help tab</li>
<li><code>stage_wp_plugin_manager_help_credits</code>: Modify contents of “Credits” help tab</li>
</ul>
<h4>WordPress MultiSite Compatibility</h4>
<p>If you’re using MultiSite and set this plugin to network activated, you can use it to attach plugins to stages on a sitewide basis 🙂</p>
<h4>Improve Your Workflow</h4>
<p>This plugin was originally meant as a complement for <a href="http://github.com/andrezrv/wordpress-bareboner" rel="nofollow ugc">WP Bareboner</a>, an advanced Git model repo, and <a href="http://github.com/andrezrv/stage-wp" rel="nofollow ugc">Stage WP</a>, a deployment tool based in Capistrano. The three projects work really well separated, but their real power can only be seen by using them together.</p>
<h4>Contribute</h4>
<p>You can make suggestions and submit your own modifications to this plugin on <a href="https://github.com/andrezrv/stage-wp-plugin-manager" rel="nofollow ugc">Github</a>.</p>


Stage WP Plugin Manager

Gives you the option to determine which plugins must be automatically activated either on local, staging or productions stages.

Set the Stage vs Stage WP Plugin Manager