Automattic\WooCommerce\Internal\Admin\Orders

PageController::is_order_screen │ public │ WC 1.0

Helper method to check if the current admin screen is related to orders.

Method of the class: PageController{}

No Hooks.

Returns

true|false.

Usage

$PageController = new PageController();
$PageController->is_order_screen( $type, $action ) : bool;

$type(string)

The order type to check for.
Default: shop_order

$action(string)

The purpose of the screen to check for. 'list', 'edit', or 'new'. Leave empty to check for any order screen.
Default: ''

PageController::is_order_screen() PageController::is order screen code ^{WC 10.3.5}

public function is_order_screen( $type = 'shop_order', $action = '' ) : bool {
	if ( ! did_action( 'current_screen' ) ) {
		wc_doing_it_wrong(
			__METHOD__,
			sprintf(
				// translators: %s is the name of a function.
				esc_html__( '%s must be called after the current_screen action.', 'woocommerce' ),
				esc_html( __METHOD__ )
			),
			'7.9.0'
		);

		return false;
	}

	$valid_types = wc_get_order_types( 'view-order' );
	if ( ! in_array( $type, $valid_types, true ) ) {
		wc_doing_it_wrong(
			__METHOD__,
			sprintf(
				// translators: %s is the name of an order type.
				esc_html__( '%s is not a valid order type.', 'woocommerce' ),
				esc_html( $type )
			),
			'7.9.0'
		);

		return false;
	}

	if ( wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled() ) {
		if ( $action ) {
			switch ( $action ) {
				case 'edit':
					$is_action = 'edit_order' === $this->current_action;
					break;
				case 'list':
					$is_action = 'list_orders' === $this->current_action;
					break;
				case 'new':
					$is_action = 'new_order' === $this->current_action;
					break;
				default:
					$is_action = false;
					break;
			}
		}

		$type_match   = $type === $this->order_type;
		$action_match = ! $action || $is_action;
	} else {
		$screen = get_current_screen();

		if ( $action ) {
			switch ( $action ) {
				case 'edit':
					$screen_match = 'post' === $screen->base && filter_input( INPUT_GET, 'post', FILTER_VALIDATE_INT );
					break;
				case 'list':
					$screen_match = 'edit' === $screen->base;
					break;
				case 'new':
					$screen_match = 'post' === $screen->base && 'add' === $screen->action;
					break;
				default:
					$screen_match = false;
					break;
			}
		}

		$type_match   = $type === $screen->post_type;
		$action_match = ! $action || $screen_match;
	}

	return $type_match && $action_match;
}