WooCommerce Code Reference

ParameterDescription
in package

Adds a description to a query/mutation argument without overriding its type.

Sets the description for a query/mutation argument. Can be used both for arguments inferred from the execute() method signature and for arguments declared via #[Parameter]. However, a parameter must not have a description in both #[Parameter] and #[ParameterDescription] — that is a build error. This attribute is repeatable: apply it once per argument that needs a description.

Table of Contents

__construct()  : mixed
Constructor.

Methods

__construct()

Constructor.

public __construct(string $name, string $description) : mixed
Parameters
$name : string

The argument name (must match the execute() parameter name).

$description : string

Human-readable description for the schema.

Return values
mixed