You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/basics/core-concepts.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,36 +11,43 @@ to properly grasp how Redux works.
11
11
:::
12
12
13
13
## Never modify core files!
14
-
Redux is extremely extensible, which means you can override nearly anything using filters. You will never find a need to modify a core file unless you're helping us to solve a bug. __***NEVER***__**modify anything inside redux-core**. If you want to change how a field works, build an extension instead. Need to modify a value when it's saved? Use a filter.
14
+
Redux is extremely extensible, which means you can override nearly anything using filters. You will never find a need to modify a core file unless
15
+
you're helping us to solve a bug. __***NEVER***__**modify anything inside redux-core**. If you want to change how a field works,
16
+
build an extension instead. Need to modify a value when it's saved? Use a filter.
15
17
16
18
::: danger Why is modifying `redux-core` files a bad practice when embedded in my own product?
17
19
Redux is built to run with only one version of the framework code. If you modify core files in your version, which you
18
20
embed in a product, there's no guarantee your version will be the version loaded should another product be using Redux.
19
-
This will most likely cause conflicts and headaches for you and your clients. By using filters and extensions, you ensure that your code will always be loaded despite the "core" that is instantiated first.
21
+
This will most likely cause conflicts and headaches for you and your clients. By using filters and extensions, you ensure that your code always loads
22
+
despite the "core" that is instantiated first.
20
23
:::
21
24
22
25
## Object Structure
23
-
We need to understand the object structure of Redux in order to understand how it all fits together.
26
+
We need to understand the object structure of Redux to understand how it all fits together.
24
27
25
28
### Field
26
-
The lowest building block is a [field](../../configuration/objects/field.md). A [field](../../configuration/objects/field.md) is what is displayed for a user to input data. It has its own set of characteristics depending on the [field type](../../core-fields). At this level, whatever args are set to the [field](../../configuration/objects/field.md) act as an override for all levels above.
29
+
The lowest building block is a [field](../../configuration/objects/field.md). A [field](../../configuration/objects/field.md) is what is displayed for a user to input data. It has its own set of characteristics
30
+
depending on the [field type](../../core-fields). At this level, whatever args are set to the [field](../../configuration/objects/field.md) act as an override for all levels above.
27
31
28
32
### Section
29
-
A [section](../../configuration/objects/section.md) is a grouping of [fields](../../configuration/objects/field.md). It groups everything together into its own array. It containes a number of arguments that can be passed down to the [fields](../../configuration/objects/field.md) below, provided the [fields](../../configuration/objects/field.md) below do not specify those same arguments on their own declaration. Again, the [fields](../../configuration/objects/field.md) level args override all.
33
+
A [section](../../configuration/objects/section.md) is a grouping of [fields](../../configuration/objects/field.md). It groups everything together into its own array. It containes a number of arguments that passed down
34
+
to the [fields](../../configuration/objects/field.md) below, provided the [fields](../../configuration/objects/field.md) below do not specify those same arguments on their own declaration. Again, the [fields](../../configuration/objects/field.md)
35
+
level args override all.
30
36
31
37
### Box
32
-
In some cases, such as is with [metaboxes](../../core-extensions/metaboxes-lite.md), an extra grouping is required. Hence, a box. A box is simply a container with a bunch of [sections](../../configuration/objects/section.md) within it. The primary purpose of a box is placement on the screen.
38
+
In some cases, such as is with [metaboxes](../../core-extensions/metaboxes-lite.md), an extra grouping is required. Hence, a box. A box is simply a container with a bunch of [sections](../../configuration/objects/section.md)
39
+
within it. The primary purpose of a box is placement on the screen.
33
40
34
41
### Instance
35
42
Instance level arguments are known as [global arguments](../../configuration/global_arguments.md). They impact all areas of
36
43
the instance. Typically, these are arguments that affect how Redux performs, but they can set an entire instance to display
37
-
a control panel in the [customizer only](../../configuration/global_arguments.md#customizer-only). If you're not sure what's
38
-
going on, the problem may be in the [global args](../../configuration/global_arguments.md).
44
+
a control panel in the [customizer only](../../configuration/global_arguments.md#customizer-only). If you're not sure what's going on, the problem may be in the [global args](../../configuration/global_arguments.md).
39
45
40
-
Remember, there can be multiple instances of Redux running in a single WordPress install. This means that all products based on Redux, be it plugins or the theme can be running at once without impacting one another.
46
+
Remember, there can be multiple instances of Redux running in a single WordPress installation. This means that all products based on Redux, be it
47
+
plugins or the theme can be running at once without impacting one another.
41
48
42
49
## Arguments
43
-
Every object has arguments and every level of nested objects can inherit or override those arguments. When looking at an
50
+
Every object has arguments, and every level of nested objects can inherit or override those arguments. When looking at an
44
51
argument, make sure you're thinking of how it will impact all the nested items below it (children).
Copy file name to clipboardExpand all lines: docs/guides/basics/getting-started.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,12 @@ through to see what suits your particular needs.
12
12
:::
13
13
14
14
## Installing
15
-
Redux must be installed to begin using it. The quickest approach is to install the WordPress.org plugin although other
15
+
Redux must be installed to begin using it. The quickest approach is to install the WordPress.org plugin, although other
16
16
approaches are available. [Read more in our install docs](install.md).
17
17
18
18
## Core Concepts
19
-
Another great guide to review is our core concepts. The Redux may be confusing without understanding how it's structured. [Read more in our core concepts docs](core-concepts.md)
19
+
Another great guide to review is our core concepts. The Redux may be confusing without understanding how it's structured.
20
+
[Read more in our core concepts docs](core-concepts.md)
20
21
21
22
## Basic Config
22
23
Once Redux is installed, we can begin digging in. Let's begin with a basic config. The [barebones example](https://github.com/reduxframework/redux-framework/blob/master/sample/barebones-config.php)
Copy file name to clipboardExpand all lines: docs/guides/basics/support-defined.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,42 +4,42 @@ sidebarDepth: 0
4
4
---
5
5
6
6
# Getting Help: Our Support Defined
7
-
We've included this document in order to help everyone understand what we will and will not support. Please read it carefully and
7
+
We've included this document to help everyone understand what we will and will not support. Please read it carefully and
8
8
with understanding as we wish to truly convey our intent to help.
9
9
10
10
::: warning Table of Contents
11
11
[[toc]]
12
12
:::
13
13
14
14
### Who are we?
15
-
We maintain an open source project entitled Redux Framework. It is used by millions of users across in all walks of life all across the
15
+
We maintain an open source project entitled Redux Framework. It is used by millions of users across in all walks of life across the
16
16
world. Redux is used primarily by developers. That means if users of our developers
17
-
approach us for help, it is often difficult and sometimes impossible to provide the requested support.
17
+
approach us for help, it's often challenging and sometimes impossible to provide the requested support.
18
18
19
19
### Why is that?
20
20
Redux is built for developers. A basic to moderate understanding of PHP, error logs, and JavaScript bugs is required. It is impossible
21
21
for us to provide solutions to those without the experience of coding in these spaces. We mean no disrespect, but often times it
22
22
takes us five times longer to explain a standard developer concept to a non-developer.
23
23
24
-
### But I'm a user, does that mean I'm out of luck?!
24
+
### But I'm a user; does that mean I'm out of luck?!
25
25
Not entirely. We want to help. We really do. We simply need to be compensated for our time. Not only are we debugging a
26
26
potential problem in OUR code, but also need to debug a problem within another developer's code to help. To do this, we
27
-
need you to support ourproject by paying for premium support.
27
+
need you to support ourproject by paying for premium support.
28
28
29
29
### But that's not fair!
30
30
It’s also not fair that your developer may have stopped supporting you. We sympathize. However, we'll be required to find out
31
31
exactly what your developer was doing and that takes a LOT of time on our part. We need to charge for that service.
32
-
Solving problems in third party applications that utilize Redux takes us away from our means as well as time spent
32
+
Solving problems in third party applications that use Redux takes us away from our means as well as time spent
33
33
making Redux better.
34
34
35
35
### Truly, we want to help!
36
-
We truly do want to help! But at the end of the day we can't offer unlimited support for circumstances beyond our control.
36
+
We truly do want to help! But at the end of the day, we can't offer unlimited support for circumstances beyond our control.
37
37
38
38
### Best of Luck!
39
-
We genuinely wish you best of luck. We're not attempting to insult. We will gladly solve problems in our code, but we cannot
40
-
solve problems in another developers code without compensation.
39
+
We genuinely wish you the best of luck. We're not attempting to insult. We will gladly solve problems in our code, but we cannot
40
+
solve problems in another developer's code without compensation.
41
41
42
42
### I still want support!
43
-
If you're still interested in support from us, you need to start by [generating a support hash](generating-a-support-hash.md).
44
-
Please do not be disappointed if we inform you that we require a purchase of [premium support](https://redux.io/extensions/premium-support)
45
-
for us to further assist you if your problem is outside the scope of our framework.
43
+
Please do not be disappointed if we inform you that we require a purchase of premium support
44
+
for us to further help you if your problem is outside the scope of our framework. For a quote, please [submit a request](https://redux.io/contact/) via our Contact Form.
45
+
Breifly describe your problem. If we're able to help, we'll send you a quote and request additional information from you then.
0 commit comments