Automattic\WooCommerce\Internal\Admin

WcPayWelcomePage::onboarding_task_additional_data() │ public │ WC 1.0

Filter the onboarding task additional data to add the WooPayments incentive data to it.

Method of the class: WcPayWelcomePage{}

No Hooks.

Return

?Array. The filtered task additional data.

Usage

$WcPayWelcomePage = new WcPayWelcomePage();
$WcPayWelcomePage->onboarding_task_additional_data( ?array $additional_data ): ?array;

?array $additional_data (required)

-

WcPayWelcomePage::onboarding_task_additional_data() WcPayWelcomePage::onboarding task additional data code ^{WC 9.6.1}

public function onboarding_task_additional_data( ?array $additional_data ): ?array {
	// Return early if there is no incentive to show.
	if ( ! $this->has_incentive() ) {
		return $additional_data;
	}

	// If we have an incentive, add the incentive ID to the additional data.
	if ( $this->get_incentive()['id'] ) {
		if ( empty( $additional_data ) ) {
			$additional_data = array();
		}
		$additional_data['wooPaymentsIncentiveId'] = $this->get_incentive()['id'];
	}

	return $additional_data;
}