function template_preprocess_node in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/node/node.module \template_preprocess_node()
2. 6 includes/theme.inc \template_preprocess_node()
3. 7 modules/node/node.module \template_preprocess_node()

Prepares variables for node templates.

Default template: node.html.twig.

Most themes use their own copy of node.html.twig. The default is located inside "/core/modules/node/templates/node.html.twig". Look in there for the full list of variables.

By default this function performs special preprocessing of some base fields so they are available as variables in the template. For example 'title' appears as 'label'. This preprocessing is skipped if:

• a module makes the field's display configurable via the field UI by means of BaseFieldDefinition::setDisplayConfigurable()
• AND the additional entity type property 'enable_base_field_custom_preprocess_skipping' has been set using hook_entity_type_build().

Parameters

array $variables: An associative array containing:

• elements: An array of elements to display in view mode.
• node: The node object.
• view_mode: View mode; e.g., 'full', 'teaser', etc.

See also

hook_entity_type_build()

\Drupal\Core\Field\BaseFieldDefinition::setDisplayConfigurable()

File

core/modules/node/node.module, line 500

The core module that allows content to be submitted to the site.

Code

function template_preprocess_node(&$variables) {
  $variables['view_mode'] = $variables['elements']['#view_mode'];

  // Provide a distinct $teaser boolean.
  $variables['teaser'] = $variables['view_mode'] == 'teaser';
  $variables['node'] = $variables['elements']['#node'];

  /** @var \Drupal\node\NodeInterface $node */
  $node = $variables['node'];
  $skip_custom_preprocessing = $node
    ->getEntityType()
    ->get('enable_base_field_custom_preprocess_skipping');

  // Make created, uid and title fields available separately. Skip this custom
  // preprocessing if the field display is configurable and skipping has been
  // enabled.
  // @todo https://www.drupal.org/project/drupal/issues/3015623
  //   Eventually delete this code and matching template lines. Using
  //   $variables['content'] is more flexible and consistent.
  $submitted_configurable = $node
    ->getFieldDefinition('created')
    ->isDisplayConfigurable('view') || $node
    ->getFieldDefinition('uid')
    ->isDisplayConfigurable('view');
  if (!$skip_custom_preprocessing || !$submitted_configurable) {
    $variables['date'] = \Drupal::service('renderer')
      ->render($variables['elements']['created']);
    unset($variables['elements']['created']);
    $variables['author_name'] = \Drupal::service('renderer')
      ->render($variables['elements']['uid']);
    unset($variables['elements']['uid']);
  }
  if (isset($variables['elements']['title']) && (!$skip_custom_preprocessing || !$node
    ->getFieldDefinition('title')
    ->isDisplayConfigurable('view'))) {
    $variables['label'] = $variables['elements']['title'];
    unset($variables['elements']['title']);
  }
  $variables['url'] = !$node
    ->isNew() ? $node
    ->toUrl('canonical')
    ->toString() : NULL;

  // The 'page' variable is set to TRUE in two occasions:
  // - The view mode is 'full' and we are on the 'node.view' route.
  // - The node is in preview and view mode is either 'full' or 'default'.
  $variables['page'] = $variables['view_mode'] == 'full' && node_is_page($node) || isset($node->in_preview) && in_array($node->preview_view_mode, [
    'full',
    'default',
  ]);

  // Helpful $content variable for templates.
  $variables += [
    'content' => [],
  ];
  foreach (Element::children($variables['elements']) as $key) {
    $variables['content'][$key] = $variables['elements'][$key];
  }
  if (isset($variables['date'])) {

    // Display post information on certain node types. This only occurs if
    // custom preprocessing occurred for both of the created and uid fields.
    // @todo https://www.drupal.org/project/drupal/issues/3015623
    //   Eventually delete this code and matching template lines. Using a field
    //   formatter is more flexible and consistent.
    $node_type = $node->type->entity;

    // Used by RDF to add attributes around the author and date submitted.
    $variables['author_attributes'] = new Attribute();
    $variables['display_submitted'] = $node_type
      ->displaySubmitted();
    if ($variables['display_submitted']) {
      if (theme_get_setting('features.node_user_picture')) {

        // To change user picture settings (e.g. image style), edit the
        // 'compact' view mode on the User entity. Note that the 'compact'
        // view mode might not be configured, so remember to always check the
        // theme setting first.
        $variables['author_picture'] = \Drupal::entityTypeManager()
          ->getViewBuilder('user')
          ->view($node
          ->getOwner(), 'compact');
      }
    }
  }

  // Add article ARIA role.
  $variables['attributes']['role'] = 'article';
}