Skip to content

Instantly share code, notes, and snippets.

@leymannx
Forked from swichers/d7-add-entity-view-mode.md
Created October 22, 2018 08:16
Show Gist options
  • Save leymannx/30abb0eb3315b63840acd9b74a395d01 to your computer and use it in GitHub Desktop.
Save leymannx/30abb0eb3315b63840acd9b74a395d01 to your computer and use it in GitHub Desktop.
Drupal 7 - Programmatically add view mode to entity

In a module file:

This will enable an additional view mode for use on the specified entity type(s). Many examples will show the custom settings here being set to TRUE. If TRUE is used then that view mode is added to all entities of the specified type regardless of if it should be on the bundle or not.

/**
 * Implements hook_entity_info_alter().
 */
function HOOK_entity_info_alter(&$entity_info) {

  $entity_info['node']['view modes'] += array(
    'view_mode_machine_name' => array(
      'label' => t('View mode display name'),
      'custom settings' => FALSE,
    ),
  );

  return $entity_info;
}

Where "view_mode_machine_name" is the machine name of the view mode you want to add (ex: sidebar).

In a hook_update(), hook_install(), or hook_enable():

This code will enable the view mode for a specific bundle. This is optional if the view mode should be disabled by default.

  $settings = field_bundle_settings('node', 'article');
  $settings['view_modes']['view_mode_machine_name']['custom_settings'] = TRUE;
  field_bundle_settings('node', 'article', $settings);

Where "node" is the entity type (node, file, taxonomy_term, etc.).

Where "article" is the bundle (node type).

Where "view_mode_machine_name" is the machine name above (ex: sidebar).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment