stellarwp/templates

A library for templating in WordPress.

1.0.0 2024-03-18 15:08 UTC

Requires

• php: >=7.4
• stellarwp/arrays: ^1.2.1

Requires (Dev)

• lucatume/wp-browser: >=3.2.3 < 3.5.1
• stellarwp/coding-standards: ^2.0
• symfony/event-dispatcher-contracts: ^2.5.1
• symfony/string: ^5.4
• szepeviktor/phpstan-wordpress: ^1.1

GPL-2.0

• StellarWP
• Matthew Batchelder

README

A library for including templates in a WordPress plugin that users can choose to override within a specific directory of a theme or child theme.

Installation

It's recommended that you install Templates as a project dependency via Composer:

composer require stellarwp/templates

We actually recommend that this library gets included in your project using Strauss.

Luckily, adding Strauss to your composer.json is only slightly more complicated than adding a typical dependency, so checkout our strauss docs.

Notes on examples

Since the recommendation is to use Strauss to prefix this library's namespaces, all examples will be using the Boomshakalaka namespace prefix.

Configuration

This library requires some configuration before its features can be used. The configuration is done via the Config class.

use Boomshakalaka\StellarWP\Templates\Config;

add_action( 'plugins_loaded', function() {
	Config::set_hook_prefix( 'boom-shakalaka' );
	Config::set_path( PATH_TO_YOUR_PROJECT_ROOT );
} );

Once you've configured the library, extend the Template class to define the location of templates for your plugin.

With your class extension, manually define where the base folder for templates is in the class' plugin_path property. Here is an example of what that class may look like:

use Boomshakalaka\StellarWP\Templates\Template;

class My_Custom_Template extends Template {

	/**
	 * Defines the base path for the templates.
	 *
	 * @since 1.0.0
	 */
	protected array $template_base_path = [ PATH_TO_YOUR_PROJECT_ROOT ];

}

Once you've done that, you can instantiate your class instance and define a few other settings:

$template = new My_Custom_Template();

// Set the folder within your plugin where templates are stored.
$template->set_template_folder( 'src/views/products' );
// Should users be able to override templates in their theme?
$template->set_template_folder_lookup( true );

With the template class set up, calling $template->template('template-file') will include the template looking for it in:

1. child theme

../themes/child/boom-shakalaka/products/template-file

1. parent theme

../themes/parent/boom-shakalaka/products/template-file

1. the plugin

../plugins/your-plugin/src/views/products/template-file