Introduction

The Onyx Theme has a specific mode of operation and folder structure. It does not follow the standard WordPress development.

All queries and templates are managed by the controllers / timber that relate to the views. See more information in Views.

No dependency other than Timber is required. The entire operation of Onyx remains on the original bases of WordPress.

Folder Structure

  • core/ - This is where the main structure of the theme resides

    • ./app - Classes for theme operation
      • ./Api - WP REST API endpoint controllers
      • ./Controllers - Requisition Controllers
      • ./Onyx - Onyx classes
    • ./config - Resides all the main functional configurations of your project
    • ./includes - Your own functions and classes
    • ./lang - Translations

  • src/ - Source files for styles and javascripts

    • ./sass
    • ./js

  • views/ - Twig Templates

Timber

All templates are created using Twig through the Timber plugin. For more information and more detailed documentation on Timber/Twig access this link.

Onyx theme has controllers on top of Timber, so before consulting the Timber documentation, check if the classes and methods used by Onyx meet your needs.

Projects Using

Some projects that use the Onyx Theme as the main production tool.

Edit this page