Access environment information in template

Question

Is there a way to check what environment craft is running on - ie, dev or not dev - via the template.

For example:

{%if env is 'dev'%}
    hello dev
{% else %}
   hello world
{% endif %}

kr37 · Answer 1 · 2020-07-14T21:32:21.987

40

In Craft 3 you can get the env using the getenv() function:

{% set env = getenv('ENVIRONMENT') %}
{% if env == 'dev' %}
    hello dev
{% else %}
    hello world
{% endif %}

Or via the app’s config service:

{% set env = craft.app.config.env %}

There's a bit more information about the .env file in the docs for Environmental Configuration.

edited Jul 14 '20 at 21:32

answered May 15 '18 at 20:53

kr37

1,355
9
18

This really helped with setting up some new custom environment variables outside of the default Craft 3 ones for a project. – Jay Aug 20 '18 at 13:30
This worked wonders! Thanks. Very handy when you want to work off local files in dev, but need the absolute URL on the production site. – mateostabio Mar 12 '19 at 16:34
THank for this simple answer. – Sameera Thilakasiri Sep 18 '19 at 08:33

Alec Ritson · Accepted Answer · 2014-08-12T08:00:02.437

26

When developing locally on Craft you would most likely have devMode => true set in your config file and set to false for your production config.

app/config/general.php

return array(
 'mydevdomain.dev' => array(
   'devMode' => true
 ),
 'mylivedomain.com' => array(
   'devMode' => false
 )
);

So you could test whether craft is in dev mode and respond to that:

{% if craft.config.devMode %}
  You are in dev mode
{% else %}
  You are not in devmode
{% endif %}

edited Aug 12 '14 at 08:00

answered Aug 11 '14 at 11:07

Alec Ritson

4,529
1
19
34

You can also define totally custom variables in the same way (e.g. 'cache' => false → {% if craft.config.cache %}) – carlcs Aug 12 '14 at 10:32
1

In my opinion, this is a risky thing to do: it's not inconceivable that an inexperienced developer might be tempted to switch on dev mode in production to debug something 'guerilla' style, which could in turn trigger these conditionals unintentionally. Yes, that's a bad idea, but it could happen. Other devs might even switch on devMode in production by accident. – James Smith Mar 30 '19 at 14:35
1

deprecated. now its craft.app.config.general.devMode – André Kelling Oct 09 '20 at 06:26

score 7 · Answer 3 · answered Dec 02 '15 at 00:05

You can set a custom "environment label" variable inside config/general.php:

return array(
    // ALL ENVIRONMENTS
    '*' => array(
    ),
    // LOCAL
    'mysite.local' => array(
        'env' => 'local'
    ),
    // DEV
    'dev.mysite.com' => array(
        'env' => 'dev'
    ),
    // PROD
    'www.mysite.com' => array(
        'env' => 'prod'
    )
);

Then use the craft.config variable to output the env variable for the current environment:

{% if craft.config.env == 'dev' %}
    hello dev
{% else %}
    hello world
{% endif %}

score 3 · Answer 4 · answered Mar 25 '21 at 19:06

I know this is an old question, but just an update:

If you're on Craft CMS v3+, craft.config.[setting-name] has been deprecated. Use craft.app.config.general.[setting-name] instead.

So if you wanted to check if you were in dev environment, you'd do craft.app.config.general.devMode, this returns a boolean value.

Access environment information in template

4 Answers4