Filters & Hooks Reference
This page provides a complete reference of all PHP filter hooks, constants, and environment variables available in Orbit.
PHP Filter Hooks
Synced Theme Patterns
| Filter Hook | Type | Default | Description |
|---|---|---|---|
orbit_enable_synced_theme_patterns | bool | true | Enable or disable Orbit's theme-to-database synced pattern module. |
orbit_synced_theme_patterns | array | Discovered patterns | Filter the array of parsed synced theme patterns during a full sync. |
orbit_synced_theme_patterns_fingerprint_parts | array | Fingerprint parts | Filter segments used to generate the pattern fingerprint cache. |
orbit_allow_theme_synced_pattern_updates | bool | false | Allow REST/Site Editor updates to Orbit-managed synced pattern posts. Passed ($allow, $post_id). |
orbit_enable_disable_external_patterns | bool | true | Enable removal of external patterns (e.g. WooCommerce block patterns). |
Branded Emails
| Filter Hook | Type | Default | Description |
|---|---|---|---|
orbit_enable_branded_emails | bool | true | Enable or disable Orbit's HTML branded email wrapper. |
orbit_branded_emails_header_logo | string | '' | URL of the header logo image in branded emails. |
orbit_branded_emails_logo_image_width | int | 120 | Width of the header logo in pixels. |
orbit_branded_emails_background_color | string | WooCommerce / #ffffff | Outer background color for branded emails. |
orbit_branded_emails_body_background_color | string | WooCommerce / #ffffff | Content container background color. |
orbit_branded_emails_body_border_color | string | Theme var / #edeff1 | Content container border color. |
orbit_branded_emails_body_text_color | string | WooCommerce / #3f474d | Primary body copy text color. |
orbit_branded_emails_link_color | string | WooCommerce / #8549ff | Hyperlink text color. |
orbit_branded_emails_footer_text_color | string | WooCommerce / #3f474d | Footer text color. |
orbit_branded_emails_font_family | string | WooCommerce / Sans stack | CSS font-family stack for emails. |
Admin UI Cleanup & Environment Bar
| Filter Hook | Type | Default | Description |
|---|---|---|---|
orbit_enable_menu_item_dashboard | bool | true | Show or hide the Dashboard menu item. |
orbit_enable_menu_item_posts | bool | true | Show or hide the Posts menu item. |
orbit_enable_menu_item_comments | bool | false | Show or hide the Comments menu item and toolbar node. |
orbit_enable_toolbar_item_new_content | bool | true | Show or hide the "+ New" item in the top admin bar. |
orbit_enable_login_logo | bool | true | Enable custom login logo replacement. |
orbit_login_logo_url | string | '' | Image URL for the /wp-login.php screen logo. |
orbit_login_logo_width | int | 250 | Width (in pixels) for the login logo. |
orbit_enable_admin_environment_name | bool | true | Display the environment badge in the toolbar for Administrators. |
Security & Privacy
| Filter Hook | Type | Default | Description |
|---|---|---|---|
orbit_enable_rest_api_user_endpoints | bool | false | Expose /wp/v2/users endpoints to unauthenticated users. |
orbit_enable_xmlrpc | bool | false | Enable XML-RPC functionality. |
orbit_enable_expose_wordpress_version | bool | false | Expose WordPress version in HTML markup and asset query strings. |
orbit_default_security_headers | array | Header array | Filter baseline HTTP security headers array. |
orbit_enable_author_pages | bool | false | Enable author archive pages (/author/username). |
Capabilities & Role Permissions
| Filter Hook | Type | Default | Description |
|---|---|---|---|
orbit_enable_editor_caps_access | bool | true | Grant edit_theme_options to Editors and Shop Managers. |
orbit_enable_user_caps_access | bool | true | Grant user management capabilities (excluding delete_users) to Editors and Shop Managers. |
orbit_enable_gravity_forms_access | bool | true | Grant Gravity Forms capabilities to Editors and Shop Managers. |
orbit_enable_privacy_page_access | bool | true | Allow Editors and Shop Managers to access Privacy Policy settings. |
Performance, Utilities & Integrations
| Filter Hook | Type | Default | Description |
|---|---|---|---|
orbit_remote_files_url | string|null | Constant / Env var | Filter remote production URL for hotlinking media files. |
orbit_action_scheduler_retention_period | int | 1209600 (2 weeks) | Retention period (in seconds) for completed Action Scheduler jobs. |
orbit_action_scheduler_default_cleaner_statuses | array | ['complete', 'canceled', 'failed'] | Action Scheduler statuses targeted for automated cleanup. |
orbit_action_scheduler_cleanup_batch_size | int | 1000 | Number of Action Scheduler jobs cleaned up per batch run. |
PHP Constants & Environment Variables
| Name | Type | Purpose | Example |
|---|---|---|---|
ORBIT_ENABLE_FAST_404 | bool (Constant) | Opt-in fast 404 response for missing static asset files. | define( 'ORBIT_ENABLE_FAST_404', true ); |
ORBIT_REMOTE_FILES_URL | string (Constant / Env) | Production base URL used to hotlink missing media files on non-production. | define( 'ORBIT_REMOTE_FILES_URL', 'https://example.com' ); |
ORBIT_ERROR_REPORTING | int|bool (Constant) | Custom error reporting bitmask, or false to disable Orbit error handling. | define( 'ORBIT_ERROR_REPORTING', E_ALL & ~E_DEPRECATED ); |
SATELLITE_PRODUCTION_URL | string (Constant / Env) | Secondary fallback production URL for remote media hotlinking. | define( 'SATELLITE_PRODUCTION_URL', 'https://example.com' ); |