Skip to content

A simple, easily extendable options framework for WordPress based on NHP Theme Options Framework.

License

Notifications You must be signed in to change notification settings

binichda/ReduxFramework

 
 

Repository files navigation

Redux Options Framework v3.0.0 Beta Build Status

Wordpress options framework which uses the WordPress Settings API, Custom Error/Validation Handling, Custom Field/Validation Types, and import/export functionality.

Please help us beta test. As soon as the community verifies there are no bugs, we will release.

Getting Started with Redux

ReduxFramework has been built as a auto-updating plugin. For now, during beta, the plugin will prompt you for an update each time a new commit occurs.

To install the plugin, just download the master branch zip file, and install as you would any other Wordpress plugin.

Setting up Redux

Inside the zip file is a sample folder. Copy this into your theme or plugin directory. DO NOT modify anything within the plugin or you will all your work at each update.

Include the sample-config.php file in your theme functions.php or plugin as follows:

require_once('path/to/copied/sample/sample-config.php');

Edit sample-config.php as needed.

Donate to the Framework

If you can, please donate to help support the ongoing development of Redux Framework!

Donate to the framework

Features

  • Uses the WordPress Settings API
  • Multiple built in field types
  • Multple layout field types
  • Fields can be over-ridden with a callback function, for custom field types
  • Easily extendable by creating Field Classes
  • Built in Validation Classes
  • Easily extendable by creating Validation Classes
  • Custom Validation error handling, including error counts for each section, and custom styling for error fields
  • Custom Validation warning handling, including warning counts for each section, and custom styling for warning fields
  • Multiple Hook Points for customisation
  • Import / Export Functionality - including cross site importing of settings
  • Easily add page help through the class
  • Much more

Stay In The Loop!

Follow us on Twitter

FAQs

  1. Why should we use require_once instead of get_template_part?
  • First, because get_template_part is for... you guessed it, themes! Redux is designed to work with both themes and plugins.
  • Second, read this.
  1. Why shouldn't we edit sample-config.php in the plugin directory?
  • Because sample-config.php will be replaced at each update of the plugin. You will lose all your effort

Are you using Redux?

Send me an email at [email protected] so I can add you to our user spotlight!

Changelog

Master

  • Removed get() and show()
  • Fixed huge performance bug
  • More bugfixes
  • Fixed spacing field
  • Converted Redux to run as an auto-updating plugin. Getting ready to post to wordpress.org
  • Fixed the auto updater to properly show changes since the last update
  • Various fields including link_color, spacing, dimensions
  • Compiler hooks to allow developers to generate CSS files only when needed
  • Stability and standardizing in HTML output throughout
  • PHP/CSS/JS fixes
  • Compress JS and use LESS (and compressed CSS) throughout

Version 3.0.0 Beta (September 12, 2013)

  • Massive code overhaul
  • Replaced redundant field types with data elements
  • Migrated to company repo
  • Added several new storage methods
  • Numerous bugfixes
  • Renamed std argument to default
  • Added MP6 support
  • Complete CSS rewrite
  • Globals are now conditional
  • Added nesting support
  • Added repeatable field
  • Restyled Dev Mode
  • Added System Info tab
  • Added compiler hooks
  • Added style and icon support to info field
  • Switched to Elusive Icons
  • Huge performance updates

Version 2.0.1 Final (September 1, 2013)

  • Added option to override icon_type per icon
  • Minor bug/versioning fixes
  • Added Font Awesome intro
  • Added raw_html option
  • Added text_sortable option
  • Switched from Aristo to Bootstrap jQuery UI theme

Version 2.0.0 (January 31, 2013)

  • Fixed SSL error which occurred occasionally with Google Webfonts
  • Added optional flag for wpautop on editors
  • Added password field type
  • Added checkbox_hide_all option
  • Added WP3.5 media chooser
  • Added Google webfonts previews
  • Updated to WP3.5 color picker
  • Minor style tweaks
  • Added graphical 'switch' option for checkboxes
  • Removed dependency on class extension for fields
  • Deprecated icons in favor of iconfonts

Version 1.0.0 (December 5, 2012)

  • Based on NHP Theme Options Framework v1.0.6
  • Cleaned up codebase
  • Changed option group name to allow multiple instances
  • Changed checkbox name attribute to id
  • Added rows attribute to textareas
  • Removed extra linebreak in upload field
  • Set default menu position to null to avoid conflicts
  • Added sample content for dashboard credit line
  • Minor style changes
  • Changed name of upload button
  • Refactored Google Webfonts function
  • Replaced stylesheet_override with admin_stylesheet
  • Made text domain a constant
  • Removed PHP closing tags to prevent issues with newlines
  • Added option to define custom start tab

About

A simple, easily extendable options framework for WordPress based on NHP Theme Options Framework.

Resources

License

Stars

Watchers

Forks

Packages

No packages published