README

A simple class that allows registering WordPress any templates from plugins. Including page templates, custom post type templates and WooCommerce templates

Installation

$ composer require oberonlai/wp-template

Usage

First, initialize the class with the plugin's directory path and template folder. For example, if you place the template files in a folder which name is 'templates', you can assing the path.

use ODS\Template;
$template = new Template( plugin_dir_path( __FILE__ ) . 'templates/' );

Don't forget the last slash in folder path.

Add page template

Page template is the template can be used repeatedly in page editor. You can use add_page() to assign the page template. There are two arguments in add_page():

$file - The page template file name
$name - Human-readable template name

use ODS\Template;
$template = new Template( plugin_dir_path( __FILE__ ) . 'templates/' );
$template->add_page( 'template-demo.php', 'my-template' );

Add page slug template.

Page slug template is the template for same slug name. You can use the page-demo.php template if your page slug's name is 'demo'. There are two arguments:

$file The page template file name
$slug For matched page slug

use ODS\Template;
$template = new Template( plugin_dir_path( __FILE__ ) . 'templates/' );
$template->add_page_slug( 'page-test.php', 'test' );

Add custom post type template

Custom post type template includes single and archive page. You can use the method add_post() to assign template file. There are three arguments :

$file The page template file name
$type Custom post type name
$position Template position optional single, archive

use ODS\Template;
$template = new Template( plugin_dir_path( __FILE__ ) . 'templates/' );
$template->add_post( 'single-book.php', 'book', 'single' );
$template->add_post( 'archive-book.php', 'book', 'archive' );

Override WordPress template

WordPress template includes serveral filters to override.

https://developer.wordpress.org/reference/hooks/type_template/

You can use the method add_wp() to assign template file. There are three arguments:

$file The page template file name
$position Template position

use ODS\Template;
$template = new Template( plugin_dir_path( __FILE__ ) . 'templates/' );
$template->add_wp( 'author.php', 'author' );
$template->add_wp( '404.php', '404' );

Override WooCommerce template

WooCommerce template has its own hierarchy. All you need to do is copy the WooCommerce template file you need to the template folder in your plugin.

You can use the method add_woocommerce() to change the default template path of WooCommerce. It will get the original template file if your plugin doesn't have the same name with WooCommerce template in templates/woocommerce path.

For example, if you have form-checkout.php file in yourplugin/templates/woocommerce/checkout, wp-template will replace it.

use ODS\Template;
$template = new Template( plugin_dir_path( __FILE__ ) . 'templates/' );
$template->add_woocommerce();

Credits

The add_page() method was adapted from http://www.wpexplorer.com/wordpress-page-templates-plugin/

oberonlai / wp-template

Maintainers

Details