reduxframework / docs

Documentation for Redux Framework, the most powerful WordPress interface framework.

title
Redux Documentation

Redux.io Documentation

Documentation for Redux.io, the world's most powerful and widely use WordPress input framework.

These docs are based off of VuePress and automatically built by GitHub Actions.

Feel free to send pull requests and improvements. We'd love your help if you find anything we've missed.

Working with VuePress

yarn install

Test Locally

yarn docs:dev

Build HTML

yarn docs:build

Works best with a Unix-based OS.

docs's Issues

Field Types - 404 Error

Hi, this URL is returning 404:

https://devs.redux.io/configuration/core-fields/

Regards,

Need a nestedkeyvalue formatter.

Need a nestedkeyvalue formatter that provides:
id => nestedkeyformatter array.

See palette_color and arg palettes

Originally posted by @dovy in #23 (comment)

#수도권오피최강자# ygm1 닷 컴~

WPGlobus 1.5.0 and Redux Framework are annoing

message removed due to vulgarity and poor attitude.

how can we make a custom class for redux field and accordion .

I want to give a custom class name to the redux field.

Redux Framework Warning

I'm using a wordpress theme which has Theme Options on WP admin panel. When i'm in the theme options, there is an error top of the dashboard like:

ace-editor-js CDN unavailable. Some controls may not render properly. Please wait a few minutes, then try refreshing the page. Unable to load some remotely hosted scripts..

How can i solve this?
By the way, i'm using VPS with CentOS.

Advanced: WPML Integration

Still uses the old config style and not the API.

validate_callback problem

sorry i write the issue in wrong place

Docs wrong with 4.x Migration & Compatibility

4.x Migration & Compatibility

https://docs.redux.io/guides/other/migration-guide.html

v 3.x =
in doc is

Redux::setSections

but not work it is

Redux::setSection

v 4 =
Redux::set_sections
Not work

Right Redux::setSection Not Redux::set_sections

missing theme options after cloning the website (files and db) to staging server

help appreciated

Redux framework slow when in admin

Hi admin

I can not load the active admin Redux
When hide it normal to open letters

admin help my

Dimensions Field Type

Hi team redux,

I found an error in dimensions field type on save.

[ 'id' => TCI_UET_CONSULA . 'header_logo_img_dimension', 'type' => 'dimensions', 'title' => __( 'Logo Image dimension', 'tci-uet-consula' ), 'subtitle' => __( 'Set the logo image dimension like width and height to show on consula header.', 'tci-uet-consula' ), 'units' => false, 'default' => [ 'Width' => '200', 'Height' => '100' ], 'required' => [ TCI_UET_CONSULA . 'header_logo_type', '=', 'img' ], ],

And here is the error;

[05-Aug-2019 13:29:15 UTC] PHP Warning: Illegal offset type in E:\wamp64-new\www\work\plugins\wp-content\plugins\tci-ultimate-elementor-themes\redux-framework\ReduxCore\framework.php on line 661

pasword hash

Hello.
I had a problem with the password.
How do I save the password encrypted in the database?
Is it possible to encrypt the password?

Argument: Permissions

Still using a href to link. Needs markdown.

Nags must be dismissible

The current nag "Redux Framework: New Documentation coming!" in the admin cannot be dismissed. It keeps coming back when the page is refreshed.

introduce-builder-to-fields Sign-off

• ACE Editor
• Background
• Border
• Button Set
• Checkbox
• Color Gradient
• Color RGBA
• Color
• Date
• Dimensions
• Divide
• Editor
• Gallery
• Image Select
• Info
• Link Color
• Media
• Multi Text
• Palette Color
• Password
• Radio
• Raw
• Section
• Select Image
• Select
• Slider
• Slides
• Sortable
• Sorter
• Spacing
• Spinner
• Switch
• Text
• Textarea
• Typography

Composer Package Incorrect?

I recently tried to composer require reduxframework/redux-framework as described in /docs/guides/basics/install.md, however Composer was unable to locate the package.

A search on Packagist only brings up redux-framework/redux-framework.

Is the documentation incorrect, or have I overlooked something?

guides/basics-using-tgm-plugin-activation.md

Can you (or anyone else) add a basic blurb on the config. That's all that needs to be done to finish it off.

🏥강남야관문(약꽝문)【💑】↩↪🔝강남오피🆙Y G M 1 닷컴☑꽝남오피💗

🏥강남야관문(약꽝문)【💑】↩↪🔝강남오피🆙Y G M 1 닷컴☑꽝남오피💗🏥강남야관문(약꽝문)【💑】↩↪🔝강남오피🆙Y G M 1 닷컴☑꽝남오피💗🏥강남야관문(약꽝문)【💑】↩↪🔝강남오피🆙Y G M 1 닷컴☑꽝남오피💗🏥강남야관문(약꽝문)【💑】↩↪🔝강남오피🆙Y G M 1 닷컴☑꽝남오피💗 from 야 관 문

Theme Options CSS and JS file URL issue when embedded in a theme

I embed Redux Framework 4.1.17 in a theme. When I visit the Theme Options page the file URLs to CSS and JS assets are incorrect. They include extra path information instead of only the URL of my website theme.

For example: https://domain.com/wp-content/plugins/var/www/vhosts/domain.com/httpdocs/wp-content/themes/sample-theme/redux-framework/redux-core/inc/fields/slides/redux-slides.css?ver=4.1.16.1598631244

Is there something I'm doing wrong that could cause this issue? Or, is the free version not able to be embedded in a theme?

Error: CSS

Error: CSS: top: Invalid type: var(--extendify--spacing--large) * -1

{top:calc(var(--extendify--spacing--large)*-1)!important}

Redux V 4.3.8

How to fix the error?
Will there be a new version with fixes?

Text size of main description.

I think this is gorgeous... The descriptions for each section are so easy to articulate. I don't have that many issues articulating the current documentation but this makes it easy for me to take a look at something with one pass and grasp how it supposed to work and get right back to work instead of spending too much time trying to examine the example to understand the appropriate way to use the code. I do have one humble suggestion.. At times the text size for the descriptions and the description's title don't appear to have much of a contrast. The text size of the description could probably be a bit smaller. For example in the following sections:

Select a Unique opt_name
Redux is built to allow multiple projects to use Redux at once. You must select a unique opt_name to avoid avoid collision with other projects. Make sure you choose something that's not too common. Oh, and no spaces.

And:

Creating a Redux Instance
Creating a Redux instance is pretty simple.

The title and description for these sections almost appear to be the same size. I think its way better for the eyes and will make it much easier to quickly recognize a section if the contrast was a little more apparent.

Metaboxes rewrite

Need to do the markdown conversion for each. These were previously done in HTML. Various errors exist specifically with date-time-picker, multi-media, repeater, and social-profiles.

• Accordion
• CodeMirror - Advanced Code Editor
• Color Schemes
• CSS Layout
• Custom Fonts
• Google Maps
• Date-Time Picker
• Icon Select
• JS Button
• Metaboxes
• Multi Media
• Repeater
• Social Profiles
• Taxonomy

default not working on type select

I'm using Redux Framework 4.1.24 and I noticed that default attribute doesn't work on input type select

wordpress.org-submissions

A developer can then delete the tracking class and be fully compliant with WordPress.org requirements. That class is located in:~/ReduxCore/inc/classes/tracking.php.

Obviously this was moved or split up. Where is it now, specifically? Can this even be removed anymore in this fashion?

If sample snippets can be included into docs for pretty much everything, that would awesome

Once done at framework level, update docs.

reduxframework/redux-framework-4#66

~/guides/advanced-embedding-redux

If you could rewrite this with the details you were thinking of before that would be great.

Redux 4 Global Argument Error

Hi team redux,

I have found an error on the global argument database ( theme_mods, theme_mods_expanded ).
When I add the database like theme_mods or theme_mods_expended, I have found an error on saving of redux options and error is Ajax:warning.
And here is the errors list by actions.

PHP Warning: Illegal offset type in ReduxCore\framework.php on line 661.
PHP Stack trace:
PHP 1. {main}() wp-admin\admin-ajax.php:0
PHP 2. do_action() wp-admin\admin-ajax.php:173
PHP 3. WP_Hook->do_action() wp-includes\plugin.php:465
PHP 4. WP_Hook->apply_filters() wp-includes\class-wp-hook.php:310
PHP 5. Redux_AJAX_Save->save() wp-includes\class-wp-hook.php:286
PHP 6. Redux_Options->validate_options() ReduxCore\inc\classes\class-redux-ajax-save.php:80
PHP 7. ReduxFramework->set() ReduxCore\inc\classes\class-redux-options.php:923

This error was so hard to find out for me. Because, I thought that error is in my PHP code. So, I sorted my PHP so many times. Before this ticket, I created a ticket, name by Dismisions Field Type Error and after realize that error is not in this field, I close the ticket.

Doc site Redirects, new

Getting ready to redirect the old doc site to the new. Need another set of eyes. Can you confirm all these look good?

# TODO - Make this page
rewrite ^(/core/advanced/setting-redux-values-on-plugin-activation.*) https://docs.redux.io.html permanent;

# Need to verify
rewrite ^(/core/advanced/updating-a-css-file-dynamically.*) https://docs.redux.io/configuration/arguments/compiler.html permanent;
rewrite ^(/core/advanced/integrating-a-compiler.*) https://docs.redux.io/configuration/arguments/compiler.html permanent;
rewrite ^(/core/advanced/enabling-typography-preview-for-local-fonts.*) https://docs.redux.io/premium/custom-fonts.html permanent;
rewrite ^(/core/advanced/add-a-custom-field.*) https://docs.redux.io/guides/basics/using-extensions.html#creating-a-custom-extension permanent;
rewrite ^(/core/redux-converter.*) https://docs.redux.io/guides/other/redux-converter.html permanent;
rewrite ^(/extensions/css-layout.*) https://docs.redux.io/premium/css-layout.html permanent;
rewrite ^(/extensions/date-time-picker.*) https://docs.redux.io/premium/date-time-picker.html permanent;
rewrite ^(/extensions/color-schemes.*) https://docs.redux.io/premium/color-schemes.html permanent;
rewrite ^(/extensions/taxonomy.*) https://docs.redux.io/premium/taxonomy.html permanent;
rewrite ^(/extensions/google-maps.*) https://docs.redux.io/premium/google-maps.html permanent;
rewrite ^(/extensions/accordion.*) https://docs.redux.io/premium/accordion.html permanent;
rewrite ^(/extensions/custom-fonts.*) https://docs.redux.io/premium/custom-fonts.html permanent;
rewrite ^(/extensions/repeater.*) https://docs.redux.io/premium/repeater.html permanent;
rewrite ^(/extensions/social-profiles.*) https://docs.redux.io/premium/social-profiles.html permanent;
rewrite ^(/extensions/multi-media.*) https://docs.redux.io/premium/multi-media.html permanent;
rewrite ^(/extensions/js-button.*) https://docs.redux.io/premium/js-button.html permanent;
rewrite ^(/extensions/icon-select.*) https://docs.redux.io/premium/icon-select.html permanent;
rewrite ^(/core/advanced/actions-hooks.*) https://docs.redux.io/configuration/hooks-action.html permanent;
rewrite ^(/core/advanced/filter-hooks.*) https://docs.redux.io/configuration/hooks-filter.html permanent;
rewrite ^(/core/templates.*) https://docs.redux.io/guides/advanced/panel-templates.html permanent;
rewrite ^(/core/redux-api.*) https://docs.redux.io/configuration/redux-api.html permanent;
rewrite ^(/core/support-defined.*) https://docs.redux.io/guides/basics/support-defined.html permanent;
rewrite ^(/core/ide-snippets-templates.*) https://docs.redux.io/guides/other/ide-snippets-and-templates.html permanent;
rewrite ^(/core/generating-a-support-hash.*) https://docs.redux.io/guides/basics/generating-a-support-hash.html permanent;
rewrite ^(/core/support/increasing-the-wordpress-memory-limit.*) https://docs.redux.io/guides/advanced/increasing-the-memory-limit.html permanent;
rewrite ^(/core/support/understanding-the-redux-framework-system-status-report.*) https://docs.redux.io/guides/advanced/health-status-report.html permanent;
rewrite ^(/core/wp_filesystem-proxy.*) https://docs.redux.io/guides/advanced/wp-filesystem-proxy.html permanent;
rewrite ^(/core/advanced/wpml-integration.*) https://docs.redux.io/guides/advanced/wpml-integration.html permanent;
rewrite ^(/core/wordpress-org-submissions.*) https://docs.redux.io/guides/other/wordpress.org-submissions.html permanent;
rewrite ^(/core/theme-check.*) https://docs.redux.io/guides/other/theme-check-warnings-and-errors.html permanent;
rewrite ^(/core/arguments.*) https://docs.redux.io/configuration/arguments-global.html permanent;
rewrite ^(/core/getting-started.*) https://docs.redux.io/guides/basics/getting-started.html permanent;
rewrite ^(/uncategorized/getting-started-with-arguments.*) https://docs.redux.io/guides/basics/core-concepts.html.html permanent;
rewrite ^(/extensions/using-extensions.*) https://docs.redux.io/guides/basics/using-extensions.html permanent;
rewrite ^(/core/advanced/update-an-option-outside-the-options-panel.*) https://docs.redux.io/guides/advanced/updating-an-option-manually.html permanent;
rewrite ^(/extensions/codemirror.*) https://docs.redux.io/premium/codemirror.html permanent;
rewrite ^(/core/the-basics/using-data-argument.*) https://docs.redux.io/configuration/arguments/data.html permanent;
rewrite ^(/extensions/metaboxes.*) https://docs.redux.io/premium/metaboxes.html permanent;
rewrite ^(/core/advanced/customizer-integration.*) https://docs.redux.io/guides/basics/customizer-integration.html permanent;
rewrite ^(/core/advanced/loading-extensions.*) https://docs.redux.io/guides/basics/using-extensions.html permanent;
rewrite ^(/core/advanced/adding-another-icon-web-font-to-the-panel.*) https://docs.redux.io/guides/advanced/using-another-icon-web-font.html permanent;
rewrite ^(/core/advanced/custom-panel-css.*) https://docs.redux.io/guides/advanced/overriding-default-css.html permanent;
rewrite ^(/core/advanced/embedding-redux-into-your-theme-or-plugin.*) https://docs.redux.io/guides/advanced/embedding-redux.html permanent;
rewrite ^(/core/sections/getting-started-with-sections.*) https://docs.redux.io/configuration/objects/section.html permanent;
rewrite ^(/core/the-basics/removing-demo-mode-and-notices.*) https://docs.redux.io/guides/basics/removing-demo-mode-notice.html permanent;
rewrite ^(/core/the-basics/required.*) https://docs.redux.io/configuration/arguments/required.html permanent;
rewrite ^(/core/the-basics/validation.*) https://docs.redux.io/configuration/arguments/validate.html permanent;
rewrite ^(/core/the-basics/using-hints-in-fields.*) https://docs.redux.io/configuration/arguments/hints.html permanent;
rewrite ^(/core/the-basics/output-2.*) https://docs.redux.io/configuration/arguments/output.html permanent;
rewrite ^(/core/fields/using-permissions.*) https://docs.redux.io/configuration/arguments/permissions.html permanent;
rewrite ^(/core/fields/importexport.*) https://docs.redux.io/core-extensions/import-export.html permanent;
rewrite ^(/core/fields/color-gradient.*) https://docs.redux.io/core-fields/color-gradient.html permanent;
rewrite ^(/core/fields/color-rgba.*) https://docs.redux.io/core-fields/color-rgba.html permanent;
rewrite ^(/core/fields/date.*) https://docs.redux.io/core-fields/date.html permanent;
rewrite ^(/core/fields/dimensions.*) https://docs.redux.io/core-fields/dimensions.html permanent;
rewrite ^(/core/fields/divide.*) https://docs.redux.io/core-fields/divide.html permanent;
rewrite ^(/core/fields/editor.*) https://docs.redux.io/core-fields/editor.html permanent;
rewrite ^(/core/fields/image-select.*) https://docs.redux.io/core-fields/image-select.html permanent;
rewrite ^(/core/fields/gallery.*) https://docs.redux.io/core-fields/gallery.html permanent;
rewrite ^(/core/fields/palette-color.*) https://docs.redux.io/core-fields/palette-color.html permanent;
rewrite ^(/core/fields/info.*) https://docs.redux.io/core-fields/info.html permanent;
rewrite ^(/core/fields/link-color.*) https://docs.redux.io/core-fields/link-color.html permanent;
rewrite ^(/core/fields/media.*) https://docs.redux.io/core-fields/media.html permanent;
rewrite ^(/core/fields/multi_text.*) https://docs.redux.io/core-fields/multi-text.html permanent;
rewrite ^(/core/fields/password.*) https://docs.redux.io/core-fields/password.html permanent;
rewrite ^(/core/fields/radio.*) https://docs.redux.io/core-fields/radio.html permanent;
rewrite ^(/core/fields/raw.*) https://docs.redux.io/core-fields/raw.html permanent;
rewrite ^(/core/fields/section.*) https://docs.redux.io/core-fields/section.html permanent;
rewrite ^(/core/fields/select.*) https://docs.redux.io/core-fields/select.html permanent;
rewrite ^(/core/fields/select-image.*) https://docs.redux.io/core-fields/select-image.html permanent;
rewrite ^(/core/fields/slider.*) https://docs.redux.io/core-fields/slider.html permanent;
rewrite ^(/core/fields/slides.*) https://docs.redux.io/core-fields/slides.html permanent;
rewrite ^(/core/fields/sortable.*) https://docs.redux.io/core-fields/sortable.html permanent;
rewrite ^(/core/fields/sorter.*) https://docs.redux.io/core-fields/sorter.html permanent;
rewrite ^(/core/fields/spacing.*) https://docs.redux.io/core-fields/spacing.html permanent;
rewrite ^(/core/fields/spinner.*) https://docs.redux.io/core-fields/spinner.html permanent;
rewrite ^(/core/fields/switch.*) https://docs.redux.io/core-fields/switch.html permanent;
rewrite ^(/core/fields/text.*) https://docs.redux.io/core-fields/text.html permanent;
rewrite ^(/core/fields/textarea.*) https://docs.redux.io/core-fields/textarea.html permanent;
rewrite ^(/core/fields/typography.*) https://docs.redux.io/core-fields/typography.html permanent;
rewrite ^(/core/fields/border.*) https://docs.redux.io/core-fields/border.html permanent;
rewrite ^(/core/fields/background.*) https://docs.redux.io/core-fields/background.html permanent;
rewrite ^(/core/fields/ace-editor.*) https://docs.redux.io/core-fields/ace-editor.html permanent;
rewrite ^(/core/fields/button_set.*) https://docs.redux.io/core-fields/button-set.html permanent;
rewrite ^(/core/fields/checkbox.*) https://docs.redux.io/core-fields/checkbox.html permanent;
rewrite ^(/core/fields/color.*) https://docs.redux.io/core-fields/color.html permanent;
rewrite ^(/core/fields/getting-started-with-fields.*) https://docs.redux.io/configuration/objects/field.html permanent;

https://build.redux.io/ is down

Can't figure out another place where to add this issue...

Metabox extension (editor) not working

Hi.
I installed the metabox extension for posts, the metabox with the editor field does not work in visual mode, only TXT.
When disable gutenberg, it works.
I wanted to leave Gutenberg, + put wp_editor for the metabox, is it possible? What needs to be fixed?
WP 6.0
Redux Framework 4.3
Theme - default

Thanks

Refresh or drop? - setting-redux-values-on-plugin-activation

This old article exists:
https://docs.reduxframework.com/core/advanced/setting-redux-values-on-plugin-activation/

If we update this to use best practices (IE, using the Redux::get_option with defaults).

Or maybe we outline how to use the plugin activation code for both setup and deleting the user's option panel settings.

Thoughts @kprovance

Deprecated article - Updating a CSS File Dynamically

Advanced: Typography Preview w/ Local Fonts Deleted
Advanced: Updating a CSS File Dynamically

These no longer work. They should be removed. We've been asked to support the filesystem article about dynamic css files more than once. I would not even include it anymore, even with a deprecated notice, because folks don;t read that part and will still ask, and we'll still have to say no.