Skip to main content

fc_is_substep_complete_{substep_id}

Type: Filter

Filters whether a checkout substep is complete.

The dynamic portion of the hook name, $substep_id, refers to the checkout substep ID. Additional hook names are created for substeps registered by other plugins. Possible hook names include:

  • fc_is_substep_complete_contact
  • fc_is_substep_complete_shipping_address
  • fc_is_substep_complete_shipping_method
  • fc_is_substep_complete_order_notes
  • fc_is_substep_complete_billing_address
  • fc_is_substep_complete_payment
  • fc_is_substep_complete_coupon_codes

Signature​

apply_filters( 'fc_is_substep_complete_{substep_id}', $is_substep_complete );

Parameters​

NameTypeDescription
$is_substep_completeboolWhether the substep is complete.

Since​

  • 4.0.0

Source: inc/checkout-steps.php

Examples​

In fc_is_substep_complete_{substep_id}, shipping_method replaces {substep_id}.

add_filter( 'fc_is_substep_complete_shipping_method',
/**
* Set specific sub-step as not-complete to force the user to always review that sub-step.
*
* @param bool $is_substep_complete Whether the substep is complete.
* @return bool Filtered value.
*/
function( $is_substep_complete ) {
return false;
},
10
);