configuration_getting started

Configuration

You are able to configure Aeria by inserting files in your theme. Aeria supports both of JSON and PHP. Aeria looks for configuration files in the themes/[Your Active Theme]/aeria-config. Aeria searches recursively in the subdirectories: you can order your config files as you like.

Each of your configuration files must contain Aeria's 3 required fields:

• "name" defines the internal name for this config file.
• "kind" defines the type of configuration: there are 7 possible types of configuration files. Check the Kinds of configuration files
• "spec" defines the specific configurations for the object. Its fields are different based on the kind of configuration. Check the specific configuration article to know more.

Since the release 1.0.2 of Aeria, you can include a fourth attribute: enabled, a boolean, containing false if the configuration file has to be skipped. By default it is true.

Kinds of configuration files

Aeria currently supports 9 types of configuration files:

• post-type declares a new post type.
• taxonomy declares a new taxonomy.
• group declares a new group.
• meta declares a new metabox.
• section declares a new type of section available in the metaboxes.
• controller declares a new controller.
• route declares a new API route.
• options declares a new options page.
• extension declares a new extension.

Please note that no other kind of configuration file is currently supported, and declaring something else will result in an error.

PHP version

<?php
return [
  "name" => "sample_extension",
  "spec" => [],
  "kind" => "extension"
]

JSON version

{
  "name": "sample_extension",
  "spec": {},
  "kind": "extension"
}