Overview
  • Namespace
  • Class

Namespaces

  • WPGraphQL
    • Data
    • Type
      • Avatar
      • Comment
        • Connection
      • CommentAuthor
      • EditLock
      • Enum
      • MediaItem
        • Mutation
      • Plugin
        • Connection
      • PostObject
        • Connection
        • Mutation
      • PostType
      • Setting
      • Taxonomy
      • TermObject
        • Connection
        • Mutation
      • Theme
        • Connection
      • Union
      • User
        • Connection
        • Mutation
    • Utils

Classes

  • InstrumentSchema

Class InstrumentSchema

Class InstrumentSchema

Namespace: WPGraphQL\Utils
Package: WPGraphQL\Data
Located at Utils/InstrumentSchema.php

Methods summary

public static WPGraphQL\WPSchema
# instrument_schema( WPGraphQL\WPSchema $schema )

Parameters

$schema

Returns

WPGraphQL\WPSchema
protected static mixed
# wrap_fields( array $fields, string $type_name )

Wrap Fields

Wrap Fields

This wraps fields to provide sanitization on fields output by introspection queries (description/deprecation reason) and provides hooks to resolvers.

Parameters

$fields
The fields configured for a Type
$type_name
The Type name

Returns

mixed
public static boolean|mixed
# check_field_permissions( mixed $source, array $args, WPGraphQL\AppContext $context, GraphQL\Type\Definition\ResolveInfo $info, string $field_resolver, string $type_name, GraphQL\Type\Definition\FieldDefinition $field_key, $field )

Check field permissions when resolving.

Check field permissions when resolving.

This takes into account auth params defined in the Schema

Parameters

$source
The source passed down the Resolve Tree
$args
The args for the field
$context
The AppContext passed down the ResolveTree
$info
The ResolveInfo passed down the ResolveTree
$field_resolver
$type_name The name of the type the fields belong to
$type_name
$field_key The name of the field
$field_key
$field The Field Definition for the resolving field
$field

Returns

boolean|mixed
API documentation generated by ApiGen