Automattic\WooCommerce\Internal\Admin\Orders\MetaBoxes

CustomerHistory::get_excluded_statuses │ private │ WC 1.0

Get the list of excluded order statuses for customer history.

Method of the class: CustomerHistory{}

Returns

string[]. Excluded status slugs without wc- prefix (e.g. 'auto-draft', 'trash', 'pending', 'failed', 'cancelled').

Usage

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

CustomerHistory::get_excluded_statuses() CustomerHistory::get excluded statuses code ^{WC 11.2.1}

private function get_excluded_statuses(): array {
	if ( null !== $this->excluded_statuses ) {
		return $this->excluded_statuses;
	}

	$default_excluded_statuses = Settings::get_default_excluded_order_statuses();
	$excluded_statuses         = get_option( 'woocommerce_excluded_report_order_statuses', $default_excluded_statuses );
	$excluded_statuses         = Settings::get_valid_order_statuses_or_default( $excluded_statuses, $default_excluded_statuses );
	$excluded_statuses         = array_merge( array( 'auto-draft', 'trash' ), $excluded_statuses );

	// Keep the value a broken filter would otherwise replace, so the merchant's saved
	// selection survives it. Mirrors Reports\DataStore::get_excluded_report_order_statuses().
	$pre_filter_statuses = $excluded_statuses;

	/**
	 * Filter the list of excluded order statuses for customer history and analytics reports.
	 *
	 * @since 4.0.0
	 * @param array $excluded_statuses Order statuses to exclude.
	 */
	$excluded_statuses = apply_filters( 'woocommerce_analytics_excluded_order_statuses', $excluded_statuses );
	if ( ! is_array( $excluded_statuses ) ) {
		wc_doing_it_wrong( __METHOD__, 'The woocommerce_analytics_excluded_order_statuses filter must return an array.', '11.2.0' );
		$excluded_statuses = $pre_filter_statuses;
	}

	$this->excluded_statuses = $excluded_statuses;
	return $this->excluded_statuses;
}