Primo Vars

Description

Contact details have a habit of appearing on a dozen pages. When the phone number or email changes, you get to find every one of them – a real pain!

Primo Vars fixes that. Define a value once on a single settings screen, give it a name, and use its shortcode wherever you need it. Change the value and every page follows.

Each variable has a type, and the type does the fiddly work for you:

• Phone: renders a tappable tel: link, while displaying the number exactly as you typed it, brackets, spaces, country code and all.
• Email: renders a mailto: link with the address obfuscated against scrapers.
• Link: renders an anchor, with an optional custom label.
• Address: a multi-line field that keeps your line breaks.
• Multi-line text: the same, for opening hours, a disclaimer, anything that runs to more than one line.
• Text: renders plain text, for anything else.

Usage

[primo_var key="phone"]
[primo_var key="email"]
[primo_var key="facebook" text="Follow us"]
[primo_var key="phone" raw="1"]

raw="1" returns the plain value with no link, for when you are building your own markup around it.

In a theme template:

<?php echo primo_vars_get( 'phone' ); ?>
<?php echo primo_vars_get( 'phone', true ); // raw ?>

In the block editor

Insert the Primo Var block, pick a variable from the dropdown, and it
renders exactly what the shortcode would. Use the shortcode when you want a
value inline in a sentence, and the block when it stands on its own.

Starter variables

A fresh install creates seven empty variables to fill in: phone, email,
address, facebook, instagram, linkedin and youtube. Delete the ones you do not
want, or add your own. A YouTube channel is just a Link, the same as any other
social profile.

For developers

Filter primo_vars_output to change what any variable renders, from the
shortcode, the block and primo_vars_get() alike. It fires for a variable
that is defined but left empty, which is what the example below relies on;
it does not fire for a key that is not defined at all, since all three entry
points return an empty string before reaching this filter in that case.

add_filter( 'primo_vars_output', function ( $html, $var, $atts ) {
    if ( '' === $html && 'phone' === $var['type'] ) {
        return 'Call the office';
    }
    return $html;
}, 10, 3 );

The HTML handed to the filter is already escaped. Anything your callback adds
is yours to escape.

Phone numbers with extra text

Real phone numbers are messy. +61 491 570 156 Option 2 and (08) 8123 1234 both display exactly as typed, and both produce a correct dial link. The trailing “Option 2” is not dialled.

Where the number cannot be worked out automatically, no link is shown rather than a wrong one. That covers vanity numbers like 1300 PRIMO, and two numbers written in one field such as (08) 8123 1234 (0412 345 678). Fill in the optional Dial as field on that row and it will link exactly as you specify.