manifest / admin / kitaris-environment-indicator

Kitaris Environment Indicator

Shows which environment you are on (local, development, staging or production) in the admin bar, so production is never mistaken for staging.

by Kitaris · github.com/builtnorth/kitaris-environment-indicator · website

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/builtnorth/kitaris-environment-indicator/archive/refs/heads/main.zip

On Packagist as kitaris/environment-indicator:

composer require kitaris/environment-indicator

No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.

Readme github.com/builtnorth/kitaris-environment-indicator ↗

See at a glance whether you are on local, development, staging or production, right in the admin bar.

Description

Kitaris Environment Indicator adds a small coloured badge to the admin bar showing which environment the site is running as. No more editing production when you meant to edit staging.

Reads the environment WordPress already knows about (WP_ENVIRONMENT_TYPE), so there is nothing to configure.
A distinct colour for each environment: local, development, staging and production.
Change any label or dot colour under Settings → Environment Indicator.
Need an environment WordPress has no type for, like QA or Client Review? Name it with a filter.
Shown to administrators only by default.
Lightweight: no front-end assets for visitors, no database tables, one option.

Set the environment

Add this to wp-config.php (or set the WP_ENVIRONMENT_TYPE environment variable):

define( 'WP_ENVIRONMENT_TYPE', 'staging' );

Accepted values are local, development, staging and production. WordPress treats a site with no setting as production.

Custom environments

WordPress itself only knows the four types above. To show any other name, return it from a filter:

add_filter( 'siratik_environment_indicator_environment', function () { return 'qa'; } );

It is shown with the Custom colour and labelled with the name ("client-review" shows as "Client Review"), unless you set a Custom label in the settings. Return an empty string to hide the badge.

For developers

Who sees the badge is filterable:

add_filter( 'siratik_environment_indicator_show', function ( $show, $environment ) { return current_user_can( 'edit_posts' ); }, 10, 2 );

Frequently Asked Questions

The badge does not appear.

It is only shown to users who can manage options, and only while the admin bar is showing.