woocommerce_review_order_eligible_statuses │ filter-hook │ WC 10.8.0

Filter the order statuses that are eligible to receive the review-request email.

Defaults to completed only. Same hook the page-load endpoint and the submission handler use, so the three entry points stay aligned.

Usage

add_filter( 'woocommerce_review_order_eligible_statuses', 'wp_kama_woocommerce_review_order_eligible_statuses_filter', 10, 2 );

/**
 * Function for `woocommerce_review_order_eligible_statuses` filter-hook.
 * 
 * @param string[] $eligible_statuses Default: `[ 'completed' ]`.
 * @param WC_Order $order             Order being inspected.
 *
 * @return string[]
 */
function wp_kama_woocommerce_review_order_eligible_statuses_filter( $eligible_statuses, $order ){
	// filter...
	return $eligible_statuses;
}
$eligible_statuses(string[])
Default: [ 'completed' ].
$order(WC_Order)
Order being inspected.

Changelog

Since 10.8.0 Introduced.

Where the hook is called

WC_Email_Customer_Review_Request::is_order_eligible_for_send()
woocommerce_review_order_eligible_statuses
SubmissionHandler::handle()
woocommerce_review_order_eligible_statuses
Scheduler::handle_status_changed()
woocommerce_review_order_eligible_statuses
Endpoint::is_authorised()
woocommerce_review_order_eligible_statuses
woocommerce/includes/emails/class-wc-email-customer-review-request.php 139-143
$eligible_statuses = (array) apply_filters(
	'woocommerce_review_order_eligible_statuses',
	array( OrderStatus::COMPLETED ),
	$this->object
);
woocommerce/src/Internal/OrderReviews/SubmissionHandler.php 120-124
$eligible_statuses = (array) apply_filters(
	'woocommerce_review_order_eligible_statuses',
	array( OrderStatus::COMPLETED ),
	$order
);
woocommerce/src/Internal/OrderReviews/Scheduler.php 99-103
$eligible_statuses = (array) apply_filters(
	'woocommerce_review_order_eligible_statuses',
	array( OrderStatus::COMPLETED ),
	$order instanceof WC_Order ? $order : null
);
woocommerce/src/Internal/OrderReviews/Endpoint.php 763-767
$eligible_statuses = (array) apply_filters(
	'woocommerce_review_order_eligible_statuses',
	array( OrderStatus::COMPLETED ),
	$order
);

Where the hook is used in WooCommerce

Usage not found.