' . t('The Custom Block module allows you to create and manage custom block types and content-containing blocks from the Custom block library page. Custom block types have fields; see the Field module help for more information. Once created, custom blocks can be placed in regions just like blocks provided by other modules; see the Block module help page for details. For more information, see the online documentation for the Custom Block module.', [':block-library' => Url::fromRoute('entity.block_content.collection')->toString(), ':block-content' => Url::fromRoute('entity.block_content.collection')->toString(), ':field-help' => Url::fromRoute('help.page', ['name' => 'field'])->toString(), ':blocks' => Url::fromRoute('help.page', ['name' => 'block'])->toString(), ':online-help' => 'https://www.drupal.org/documentation/modules/block_content']) . '
'; $output .= '' . t('Blocks in the block library belong to Custom block types, each with its own fields and display settings. After creating a block, place it in a region from the Block layout page.', [':types' => Url::fromRoute('entity.block_content_type.collection')->toString(), ':blocks' => Url::fromRoute('block.admin_display')->toString()]) . '
'; return $output; case 'entity.block_content_type.collection': $output = '' . t('Each block type has its own fields and display settings. Create blocks of each type on the Blocks page in the custom block library.', [':block-library' => Url::fromRoute('entity.block_content.collection')->toString()]) . '
'; return $output; } } /** * Implements hook_theme(). */ function block_content_theme($existing, $type, $theme, $path) { return [ 'block_content_add_list' => [ 'variables' => ['content' => NULL], 'file' => 'block_content.pages.inc', ], ]; } /** * Implements hook_entity_type_alter(). */ function block_content_entity_type_alter(array &$entity_types) { /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */ // Add a translation handler for fields if the language module is enabled. if (\Drupal::moduleHandler()->moduleExists('language')) { $translation = $entity_types['block_content']->get('translation'); $translation['block_content'] = TRUE; $entity_types['block_content']->set('translation', $translation); } } /** * Adds the default body field to a custom block type. * * @param string $block_type_id * Id of the block type. * @param string $label * (optional) The label for the body instance. Defaults to 'Body' * * @return \Drupal\field\Entity\FieldConfig * A Body field object. */ function block_content_add_body_field($block_type_id, $label = 'Body') { // Add or remove the body field, as needed. $field = FieldConfig::loadByName('block_content', $block_type_id, 'body'); if (empty($field)) { $field = FieldConfig::create([ 'field_storage' => FieldStorageConfig::loadByName('block_content', 'body'), 'bundle' => $block_type_id, 'label' => $label, 'settings' => ['display_summary' => FALSE], ]); $field->save(); /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */ $display_repository = \Drupal::service('entity_display.repository'); // Assign widget settings for the default form mode. $display_repository->getFormDisplay('block_content', $block_type_id) ->setComponent('body', [ 'type' => 'text_textarea_with_summary', ]) ->save(); // Assign display settings for default view mode. $display_repository->getViewDisplay('block_content', $block_type_id) ->setComponent('body', [ 'label' => 'hidden', 'type' => 'text_default', ]) ->save(); } return $field; } /** * Implements hook_query_TAG_alter(). * * Alters any 'entity_reference' query where the entity type is * 'block_content' and the query has the tag 'block_content_access'. * * These queries should only return reusable blocks unless a condition on * 'reusable' is explicitly set. * * Block_content entities that are not reusable should by default not be * selectable as entity reference values. A module can still create an instance * of \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface * that will allow selection of non-reusable blocks by explicitly setting * a condition on the 'reusable' field. * * @see \Drupal\block_content\BlockContentAccessControlHandler */ function block_content_query_entity_reference_alter(AlterableInterface $query) { if ($query instanceof SelectInterface && $query->getMetaData('entity_type') === 'block_content' && $query->hasTag('block_content_access')) { $data_table = \Drupal::entityTypeManager()->getDefinition('block_content')->getDataTable(); if (array_key_exists($data_table, $query->getTables()) && !_block_content_has_reusable_condition($query->conditions(), $query->getTables())) { $query->condition("$data_table.reusable", TRUE); } } } /** * Utility function to find nested conditions using the reusable field. * * @todo Replace this function with a call to the API in * https://www.drupal.org/project/drupal/issues/2984930 * * @param array $condition * The condition or condition group to check. * @param array $tables * The tables from the related select query. * * @see \Drupal\Core\Database\Query\SelectInterface::getTables * * @return bool * Whether the conditions contain any condition using the reusable field. */ function _block_content_has_reusable_condition(array $condition, array $tables) { // If this is a condition group call this function recursively for each nested // condition until a condition is found that return TRUE. if (isset($condition['#conjunction'])) { foreach (array_filter($condition, 'is_array') as $nested_condition) { if (_block_content_has_reusable_condition($nested_condition, $tables)) { return TRUE; } } return FALSE; } if (isset($condition['field'])) { $field = $condition['field']; if (is_object($field) && $field instanceof ConditionInterface) { return _block_content_has_reusable_condition($field->conditions(), $tables); } $field_parts = explode('.', $field); $data_table = \Drupal::entityTypeManager()->getDefinition('block_content')->getDataTable(); foreach ($tables as $table) { if ($table['table'] === $data_table && $field_parts[0] === $table['alias'] && $field_parts[1] === 'reusable') { return TRUE; } } } return FALSE; }