WooCommerce Code Reference

ListProducts
in package

Query to list products with cursor-based pagination.

Demonstrates: #[Unroll] on parameter, enum as direct param, multiple capabilities.

Table of Contents

execute()  : Connection
List products with optional filtering and pagination.

Methods

execute()

List products with optional filtering and pagination.

public execute(PaginationParams $pagination, ProductFilterInput $filters[, ProductType|null $product_type = null ][, array<string|int, mixed>|null $_query_info = null ]) : Connection
Parameters
$pagination : PaginationParams

The pagination parameters.

$filters : ProductFilterInput

Filter criteria (unrolled to flat args).

$product_type : ProductType|null = null

Optional product type filter.

$_query_info : array<string|int, mixed>|null = null

Unified query info tree from the GraphQL request.

Tags
throws
ApiException

When an unsupported stock_status filter value is passed.

Return values
Connection