ClassesBigCommerceCheckoutRequirements Notice

Requirements_Notice

Shows a notice if the required configuration for checkout is not complete

  • Full name: \BigCommerce\Checkout\Requirements_Notice

Constants

ConstantVisibilityTypeValue
REFRESHpublicstring’bigcommerce_checkout_requirements_refresh’

Methods

__construct

Constructor to initialize the setup status.

public __construct(\BigCommerce\Merchant\Setup_Status $status): mixed

Parameters:

ParameterTypeDescription
$status\BigCommerce\Merchant\Setup_StatusInstance of Setup_Status to manage the store’s setup status.

check_requirements

Checks the BigCommerce API to verify that checkout requirements have been met. Displays admin notices if requirements are not satisfied.

public check_requirements(): void

refresh_status

Admin post handler to refresh the checkout requirements status cache.

public refresh_status(): void

filter_embedded_checkout

Disables embedded checkout if SSL is not supported.

public filter_embedded_checkout(int|bool $option): int|bool

Parameters:

ParameterTypeDescription
$optionint|boolCurrent option value.

Return Value:

Modified option value.


can_enable_embedded_checkout

Determines if embedded checkout can be enabled.

public can_enable_embedded_checkout(): bool

Return Value:

True if SSL is supported, false otherwise.



Automatically generated on 2025-01-21