/wpemerge-theme

A modern WordPress starter theme which uses the WP Emerge framework 🚀 https://wpemerge.com/

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

WP Emerge Theme

Packagist Gitter

A modern WordPress starter theme which uses the WP Emerge framework.

This is the WP Emerge Theme project - for the WP Emerge framework please check out https://github.com/htmlburger/wpemerge.

Summary

Documentation

https://wpemerge.com/

Development Team

Brought to you by Atanas Angelov and the lovely folks at htmlBurger.

Comparison Table

WP Emerge Theme Sage Timber
View Engine PHP, Blade, Twig PHP, Blade Twig
Routing ✔ ✖ ✖
MVC ✖✔✔ ✖✔✖¹ ✖✔✖
Middleware ✔ ✖ ✖
View Composers ✔ ✔/✖² ✖
Service Container ✔ ✖ ✖
Stylesheets SASS + PostCSS SASS + PostCSS N/A³
JavaScript ES6 ES6 N/A³

¹ Sage's Controller is more a View Model than a Controller.

² Sage's Controller provides similar functionality but is limited to 1 composer (controller) per view and vice versa.

³ Timber does not provide a front-end build process so you can implement whatever you prefer.

Email any factual inaccuracies to atanas.angelov.dev@gmail.com so they can be corrected.

Features

  • All features from WP Emerge:
    • Routes with optional rewrite rule integration
    • Controllers
    • Middleware
    • PSR-7 Responses
    • View Composers
    • Service Container
    • Service Providers
    • Support for Php, Blade 5.4 and/or Twig 2 for views
  • SASS + PostCSS for stylesheets. Separate bundles are created for front-end, administration and login pages.
  • ES6 for JavaScript. Separate bundles are created for front-end, administration and login pages.
  • Webpack to transpile and bundle assets, create sprites, optimize images etc.
  • Browsersync for synchronized browser development.
  • Optional CSS packages:
    • Boostrap 4
    • Bulma
    • Foundation
    • Tachyons
    • FontAwesome
  • PHP unit testing scaffolding

Requirements

Directory structure

wp-content/themes/your-theme
├── app/
│   ├── helpers/              # Helper files, add your own here as well
│   ├── setup/                # Register WordPress menus, post types etc.
│   │   ├── menus.php
│   │   ├── post-types.php
│   │   ├── sidebars.php
│   │   ├── taxonomies.php
│   │   ├── theme-support.php
│   │   └── widgets.php
│   ├── src/                  # PSR-4 autoloaded classes
│   │   ├── Controllers/      # Controller classes for WP Emerge routes
│   │   ├── Widgets/          # Widget classes
│   │   └── ...
│   ├── config.php            # WP Emerge configuration
│   ├── helpers.php           # Require your helper files here
│   ├── hooks.php             # Register your actions and filters here
│   └── framework.php         # Register your WP Emerge routes, globals etc.
├── dist/                     # Bundles, optimized images etc.
├── languages/                # Language files
├── resources/
│   ├── build/                # Build process configuration
│   ├── styles/
│   │   ├── admin/            # Administration styles
│   │   ├── login/            # Login styles
│   │   └── index.scss        # Front-end entry point SCSS file
│   ├── fonts/
│   ├── images/
│   └── scripts/
│   │   ├── admin/            # Administration scipts
│   │   ├── login/            # Login scripts
│       └── index.js          # Front-end entry point JavaScript file
├── theme/                    # Required theme files and views
│   ├── partials/             # View partials
│   ├── templates/            # Page templates
│   ├── functions.php         # Bootstrap theme
│   ├── screenshot.png        # Theme screenshot
│   ├── style.css             # Theme stylesheet (avoid adding css here)
│   └── [index.php ...]
├── vendor/                   # Composer packages
├── README.md                 # Your theme README
└── ...

Notable directories

app/helpers/

Add PHP helper files here. Helper files should include function definitions only. See below for information on where to put actions, filters, classes etc.

app/setup/

Modify files here according to your needs. These files should contain registrations and declarations of WordPress entities only such as post types, taxonomies etc.

app/src/

Add PHP class files here. All clases in the App\ namespace are autoloaded according to the PSR-4 standard.

resources/styles/

Add .css and .scss files here. Don't forget to @import them in index.scss. Note that you are not requird to use SASS at all if you do not wish to do so, the only requirement is that index.scss file remains with an .scss extension.

resources/styles/admin and resources/styles/login

These directories are for the admin and login bundles, respectively. They work identically to the main resources/css directory.

resources/images/

Add images for styling here. Optimized copies will be placed in dist/images/ when running the build process.

resources/scripts/

Add JavaScript files here. The entry point is resources/scripts/index.js.

resources/scripts/admin and resources/scripts/login

These directories are for the admin and login bundles, respectively. They work identically to the main resources/scripts directory.

theme/

Add views in this, the theme/partials/ or the theme/templates/ directories accordingly. Avoid adding any PHP logic here, unless it pertains to layouting (PHP logic should go into helper files or WP Emerge controllers)

Contributing

WP Emerge Theme is completely open source and we encourage everybody to participate by: