Skip to content

Commit da7cb39

Browse files
committed
New: categorise filters documentation
1 parent 31ac628 commit da7cb39

File tree

1 file changed

+39
-18
lines changed

1 file changed

+39
-18
lines changed

README.md

Lines changed: 39 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ If necessary, you may install it manually by downloading a Zip archive from [Git
3030
- Remove unwanted dashboard widgets
3131
- Replace the login logo (configurable)
3232
- Remove the footer message in CMS
33+
- Adds an environment icon to indicate the configured environment type
3334

3435
### Security
3536

@@ -60,24 +61,6 @@ If necessary, you may install it manually by downloading a Zip archive from [Git
6061

6162
## Available Filters
6263

63-
The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
64-
65-
- `orbit_enable_wordpress_updates`: Control the visibility of the WordPress updates item in the toolbar. Default `false` (hidden).
66-
- `orbit_enable_xmlrpc`: Enable or disable XML-RPC functionality. Default `false` (disabled).
67-
- `orbit_enable_user_caps_access`: Enable Orbit's user capability restrictions. Default `true` (enabled).
68-
- `orbit_enable_editor_caps_access`: Enable Orbit's editor capability restrictions. Default `true` (enabled).
69-
- `orbit_enable_gravity_forms_access`: Enable Orbit's Gravity Forms capability restrictions. Default `true` (enabled).
70-
- `orbit_enable_expose_wordpress_version`: Show or hide the WordPress version in the site's frontend markup. Default `false` (hidden).
71-
- `orbit_enable_admin_environment_name`: Control the display of the environment name in the admin area. Default `true` (enabled).
72-
- `orbit_enable_menu_item_dashboard`: Control the visibility of the Dashboard menu item. Default `true` (visible).
73-
- `orbit_enable_menu_item_posts`: Control the visibility of the Posts menu item. Default `true` (visible).
74-
- `orbit_enable_menu_item_comments`: Control the visibility of the Comments menu item and toolbar item. Default `false` (hidden).
75-
- `orbit_enable_toolbar_item_new_content`: Control the visibility of the "New Content" item in the toolbar. Default `true` (visible).
76-
- `orbit_enable_login_logo`: Enable replacement of the login logo. Default `true` (enabled).
77-
- `orbit_login_logo_url`: Provide a URL to replace the default WordPress login logo. No default.
78-
- `orbit_enable_rest_api_user_endpoints`: Enable or disable REST API user endpoints. Default `false` (disabled).
79-
- `orbit_remote_files_url`: Override the production URL used for loading remote media files. Default value comes from `ORBIT_REMOTE_FILES_URL`.
80-
8164
### Branded Emails
8265

8366
The following filters can be used to override default behaviour/values of branded email features.
@@ -93,6 +76,44 @@ The following filters can be used to override default behaviour/values of brande
9376
- `orbit_branded_emails_font_family`: Set the font family of branded emails. Default `woocommerce_email_font_family || '"Helvetica Neue", Helvetica, Roboto, Arial, sans-serif'`.
9477
- `orbit_branded_emails_logo_image_width`: Set the logo image width in branded emails. Default `woocommerce_email_header_image_width || 120`.
9578

79+
### UI Cleanup
80+
81+
The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
82+
83+
- `orbit_enable_menu_item_dashboard`: Control the visibility of the Dashboard menu item. Default `true` (visible).
84+
- `orbit_enable_menu_item_posts`: Control the visibility of the Posts menu item. Default `true` (visible).
85+
- `orbit_enable_menu_item_comments`: Control the visibility of the Comments menu item and toolbar item. Default `false` (hidden).
86+
- `orbit_enable_toolbar_item_new_content`: Control the visibility of the "New Content" item in the toolbar. Default `true` (visible).
87+
- `orbit_enable_login_logo`: Enable replacement of the login logo. Default `true` (enabled).
88+
- `orbit_login_logo_url`: Provide a URL to replace the default WordPress login logo. No default.
89+
- `orbit_enable_admin_environment_name`: Control the display of the environment name in the admin area. Default `true` (enabled).
90+
91+
### Security
92+
93+
The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
94+
95+
- `orbit_enable_rest_api_user_endpoints`: Enable or disable REST API user endpoints. Default `false` (disabled).
96+
- `orbit_enable_xmlrpc`: Enable or disable XML-RPC functionality. Default `false` (disabled).
97+
- `orbit_enable_expose_wordpress_version`: Show or hide the WordPress version in the site's frontend markup. Default `false` (hidden).
98+
99+
### Capabilities
100+
101+
The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
102+
103+
- `orbit_enable_user_caps_access`: Enable Orbit's user capability restrictions. Default `true` (enabled).
104+
- `orbit_enable_editor_caps_access`: Enable Orbit's editor capability restrictions. Default `true` (enabled).
105+
- `orbit_enable_gravity_forms_access`: Enable Orbit's Gravity Forms capability restrictions. Default `true` (enabled).
106+
107+
### Other Safety Measures
108+
109+
The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
110+
111+
- `orbit_enable_wordpress_updates`: Control the visibility of the WordPress updates item in the toolbar. Default `false` (hidden).
112+
113+
### Other Features
114+
115+
- `orbit_remote_files_url`: Override the production URL used for loading remote media files. Default value comes from `ORBIT_REMOTE_FILES_URL`.
116+
96117
### Examples
97118

98119
You can use standard WordPress functions like `__return_true` and `__return_false` to easily toggle these features. Add the following lines to your theme or a custom plugin:

0 commit comments

Comments
 (0)