The famous Twig Template for WordPress
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Build Status codecov Scrutinizer Code Quality

Twig for WordPress

Twig for WordPress allow you to use the famous Twig template engine https://twig.symfony.com/ but extend it to be able to use the functions provided by WordPress such as esc_html, esc_html__, wp_kses etc...

This package register the escape function as filters and functions because translator functions need to be pass a textdomain.

Modules

The package provide filters, functions and other stuffs into twig by define modules.

Modules are class instances that implements an interface TwigWp\Module\Injectable used by the Provider TwigWp\Module\Provider that allow us to retrieve all modules to be set into twig instance.

There is a filter twigwp.modules within the Provider::modules method that allow third party softwares to hook into the modules list so, they'll be able to add other filters, functions, tags or whatever they want to use to extend the twig instance (read about how to extend twig here https://twig.symfony.com/doc/2.x/advanced.html).

Escapers

Twig for WordPress define as filters and functions the followings:

  • esc_js
  • esc_sql
  • esc_textarea
  • esc_url
  • esc_url_raw
  • esc_attr
  • esc_html

Kses

The kses are defined only as functions.

  • wp_kses
  • wp_kses_post
  • wp_kses_allowed_html

Sanitizers

The sanitizers are defined only as functions.

  • sanitize_html_class
  • sanitize_text_field
  • sanitize_title
  • sanitize_key

L10n

Localization functions, including the escaped ones. Localizations functions that start with esc_ (escape) are also registered as filters.

  • __
  • _e
  • _n
  • _x
  • _ex
  • _nx
  • esc_attr__
  • esc_attr_e
  • esc_attr_x
  • esc_html__
  • esc_html_e
  • esc_html_x

Template Functions

This module include all of the functions that echo html markup even if them are not WordPress template functions.

This because most of the WordPress functions usually get some configuration by array and output html markup. Having to put in a object property the entire markup isn't usefull since you want to have your markup into your views, these functions will help you to pass the configuration and call the output function directly, avoiding to permit to parse html markup that may result in a unescaped html.

  • wp_nav_menu
  • get_adjacent_post_link

Provider

The modules are retrieved by a Provider.

Within the provider the modules can be filtered twigwp.modules.

So if you want to add a new module you can hook into this filter and return a new instance of TwigWp\Module\Injectable.

A Module is used to extend the twig instance, the method injectInto get a \Twig\Environment instance to use for example to add a new function, a new filter or a new tag etc...

For example:

class MyModule implements TwigWp\Module\Injectable {

	public function injectInto(\Twig\Environment $twig): \Twig\Environment {
		// Do your stuffs here.

		return $twig;
	}

}

$provider = new Provider(new \Twig\Environmnet());

add_filter('twigwp.modules', function($modules)
{
	$modules['module_name'] = new MyModule();

	return $modules;
});

$modules = $provider->modules();

This is just an example because you'll never need to create an instance of the Module Provider. Everything is handled by the Factory class.

You just need to add your filter and everything is ok.

Factory

The package provide a Factory class that help you on creating a new instance of the \Twig\Environment class.

If you want to create a new Twig instance you can simply create a factory instance by passing a \Twig\Loader\LoaderInterface object and the twig options if you want to customize the environment.

Then call the create method and you've done.

$twigFactory = new \TwigWp\Factory(
	new \Twig\Loader\FilesystemLoader(),
	[
        'debug' => false,
        'charset' => 'UTF-8',
        'base_template_class' => 'Twig_Template',
        'strict_variables' => false,
        'autoescape' => 'html',
        'cache' => false,
        'auto_reload' => null,
        'optimizations' => -1,
	]
);

$twig = $twigFactory->create();

Pretty easy, right?

License

This programm is free software and is licensed using GPL2.

For more info about the license see https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html

Requirements

PHP >= 7.0

Bugs Reporting

To report bugs please refer to https://github.com/widoz/twig-wordpress/issues

Support

For support just open a new issue https://github.com/widoz/twig-wordpress/issues and apply the label help wanted.