woocommerce_rest_prepare_leaderboard │ filter-hook │ WC 1.0

Filter the list returned from the API.

Usage

add_filter( 'woocommerce_rest_prepare_leaderboard', 'wp_kama_woocommerce_rest_prepare_leaderboard_filter', 10, 3 );

/**
 * Function for `woocommerce_rest_prepare_leaderboard` filter-hook.
 * 
 * @param WP_REST_Response $response The response object.
 * @param array            $item     The original item.
 * @param WP_REST_Request  $request  Request used to generate the response.
 *
 * @return WP_REST_Response
 */
function wp_kama_woocommerce_rest_prepare_leaderboard_filter( $response, $item, $request ){

	// filter...
	return $response;
}

$response(WP_REST_Response)

The response object.

$item(array)

The original item.

$request(WP_REST_Request)

Request used to generate the response.

Where the hook is called

return apply_filters( 'woocommerce_rest_prepare_leaderboard', $response, $item, $request );

Where the hook is used in WooCommerce