Field scopes

Throughout our help articles, we use examples showcasing metafields for the product scope, i.e. custom fields for products. This is done to maintain consistency between the different code snippets. Please know that every example, that uses the product scope can just as well use any of the other 8 scopes available:

  • variant (product.variants)

  • collection

  • page

  • blog

  • article

  • order

  • customer

  • shop

so this example use of a product metafield:

{{ product.metafields.accentuate.my_custom_field }}

could just as well be written as:

{{ page.metafields.accentuate.my_custom_field }}

or:

{{ collection.metafields.accentuate.my_custom_field }}

depending on which scope "my_custom_field" was created for using ACF and the context of its use within the theme.

Global fields

Global fields in ACF work similar to shop fields and the two can be used interchangeably. One crucial difference is that global fields can be referenced from field definitions belonging to other scopes such as products, collections, pages etc. using a "Reference fields: Globals" type. This allows you to use global fields as puzzle pieces for building your field definitions for a specific scope, making it a breeze to maintain cross-site content of any type. You define and edit global fields as you would for any other scope in ACF. This allows you to store content globally available (within your shop, that is)

Custom fields for the global scope are saved as shop-level metafields and have their namespace locked to globals. You cannot create global fields with another namespace and you cannot use the globals namespace for shop-level custom fields.

Aggregate scopes

ACF supports the creation of custom fields for Shopify-specific entities, that don't in themselves serve as scopes in Shopify and thus cannot be directly used as a target for metafields. These entities or "aggregate scopes" are:

  • product types

  • vendors

  • locations

For each of these scopes, you can define custom fields as usual and edit the values for each "instance" ie. a particular product type, a specific vendor or a location, just as you would for a product or a collection in ACF. This allows you to store content where it makes most sense, for example vendor information at a higher level than your individual products, making it easier to maintain your field values. Custom fields for aggregate scopes are stored with the "shop" scope in Shopify and have their namespaces locked to a specific value depending on the scope:

  • types is a reserved namespace for product type fields

  • vendors is a reserved namespace for vendor fields

  • locations is a reserved namespace for location fields

You cannot create product type, vendor or location fields with other namespaces than the above and you cannot use these namespaces for other shop-level custom fields.

Accessing metafields for types, vendors, and locations

To access a custom field value for an individual product type, use this construct:

shop.metafields.types.my_field_name['cars'] 

Similarly for vendors:

shop.metafields.vendors.my_field_name['microsoft']

Note: the value used as the last parameter for types and vendors must be a handleized value. These shop-level metafield constructs work in a similar way as Liquid's global objects "all_products", "collections" etc.

Access to metafields for locations follows the same general principle, but uses Shopify's internal id numbers for its location objects. You don't have direct access to your shop's locations from Liquid, but you can copy a specific location's id from your shop's admin interface and use it to access the location's custom field:

shop.metafields.locations.my_field_name[1234567890]  

Examples

Showing the vendor's logo (stored in a Media v2 field) when viewing a specific product:

{% assign vendor_handle = product.vendor | handleize %}
{% assign logo = shop.metafields.vendors.logo[vendor_handle] | first %} 

<img src="{{ logo.src }}" alt="{{ logo.alt }}"/>

Showing a product's type's care instructions when viewing a specific product:

{% assign product_type_handle = product.type | handleize %}

<p>{{ shop.metafields.types.care_instructions[product_type_handle] }}</p>

Last updated