Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 3.34 KB

configuration.md

File metadata and controls

78 lines (51 loc) · 3.34 KB

Configuration

Basic usage

The Config API has received a completely overhauled API. Using the Config API, you can now retrieve at run-time any configuration property.

Configuration files are stored in resources/config folders.

Retrieve all properties

Use the get() method to retrieve all properties of a defined configuration file.

Let's grab all properties of the theme's theme.config.php file:

use Themosis\Facades\Config;

$all = Config::get('theme');

The above code is fetching all properties from the theme.config.php file stored in the resources/config folder. Simply provide the file name without the .config.php extension as a parameter of the get() method.

use Themosis\Facades\Config;

// Grab all theme templates
$templates = Config::get('templates');

Plugin configuration file names

When creating configuration files for a custom plugin, we recommend you to prefix your configuration file names with your domain tld, domain and plugin name in front of the configuration base name in order to avoid conflicts.

If your plugin creates a templates.config.php file, it will break the theme's templates.config.php configuration.

Here is a valid templates configuration file for a custom plugin: com_domain_shop_templates.config.php

And in order to retrieve it from your plugin:

$templates = Config::get('com_domain_shop_templates');

Retrieve a specific property

Depending of your application, you might need to retrieve only one specific property from a configuration file.

For this, simply use a dot syntax to specify your property. For example, let's retrieve the namespace property from the theme.config.php file:

$namespace = Config::get('theme.namespace');

Note: you can't set/modify configuration values at run-time. Configuration values are read only.

Theme configuration files

Here is a complete list of the configuration files stored inside the theme.

  • constants: Allow you to define constant variables.
  • images: Allow you to register image sizes for your media library.
  • loading: Allow you to specify directories of classes for autoloading. By default, it is loading your theme's controller and model classes.
  • menus: Allow you to define custom navigation menu locations. More information in the WordPress codex.
  • providers: Allow you to define the list of theme's service providers.
  • sidebars: Help you register your sidebars for your website/application. Uses the same arguments found in the WordPress codex: register_sidebar().
  • supports: Equivalent to the add_theme_support() function.
  • templates: Handles the custom templates. Define your templates inside this file by providing a key or key/value pairs.
  • theme: Main configuration file. You can specify your own class aliases inside this file.

Details on how to modify and use those configurations are explained inside each file.