Automattic\WooCommerce\Internal\Admin\Settings\PaymentsProviders

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.

Метод класса: PaymentGateway{}

Хуков нет.

Возвращает

Строку. The onboarding URL for the payment gateway.

Использование

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

$payment_gateway(WC_Payment_Gateway) (обязательный)

The payment gateway object.

$return_url(строка)

The URL to return to after onboarding. This will likely get attached to the onboarding URL.
По умолчанию: ''

Код PaymentGateway::get_onboarding_url() PaymentGateway::get onboarding url ^{WC 10.5.0}

public function get_onboarding_url( WC_Payment_Gateway $payment_gateway, string $return_url = '' ): string {
	try {
		if ( method_exists( $payment_gateway, 'get_connection_url' ) && 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 );
		}
	} catch ( Throwable $e ) {
		// Do nothing but log so we can investigate.
		SafeGlobalFunctionProxy::wc_get_logger()->debug(
			'Failed to get gateway connection URL: ' . $e->getMessage(),
			array(
				'gateway'   => $payment_gateway->id,
				'source'    => 'settings-payments',
				'exception' => $e,
			)
		);
	}

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