Skip to content

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 HookTypeDefaultDescription
orbit_enable_synced_theme_patternsbooltrueEnable or disable Orbit's theme-to-database synced pattern module.
orbit_synced_theme_patternsarrayDiscovered patternsFilter the array of parsed synced theme patterns during a full sync.
orbit_synced_theme_patterns_fingerprint_partsarrayFingerprint partsFilter segments used to generate the pattern fingerprint cache.
orbit_allow_theme_synced_pattern_updatesboolfalseAllow REST/Site Editor updates to Orbit-managed synced pattern posts. Passed ($allow, $post_id).
orbit_enable_disable_external_patternsbooltrueEnable removal of external patterns (e.g. WooCommerce block patterns).

Branded Emails

Filter HookTypeDefaultDescription
orbit_enable_branded_emailsbooltrueEnable or disable Orbit's HTML branded email wrapper.
orbit_branded_emails_header_logostring''URL of the header logo image in branded emails.
orbit_branded_emails_logo_image_widthint120Width of the header logo in pixels.
orbit_branded_emails_background_colorstringWooCommerce / #ffffffOuter background color for branded emails.
orbit_branded_emails_body_background_colorstringWooCommerce / #ffffffContent container background color.
orbit_branded_emails_body_border_colorstringTheme var / #edeff1Content container border color.
orbit_branded_emails_body_text_colorstringWooCommerce / #3f474dPrimary body copy text color.
orbit_branded_emails_link_colorstringWooCommerce / #8549ffHyperlink text color.
orbit_branded_emails_footer_text_colorstringWooCommerce / #3f474dFooter text color.
orbit_branded_emails_font_familystringWooCommerce / Sans stackCSS font-family stack for emails.

Admin UI Cleanup & Environment Bar

Filter HookTypeDefaultDescription
orbit_enable_menu_item_dashboardbooltrueShow or hide the Dashboard menu item.
orbit_enable_menu_item_postsbooltrueShow or hide the Posts menu item.
orbit_enable_menu_item_commentsboolfalseShow or hide the Comments menu item and toolbar node.
orbit_enable_toolbar_item_new_contentbooltrueShow or hide the "+ New" item in the top admin bar.
orbit_enable_login_logobooltrueEnable custom login logo replacement.
orbit_login_logo_urlstring''Image URL for the /wp-login.php screen logo.
orbit_login_logo_widthint250Width (in pixels) for the login logo.
orbit_enable_admin_environment_namebooltrueDisplay the environment badge in the toolbar for Administrators.

Security & Privacy

Filter HookTypeDefaultDescription
orbit_enable_rest_api_user_endpointsboolfalseExpose /wp/v2/users endpoints to unauthenticated users.
orbit_enable_xmlrpcboolfalseEnable XML-RPC functionality.
orbit_enable_expose_wordpress_versionboolfalseExpose WordPress version in HTML markup and asset query strings.
orbit_default_security_headersarrayHeader arrayFilter baseline HTTP security headers array.
orbit_enable_author_pagesboolfalseEnable author archive pages (/author/username).

Capabilities & Role Permissions

Filter HookTypeDefaultDescription
orbit_enable_editor_caps_accessbooltrueGrant edit_theme_options to Editors and Shop Managers.
orbit_enable_user_caps_accessbooltrueGrant user management capabilities (excluding delete_users) to Editors and Shop Managers.
orbit_enable_gravity_forms_accessbooltrueGrant Gravity Forms capabilities to Editors and Shop Managers.
orbit_enable_privacy_page_accessbooltrueAllow Editors and Shop Managers to access Privacy Policy settings.

Performance, Utilities & Integrations

Filter HookTypeDefaultDescription
orbit_remote_files_urlstring|nullConstant / Env varFilter remote production URL for hotlinking media files.
orbit_action_scheduler_retention_periodint1209600 (2 weeks)Retention period (in seconds) for completed Action Scheduler jobs.
orbit_action_scheduler_default_cleaner_statusesarray['complete', 'canceled', 'failed']Action Scheduler statuses targeted for automated cleanup.
orbit_action_scheduler_cleanup_batch_sizeint1000Number of Action Scheduler jobs cleaned up per batch run.

PHP Constants & Environment Variables

NameTypePurposeExample
ORBIT_ENABLE_FAST_404bool (Constant)Opt-in fast 404 response for missing static asset files.define( 'ORBIT_ENABLE_FAST_404', true );
ORBIT_REMOTE_FILES_URLstring (Constant / Env)Production base URL used to hotlink missing media files on non-production.define( 'ORBIT_REMOTE_FILES_URL', 'https://example.com' );
ORBIT_ERROR_REPORTINGint|bool (Constant)Custom error reporting bitmask, or false to disable Orbit error handling.define( 'ORBIT_ERROR_REPORTING', E_ALL & ~E_DEPRECATED );
SATELLITE_PRODUCTION_URLstring (Constant / Env)Secondary fallback production URL for remote media hotlinking.define( 'SATELLITE_PRODUCTION_URL', 'https://example.com' );