WooCommerce Code Reference

Attributes

Interfaces, Classes and Traits

ArrayOf
Declares the element type for an array-typed property or return value.
ConnectionOf
Marks a query's return type as a Relay-style connection of the given node type.
Deprecated
Marks a field or enum value as deprecated in the GraphQL schema.
Description
Provides a human-readable description for the annotated element.
Experimental
Marks a code-API element as experimental: present in the schema, but not stable enough to be relied on in production.
HiddenFromMetadataQuery
Marker attribute that opts a code-API target out of the `_apiMetadata` discovery query without affecting any other behaviour. Apply on a class (output / input type, query, mutation) or on a property to hide that target's row — and all its metadata / authorization descriptors — from the `_apiMetadata` endpoint.
Ignore
Tells the builder to skip the annotated element entirely.
Internal
Marks a code-API element as for WooCommerce internal use.
Metadata
Attaches a name/value metadata entry to a code-API element.
Name
Overrides the GraphQL name derived from the PHP class or property name.
Parameter
Declares an explicit GraphQL argument for a query or mutation.
ParameterDescription
Adds a description to a query/mutation argument without overriding its type.
PublicAccess
Marks a query or mutation as publicly accessible without authentication.
RequiredCapability
Declares a WordPress capability required to execute a query or mutation, or to read an output field, or to set an input field on a mutation.
ReturnType
Declares the GraphQL return type of execute() when it returns an interface.
ScalarType
Overrides the GraphQL type for a property with a custom scalar.
Unroll
Expands a class's properties into individual flat GraphQL arguments.