Skip to content

Latest commit

 

History

History
105 lines (78 loc) · 8.2 KB

README.md

File metadata and controls

105 lines (78 loc) · 8.2 KB
Raw

Gutenberg Template Library & Redux Framework

WordPress plugin WordPress Build Status Slack

Redux is powered by the Extendify team. Learn more at extendify.com

New to Version 4.3

Beta testing instructions for Metaboxes

  • Metaboxes config is includes in the sample config. Demo metaboxes are viewable on pages and posts when the demo panel is active.
  • If you are already using the Metaboxes extension of Redux Pro, there is nothing you need to update. The version of Metaboxes within the Redux core will override both the extension and Pro.
  • Please verify metaboxes in your existing project still function normally.
  • Please do not use this code in your production releases yet. Internal beta testing for your organization fine and encouraged.

New to Version 4.2

See the sample folder for examples for the new and improved fields.

  • Additional Typography features: Top and bottom margins, text shadow.
  • New Media Image Filters (greyscale, sepia, opacity, contrast, invert, blur, saturate, brightness, hue-rotate).
  • New Gradient Field Filters (type, reach, angle), including output for autogenerated CSS.
  • New Box Shadow field with output for autogenerated CSS.
  • New Flyout Submenus: flyout_submenus global arg.
  • New Alpha color option for color field: color_alpha field arg for fields that support color pickers.
  • Removed: async_typography global arg. Google no longer supports it. Use font_display with one of the following auto|block|swap|fallback|optional. See: https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display
  • Automatic update option for Google Fonts without a Pro subscription.

Follow us on Social Media!

Follow us on Twitter Like us on Facebook

Changelog

See Changelog.md

Documentation

Need a little help with Redux? Come check out our brand-new documentation site at devs.redux.io, chock-full of tutorials and examples!

Help Us Translate Redux

Please head over to the plugin page to learn how you can help us translate Redux quickly. Any and all are translations are welcome. We appreciate your help! https://translate.wordpress.org/projects/wp-plugins/redux-framework/

Features

  • Uses the WordPress Settings API
  • Multiple built in field types
  • Multple layout field types
  • Fields can be overloaded 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
  • Fully responsive options panel
  • Much more

What's new in version 4?

Core Rewrite

Our code base has been rebuilt from the ground up. With compartmentalized code, autoloading, and class inheritance, Redux is now faster and more efficient than it’s ever been!

Top of the Line Security!

Redux meets security standards laid out by WordPress Coding Standards, WordPress VIP Standards, and ThemeForest Guidelines. Focus includes escaping, sanitizing, and nonces verification, and database query prep/caching.

Gutenberg Template Library

Supercharge the Gutenberg editor with our ever-growing library of WordPress Blocks and templates. Discover what’s possible and implement any design on your website in virtually no time at all. See the WordPress plugin page for much more information!

Automatic Google Font Updates.

This is one of the crown jewels of Redux v4! Your users will have the ability to update Google Fonts as updates are available or automatic ‘behind the scenes’ updates. No more waiting for updates and no API key required!

Field Sanitizing

Field sanitizing allows one to pass an array of function names as an argument to a field in which the return value will be the sanitizing string. This feature will only work with text based fields including text, textarea, and multi_text (ACE Editor and WP Editor not included).

One may use any existing function including PHP functions, WordPress functions and custom written functions. The return value of any used function must be that of a string. Any other return value will be disregarded.

Please view the sample-config.php file for specific examples.

Select2 AJAX Loading

The AJAX loading routines for the select2 fields have been fixed/finished. See the 'capabilities' field in the demo panel for an example.

For the interim, this feature will only work when used in conjunction with the data argument (that is, the one that fetches WordPress data).

To set AJAX loading, add the 'ajax' => true argument to your select field. The min_input_length argument may also be added to specify how many characters should be typed before results are shown. Default is 1.

Field/Section Disabling

This feature has been request quite a few times over the years. Fields and sections can now be disabled by adding the 'disabled' => true argument to either a section or a field. The section or field will then appear 'greyed out' and not respond to input. This comes in handy in the event one may want to offer teasers for premium versions of their products.

Since those with a little CSS know-how could easily reactivate disabled fields with a little CSS, we took the added precaution of having Redux remove any name attributes on disabled fields/sections. This way, even if a clever user reactivates the field, it will never save.

Updated Panel Interface

The option panel interface has been brought up to date with the current WordPress admin design. It is also now ‘theme aware’. Panel colors will now follow suit with the selected admin theme.

Improved Field Validation

Due to the need for multiple field validations, Redux now supports an array of validations versus the previously limiting single argument. Validation results now appear in real time after a save without the need for page refresh.

Full v3 Backward Compatibility

We take backward compatibility very seriously here and strive to maintain it. Redux v4 has been designed to act as a drop in replacement to offer new functionality without breaking existing functionality.

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 work.