woocommerce_rest_prepare_report_stock_stats filter-hookWC 6.5.0

Filter a report returned from the API.

Allows modification of the report data right before it is returned.

Usage

add_filter( 'woocommerce_rest_prepare_report_stock_stats', 'wp_kama_woocommerce_rest_prepare_report_stock_stats_filter', 10, 3 );

/**
 * Function for `woocommerce_rest_prepare_report_stock_stats` filter-hook.
 * 
 * @param WP_REST_Response $response The response object.
 * @param WC_Product       $report   The original object.
 * @param WP_REST_Request  $request  Request used to generate the response.
 *
 * @return WP_REST_Response
 */
function wp_kama_woocommerce_rest_prepare_report_stock_stats_filter( $response, $report, $request ){

	// filter...
	return $response;
}
$response(WP_REST_Response)
The response object.
$report(WC_Product)
The original object.
$request(WP_REST_Request)
Request used to generate the response.

Changelog

Since 6.5.0 Introduced.

Where the hook is called

Controller::prepare_item_for_response()
woocommerce/src/Admin/API/Reports/Stock/Stats/Controller.php 77
return apply_filters( 'woocommerce_rest_prepare_report_stock_stats', $response, $report, $request );

Where the hook is used in WooCommerce

Usage not found.