Before digging into the WordPress configuration, please note that all the configuration files for the Themosis framework are stored in the config directory located at project root.
The folder is containing a list of files, each dedicated to some features or packages of your application (application, cache, database, WordPress, ...). Each file is documented so feel free to read the files and get to know the options available to you.
The root config directory is storing global or shared options for your application. But both theme and custom plugins you develop also store dedicated configuration files into a config directory.
Let's first explore the environment configuration in order to set up our application and then proceed to the WordPress installation.
The Themosis framework has always provided a way to define environment variables. Environment management is defined in a single .env file at project root.
If you install the Themosis framework with Composer, the repository holds a default .env.sample file which is automatically renamed to .env upon installation for you.
Thanks to this .env file, you're now able to store critical data for your application services out of the web server public root.
In order to complete your application installation, you need to configure it by using this .env file.
Open your project .env file from your code editor or IDE. The .env file contains the following default variables:
APP_ENV=local
APP_DEBUG=false
APP_KEY=
APP_TD=themosis
AUTH_KEY=
SECURE_AUTH_KEY=
LOGGED_IN_KEY=
NONCE_KEY=
AUTH_SALT=
SECURE_AUTH_SALT=
LOGGED_IN_SALT=
NONCE_SALT=
APP_URL=http://local.test
WP_URL=http://local.test/cms
DATABASE_NAME=themosis
DATABASE_USER=root
DATABASE_PASSWORD=root
DATABASE_HOST=localhost
DATABASE_PREFIX=th_
MAIL_HOST=your-smtp-host
MAIL_USERNAME=null
MAIL_PASSWORD=null
[email protected]
MAIL_FROM_NAME=ThemosisThe application environment is set for local development with debugging option set to false by default.
If you remove the
APP_ENVvariable, its value is set toproductionby default. Since release3.0, theAPP_DEBUGvariable is set tofalseby default to avoid error exceptions when installing WordPress. Feel free to turn debug mode back on once WordPress is installed.
In order to install the application, you need to fill in the database options as well as defining your local virtual host URL in the APP_URL and WP_URL configurations.
The APP_URL variable is the base URL of your application and the WP_URL is the base URL of the WordPress directory. Here WordPress is installed in the subdirectory cms, so make sure to keep the /cms fragment in your WP_URL value.
Environment variables defined in the .env file are parsed by the vlucas/phpdotenv package. The package is loading those variables into the $_ENV and $_SERVER superglobals of PHP making them available anywhere in your application.
In order to retrieve a value from your environment configuration file, you can use the env() helper function:
$debug = env('APP_DEBUG');You can also specify a default value if the requested environment variable does not exist:
$custom = env('CUSTOM_VAR', 'default value');The current application environment is defined by the APP_ENV variable from your .env file. You can access this value by using the environment() method of the App facade like so:
$env = App::environment();You may also pass arguments to the environment method to check if the environment matches a given value. The method will return true if the environment matches any of the given values:
if (App::environment('local')) {
// Local environment...
}
if (App::environment(['local', 'staging'])) {
// Environment is either "local" or "staging"...
}Now that your .env default variables are filled in, you can open your browser and visit your application at the URL defined in APP_URL environment variable.
Follow steps on screen in order to complete the WordPress installation.
The framework bundles a wordpress.php configuration file stored in the config directory.
Instead of populating the wp-config.php file, you can now add all your WordPress constants into the config/wordpress.php file.
From that file, you can also access your environment variables with the use of the env() helper function.
When scaffolding the Themosis framework for the first time, salt and nonce keys are automatically generated for you and defined in the .env file. The related WordPress constants are populated in the config/wordpress.php file.
You can also generate the authentication keys by running the following command from your terminal or console:
php artisan salts:generateAs usual, you can also manually set your WordPress authentication keys and salts constants from the WordPress generator.
// config/wordpress.php
define('AUTH_KEY', config('app.salts.auth_key'));
define('SECURE_AUTH_KEY', config('app.salts.secure_auth_key'));
define('LOGGED_IN_KEY', config('app.salts.logged_in_key'));
define('NONCE_KEY', config('app.salts.nonce_key'));
define('AUTH_SALT', config('app.salts.auth_salt'));
define('SECURE_AUTH_SALT', config('app.salts.secure_auth_salt'));
define('LOGGED_IN_SALT', config('app.salts.logged_in_salt'));
define('NONCE_SALT', config('app.salts.nonce_salt'));The Themosis framework is using the illuminate/config package for managing the application configuration.
You can access the configuration values by using the config() helper function:
$name = config('app.name');The Config facade is also available. Use the get() method in order to retrieve a configuration value:
$charset = Config::get('app.charset');Both the config() helper function and the Config facade get() method can define a second parameter. The second parameter is used to return a default value if the configuration value requested does not exist:
$name = config('app.name', 'My Application');
$env = Config::get('app.env', 'staging');The configuration API is using a dot syntax in order to look through your configuration files. In the example above, the app fragment before the dot is indicating the app.php file stored into the config root directory. The name fragment is configuration key name in that file.
You can nest configuration values. For example, the app.php file contains the following configuration for WordPress:
$wp_directory = config('app.wp.dir');By providing the configuration file name without the .php extension, you can retrieve all of its configuration values.
Let's grab all properties of the theme's theme.php configuration file:
$all = config('theme');The above code is fetching all properties from the theme.php file stored in the theme config folder.
Please note, that if configuration files with the same name are defined under both the root config directory as well as plugin or theme config folders Themosis does not merge their contents.
The active plugins' config files override the root configuration, and the active theme's configuration files override both. However, WordPress loads the global configuration first, active plugins' config files after and the active theme's config at last, which means the value under certain configuration keys would be different at different times during each page load. This can cause unexpected behaviour as it may be hard to predict which configuration file will be effective when accessing the configuration in some parts of your application.
Therefore, it is best to use unique configuration file names for the root configurations and all active Themosis Plugins and Theme.
Read the application structure guide