block.module 14.3 KB
Newer Older
1
<?php
Dries's avatar
Dries committed
2

3 4
/**
 * @file
5
 * Controls the visual building blocks a page is constructed with.
6 7
 */

8
use Drupal\block\BlockInterface;
9
use Drupal\Core\Routing\RouteMatchInterface;
10
use Drupal\language\Entity\ConfigurableLanguage;
11
use Drupal\system\Entity\Menu;
12
use Drupal\block\Entity\Block;
13

14
/**
15
 * Implements hook_help().
16
 */
17
function block_help($route_name, RouteMatchInterface $route_match) {
18 19
  switch ($route_name) {
    case 'help.page.block':
20
      $output = '';
21
      $output .= '<h3>' . t('About') . '</h3>';
22
      $output .= '<p>' . t('The Block module allows you to place blocks in regions and to configure their settings. For more information, see <a href="!blocks-documentation">the online documentation for the Blocks module</a>.', array('!blocks-documentation' => 'https://drupal.org/documentation/modules/block/')) . '</p>';
23 24
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
25 26 27 28 29
      $output .= '<dt>' . t('Placing and moving blocks') . '</dt>';
      $output .= '<dd>' . t('You can place a block by clicking on its title in the in the <em>Place blocks</em> list on the <a href="!blocks">Block layout page</a>. You can then choose the appropriate region from the <em>Region</em> dropdown menu. Once a block has been placed, it can also be moved to a different region by chosing a region from the <em>Region</em> dropdown menu on the Block layout page, or by dragging and dropping it to the right posititon.', array('!blocks' => \Drupal::url('block.admin_display'))) . '</dd>';
      $output .= '<dt>' . t('Demonstrating block regions for a theme') . '</dt>';
      $output .= '<dd>' . t('You can see which region is where in a theme by clicking an the <em>Demonstrate block regions</em> link on the <a href="!blocks">Block layout page</a>. Regions are specific to each theme, so you need to toggle to a different theme first to demonstrate its block regions.', array('!blocks' => \Drupal::url('block.admin_display'))) . '</dd>';
      $output .= '<dt>' . t('Toggling between different themes') . '</dt>';
30
      $output .= '<dd>' . t('Blocks are placed and configured specifically for each theme. The Block layout page opens with the default theme, but you can toggle to other installed themes.') . '</dd>';
31 32
      $output .= '<dt>' . t('Configuring block settings') . '</dt>';
      $output .= '<dd>' . t('To change the settings of an individual block click on the <em>Configure</em> link on the <a href="!blocks">Block layout page</a>. The available options vary depending on the module that provides the block. For all blocks you can change the block title and toggle whether to display it.', array('!blocks' => Drupal::url('block.admin_display'))) . '</dd>';
33
      $output .= '<dt>' . t('Controlling visibility') . '</dt>';
34 35
      $output .= '<dd>' . t('You can control the visibility of a block by restricting it to specific pages, content types, and/or roles by setting the appropriate options under <em>Visibility settings</em> of the block configuration.') . '</dd>';
      $output .= '<dt>' . t('Adding custom blocks') . '</dt>';
36
      $output .= '<dd>' . t('You can add custom blocks, if the the <em>Custom Block</em> module is enabled on the <a href="!extend">Extend page</a>. For more information, see the <a href="!blockcontent-help">Custom Block help page</a>.', array('!extend' => \Drupal::url('system.modules_list'), '!blockcontent-help' => \Drupal::url('help.page', array('name' => 'block_content')))) . '</dd>';
37
      $output .= '</dl>';
38
      return $output;
39
  }
40
  if ($route_name == 'block.admin_display' || $route_name == 'block.admin_display_theme') {
41
    $demo_theme = $route_match->getParameter('theme') ?: \Drupal::config('system.theme')->get('default');
42
    $themes = list_themes();
43
    $output = '<p>' . t('This page provides a drag-and-drop interface for adding a block to a region, and for controlling the order of blocks within regions. To add a block to a region, or to configure its specific title and visibility settings, click the block title under <em>Place blocks</em>. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page.') . '</p>';
44
    $output .= '<p>' . l(t('Demonstrate block regions (!theme)', array('!theme' => $themes[$demo_theme]->info['name'])), 'admin/structure/block/demo/' . $demo_theme) . '</p>';
45 46
    return $output;
  }
47 48
}

49
/**
50
 * Implements hook_theme().
51 52 53
 */
function block_theme() {
  return array(
54
    'block' => array(
55
      'render element' => 'elements',
56
      'template' => 'block',
57
    ),
58 59 60 61
    'block_list' => array(
      'render element' => 'form',
      'template' => 'block-list',
    ),
62 63 64
  );
}

65
/**
66
 * Implements hook_page_build().
67
 *
68
 * Renders blocks into their regions.
69
 */
70
function block_page_build(&$page) {
71
  $theme = \Drupal::theme()->getActiveTheme()->getName();
72

73
  // Fetch a list of regions for the current theme.
74
  $all_regions = system_region_list($theme);
75
  if (\Drupal::routeMatch()->getRouteName() != 'block.admin_demo') {
76 77 78 79 80
    // Create a full page display variant, which will load blocks into their
    // regions.
    $page += \Drupal::service('plugin.manager.display_variant')
      ->createInstance('full_page')
      ->build();
81 82 83
  }
  else {
    // Append region description if we are rendering the regions demo page.
84 85 86 87 88 89
    $visible_regions = array_keys(system_region_list($theme, REGIONS_VISIBLE));
    foreach ($visible_regions as $region) {
      $description = '<div class="block-region">' . $all_regions[$region] . '</div>';
      $page[$region]['block_description'] = array(
        '#markup' => $description,
        '#weight' => 15,
90
      );
91
    }
92 93 94
    $page['page_top']['backlink'] = array(
      '#type' => 'link',
      '#title' => t('Exit block region demonstration'),
95
      '#href' => 'admin/structure/block' . (\Drupal::config('system.theme')->get('default') == $theme ? '' : '/list/' . $theme),
96
      '#options' => array('attributes' => array('class' => array('block-demo-backlink'))),
97 98
      '#weight' => -10,
    );
99 100 101
  }
}

102
/**
103
 * Returns an array of block class instances by theme.
104
 *
105
 * @param $theme
106 107
 *   The theme to rehash blocks for. If not provided, defaults to the currently
 *   used theme.
108
 *
109
 * @return
110
 *   Blocks currently exported by modules.
111
 */
112
function _block_rehash($theme = NULL) {
113
  $theme = $theme ? $theme : \Drupal::config('system.theme')->get('default');
114
  $regions = system_region_list($theme);
115 116
  $blocks = entity_load_multiple_by_properties('block', array('theme' => $theme));
  foreach ($blocks as $block_id => $block) {
117 118 119 120 121 122
    // Remove any invalid block from the list.
    // @todo Remove this check as part of https://drupal.org/node/1776830.
    if (!$block->getPlugin()) {
      unset($blocks[$block_id]);
      continue;
    }
123
    $region = $block->get('region');
124
    $status = $block->status();
125
    // Disable blocks in invalid regions.
126
    if (!empty($region) && $region != BlockInterface::BLOCK_REGION_NONE && !isset($regions[$region]) && $status) {
127
      drupal_set_message(t('The block %info was assigned to the invalid region %region and has been disabled.', array('%info' => $block_id, '%region' => $region)), 'warning');
128 129
      // Disabled modules are moved into the BlockInterface::BLOCK_REGION_NONE
      // later so no need to move the block to another region.
130
      $block->disable()->save();
131
    }
132
    // Set region to none if not enabled.
133
    if (!$status && $region != BlockInterface::BLOCK_REGION_NONE) {
134
      $block->set('region', BlockInterface::BLOCK_REGION_NONE);
135
      $block->save();
136
    }
137
  }
138 139
  return $blocks;
}
Dries's avatar
Dries committed
140

141
/**
142
 * Initializes blocks for installed themes.
143 144 145
 *
 * @param $theme_list
 *   An array of theme names.
146
 */
147
function block_themes_installed($theme_list) {
148 149
  foreach ($theme_list as $theme) {
    block_theme_initialize($theme);
150 151 152 153
  }
}

/**
154
 * Assigns an initial, default set of blocks for a theme.
155
 *
156 157 158
 * This function is called the first time a new theme is installed. The new
 * theme gets a copy of the default theme's blocks, with the difference that if
 * a particular region isn't available in the new theme, the block is assigned
159
 * to the new theme's default region.
160
 *
161 162 163
 * @param $theme
 *   The name of a theme.
 */
164
function block_theme_initialize($theme) {
165
  // Initialize theme's blocks if none already registered.
166
  $has_blocks = entity_load_multiple_by_properties('block', array('theme' => $theme));
167
  if (!$has_blocks) {
168
    $default_theme = \Drupal::config('system.theme')->get('default');
169 170
    // Apply only to new theme's visible regions.
    $regions = system_region_list($theme, REGIONS_VISIBLE);
171 172
    $default_theme_blocks = entity_load_multiple_by_properties('block', array('theme' => $default_theme));
    foreach ($default_theme_blocks as $default_theme_block_id => $default_theme_block) {
173 174 175 176 177 178
      if (strpos($default_theme_block_id, $default_theme . '_') === 0) {
        $id = str_replace($default_theme, $theme, $default_theme_block_id);
      }
      else {
        $id = $theme . '_' . $default_theme_block_id;
      }
179
      $block = $default_theme_block->createDuplicate();
180 181
      $block->set('id', $id);
      $block->set('theme', $theme);
182 183
      // If the region isn't supported by the theme, assign the block to the
      // theme's default region.
184 185
      if (!isset($regions[$block->get('region')])) {
        $block->set('region', system_default_region($theme));
186
      }
187
      $block->save();
188 189 190 191
    }
  }
}

192 193 194 195
/**
 * Implements hook_rebuild().
 */
function block_rebuild() {
196 197 198 199
  foreach (list_themes() as $name => $data) {
    if ($data->status) {
      _block_rehash($name);
    }
200
  }
201
}
202

203 204 205 206 207 208
/**
 * Implements hook_theme_suggestions_HOOK().
 */
function block_theme_suggestions_block(array $variables) {
  $suggestions = array();

209
  $suggestions[] = 'block__' . $variables['elements']['#configuration']['provider'];
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
  // Hyphens (-) and underscores (_) play a special role in theme suggestions.
  // Theme suggestions should only contain underscores, because within
  // drupal_find_theme_templates(), underscores are converted to hyphens to
  // match template file names, and then converted back to underscores to match
  // pre-processing and other function names. So if your theme suggestion
  // contains a hyphen, it will end up as an underscore after this conversion,
  // and your function names won't be recognized. So, we need to convert
  // hyphens to underscores in block deltas for the theme suggestions.

  // We can safely explode on : because we know the Block plugin type manager
  // enforces that delimiter for all derivatives.
  $parts = explode(':', $variables['elements']['#plugin_id']);
  $suggestion = 'block';
  while ($part = array_shift($parts)) {
    $suggestions[] = $suggestion .= '__' . strtr($part, '-', '_');
  }

227 228
  if (!empty($variables['elements']['#id'])) {
    $suggestions[] = 'block__' . $variables['elements']['#id'];
229 230 231 232 233
  }

  return $suggestions;
}

234
/**
235 236 237
 * Prepares variables for block templates.
 *
 * Default template: block.html.twig.
238
 *
239
 * Prepares the values passed to the theme_block function to be passed
240 241
 * into a pluggable template engine. Uses block properties to generate a
 * series of template file suggestions. If none are found, the default
242
 * block.html.twig is used.
243
 *
244 245 246
 * Most themes use their own copy of block.html.twig. The default is located
 * inside "core/modules/block/templates/block.html.twig". Look in there for the
 * full list of available variables.
247
 *
248 249 250 251
 * @param array $variables
 *   An associative array containing:
 *   - elements: An associative array containing the properties of the element.
 *     Properties used: #block, #configuration, #children, #plugin_id.
252 253
 */
function template_preprocess_block(&$variables) {
254 255
  $variables['configuration'] = $variables['elements']['#configuration'];
  $variables['plugin_id'] = $variables['elements']['#plugin_id'];
256 257
  $variables['base_plugin_id'] = $variables['elements']['#base_plugin_id'];
  $variables['derivative_plugin_id'] = $variables['elements']['#derivative_plugin_id'];
258 259
  $variables['label'] = !empty($variables['configuration']['label_display']) ? $variables['configuration']['label'] : '';
  $variables['content'] = $variables['elements']['content'];
260 261 262 263 264
  // A block's label is configuration: it is static. Allow dynamic labels to be
  // set in the render array.
  if (isset($variables['elements']['content']['#title']) && !empty($variables['configuration']['label_display'])) {
    $variables['label'] = $variables['elements']['content']['#title'];
  }
265

266
  // Create a valid HTML ID and make sure it is unique.
267 268
  if (!empty($variables['elements']['#id'])) {
    $variables['attributes']['id'] = drupal_html_id('block-' . $variables['elements']['#id']);
269
  }
270 271

  // Proactively add aria-describedby if possible to improve accessibility.
272 273 274
  if ($variables['label'] && isset($variables['attributes']['role'])) {
    $variables['title_attributes']['id'] = drupal_html_id($variables['label']);
    $variables['attributes']['aria-describedby'] = $variables['title_attributes']['id'];
275 276
  }

277
}
278

279
/**
280
 * Implements hook_ENTITY_TYPE_delete() for user_role entities.
281
 *
282
 * Removes deleted role from blocks that use it.
283 284
 */
function block_user_role_delete($role) {
285
  foreach (Block::loadMultiple() as $block) {
286 287 288 289 290
    /** @var $block \Drupal\block\BlockInterface */
    $visibility = $block->getVisibility();
    if (isset($visibility['user_role']['roles'][$role->id()])) {
      unset($visibility['user_role']['roles'][$role->id()]);
      $block->getPlugin()->setVisibilityConfig('user_role', $visibility['user_role']);
291
      $block->save();
292 293
    }
  }
294 295
}

296
/**
297
 * Implements hook_ENTITY_TYPE_delete() for menu entities.
298
 */
299 300
function block_menu_delete(Menu $menu) {
  if (!$menu->isSyncing()) {
301
    foreach (Block::loadMultiple() as $block) {
302 303 304
      if ($block->get('plugin') == 'system_menu_block:' . $menu->id()) {
        $block->delete();
      }
305 306
    }
  }
307 308
}

309
/**
310
 * Implements hook_ENTITY_TYPE_delete() for 'configurable_language'.
311 312 313
 *
 * Delete the potential block visibility settings of the deleted language.
 */
314
function block_configurable_language_delete(ConfigurableLanguage $language) {
315
  // Remove the block visibility settings for the deleted language.
316
  foreach (Block::loadMultiple() as $block) {
317 318
    /** @var $block \Drupal\block\BlockInterface */
    $visibility = $block->getVisibility();
319 320
    if (isset($visibility['language']['langcodes'][$language->id()])) {
      unset($visibility['language']['langcodes'][$language->id()]);
321
      $block->getPlugin()->setVisibilityConfig('language', $visibility['language']);
322
      $block->save();
323 324
    }
  }
325
}