Is it possible to tokenize theme options to make them available to the basic site editor

Question

Forgive this if it's a duplicate, as I don't know what I don't know when asking this question. I am not sure I am even using the correct terminology (tokenize).

What I am trying to do is get an option that is set up in the back end of my theme:

array(
    'title' => esc_html__('Email Address', 'z_theme'),
    'subtitle' => esc_html__('Type email address.', 'z_theme'),
    'id' => 'email_address',
    'type' => 'text',
    'required' => array('top_header_opt', '!=', 'false'),
    'default' => '[email protected]',
),

I can easily get this via my PHP inside my theme ...

$opt = get_option('z_theme_opt');
$email_address = $opt['email_address'];

And plop it in the header / footer etc etc .. But I want the end user to be able to grab it any time with some sort of tokenized effort directly through the editor IE

<H3>[[email_address]]</H3>

While building the site out .. So that any time email_address is changed in the theme options, it is pulled through to the rest of the site, and does not need to remain hard coded in the HTML.

With WordPress's current functionality, is this a thing? If not how would I go about building that into my theme?

Answer 1

Ok through much research, I came up with a way to do this through my theme without having to create a separated plugin. First I set the options in the back end (I am using Redux Framework WP Plugin):

<?php
Redux::setSection('z_theme_opt', array(
    'title'     => esc_html__('Page Tokens', 'z_theme'),
    'id'        => 'opt_page_tokens',
    'icon'      => 'dashicons dashicons-html',
    'fields'    => array(
        array(
            'id'    => 'token_phone',
            'type'  => 'text',
            'title' => esc_html__('[[Phone_Number]]', 'z_theme'),
            'default'    => ''
        ),
        array(
            'id'    => 'token_email',
            'type'  => 'text',
            'title' => esc_html__('[[Email_Address]]', 'z_theme'),
            'default'     => ''
        ),

    ),
));

But however you set up your options is fine .. So long as you know the key the option is stored under. Here we're using

token_phone
token_email

Then in my functions.php within the theme, I added a filter on the_content() ... simply intercepting it

function filter_my_content($content) {
  $opt = get_option('z_theme_opt');

  $filter = [];
  $filter['[[Phone_Number]]'] = $opt['token_phone'];
  $filter['[[Email_Address]]'] = $opt['token_email'];

  foreach ($filter as $key => $val){
    $content = str_replace($key, $val, $content);
  }

return $content;
}

add_filter('the_content', 'filter_my_content');

So now in the editor .. Users can call these tokens any time they wish: