Directory Structure¶

We’ve organized the files and folders in order to be easy to understand and use. What follows is the directory and file structure of an Unyson theme:

themes/
├-parent-theme/
│ └-framework-customizations/
│   ├-extensions/
│   │ ├─extension-name/
│   │ └─...
│   └-theme/
│     ├-manifest.php   # Theme details: title, description, version, dependencies, etc.
│     ├-config.php     # Theme specific configuration
│     └─options/
│       ├─settings.php # Theme settings options
│       ├─customizer.php # Customizer options
│       ├─posts/       # Post types options
│       │ ├─post.php
│       │ ├─testimonial.php
│       │ ├─{post-type}.php
│       │ └─...
│       └─taxonomies/  # Taxonomy terms options
│         ├─category.php
│         ├─post_tag.php
│         ├─{taxonomy}.php
│         └─...
└-child-theme/
  └-framework-customizations/
    └-... # same as in then parent theme, but here you can overwrite specific files from the parent theme

Let’s take a closer look at each directory and file, and understand how it works.

• framework-customizations/theme/ - Contains options, views, helpers, and all bunch of theme stuff, we’ll take a closer look at every file below.

• framework-customizations/theme/manifest.php - Contains an array with information about theme, accessible through fw()->theme->manifest->get('key');. More details about the theme manifest.

• framework-customizations/theme/config.php - Theme configuration array, accessible through fw()->theme->get_config('key');. Here are the default values.

  $cfg = array(
      // Theme Settings form ajax submit
      'settings_form_ajax_submit' => true,
      // Theme Settings side tabs
      'settings_form_side_tabs' => true,
  );
  

• framework-customizations/theme/options/ - A directory containing option files: post types, taxonomies, customizer and theme settings page options. The framework will automatically pick them, display in admin pages and save the values in the database. Also you can add custom options files in it, for e.g. framework-customizations/theme/options/my-options.php and access them through fw()->theme->get_options('my-options'). Use the fw_get_db_..._option() functions to get the settings, customizer, posts and taxonomies options values from the database.

  For e.g. you can add options in Customizer in two steps:

  1. Create {theme}/framework-customizations/theme/options/customizer.php

     $options = array(
         'section_1' => array(
             'title' => __('Unyson Section', '{domain}'),
             'options' => array(
     
                 'option_1' => array(
                     'type' => 'text',
                     'value' => 'Default Value',
                     'label' => __('Unyson Option', '{domain}'),
                     'desc' => __('Option Description', '{domain}'),
                 ),
     
             ),
         ),
     );
     

  2. Use option value in template

     $value = fw_get_db_customizer_option('option_1');
     

• framework-customizations/extensions/ - Contains customizations for the framework extensions. You can overwrite options, views and configuration files of the extensions located in the framework or custom locations like other plugins. You can also store there theme extensions and create sub-extensions for extensions located in the framework or custom locations. Extension is identified by its relative path, for e.g. an extension can be located in:

  • Framework wp-content/plugins/unyson/framework/extensions/{extension-name}
  • Plugin wp-content/plugins/whaterever-plugin/custom-dir/extensions/{extension-name}

  that extension can be customized in {theme}/framework-customizations/extensions/{extension-name}. Also you can create a sub-extension in {theme}/framework-customizations/extensions/{extension-name}/extensions/{sub-extension-name}.

You can also create a framework-customizations/ directory in the child theme. There you can do the same things as in parent theme, and also you can overwrite some files from the parent theme, like options and configuration files. Keep in mind that some files from the child theme are included before the parent theme files (or the other way around, it depends on the case) to give you the ability to customize some parent theme behavior.