Automattic\WooCommerce\Internal\Admin\Settings\PaymentsProviders\WooPayments

WooPaymentsService::mark_onboarding_step_completed │ public │ WC 1.0

Mark an onboarding step as completed.

Method of the class: WooPaymentsService{}

No Hooks.

Returns

bool. Whether the onboarding step was marked as completed.

Usage

$WooPaymentsService = new WooPaymentsService();
$WooPaymentsService->mark_onboarding_step_completed( $step_id, $location, $overwrite, ?string $source ): bool;

$step_id(string) (required)

The ID of the onboarding step.

$location(string) (required)

The location for which we are onboarding. This is an ISO 3166-1 alpha-2 country code.

$overwrite(true|false)

Whether to overwrite the step status if it is already completed and update the timestamp.
Default: false

?string $source

.
Default: self::SESSION_ENTRY_DEFAULT

WooPaymentsService::mark_onboarding_step_completed() WooPaymentsService::mark onboarding step completed code ^{WC 11.1.1}

public function mark_onboarding_step_completed( string $step_id, string $location, bool $overwrite = false, ?string $source = self::SESSION_ENTRY_DEFAULT ): bool {
	$this->check_if_onboarding_step_action_is_acceptable( $step_id, $location );

	return $this->record_onboarding_step_completed( $step_id, $location, $overwrite, $source );
}