Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

Commit

Permalink
Merge pull request #821 from eileenmcnaughton/patch-12
Browse files Browse the repository at this point in the history
Add `settings_pages` to main spec
  • Loading branch information
homotechsual authored Jun 15, 2020
2 parents 2314fc0 + a28ff0d commit e7e4503
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/framework/setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Each file consists of a php snippet which returns an array. Array keys are strin
'is_domain' => 1,
'is_contact' => 0,
'description' => ts('If enabled, CiviCRM will permit submissions from external sites to profiles. This is disabled by default to limit abuse.'),
`settings_pages` => ['remote' => ['weight' => 10]],
),
```

Expand Down Expand Up @@ -76,6 +77,7 @@ The Supported Properties for settings are:
| `on_change` | Callback function when this setting is altered e.g when you enable a component or logging| |
| `is_domain` | Domain setting| Setting is_domain to 1 indicates that the setting applies to the entire installation (in single site mode) or to a single domain in multi-site mode. If is_domain is set to 1, then is_contact must be set to 0. |
| `is_contact` | Contact setting| Setting is_contact to 1 indicates that the setting applies to a single contact and can be different for each contact. If is_contact is set to 1, is_domain must be set to 0. |
|`settings_pages`|Metadata for presentation on settings pages|The key (or keys) are the last part of the url on the page the setting should be displayed on. Adding a weight provides sorting|

### Deprecated Properties

Expand Down

0 comments on commit e7e4503

Please sign in to comment.