Automattic\WooCommerce\Api\Infrastructure

Principal{} │ WC 1.0

Default principal class for the WooCommerce dual code+GraphQL API.

Plugins that authenticate against something other than WordPress users must ship their own principal class at <plugin-api-namespace>\Infrastructure\... together with a matching PrincipalResolver. Plugins that build on WP-user auth can either use this class directly (no resolver needed; the controller falls back to new Principal( [wp_get_current_user()](/function/wp_get_current_user) )) or extend it to add their own fields.

No Hooks.

Usage

$Principal = new Principal();
// use class methods

Methods

1. public __construct(
2. public can_introspect()
3. public can_use_debug_mode()
4. public is_authenticated()

Principal{} Principal{} code ^{WC 10.9.1}

class Principal {
	/**
	 * Constructor.
	 *
	 * @param \WP_User $user The WordPress user behind the request. For anonymous requests this is a `WP_User` with `ID === 0`, as returned by {@see \wp_get_current_user()}.
	 */
	public function __construct(
		public readonly \WP_User $user,
	) {
	}

	/**
	 * Whether the underlying WP user is authenticated.
	 *
	 * Convenience for `$principal->user->ID > 0`, the canonical anonymous
	 * marker in WordPress. Use this in `authorize()` / `execute()` bodies that
	 * need to distinguish anonymous from authenticated callers.
	 */
	public function is_authenticated(): bool {
		return $this->user->ID > 0;
	}

	/**
	 * Whether this principal may run GraphQL schema introspection on the endpoint.
	 *
	 * Implementing `can_introspect()` is opt-in for plugin principal classes,
	 * a principal that doesn't define it is denied by default. Plugins building
	 * authenticated endpoints should make an explicit decision per principal
	 * model rather than inheriting an introspection policy by accident.
	 */
	public function can_introspect(): bool {
		return user_can( $this->user, 'manage_woocommerce' );
	}

	/**
	 * Whether this principal may activate GraphQL debug mode on the endpoint.
	 *
	 * Implementing `can_use_debug_mode()` is opt-in for plugin principal classes,
	 * a principal that doesn't define it is denied by default. Plugins building
	 * authenticated endpoints should make an explicit decision per principal
	 * model rather than inheriting a debug mode policy by accident.
	 *
	 * Note that this method's outcome is necessary but not sufficient for debug
	 * mode to be active: the controller also requires the request to carry
	 * `_debug=1`. The decision can be overridden by the
	 * `woocommerce_graphql_can_use_debug_mode` filter.
	 */
	public function can_use_debug_mode(): bool {
		return user_can( $this->user, 'manage_options' );
	}
}