Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix missing available operators in the conditional logic section. #70

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix missing available operators in the conditional logic section. #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions documentation/20-fields/1-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ New field are created using the `make` method `Field::make( $type, $name, $label

`$type`

The type of the field. This parameter should be valid class name of a field. For example `text` will create field of class `Field_Text`.
The type of the field. This parameter should be valid class name of a field. For example `text` will create field of class `Field_Text`.

`$name`

Expand Down Expand Up @@ -97,7 +97,7 @@ The conditional rules are passed in a two-dimensional array and each rule can ha
| --------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------| -------- |
| `field` | The field name to which the rule is applied. The name should be the same as defined in the container. | `string` | Yes |
| `value` | The value of the field. It can be an array only when `compare` is `IN`, `NOT IN`, `INCLUDES` or `EXCLUDES`. | `string|array`, default: `""` | No |
| `compare` | Operator to test. Possible values are: `=`, `<`, `>`, `<=`, `>=`, `IN`, `NOT IN`, `INCLUDES`, `EXCLUDES`. | `string`, default: `=` | No |
| `compare` | Operator to test. Possible values are: `=`, `!=`, `<`, `>`, `<=`, `>=`, `IN`, `NOT IN`, `INCLUDES`, `EXCLUDES`. | `string`, default: `=` | No |

You can optionally pass the `relation` key and set it to either `AND` (default) or `OR`. It defines the relation, when there is more than one rule.

Expand All @@ -116,7 +116,7 @@ Field::make( 'text', 'crb_facebook', 'Facebook URL' )
array(
'field' => 'crb_show_socials',
'value' => 'yes', // Optional, defaults to "". Should be an array if "IN" or "NOT IN" operators are used.
'compare' => '=', // Optional, defaults to "=". Available operators: =, <, >, <=, >=, IN, NOT IN
'compare' => '=', // Optional, defaults to "=". Available operators: =, !=, <, >, <=, >=, IN, NOT IN, INCLUDES, EXCLUDES
)
) ),
```
Expand Down