Wonderflux

====================================

Wonderflux WordPress theme framework

Version v2.6 - DEVELOPMENT VERSION - NOT FOR LIVE PRODUCTION ENVIRONMENTS!

Stable/production releases: https://github.com/Jonnyauk/Wonderflux/releases

Copyright (c)2011-2018 Jonny Allbut

Web: https://jonnya.net

GitHub: Jonnyauk

Twitter: @Jonnyauk

====================================

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You may have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

You may also view the license online: http://www.gnu.org/licenses/gpl-2.0.html

Welcome to Wonderflux

A free, professional Open Source responsive theme framework for WordPress & BuddyPress

Wonderflux is distributed under the GPL v2 license and just like WordPress is free to download, use and modify. YES, you can use Wonderflux on as many commercial, non-commercial and personal WordPress websites as you wish without any a fee, subscription or credit required (but it would be appreciated!)

Anyone is welcome to suggest ideas or code on GitHub, the goal is to develop a fantastic professional theme framework for everyone to use, for free, to make amazing WordPress sites! I appreciate any comments or patches - big or small!

• Project development home
• Ideas and bug reports
• Dev milestones
• Follow Wonderflux on Twitter

Help and documentation

The Wonderflux documentation site is a (slowly!) growing reference of all the files, functions, hooks & filters you can use in your child themes. Apologies, coding is much more fun than writing documentation, but there is complete in-line code documentation (PHPDoc format) in functions.php to refer to.

Please note the documentation website is somewhat out of date - I've fallen behind a little on working on this unfortunately, due to my normal (paid!) work. However, once I've completed Wonderflux v2.0 I'll be turning my attention back to documentation!

• All documentation
• Hooks
• Functions
• Filters
• Constants
• Files

Quickstart

Getting bored already and want to dive in - lets go!

1. [Download the latest stable release of Wonderflux.] (https://github.com/Jonnyauk/Wonderflux/releases) NOTE: Ensure directory is called wonderflux if downloading straight from GitHub master branch (not Wonderflux-master).
2. [Download WFX Girder demo child theme.] (https://github.com/Jonnyauk/wonderflux-girder/releases) NOTE: You can rename this directory to anything you wish.
3. Unzip and install both directories to wp-content/themes directory.
4. Activate WFX Girder demo child theme.
5. Take a look at the source code of WFX Girder child theme to learn more!

Layout and configuration options

Any active child theme of Wonderflux automatically has access to a number of theme configuration options (almost all are filterable on individual view too - cool!)

You'll find these in the admin area under 'Appearance > WFX Stylelab'.

• Number of vertical columns
• Create additional multiple column layout definition sets
• Column system gutter width
• Main content width
• Main container position
• Optimise media queries (remove rarely used CSS rules = huge reduction in file output)
• Content width
• Sidebar width
• Sidebar position
• Sidebar/main content responsive breakpoint for full width
• Sidebar display
• Media content width
• Hide Wonderflux page templates
• Document type
• Document language
• Document character set

Other features available in admin area:

• Generate a single compressed/minified Flux Layout CSS file, less than 6k Gzipped!
• Full server environmental system report
• Backup and restore Wonderflux options

Feeling brave? Beta testers can try out the shiny new Customizer options by installing the WP Flux Layout plugin plugin. It's a work in progress right now and is not complete (may be missing options!), but when installed it automatically interacts with Wonderflux options - cute!

Getting started

If you've used WordPress much, you are going to be right at home here! Wonderflux is developed to be similar to WordPress - it uses many of the same principles like actions and filters. It also features strong compliance with the latest WordPress theme standards (unlike most other frameworks!) and does pretty-much everything the WordPress way.

Wonderflux is a theme framework (sometimes called a parent theme) that you use by building your own child themes. You simply have both Wonderflux and your child theme uploaded to your normal WordPress theme directory.

By activating your child theme in the WordPress admin area just like a normal theme, it will automatically use files and functionality from Wonderflux, giving you a powerful toolkit and dynamic CSS layout system to rapidly develop bespoke WordPress themes for any purpose.

What makes a child theme work is a single line in the top section of style.css - Template: wonderflux. This lets WordPress know you want to use Wonderflux as a parent theme.

Child themes can be as simple as a single style.css file, or include any number of files that override or add functionality to Wonderflux or your website. A simple rule to remember is that if a core Wonderflux theme layout file exists in your child theme directory (eg header-content.php) it will be used instead of the core Wonderflux file. Read more about this in the Template parts section below.

Only advanced developers will need to actually override other standard Wonderflux template files in their Wonderflux child theme, for example header.php or footer.php

IF YOU OVERRIDE THESE YOU SHOULD DUPLICATE THE CORE FILE FROM WONDERFLUX INTO YOUR CHILD THEME DIRECTORY, this will ensure you retain the Wonderflux structure and hook system to give you the perfect starter file to begin playing with!

WFX Girder - a demonstration theme

The quickest way to begin learning how to use Wonderflux is to download the WFX Girder demonstration child theme and examine the file structure and code. There are lots of comments in each file to get you started.

WFX Girder is not only a good way to learn Wonderflux, but also provides a solid base starter child theme for you to build your own themes with.

Download WFX Girder theme

Live demo of WFX Girder theme

Template parts

These important files contain very simple content and layout. Separating the surrounding layout logic and code from the actual content makes the files simpler to edit. They can be thought of as re-useable parts that help avoid repetition of code.

An example is loop-content.php - used to display the main content of your site. Instead of repeating common CSS classes and layout just edit this one file, or see below on optionally extending with location awareness for more complex configurations.

If you have not worked with theme frameworks, parent themes or get_template_part() before - welcome to the future of WordPress theme development... and this barely scratches the surface of what Wonderflux can do for you!

Any file that has '-content' in the name is a template part:

• header-content-php
• loop-content.php (used to display main content)
• sidebar-content.php
• footer-content.php

Extend template parts with location awareness

Wonderflux extends the principle of template parts by adding location awareness. This automatically adds the ability to use files such as header-content-category.php which will override header-content.php when viewing a category archive.

Location awareness works automatically - if the file exists it gets used, otherwise it falls back to using the default file (the last listed). You will see the files shown below in the order, or cascade of files that will be used in given locations. We are using template part loop-content.php as an example template part, but this will work with any main template part, or indeed your own files if you use the wfx_get_template_part() function.

The loop-content-archive.php template part, is an useful (optional) file for child theme developers. It's used as a common fallback file when viewing category, tag, taxonomy, date and search archives views for a consistent archive display experience. You can of-course create files such as loop-content-date.php or loop-content-search.php to override this.

Wonderflux also feature basic