README

Renders Handlebars/Moustache templates within your WordPress Theme/Plugin. Handlebars rendering is powered by LightnCandy. Tested with WordPress 5.2.3

Installation

You can install this (must-use) plugin two ways

Via Composer

If you load your dependenies via Composer you can load this plugin with

$ php composer require iantsch/wp-hbs-engine

Via Download

Download/fork this repository and copy the plugin-folder into wp-content/plugins/. If you visit your Plugin section in the wp-admin area, activate it and you are good to go.

Troubleshoots

You need to load the zordius/lightncandy dependency via composer. Install composer and run $ composer install in the wp-content/plugins/wp-hbs-engine folder.

The plugin needs a folder with write permissions for caching the handlebar files. It tries to create the folder wp-content/plugins/wp-hbs-engine/cache.

The plugin will try to load partials from the default folder src/templates/partials within your current theme. If the folder does not exist please add it (or use the filter hook to adapt).

Usage

Setup and modify the render engine to your needs in your functions.php or your plugin

add_filter('MBT/Engine/Handlebars/Helpers', function($helpers) {
  $helpers['__'] = function($string) {
    return __($string, 'mbt');
  };
  $helpers['permalink'] = 'get_permalink';
  $helpers['content'] = function() {
    return apply_filters('the_content', get_the_content());
  };
  return $helpers;
});

In your theme call it like a WordPress function.

global $post;
while (have_posts()){
  the_post();
  $data = (array) $post;
  the_hbs_template('article', $data);
}

In your article.hbs it is handlebarsjs.com syntax

<h2>{{this.post_title}}</h2>
<div>{{{content}}}</div>
<a href="{{permalink}}">{{__ 'Click'}}</a>

API

get_hbs_template

the_hbs_template

Hooks

There are several hooks to modify and adapt the render engine

Filters

MBT/Engine/Handlebars/Extension

MBT/Engine/Handlebars/Helpers

MBT/Engine/Handlebars/Flags

MBT/Engine/Handlebars/Partials

MBT/Engine/Handlebars/DefaultData

MBT/Engine/Handlebars/Data

MBT/Engine/Handlebars/Html

Actions

MBT/Engine/Handlebars/Init

Credits

@iantsch - web developer behind this and other projects.