Automattic\WooCommerce\Internal\Admin

WcPayWelcomePage::get_active_payments_task_slug │ private │ WC 1.0

Get the slug of the active payments task.

It can be either 'woocommerce-payments' or 'payments'.

Method of the class: WcPayWelcomePage{}

No Hooks.

Returns

String. Either 'woocommerce-payments' or 'payments'. Empty string if no task is found.

Usage

// private - for code of main (parent) class only
$result = $this->get_active_payments_task_slug(): string;

WcPayWelcomePage::get_active_payments_task_slug() WcPayWelcomePage::get active payments task slug code ^{WC 10.3.6}

private function get_active_payments_task_slug(): string {
	$setup_task_list    = TaskLists::get_list( 'setup' );
	$extended_task_list = TaskLists::get_list( 'extended' );

	// The task pages are not available if the task lists don't exist or are not visible.
	// Bail early if we have no task to work with.
	if (
		( empty( $setup_task_list ) || ! $setup_task_list->is_visible() ) &&
		( empty( $extended_task_list ) || ! $extended_task_list->is_visible() )
	) {
		return '';
	}

	// The Payments task in the setup task list.
	if ( ! empty( $setup_task_list ) && $setup_task_list->is_visible() ) {
		$payments_task = $setup_task_list->get_task( 'payments' );
		if ( ! empty( $payments_task ) && $payments_task->can_view() ) {
			return 'payments';
		}
	}

	// The Additional Payments task in the extended task list.
	if ( ! empty( $extended_task_list ) && $extended_task_list->is_visible() ) {
		$payments_task = $extended_task_list->get_task( 'payments' );
		if ( ! empty( $payments_task ) && $payments_task->can_view() ) {
			return 'payments';
		}
	}

	// The WooPayments task in the setup task list.
	if ( ! empty( $setup_task_list ) && $setup_task_list->is_visible() ) {
		$payments_task = $setup_task_list->get_task( 'woocommerce-payments' );
		if ( ! empty( $payments_task ) && $payments_task->can_view() ) {
			return 'woocommerce-payments';
		}
	}

	return '';
}