Gallery

ACF Pro
Last Upated: Thursday, Feb 1, 2024

gallery

The Gallery field is native to ACF PRO and provides an interactive interface for managing a collection of attachments.

Resolve Type

The "gallery" field type resolves as a "AcfMediaItemConnection" Type in the GraphQL Schema.

This allows for images to be queried as a nodes of the MediaItem Type, where the client can ask for any property of each Image.

Field Settings

Return Format

Impact on WPGraphQL not yet documented

Set as Global Conditional Logic

This is a presentational field in the WordPress admin and has no impact on the GraphQL Schema or GraphQL resolvers.

Wrapper Attributes

This is a presentational field in the WordPress admin and has no impact on the GraphQL Schema or GraphQL resolvers.

Show in GraphQL

Checking this will expose the field to the GraphQL Schema. 

NOTE: If a field is added to the GraphQL Schema, then later removed from the Schema, this is considered a breaking change as client applications that were querying for the field would be breaking once it’s been removed from the Schema.

GraphQL Description

The description of the field that is returned when using Schema Introspection queries, used by tools such as the GraphiQL IDE.

GraphQL Field Name

The name of the field in the GraphQL Schema. The name must be unique to the Field Group (i.e. there cannot be 2 fields in one ACF Field Group with the same “GraphQL Field Name”, including when using Clone Fields). 

Field Name

This is the name that is used to store field data in meta tables. The name will not affect the GraphQL Schema, but if the name is changed after data is already saved, it might impact resolution of the previously stored data. Changing the field name could negatively impact the GraphQL experience.

Field Label

This field is presentational for the WordPress admin and will not impact the GraphQL Schema.

Required

The “required” setting on an ACF Field does not directly impact the WPGraphQL Schema. While it might seem like setting an ACF Field to “required” should enforce the field to be a “Non Null” field in the GraphQL Schema, we believe this would be a mistake. Setting a field in the GraphQL Schema as “NonNull” will return errors if no data is present to be returned. Since the “required” setting can be toggled “on” on an ACF Field long after content already exists with no data for the field, this would cause errors to be returned for older content, and we believe this to be unexpected behavior. Instead of tying “GraphQL Non Null” to the ACF “Required” setting, we’ve provided a “GraphQL: NonNull” setting where you can explicitly opt-in to a field being “Non Null” in the Schema.

Instructions

This field is used to tell people in the WordPress admin how to use the field. If a “GraphQL Description” is not provided for a field, the “instructions” will be used as a fallback in GraphQL Introspection queries, used in tools such as the GraphiQL IDE.

Conditional Logic

Conditional Logic should not impact the GraphQL Schema. Fields that are conditionally available in the admin should always be available in the Schema. The data that is resolved for a field might be impacted by conditional logic.

Field Configuration