Filters

Filters let your code modify a value as it passes through WPGraphQL — the schema, a query, a response, and more. Below are the filters WPGraphQL provides for you to hook into.

Authentication and Authorization

• graphql_authentication_error_status_code

  Filter the HTTP status code returned for authentication errors.

• graphql_authentication_errors

  If false, there are no authentication errors.

• graphql_authentication_errors

  Allow plugins to prevent the downgrade via the graphql_authentication_errors filter.

• graphql_cookie_auth_require_nonce

  Filter whether to require a nonce for cookie-based authentication.

• graphql_field_resolver_auth_error_message

  Filters the default authorization error message for field resolvers.

• graphql_pre_restrict_endpoint

  Allows overriding the default graphql_restrict_endpoint behavior.

• graphql_require_authentication_allowed_fields

  Filters the allowed root fields

Connections

• graphql_allowed_post_stati

  Filters the post statuses the current user is allowed to query in this connection.

• graphql_comment_connection_args

  Filters the GraphQL args before they are used in get_query_args().

• graphql_comment_connection_query_args

  Filters the query args used by the connection.

• graphql_connection

  Filter the connection.

• graphql_connection_args

  Filters the GraphQL args before they are used in get_query_args().

• graphql_connection_default_query_amount

  Filters the default query amount for a connection, if no first or last GraphQL argument is supplied.

• graphql_connection_edge

  Filter the edge within the connection.

• graphql_connection_edges

  Filters the edges in the connection.

• graphql_connection_ids

  Filter the connection IDs

• graphql_connection_is_valid_model

  Filters whether or not the model is valid.

• graphql_connection_loader_name

  Filters the loader name.

• graphql_connection_max_query_amount

  Filter the maximum number of posts per page that should be queried.

• graphql_connection_nodes

  Set the items.

• graphql_connection_page_info

  Filter the pageInfo that is returned to the connection.

• graphql_connection_pre_get_query

  When this filter returns anything but null, it will be used as the resolved query, and the default query execution will be skipped.

• graphql_connection_pre_should_execute

  Filters whether or not the query should execute, BEFORE any data is fetched or altered.

• graphql_connection_query

  Set the query for the resolver, for use as reference in filters, etc Filter the query.

• graphql_connection_query_args

  Filters the query args before they are used in the query.

• graphql_connection_query_class

  Filters the $query_class that will be used to execute the query.

• graphql_connection_should_execute

  Check if the connection should execute.

• graphql_cursor_ordering_field

  Filters the field used for ordering when cursors are used for pagination

• graphql_map_input_fields_to_get_terms

  Filter the input fields This allows plugins/themes to hook in and alter what $args should be allowed to be passed from a GraphQL Query to the get_terms query

• graphql_map_input_fields_to_wp_comment_query

  Filter the input fields This allows plugins/themes to hook in and alter what $args should be allowed to be passed from a GraphQL Query to the get_terms query

• graphql_map_input_fields_to_wp_query

  Filter the input fields This allows plugins/themes to hook in and alter what $args should be allowed to be passed from a GraphQL Query to the WP_Query

• graphql_map_input_fields_to_wp_user_query

  Filter the input fields This allows plugins/themes to hook in and alter what $args should be allowed to be passed from a GraphQL Query to the WP_User_Query

• graphql_menu_item_connection_args

  Filters the GraphQL args before they are used in get_query_args().

• graphql_menu_item_connection_restrict_to_locations

  Filter whether the menu item connection should be restricted to items assigned to a registered menu location.

• graphql_post_object_connection_args

  Filters the GraphQL args before they are used in get_query_args().

• graphql_post_object_connection_query_args

  Filter the $query args to allow folks to customize queries programmatically

• graphql_post_object_cursor_meta_key

  Allow filtering the meta key used for cursor based pagination

• graphql_pre_comment_cursor_node

  If pre-hooked, return filtered node.

• graphql_pre_post_cursor_node

  If pre-hooked, return filtered node.

• graphql_pre_resolve_menu_item_connected_node

  When this filter returns anything other than null it will be used as the resolved connection for the menu item’s connected node, short-circuiting the default resolution.

• graphql_pre_term_cursor_node

  If pre-hooked, return filtered node.

• graphql_pre_user_cursor_node

  If pre-hooked, return filtered node.

• graphql_pre_wp_comments_query_cursor_pagination_support

  If pre-filter hooked, return $pre_pieces.

• graphql_pre_wp_query_cursor_pagination_stability

  If pre-filter hooked, return $pre_orderby.

• graphql_pre_wp_query_cursor_pagination_support

  If pre-filter hooked, return $pre_where.

• graphql_pre_wp_term_query_cursor_pagination_support

  If pre-filter hooked, return $pre_pieces.

• graphql_pre_wp_user_query_cursor_pagination_stability

  If pre-filter hooked, return $pre_orderby.

• graphql_pre_wp_user_query_cursor_pagination_support

  If pre-filter hooked, return $pre_where.

• graphql_term_object_connection_args

  Filters the GraphQL args before they are used in get_query_args().

• graphql_term_object_connection_query_args

  Filters the query args used by the connection.

Debugging and Instrumentation

• graphql_cache_collection_get_list_types

  Filters list type cache keys derived by QueryAnalyzer.

• graphql_cache_collection_get_query_models

  Filters query model cache keys derived by QueryAnalyzer.

• graphql_cache_collection_get_query_types

  Filters query type cache keys derived by QueryAnalyzer.

• graphql_debug_enabled

  Filters whether GraphQL debug mode is enabled.

• graphql_debug_log

  Return the filtered debug log

• graphql_debug_log_entry

  Filter the log entry for the debug log

• graphql_debug_logs_enabled

  Filters whether GraphQL Debug is enabled enabled.

• graphql_field_definition

  Filter the field definition

• graphql_pre_query_analyzer_get_list_types

  Filters list types before QueryAnalyzer derives them from the AST.

• graphql_pre_query_analyzer_get_models

  Filters model identifiers before QueryAnalyzer derives them from the AST.

• graphql_pre_query_analyzer_get_query_types

  Filters query types before QueryAnalyzer derives them from the AST.

• graphql_pre_resolve_field

  When this filter return anything other than the $nil it will be used as the resolved value and the execution of the actual resolved is skipped.

• graphql_query_analyzer_get_headers

  Filters GraphQL response headers after query analyzer headers are appended.

• graphql_query_analyzer_get_runtime_nodes

  Filters runtime node identifiers captured while resolving a GraphQL request.

• graphql_query_analyzer_graphql_keys

  Filters the assembled query analyzer keys before they are returned.

• graphql_query_analyzer_header_length_limit

  Many clients have an 8k (8192 characters) header length cap.

• graphql_query_analyzer_runtime_node

  Filter the node ID before returning to the list of resolved nodes

• graphql_query_log_entry

  Filter a single saved query row after default normalization.

• graphql_resolve_field

  Fire an action before the field resolves

• graphql_should_analyze_queries

  Filters whether to analyze queries for all GraphQL requests.

• graphql_should_analyze_query

  Filters whether to analyze queries or for a specific GraphQL request.

• graphql_should_show_query_analyzer_in_extensions

  Filters whether query analyzer details should be included in response extensions.

• graphql_tracing_response

  Filter the trace

• graphql_tracing_response

  Filter the trace

• graphql_user_can_see_query_logs

  Filter whether the logs can be seen in the request results or not

• graphql_user_can_see_trace_data

  Filter whether the logs can be seen in the request results or not

Model Layer

• graphql_comment_insert_post_args

  Filter the $insert_post_args

• graphql_data_is_private

  Filter to determine if the data should be considered private or not

• graphql_dataloader_get_cached

  Use this filter to retrieving cached data objects from third-party caching system.

• graphql_dataloader_get_model

  Filter the model before returning.

• graphql_dataloader_pre_get_model

  This filter allows the model generated by the DataLoader to be filtered.

• graphql_dataloader_set_cached

  Use this filter to store entry in a third-party caching system.

• graphql_html_entity_decoding_enabled

  Determine whether html_entity_decode should be applied to the string

• graphql_media_item_create_allowed_protocols

  Filter the allowed protocols for the mutation

• graphql_media_item_insert_post_args

  Filter the $insert_post_args

• graphql_model_field_capability

  Capability to check required for the field

• graphql_model_prepare_fields

  Filter the array of fields for the Model before the object is hydrated with it

• graphql_object_visibility

  Filter the visibility name to be returned

• graphql_post_object_create_default_post_status

  Filter the default post status to use when the post is initially created.

• graphql_post_object_create_should_set_intended_post_status

  Determine whether the intended status should be set or not.

• graphql_post_object_insert_post_args

  Filter the $insert_post_args

• graphql_post_object_mutations_allow_term_creation

  Filter whether to allow terms to be created during a post mutation.

• graphql_pre_model_data_is_private

  Filter to short circuit default is_private check for the model.

• graphql_pre_return_field_from_model

  Filter to short circuit the callback for any field on a type.

• graphql_resolve_revision_meta_from_parent

  Filters whether to resolve revision metadata from the parent node by default.

• graphql_restricted_data_cap

  Filter for the capability to check against for restricted data

• graphql_return_field_from_model

  Filter the data returned by the default callback for the field

• graphql_term_object_insert_term_args

  Filter the $insert_args

• graphql_user_insert_post_args

  Filters the mappings for input to arguments

• graphql_user_mutation_input_fields

  Filters all of the fields available for input

Request Lifecycle

• graphql_access_control_allow_headers

  Filtered list of access control headers.

• graphql_allowed_hosts

  Filters hostnames treated as belonging to this WordPress install when resolving node URIs.

• graphql_app_context_config

  This filters the config for the AppContext.

• graphql_data_loader_classes

  Filter to change the data loader classes.

• graphql_execute_query_params

  Allow the query string to be determined by a filter.

• graphql_http_request_response_errors

  Filter thrown GraphQL errors

• graphql_invalid_content_type_status_code

  Filter the status code to return when the content type is invalid

• graphql_is_batch_queries_enabled

  Filter whether batch queries are supported or not

• graphql_is_graphql_http_request

  Filter whether the request is a GraphQL HTTP Request.

• graphql_is_valid_http_content_type

  Allow graphql to validate custom content types for HTTP POST requests

• graphql_mutation_input

  Filters the mutation input before it’s passed to the mutateAndGetPayload callback.

• graphql_mutation_payload

  Filters the payload returned from the default mutateAndGetPayload callback.

• graphql_post_resolve_uri

  This filter provides a fallback for resolving nodes that were unable to be resolved by NodeResolver::resolve_uri.

• graphql_pre_is_graphql_http_request

  Filter whether the request is a GraphQL HTTP Request.

• graphql_pre_mutate_and_get_payload

  Filter to short circuit the mutateAndGetPayload callback.

• graphql_pre_resolve_uri

  When this filter return anything other than null, it will be used as a resolved node and the execution will be skipped.

• graphql_query_id_hash_algorithm

  Filter the hash algorithm to allow different algorithms.

• graphql_request_data

  Filters normalized GraphQL request data before GET requests are parsed.

• graphql_request_data

  Filters normalized GraphQL request data before POST requests are parsed.

• graphql_request_results

  Filter the $response of the GraphQL execution.

• graphql_resolve_node_type

  Add a filter to allow externally registered node types to return the proper type based on the node_object that’s returned

• graphql_resolve_uri

  When this filter return anything other than null, it will be used as a resolved node and the execution will be skipped.

• graphql_resolve_uri_query_class

  Filter the query class used to resolve the URI.

• graphql_response_headers_to_send

  Filter the $headers to send

• graphql_response_status_code

  Filter the $status_code before setting the headers

• graphql_root_value

  Return the filtered root value

• graphql_send_nocache_headers

  Filters whether no-cache headers should be sent on the GraphQL HTTP response.

• graphql_validation_rules

  Return the validation rules to use in the request

• pre_graphql_execute_request

  Filter this to be anything other than null to short-circuit the request.

• pre_graphql_execute_request

  Filter this to be anything other than null to short-circuit HTTP execution.

Schema Registration

• graphql_custom_scalar_config

  Filters scalar type configuration before the scalar is registered.

• graphql_enum_values

  Filter all object fields, passing the $typename as a param This is useful when several different types need to be easily filtered at once.

• graphql_excluded_connections

  Filter the list of GraphQL connections to excluded from the registry.

• graphql_excluded_mutations

  Filter the list of GraphQL mutations to excluded from the registry.

• graphql_excluded_types

  Filter the list of GraphQL types to exclude from the schema.

• graphql_get_type

  Filter the type before it is loaded into the registry.

• graphql_input_fields

  Filter all object fields, passing the $typename as a param This is useful when several different types need to be easily filtered at once.

• graphql_interface_fields

  Filter all interface fields, passing the $typename as a param This is useful when several different types need to be easily filtered at once.

• graphql_interface_resolve_type

  Filter the resolve type method for all interfaces

• graphql_introspection_keys

  Filter the keys that are prepared for introspection.

• graphql_object_fields

  Filter all object fields, passing the $typename as a param This is useful when several different types need to be easily filtered at once.

• graphql_post_entities_allowed_post_types

  Pass through a filter to allow the post_types to be modified.

• graphql_pre_format_name

  Filter to manually format a GraphQL name according to custom rules.

• graphql_schema

  Filter the Schema

• graphql_schema

  Generate & Filter the schema.

• graphql_schema_config

  Set the $filterable_config as the $config that was passed to the WPSchema when instantiated

• graphql_term_entities_allowed_taxonomies

  Pass through a filter to allow the taxonomies to be modified.

• graphql_type_interfaces

  Filters the interfaces applied to an object type

• graphql_type_name

  Filters the GraphQL type name used during enum type construction.

• graphql_type_name

  Filters the GraphQL type name before the input type is registered.

• graphql_type_name

  Filters the GraphQL type name before the interface type is registered.

• graphql_type_name

  Filters the GraphQL type name before the object type is registered.

• graphql_type_name

  Filters the GraphQL type name used during scalar type construction.

• graphql_type_name

  Filters the GraphQL type name used during type construction.

• graphql_type_registry

  Generate & Filter the schema.

• graphql_union_possible_types

  Filters the possible GraphQL object types for the union.

• graphql_union_resolve_type

  Filters the resolved GraphQL object type for a union value.

• graphql_wp_connection_type_config

  Filter the config of WPConnectionType

• graphql_wp_interface_type_config

  Filter the config of WPInterfaceType

• graphql_wp_mutation_type_config

  Filter the config of WPMutationType

• graphql_wp_object_type_config

  Filter the config of WPObjectType

• graphql_wp_union_type_config

  Filter the config of WPUnionType

• register_graphql_post_type_args

  Filters the graphql args set on a post type

• register_graphql_taxonomy_args

  Filters the graphql args set on a taxonomy

Settings and Admin

• graphql_add_admin_notice

  Pass the notice through a filter before registering it

• graphql_admin_notices_is_allowed_admin_page

  Filter to determine if the current admin page is within the scope of the plugin’s own pages.

• graphql_allowed_setting_groups

  Filter the $allowed_settings to allow some to be enabled or disabled from showing in the GraphQL Schema.

• graphql_allowed_settings_by_group

  Filter the $allowed_settings_by_group to allow enabling or disabling groups in the GraphQL Schema.

• graphql_enable_graphiql

  Filters whether the embedded GraphiQL IDE should be enabled.

• graphql_endpoint

  Filter the configured endpoint path for WPGraphQL.

• graphql_endpoint

  Filter the relative endpoint path where GraphQL can be accessed.

• graphql_experimental_features_cap

  Filters the capability required to turn experimental features on and off.

• graphql_experimental_features_override

  Filters global experimental feature overrides.

• graphql_experiments_registered_classes

  Filters the list of registered experiment classes.

• graphql_get_dependents

  Filters the list of plugins that use WPGraphQL as a dependency.

• graphql_get_extensions

  Filter the list of extensions, allowing other plugins to add or remove extensions.

• graphql_get_possible_dependents

  Filters the list of plugins that use WPGraphQL as a dependency.

• graphql_get_setting_section_field_value

  Filter the value before returning it

• graphql_get_setting_section_fields

  Filter the section fields

• graphql_render_admin_page

  Filters the rendered GraphiQL admin page markup.

• graphql_setting_field_config

  Filter the setting field config

• graphql_settings_sections

  Filters the WPGraphQL settings sections.

• graphql_settings_sections

  Filters the WPGraphQL settings sections.

• graphql_should_show_experiments_in_extensions

  Filter whether experiments should be shown in GraphQL response extensions.

• graphql_show_admin

  Filters whether WPGraphQL admin pages should be visible.

• wp_graphql_experiment_config

  Filters the experiment configuration.

• wp_graphql_experiment_enabled

  Filters whether the experiment is active.

• wpgraphql_enable_major_autoupdates

  Filter whether to allow major autoupdates.

• wpgraphql_enable_untested_autoupdates

  Filter whether to allow autoupdates with untested plugins.

• wpgraphql_experimental_features_enabled

  Filter whether WPGraphQL experimental features should be enabled.

• wpgraphql_untested_release_type

  Filter the release type to use when checking for untested plugins.