phile/content-variables

A plugin to add custom variables in your content before it is parsed.

1.0.1 2018-03-07 16:02 UTC

README

A plugin for Phile to add custom variables in your content before it is parsed.

1.1 Installation (composer)

composer require phile/content-variables

1.2 Installation (Download)

  • Install the latest version of Phile
  • Clone this repo into plugins/phile/contentVariables

2. Activation

After you have installed the plugin. You need to add the following line to your config.php file:

$config['plugins']['phile\\contentVariables'] = array('active' => true);

Usage

You must have a variables array in your config.

$config['variables'] = array(
  'site_title' => $config['site_title'],
  'base_url' => 'https://example.com/
);

These keys are the variables, and the value is what the replaced string will be. So now when you reference %base_url% in your markdown/textile/content pages, it will be rendered as your real base URL:

This is a link to my [base URL](%base_url%)

Will be rendered as:

<p>This is a link to my <a href="https://example.com">base URL</a></p>

Another example for a site with the title PhileCMS:

Welcome to %site_title%!

Becomes:

<p>Welcome to PhileCMS!</p>

Config

This plugin allows the open and close tags for your variables to be set. By default they are both set to the following:

'open_tag' => '%', // the open tag for the variable
'close_tag' => '%' // the close tag for the variable

This means any text wrapped with % signs will be replaced.