Getting Started


CSS Variables

This theme generates CSS variables to add styles to items within the site. These variables should be used, wherever possible, within the child theme to keep styles consistent across the site.

Usage example: color: var(--primary_color);

  • --primary_color
  • --secondary_color
  • --logo_height
  • --scrolling_logo_height
  • --scrolling_header_background
  • --header_background
  • --top_bar_background
  • --footer_background
  • --copyright_background
  • --favicon_url
  • --page_container_width
  • --all_font_family
  • --all_font_color
  • --all_font_weight
  • --all_font_transform
  • --body_font_family
  • --body_font_color
  • --body_font_weight
  • --body_font_size
  • --body_font_transform
  • --h1_font_family
  • --h1_font_color
  • --h1_font_weight
  • --h1_font_transform
  • --h2_font_family
  • --h2_font_weight
  • --h2_font_transform
  • --h3_font_family
  • --h3_font_weight
  • --h3_font_transform
  • --h4_font_family
  • --h4_font_weight
  • --h4_font_transform
  • --h5_font_family
  • --h5_font_weight
  • --h5_font_transform
  • --h6_font_family
  • --h6_font_weight
  • --h6_font_transform
  • --menu_items_font_family
  • --menu_items_font_color
  • --menu_items_font_weight
  • --menu_items_font_size
  • --menu_items_font_transform

Using Theme Options in PHP

Theme options can be retrieved using legendary_toolkit_get_theme_option('OPTION KEY')

Debug Mode

To enable debug mode on theme panel add define('TOOLKIT_DEBUG', TRUE); in wp-config.php

Included Libraries


Bootstrap

Primary CSS framework, used for grid and buttons.

v4.5.3 Docs

Popper.js

Used for Bootstrap popovers and tooltips positioning.

v1.16.1 Docs

Font Awesome Free

Primary icon library. For alternatives, see Bootstrap Icons

v5.15.1 Icons

General


Upload the logo in .png or .jpg format. Logo is used in the primary header of the site.

Option Key: logo

Returns the ID of the uploaded media attachment

Favicon

Upload the favicon in .png or .jpg format.

Option Key: favicon

Returns the ID of the uploaded media attachment

Primary Color

See CSS Variable --primary_color

Select a color to apply styles to the following elements:

  • Standard links
  • Buttons with class .btn
  • Buttons created from Formidable Forms plugin
  • Blockquote border-left

Option Key: primary_color

Returns the HEX value of the selected color

Secondary Color

See CSS Variable --secondary_color

Select a color to apply styles to the following elements:

  • No current elements available

Option Key: secondary_color

Returns the HEX value of the selected color

Page Container Width

Overwrites Bootstrap's default container width.

Option Key: page_container_width

Returns numeric value in pixels (Default: 1320)

Enable GDPR Compliance

Adds GDPR Compliance check before the closing </body> tag, allowing users to accept cookies from the website. JavaScript asset is located at /assets/js/gdpr.js.

Option Key: enable_gdpr_compliance

Returns "on" when enabled

Header


Enable Full Width Header

Adds Bootstrap container-fluid class to primary header. Defaults to container

Option Key: full_width_header

Returns "on" when enabled

Enable Transparent Header

See CSS Variable --header_color

Applies a transparent background color to the primary header header#masthead.

Option Key: transparent_header

Returns "on" when enabled

Header Background

Select a color to apply styles to the following elements:

  • Primary Header header#masthead

Option Key: header_background

Returns the HEX value of the selected color

Scrolling Header Background

Select a color to apply styles to the following elements:

  • Primary Header after scrolling header#masthead.sticky_header.is-stuck

Option Key: scrolling_header_background

Returns the HEX value of the selected color

Enable Sticky Header

Applies sticky_header class to header#masthead. Positions the header as fixed. Initiates JS function to add class .is-stuck when scrolling. Adds var(--logo_height) as margin-top to #content or #page_title, depending on settings.

Option Key: sticky_header

Returns "on" when enabled

Logo Height

See CSS Variable --logo_height

Sets height of #site_logo. Sets margin-top of #content. Sets line-height of primary nav items.

Option Key: logo_height

Returns numeric value in pixels (Default: 100)

Scrolling Header Height

See CSS Variable --scrolling_logo_height

Sets height of #site_logo when scrolling. Sets line-height of menu items when scrolling.

Option Key: scrolling_logo_height

Returns numeric value in pixels (Default: 100)

Enable Top Bar

Adds top bar area above primary nav. Template file found in /template-parts/header-topbar.php

Option Key: enable_top_bar

Returns "on" when enabled

Top Bar Background

See CSS Variable --top_bar_background

Select a color to apply styles to the following elements:

  • Top Bar Background

Option Key: top_bar_background

Returns the HEX value of the selected color

Top Bar Content

Allows users to add content to the top bar.

Option Key: top_bar_content

Returns HTML from WYSIWYG editor

Enable Page Title

Adds page title area on all inside pages above primary content area.

Option Key: page_title

Page Title Content

Shortcodes are available for [page_title] and [breadcrumbs].

Allows users to customize the page title area.

Option Key: page_title_content

Returns HTML from WYSIWYG editor

Menu


Show Cart in Menu

Mobile Menu Position

Mobile Menu Width

Mobile Menu Breakpoint

Mobile Menu Top Content

Mobile Menu Bottom Content

Footer


Typography


Body

All Headings

Headings

Blog


Excerpt Length

Show Sidebar on Single Posts

Enable Comments

Show Sidebar on Archive Pages

Pages & Posts


Page Sidebar

Page Sidebar Position

Post Sidebar

Post Sidebar Position

Archives Sidebar Position

Archives Sidebar

Utilities


Available Shortcodes

[page_title]

Displays the page title text

[breadcrumbs]

Displays a styled list of page links

Parameters
sep (String) Optional
Text or HTML entity used as a separator between items
show_on_home (Int Bool) Optional
1 - show breadcrumbs on the homepage, 0 - don't show
home_text (String) Optional
Text to show on homepage before the breadcrumbs
show_current (Int Bool) Optional
1 - show current post/page title in breadcrumbs, 0 - don't show
before_current (String) Optional
HTML tag use before the current item
after_current (String) Optional
HTML tag use after the current item

[custom_widget]

Displays the post content of the provided post

Parameters
id (Int) Required
Post ID of the widget post

[toolkit_menu]

Displays the given menu using WordPress default navwalker

Parameters
id (Int) Required
Post ID of the menu
class (String) Optional
Class added to the menu's ul tag

[toolkit_logo]

Displays the saved logo using template-parts/header-logo.php

[year]

Displays the current year

Widgets


Examples