Hooks reference
Every action and filter in Siteryn Checkout and Pro, with exact signatures, checked against the code.
Lifecycle
| Hook | Type | Arguments · when |
|---|---|---|
siteryn_checkout_loaded | action | ( Plugin $plugin ). Free has booted. Extensions start here. |
siteryn_checkout_upgrade | action | ( string|false $old, string $new ). init (20) on a version change. |
siteryn_checkout_builder_saved | action | ( string $page_type, array $layout, string $status ). After a valid save (draft or published). |
siteryn_checkout_builder_unpublished | action | ( string $page_type ) |
Registration & schemas
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_builder_register_blocks | action | ( BlockRegistry $registry ). Register, replace or unregister elements. |
siteryn_checkout_builder_page_types | filter | ( array $types ) |
siteryn_checkout_builder_modes | filter | ( array $modes, string $page_type ). Add layout modes. |
siteryn_checkout_builder_limits | filter | ( array $limits, string $page_type ). The 5 numeric limits only. |
siteryn_checkout_builder_page_settings_schema | filter | ( array $schema, string $page_type ). Page settings fields. |
siteryn_checkout_builder_node_settings_schema | filter | ( array $fields, string $node_type, string $page_type ). Section, row, column and element-wrapper fields. |
siteryn_checkout_builder_block_settings_schema | filter | ( array $settings, string $block_name, string $page_type ). Add fields to an existing element. |
siteryn_checkout_builder_breakpoints | filter | ( array{tablet:int, mobile:int} ). Default 1024 / 767. |
siteryn_checkout_builder_richtext_allowed_html | filter | ( array $allowed ). The wp_kses allowlist for Text. |
siteryn_checkout_builder_layout_presets | filter | ( array $presets, string $page_type ). Layout picker entries. |
siteryn_checkout_builder_starter_designs | filter | ( array $designs, string $page_type ) |
siteryn_checkout_builder_thumb_kinds | filter | ( array $kinds ). How elements are drawn in layout thumbnails. |
siteryn_checkout_builder_schema_migrations | filter | ( array $steps, string $page_type ). Callables ( array $layout, string $page_type ): array. |
siteryn_checkout_builder_legacy_layout | filter | ( array $layout, string $page_type, array $settings ). The settings-derived default design. |
Validation & availability
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_builder_validate_layout | filter | ( array $errors, array $layout, string $page_type ). Each error needs code and message, and optionally path (block:{id}). |
siteryn_checkout_builder_storefront_ready | filter | ( bool $ready, string $page_type ). Whether a page may be published. |
siteryn_checkout_builder_is_renderable | filter | ( bool $ok, string $page_type ). Final say on using the builder. |
siteryn_checkout_builder_repository | filter | ( DesignRepository $repo ). Swap the design storage. |
Rendering
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_builder_node_visible | filter | ( bool $visible, array $node, RenderContext $context ). Conditional visibility. |
siteryn_checkout_builder_node_attributes | filter | ( array $attrs, string $type, array $node, RenderContext $context ). Only data-*, aria-* and hidden. |
siteryn_checkout_builder_render_block | filter | ( string $html, array $block, RenderContext $context ) |
siteryn_checkout_builder_root_classes | filter | ( string[] $classes, array $layout, RenderContext $context ) |
siteryn_checkout_builder_node_declarations | filter | ( array $css, string $node_type, array $settings ). Settings → CSS properties. |
siteryn_checkout_builder_node_css_rules | filter | ( array $rules, string $node_type, array $node, array $base ). Per-device rules [ [media, decls] ]. |
siteryn_checkout_builder_render_output | filter | ( array{html, css} $result, array $layout, RenderContext $context ). Keep both keys. |
siteryn_checkout_builder_checkout_fragments | filter | ( array $fragments, array $layout ). Extra checkout refresh fragments. |
siteryn_checkout_builder_billing_lead_fields | filter | ( array{keys, title} $lead, array $settings, RenderContext $context, bool $has_contact ) |
siteryn_checkout_builder_shipping_calculator_blocks | filter | ( string[] $names ). Elements that act as a shipping calculator. |
siteryn_checkout_builder_preview_field_labels | filter | ( string[] $labels, string $block_name ). Sample labels in previews. |
siteryn_checkout_builder_preview_styles | filter | ( array $styles ). Stylesheets for the preview canvas ({href, media}). |
Steps
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_builder_steps_progress | filter | ( array $progress ). Restyle the progress bar: classes, markers, extras, item_classes, titles, states, meta, settings. |
siteryn_checkout_builder_step_script_data | filter | ( array $data, array $step ). Step data sent to the storefront script (default {id, title}; also reads next_label and validate, where false skips the required-field check). |
siteryn_checkout_builder_step_nav_classes | filter | ( string[] $classes, array $layout ). Back / Continue bar classes. |
siteryn_checkout_builder_sanitize_step | filter | ( array $clean, array $raw, int $index ). One sanitized step on save. Free keeps only id and title (always Free's own values); add your own per-step keys sanitized from $raw. |
Settings & admin
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_settings_sections · _settings_fields | filter | ( array ). Admin tabs and settings fields. |
siteryn_checkout_settings_save_redirect | filter | ( false|array $redirect, string $option_name ) |
siteryn_checkout_settings_reset_actions | filter | ( array $map ) |
siteryn_checkout_settings_nav_icon · _nav_sublabel · _nav_badge · _description | filter | ( string $value, string $section ) |
siteryn_checkout_settings_panel_sidebar · _settings_after_form | action | ( string $section ) |
siteryn_checkout_system_status_cards | filter | ( array $cards ): each {label, value, icon, variant} |
siteryn_checkout_admin_icons | filter | ( array $icons ): name → SVG markup |
siteryn_checkout_locate_template | filter | ( string $path, string $template_name ). Siteryn's own partials. |
siteryn_checkout_before_template · _after_template | action | ( string $template_name, array $args ) |
siteryn_dashboard_plugins | filter | ( array $plugins ). Shared Siteryn Welcome page cards. |
siteryn_deactivation_feedback_endpoint | filter | ( string $url ) |
Buy Now
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_buy_now_visible | filter | ( bool $show, WC_Product $product, string $context ). $context is single or loop. |
siteryn_checkout_buy_now_button | filter | ( array{label, classes} $button, WC_Product $product, string $context ) |
siteryn_checkout_buy_now_redirect | filter | ( string $url ). One argument; default the Checkout URL. |
Pro
| Hook | Type | Arguments · purpose |
|---|---|---|
siteryn_checkout_pro_loaded | action | ( Plugin $plugin ) |
siteryn_checkout_pro_upgrade | action | ( string|false $installed, string $current ) |
siteryn_checkout_pro_license_activated | action | ( ActivationOutcome $outcome ) |
siteryn_checkout_pro_license_deactivated | action | ( bool $done ) |
siteryn_checkout_pro_free_plugin_loaded | filter | ( bool $loaded ) |
siteryn_checkout_pro_condition_protected_blocks | filter | ( string[] $blocks, string $page_type ). Elements conditions may not hide. |
siteryn_checkout_pro_max_designs | filter | ( int $max = 20, string $page_type ) |
siteryn_checkout_pro_max_revisions | filter | ( int $max = 15, string $page_type ) |