Shared Field Display Settings Documentation

Module Overview

Shared Field Display Settings enables functionality for field display settings to be shared and updated across content types and/or display view modes by establishing a default settings source.

Why You Might Want This Module

As an example, this module allows for sharing of display settings for a field, such as a call-to-action, that may be present across multiple site pages and component elements without having to establish settings manually for each field instance. 

Installing & Enabling Shared Field Display Settings

Install the module using composer. Get the exact command from the recommended release on the main project page.

Once installed, there are two methods of enabling the module:

1. Enable the module via Drush: (drush en sfds)
2. Enable the module in the UI: (/admin/modules)

Using Shared Field Display Settings

Once enabled, new configuration options will be available within the field settings under Field Storage. Select the checkbox "Enable shared field display for this field" to set the existing, specific field display settings as the Global or Per Bundle defaults that will be inherited by other content types and/or view modes. The example below is accessing the field settings for a newsletter opt-in boolean field. 

Global

Establishes field display settings for all shared fields across all content types and view modes.

The admin must choose an existing content type to serve as the global default for field display settings to be shared. All content types and view modes utilizing the same field will inherit the existing field display settings from the global default - in this example the default field is located on the Basic Page content type. 

If the same newsletter opt-in boolean field is added to the Landing Page content type, the field display settings are inherited from the Global default field display settings (Basic Page).

When establishing a global default, the field display settings are also inherited across all view modes. In this example the Teaser view mode on the Landing Page content type can be seen inheriting the Global default field display settings. Note: the field must be enabled for each display mode to be displayed. 

Per Bundle

Establishes field display settings across all view modes for a single content type only. This option is available when field display settings are required across all of the content type view modes, but the settings are not intended to be shared with the same fields present on other content types. No option to select a content type is available within the "Shared field display settings."

Updating Field Display Settings

If field display settings changes are required, editing the Global or Per Bundle defaults allows the admin to make changes to the field display settings for all shared instances from a single location versus updating the field display settings across all content types and/or view modes individually. 

If a field display setting was previously enabled as a Global or Per Bundle default and the default setting is disabled, the admin is required to update the field display settings on all previously inheriting content types and/or view modes. It is important to be intentional about which content types and view modes will inherit field display settings to avoid such an issue.

Field Reference

If necessary, shared fields can be viewed within the admin Field List: (/admin/reports/fields)