PHP Класс WC_API_Reports

Наследование: extends WC_API_Resource

Защищенные свойства (Protected)

Свойство	Тип	Описание
$base	string	the route base

Метод	Описание
get_reports ( ) : array	Get a simple listing of available reports
get_sales_report ( string $fields = null, array $filter = [] ) : array	Get the sales report
get_top_sellers_report ( string $fields = null, array $filter = [] ) : array	Get the top sellers report
register_routes ( array $routes ) : array	Register the routes for this class

Метод	Описание
validate_request ( null $id = null, null $type = null, null $context = null ) : boolean	Verify that the current user has permission to view reports

Метод	Описание
setup_report ( array $filter )	Setup the report object and parse any date filtering

Get a simple listing of available reports

С версии: 2.1

public get_reports ( ) : array
Результат	array

Get the sales report

С версии: 2.1

public get_sales_report ( string $fields = null, array $filter = [] ) : array
$fields	string	fields to include in response
$filter	array	date filtering
Результат	array

Get the top sellers report

С версии: 2.1

public get_top_sellers_report ( string $fields = null, array $filter = [] ) : array
$fields	string	fields to include in response
$filter	array	date filtering
Результат	array

GET /reports GET /reports/sales

С версии: 2.1

public register_routes ( array $routes ) : array
$routes	array
Результат	array

Verify that the current user has permission to view reports

См. также: WC_API_Resource::validate_request()

С версии: 2.1

protected validate_request ( null $id = null, null $type = null, null $context = null ) : boolean
$id	null	unused
$type	null	unused
$context	null	unused
Результат	boolean	true if the request is valid and should be processed, false otherwise

the route base

protected string $base
Результат	string