function entity_get_display

You are here

8 entity.inc entity_get_display($entity_type, $bundle, $view_mode)

Returns the entity view display associated to a bundle and view mode.

Use this function when assigning suggested display options for a component in a given view mode. Note that they will only be actually used at render time if the view mode itself is configured to use dedicated display settings for the bundle; if not, the 'default' display is used instead.

The function reads the entity view display from the current configuration, or returns a ready-to-use empty one if configuration entry exists yet for this bundle and view mode. This streamlines manipulation of display objects by always returning a consistent object that reflects the current state of the configuration.

Example usage:

  • Set the 'body' field to be displayed and the 'field_image' field to be hidden on article nodes in the 'default' display.
entity_get_display('node', 'article', 'default')
  ->setComponent('body', array(
    'type' => 'text_summary_or_trimmed',
    'settings' => array('trim_length' => '200')
    'weight' => 1,
  ))
  ->removeComponent('field_image')
  ->save();

Parameters

string $entity_type: The entity type.

string $bundle: The bundle.

string $view_mode: The view mode, or 'default' to retrieve the 'default' display object for this bundle.

Return value

\Drupal\Core\Entity\Display\EntityViewDisplayInterface The entity view display associated to the view mode.

75 calls to entity_get_display()
CommentManager::addBodyField in core/modules/comment/lib/Drupal/comment/CommentManager.php
Creates a comment_body field instance.
CommentManager::addDefaultField in core/modules/comment/lib/Drupal/comment/CommentManager.php
Utility method to add the default comment field to an entity.
CommentPagerTest::testTwoPagers in core/modules/comment/lib/Drupal/comment/Tests/CommentPagerTest.php
Confirms comment paging works correctly with two pagers.
ConfigExportImportUITest::testExportImport in core/modules/config/lib/Drupal/config/Tests/ConfigExportImportUITest.php
Tests a simple site export import case.
CustomBlockFieldTest::testBlockFields in core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockFieldTest.php
Checks block edit functionality.

... See full list

File

core/includes/entity.inc, line 439
Entity API for handling entities like nodes or users.

Code

function entity_get_display($entity_type, $bundle, $view_mode) {
  // Try loading the display from configuration.
  $display = entity_load('entity_view_display', $entity_type . '.' . $bundle . '.' . $view_mode);

  // If not found, create a fresh display object. We do not preemptively create
  // new entity_view_display configuration entries for each existing entity type
  // and bundle whenever a new view mode becomes available. Instead,
  // configuration entries are only created when a display object is explicitly
  // configured and saved.
  if (!$display) {
    $display = entity_create('entity_view_display', array(
      'targetEntityType' => $entity_type,
      'bundle' => $bundle,
      'mode' => $view_mode,
      'status' => TRUE,
    ));
  }

  return $display;
}