circul8/wordpress-starter-theme

Starter theme to build a Timber theme

dev-master / 1.0.x-dev 2018-06-15 02:22 UTC

Requires

• advanced-custom-fields/advanced-custom-fields-pro: *
• wpackagist-plugin/disable-comments: ^1.7
• wpackagist-plugin/post-types-order: ^1.9.3
• wpackagist-plugin/timber-library: ^1.2
• wpackagist-plugin/tinymce-advanced: ^4.5
• wpackagist-plugin/types: ^2.3.1
• wpackagist-plugin/wp-tracy: ^1.0

MIT

• Jan Blasko
• jarednova

README

Starter theme based on Timber's Starter Theme. It is already part of Circul8 Wordpress Stack, can be also used with Root's Bedrock or normal Wordpress installation.

Installation

1. Using Circul8 Wordpress Stack
   1. composer create-project circul8/wordpress new-project
2. Using Bedrock or normal Wordpress installation
   1. Navigate to /web/app/themes/ or /wp-content/themes/
   2. Run git clone [e-mail]:circul8/wordpress-starter-theme.git
   3. Run composer install

Dependencies

• Composer
• Timber + Twig

Templating system

Templating is done by Timber plugin which uses Twig.

Custom filters

Filter	Description
dump	Dumps the variable to the Tracy's debug panel.
cfs($post_id = NULL, $options = [])	Returns CFS()->get($field_name, $post_id, $options) as descibred here where $field_name is filtered value.
post	Returns new Timber\Post($id) where $id is filtered value.
image	Returns new Timber\Image($id) where $id is filtered value.
target	Returns _blank or _self, expects Hyperlink Array from CFS.
webalize	Webalize string: "Hello, my friend!" -> "hello-my-friend"

Plugins

Those 👇 are Must-Use plugins installed into mu-plugins folder. If you install this theme from project's root using composer require, those plugins may be installed into plugins folder instead.

Plugin	Description
timber-library	The core plugin to create custom theme.
custom-field-suite	To manage custom fields.
wp-tracy	Debugging, adds debug panel.
disable-comments	To disable comments.
tinymce-advanced	Advanced WYSIWYG.

Directory structure

├─ assets			← Static files - images, CSS, LESS, gulp, JS, ...
├─ defaults			← Timber's starter theme twig files for fallback.
├─ pages			← Custom Wordpress template pages (.php)
├─ templates			← Custom twig templates.
│   └─ partials			← Components & other partials such as HTML header, footer, GA, ...
├─ admin.CSS			← Custom CSS sheet for administration.
└─ functions.php		← Theme boostrap