Automattic\WooCommerce\Internal\Admin\Settings\PaymentProviders

PaymentGateway::get_onboarding_url │ public │ WC 1.0

Get the onboarding URL for the payment gateway.

This URL should start or continue the onboarding process.

Method of the class: PaymentGateway{}

No Hooks.

Returns

String. The onboarding URL for the payment gateway.

Usage

$PaymentGateway = new PaymentGateway();
$PaymentGateway->get_onboarding_url( $payment_gateway, $return_url ): string;

$payment_gateway(WC_Payment_Gateway) (required)

The payment gateway object.

$return_url(string)

The URL to return to after onboarding. This will likely get attached to the onboarding URL.
Default: ''

PaymentGateway::get_onboarding_url() PaymentGateway::get onboarding url code ^{WC 9.9.3}

public function get_onboarding_url( WC_Payment_Gateway $payment_gateway, string $return_url = '' ): string {
	if ( is_callable( array( $payment_gateway, 'get_connection_url' ) ) ) {
		// If we received no return URL, we will set the WC Payments Settings page as the return URL.
		$return_url = ! empty( $return_url ) ? $return_url : admin_url( 'admin.php?page=wc-settings&tab=checkout&from=' . Payments::FROM_PROVIDER_ONBOARDING );

		return (string) $payment_gateway->get_connection_url( $return_url );
	}

	// Fall back to pointing users to the payment gateway settings page to handle onboarding.
	return $this->get_settings_url( $payment_gateway );
}