Download the PHP package iantsch/wp-hbs-engine without Composer

On this page you can find all versions of the php package iantsch/wp-hbs-engine. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of iantsch/wp-hbs-engine

Informations about the package wp-hbs-engine

WordPress Handlebars Engine

[licence]() [tag]()

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

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

In your theme call it like a WordPress function.

In your article.hbs it is handlebarsjs.com syntax

API

get_hbs_template

Parameter Type Description
$template string template name
$data string associative array with all the needed data for the template
$templateDir | string | boolean | absolutee path to template entry directory, defaults to /src/templates/ in current theme
$cacheDir | string | boolean | absolute path to caching directory, defaults to /cache/ in plugins folder

Returns: $html - the rendered HTML output

the_hbs_template

Parameter Type Description
$template string template name
$data string associative array with all the needed data for the template
$templateDir | string | boolean | absolutee path to template entry directory, defaults to /src/templates/ in current theme
$cacheDir | string | boolean | absolute path to caching directory, defaults to /cache/ in plugins folder

echoes the rendered HTML output

Hooks

There are several hooks to modify and adapt the render engine

Filters

MBT/Engine/Handlebars/Extension

Parameter Type Description
$extension | string | file extension, default: hbs

Returns: $extension - file extension of your handlebar templates

MBT/Engine/Handlebars/Helpers

Parameter Type Description
$helpers array associative array with callback functions for the implemented helpers
$this object Current instance of Handlebars engine

Returns: $helpers - array of handlebars helper

MBT/Engine/Handlebars/Flags

Parameter Type Description
$flags int bitwise flags used by LightnCandy
$this object Current instance of Handlebars engine

Returns: $flags - LightnCandy Flags

MBT/Engine/Handlebars/Partials

Parameter Type Description
$partials array associative array with the relative path to the partials
$this object Current instance of Handlebars engine

Returns: $partials - array of available partials

MBT/Engine/Handlebars/DefaultData

Parameter Type Description
$defaultData array fallback data for the template
$template string template name

Returns: $defaultData - fallback data for the template

MBT/Engine/Handlebars/Data

Parameter Type Description
$data array associative array with all the needed data for the template
$template string template name

Returns: $data - the data for the template

MBT/Engine/Handlebars/Html

Parameter Type Description
$html string rendered HTML output (with data)
$template string template name
$data array data used to render output

Returns: $html - the rendered HTML output

Actions

MBT/Engine/Handlebars/Init

Parameter Type Description
$this object Current instance of Handlebars engine

Credits

@iantsch - web developer behind this and other projects.

All versions of wp-hbs-engine with dependencies

PHP Build Version
Package Version
Requires composer/installers Version ~1.0
zordius/lightncandy Version 1.2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package iantsch/wp-hbs-engine contains the following files

Loading the files please wait ....