2017 © Pedro Peláez
 

library extended-template-parts

A library which provides extended functionality to WordPress template parts, including template variables and caching.

image

johnbillion/extended-template-parts

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 7 Forks
  • 2 Open issues
  • 7 Versions
  • 41 % Grown

The README.md

Stable Release License, (*1)

Extended Template Parts

Extended Template Parts is a library which provides extended functionality to WordPress template parts, including template variables and fragment caching., (*2)

Features

  • Pass variables into your template parts and access them via the $this->vars array. No polluting of globals!
  • Easy optional caching of template parts using transients.

Minimum Requirements

PHP: 7.0
WordPress: 4.4, (*3)

Installation

Extended Template Parts is a developer library, not a plugin, which means you need to include it somewhere in your own project. You can use Composer:, (*4)

composer require johnbillion/extended-template-parts

Or you can download the library and include it manually:, (*5)

require_once 'extended-template-parts/extended-template-parts.php';

Basic Usage

The get_extended_template_part() function behaves exactly like WordPress' get_template_part() function, except it loads the template part from the template-parts subdirectory of the theme for better file organisation. The usual parent/child theme hierarchy is respected., (*6)

get_extended_template_part( 'foo', 'bar' );

Use the $vars parameter to pass in an associative array of variables to the template part:, (*7)

get_extended_template_part( 'foo', 'bar', [
    'my_variable' => 'Hello, world!',
] );

In your template-parts/foo-bar.php template part file, you can access the variables that you passed in by using $this->vars:, (*8)

echo esc_html( $this->vars['my_variable'] );

Advanced Usage

The get_extended_template_part() function also accepts a second optional parameter that controls the directory name and caching., (*9)

The following code will load foo-bar.php from the my-directory subdirectory and automatically cache its output in a transient for one hour:, (*10)

get_extended_template_part( 'foo', 'bar', [
    'my_variable' => 'Hello, world!',
], [
    'dir'   => 'my-directory',
    'cache' => 1 * HOUR_IN_SECONDS,
] );

License: GPLv2 or later

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version., (*11)

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details., (*12)

The Versions

11/04 2018

dev-master

9999999-dev https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

11/04 2018

dev-develop

dev-develop https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

11/04 2018

1.1.0

1.1.0.0 https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

18/04 2016

1.0.3

1.0.3.0 https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

01/03 2016

1.0.2

1.0.2.0 https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

15/02 2016

1.0.1

1.0.1.0 https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including template variables and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

25/01 2016

1.0.0

1.0.0.0 https://github.com/johnbillion/extended-template-parts/

A library which provides extended functionality to WordPress template parts, including theme templating and caching.

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires