Skip to content

ConnorBurton/CleanBuild

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 

Repository files navigation

CleanBuild

A clean WordPress boilerplate to make creating custom sites quicker & easier.

Table of contents

Required Plugins

ACF is required to enable the custom shortcodes/options that the skeleton html includes.

  • Advanced Custom Fields Pro

Included 3rd Party Libraries

Theses libraries are enqueued in functions/wordpress/site-enqueue.php but are commented out by default.

  • Slick.js
  • Backstretch
  • Fancybox
  • FontAwesome 5

Company Detail Shortcodes

These are all of the shortcodes & their options that are generated using the Company Details tab in the backend of WordPress.

Shortcodes

Company Address

Returns the Company Address field. It returns each row in to a separate li tag.

<?php echo do_shortcode('[address]'); ?>
Option Type Default Description
row int 1 Selects which repeater row phone number will be returned
include-name boolean false Will return the company name as the first li
container boolean true Will wrap the returned list items in a ul with the class of address-list

Company Email Address

Returns the Company Email Address field in plaintext.

<?php echo do_shortcode('[email]'); ?>
Option Type Default Description
row int 1 Selects which repeater row of the Email Address field will be returned
link boolean false Will return the email address with mailto: before the email and a ?subject after
quick-link boolean false Will return the email address automatically wrapped in an a tag

Company Phone Number

Returns the Company Phone Number field in plaintext.

<?php echo do_shortcode('[phone]'); ?>
Option Type Default Description
row int 1 Selects which repeater row of the Phone Number field will be returned
link boolean false Will return the phone number with tel: before the number
quick-link boolean false Will return the phone number automatically wrapped in an a tag

Company Social Links

Returns the Company Social Links field. It returns each row in to a separate a tag.

<?php echo do_shortcode('[social]'); ?>
Option Type Default Description
container boolean true Will wrap the returned social links in a div with the class of social-links

Company Name

Returns the Company Name field in plaintext.

<?php echo do_shortcode('[company-name]'); ?>

Company Fax Number

Returns the Company Fax Number field in plaintext.

<?php echo do_shortcode('[fax]'); ?>

Company Registration Number

Returns the Company Reg Number field in plaintext.

<?php echo do_shortcode('[reg-number]'); ?>

Company Opening Hours

Returns each Company Opening Hours row in to a p tag.

<?php echo do_shortcode('[opening-hours]'); ?>
Option Type Default Description
container boolean false Will wrap the returned opening times in a div with the class of opening-hours
single-line boolean false Will return all rows in to a single p tag with a space on the end of each row