actions-and-filters.md

Actions & Filters

Actions

• graphql_gf_init
• graphql_gf_before_register_types
• graphql_gf_after_register_types

graphql_gf_init

Fires after the plugin has been initialized.

apply_filters( 'graphql_gf_init', $instance );

Parameters

• $instance (GF) : The plugin instance.

graphql_gf_before_register_types

Fires before plugin registers types to the GraphQL schema

apply_filters( 'graphql_gf_before_register_types', $type_registry );

Parameters

• $type_registry (WPGraphQL\Registry\TypeRegistry) : The WPGraphQL registry of Types used in the GraphQL schema.

graphql_gf_after_register_types

Fires after plugin registers types to the GraphQL schema

apply_filters( 'graphql_gf_after_register_types', $type_registry );

Parameters

• $type_registry (WPGraphQL\Registry\TypeRegistry) : The WPGraphQL registry of Types used in the GraphQL schema.

Filters

• graphql_gf_can_view_draft_entries
• graphql_gf_can_view_entries
• graphql_gf_entries_connection_query_args
• graphql_gf_field_value_input_class
• graphql_gf_field_value_input_args
• graphql_gf_field_value_input_name
• graphql_gf_field_value_input_prepared_value
• graphql_gf_forms_connection_query_args
• graphql_gf_form_field_child_types
• graphql_gf_form_field_name_map
• graphql_gf_form_field_setting_properties
• graphql_gf_form_field_value_properties
• graphql_gf_form_field_values_input_fields
• graphql_gf_form_object
• graphql_gf_gatsby_enabled_actions
• graphql_gf_ignored_field_types
• graphql_gf_registered_connection_classes
• graphql_gf_registered_entry_types
• graphql_gf_registered_enum_classes
• graphql_gf_registered_field_classes
• graphql_gf_registered_input_classes
• graphql_gf_registered_interface_classes
• graphql_gf_registered_mutation_classes
• graphql_gf_registered_object_classes
• graphql_gf_update_repo_url

graphql_gf_can_view_draft_entries

Filter to control whether the user should be allowed to view draft entries.

apply_filters( 'graphql_gf_can_view_draft_entries', bool $can_view_entries, int $form_id, string $resume_token, array $draft_entry );

Parameters

• $can_view_entries (bool) : Whether the user can view draft entries. By default this anyone.
• $form_id (int) : The GF form ID being queried by GraphQL.
• $resume_token (string) : The draft entry resume token being queried by GraphQL.
• $draft_entry (array) : The Gravity Forms draft entry data array.

graphql_gf_can_view_entries

Filter to control whether the user should be allowed to view submitted entries.

apply_filters( 'graphql_gf_can_view_entries', bool $can_view_entries, int $form_id, int $entry_id, array $entry );

Parameters

• $can_view_entries (bool) : Whether the user can view draft entries. By default this is the user who submitted the entry, and any user with the gravityforms_view_entries and gform_full_access capabilities.
• $form_id (int) : The GF form ID being queried by GraphQL.
• $entry_id (string) : The entry ID being queried by GraphQL.
• $draft_entry (array) : The Gravity Forms entry data array.

graphql_gf_entries_connection_query_args

Filter the Submitted Entry's $query_args to allow folks to customize queries programmatically.

apply_filters( 'graphql_gf_entries_connection_query_args', array $query_args, mixed $source, array $args, AppContext $context, ResolveInfo $info );

Parameters

• $query_args (array) : The query args that will be passed to GF_Query.
• $source (mixed) : The source passed down the Resolve Tree.
• $args (array) : Array of arguments input in the field as part of the GraphQL query.
• $context (AppContext) : Object passed down the GraphQL tree.
• $info (ResolveInfo) : The ResolveInfo passed down the GraphQL tree.

graphql_gf_field_value_input_class

Filters the AbstractFieldValueInput class used to process form field submissions. Useful for adding mutation support for custom Gravity Forms fields.

apply_filters( 'graphql_gf_field_value_input_class', string $input_class, array $args, GF_Field $field, array $form, array|null $entry, bool $is_draft_mutation  );

Parameters

• $input_class (string) : The FieldValueInput class to use. The class must extend AbstractFieldValueInput.
• $args (array) : The GraphQL input value name to use. E.g. checkboxValues.
• $field (GF_Field) : The current Gravity Forms field object.
• $form (array) : The current Gravity Forms form object.
• $entry (array|null) : The current Gravity Forms entry object. Only set when using update (gfUpdateEntry, gfUpdateDraftEntry) mutations.
• $is_draft_mutation (bool) : Whether the mutation is handling a Draft Entry, i.e. on gfUpdateDraftEntry, or gfSubmitForm with saveAsDraft is true).

graphql_gf_field_value_input_args

Filters the GraphQL input args provided from the field value input. Useful for supporting custom Gravity Forms field value input types.

apply_filters( 'graphql_gf_field_value_input_args', array|string $args, GF_Field $field, array $form, array|null $entry, bool $is_draft_mutation, string $field_name );

Parameters

• $args (string|array) : The input args from the field value input.
• $field (GF_Field) : The current Gravity Forms field object.
• $form (array) : The current Gravity Forms form object.
• $entry (array|null) : The current Gravity Forms entry object. Only set when using update (gfUpdateEntry, gfUpdateDraftEntry) mutations.
• $is_draft_mutation (bool) : Whether the mutation is handling a Draft Entry, i.e. on gfUpdateDraftEntry, or gfSubmitForm with saveAsDraft is true).
• $name (string) : The GraphQL input value name to use. E.g. checkboxValues.

graphql_gf_field_value_input_name

Filters the accepted GraphQL input value key for the form field. Useful for adding support for custom Gravity Forms field value inputs.

apply_filters( 'graphql_gf_field_value_input_name', string $name, GF_Field $field, array $form, array|null $entry, bool $is_draft_mutation  );

Parameters

• $name (string) : The GraphQL input value name to use. E.g. checkboxValues.
• $field (GF_Field) : The current Gravity Forms field object.
• $form (array) : The current Gravity Forms form object.
• $entry (array|null) : The current Gravity Forms entry object. Only set when using update (gfUpdateEntry, gfUpdateDraftEntry) mutations.
• $is_draft_mutation (bool) : Whether the mutation is handling a Draft Entry, i.e. on gfUpdateDraftEntry, or gfSubmitForm with saveAsDraft is true).

graphql_gf_field_value_input_prepared_value

Filters the prepared field value to be submitted to Gravity Forms. Useful for supporting custom Gravity Forms field value submissions.

apply_filters( 'graphql_gf_field_value_input_prepared_value', array|string $prepared_field_value, array|string $args, GF_Field $field, array $form, array|null $entry, bool $is_draft_mutation, string $field_name );

Parameters

• $prepared_field_value : The field value formatted for use in Gravity Forms submissions.
• $args (string|array) : The input args from the field value input.
• $field (GF_Field) : The current Gravity Forms field object.
• $form (array) : The current Gravity Forms form object.
• $entry (array|null) : The current Gravity Forms entry object. Only set when using update (gfUpdateEntry, gfUpdateDraftEntry) mutations.
• $is_draft_mutation (bool) : Whether the mutation is handling a Draft Entry, i.e. on gfUpdateDraftEntry, or gfSubmitForm with saveAsDraft is true).
• $name (string) : The GraphQL input value name to use. E.g. checkboxValues.

graphql_gf_forms_connection_query_args

Filter the Form $query_args to allow folks to customize queries programmatically.

apply_filters( 'graphql_gf_forms_connection_query_args', array $query_args, mixed $source, array $args, AppContext $context, ResolveInfo $info );

Parameters

• $query_args (array) : The query args that will be passed to GFAPI::get_forms().
• $source (mixed) : The source passed down the Resolve Tree.
• $args (array) : Array of arguments input in the field as part of the GraphQL query.
• $context (AppContext) : Object passed down the GraphQL tree.
• $info (ResolveInfo) : The ResolveInfo passed down the GraphQL tree.

graphql_gf_form_field_child_types

Filter for altering the child types of a specific GF_Field.

apply_filters( 'graphql_gf_form_field_child_types', array $child_types, string $field_type );

Parameters

• $child_types (array) : An array of GF_Field::$type => GraphQL type names. E.g.:

// For $type = 'quiz'.
$child_types = [
  'checkbox' => 'QuizCheckboxField',
  'radio'    => 'QuizRadioField',
  'select'   => 'QuizSelectField',
];

• $field_type (string) : The 'parent' GF_Field::$type. E.g. quiz.

graphql_gf_form_field_setting_properties

Filter to modify the Form Field GraphQL fields based on GF_Field::form_editor_field_settings() .

apply_filters( 'graphql_gf_form_field_setting_properties', array $properties, string $setting, GF_Field $field );

Parameters

• $properties (array) : An array of WPGraphQL field $config arrays .
• $setting (string) : The form_editor_field_settings() key.
• $field _(GF_Field) : The Gravity Forms Field object.

graphql_gf_form_field_value_properties

Filter to modify the Form Field value GraphQL fields.

apply_filters( 'graphql_gf_form_field_value_properties', array $properties, GF_Field $field );

Parameters

• $properties (array) : An array of WPGraphQL field $config arrays .
• $field _(GF_Field) : The Gravity Forms Field object.

graphql_gf_form_field_values_input_fields

Filter to modify the Form Field value GraphQL fields. Useful for adding support for inputs used by custom Gravity Forms fields.

apply_filters( 'graphql_gf_form_field_values_input_fields', array $fields );

Parameters

• $fields (array) : An array of WPGraphQL field $config arrays .

graphql_gf_form_fields_name_map

Filter to map the Gravity Forms Field type to a safe GraphQL type (in PascalCase ).

apply_filters( 'graphql_gf_form_fields_name_map', array $fields_to_map );

Parameters

• $fields_to_map (array) : An array of GF field types to GraphQL type names. E.g. 'fileupload' => 'FileUpload'.

graphql_gf_form_object

Filter to modify the form data before it is sent to the client. This hook is somewhat similar to GF's gform_pre_render hook, and can be used for dynamic field input population among other things.

apply_filters( 'graphql_gf_form_object', array $form );

Parameters

• $form (array) : The GF Form object.

graphql_gf_gatsby_enabled_actions

Filter for overriding the list of enabled actions that WPGatsby should monitor.

apply_filters( 'graphql_gf_gatsby_enabled_actions', array $enabled_actions );

Parameters

• $enabled (array) : An array of the enabled actions for WPGatsby to monitor. Possible array values: create_form, update_form, delete_form, create_entry, update_entry.

graphql_gf_ignored_field_types

Filters the list of ignored field types. Useful for adding/removing support for a specific Gravity Forms field.

apply_filters( 'graphql_gf_ignored_field_types', array $ignored_fields );

Parameters

• $ignored_fields (array) : An array of GF_Field::$type names to be ignored by WPGraphQL.

graphql_gf_registered_{$type}_classes

Filters the list of PHP classes that register GraphQL. Useful for adding/removing GF specific GraphQL types to the schema.

Possible types are connection (e.g. graphql_gf_registered_connection_classes ), enum , field , input , interface , mutation and object .

apply_filters( 'graphql_gf_registered_{$type}_classes', array $classes_to_register );

Parameters

• $classes_to_register (array) : Array of PHP classes with GraphQL types to be registered to the schema.

graphql_gf_registered_entry_types

Filter for modifying the Gravity Forms Entry types supported by WPGraphQL.

apply_filters( 'graphql_gf_registered_entry_types', array $entry_types );

Parameters

• $entry_types (array) : An array of Data Loader names => GraphQL Types. E.g: [ [ 'gf_entry' => 'GfSubmittedEntry ] ]

graphql_gf_update_repo_url

Filters the repo url used in the update checker.

Useful for checking updates against a fork.

apply_filters( 'graphql_gf_update_repo_url', string $repo_link );

Parameters

• $repo_link (string) : The url to the repo, as required by plugin-update-checker.