108 lines
5.7 KiB
Plaintext
108 lines
5.7 KiB
Plaintext
<?php
|
|
|
|
/**
|
|
* @file
|
|
* Allows the creation of custom blocks through the user interface.
|
|
*/
|
|
|
|
use Drupal\Core\Routing\RouteMatchInterface;
|
|
use Drupal\field\Entity\FieldConfig;
|
|
use Drupal\field\Entity\FieldStorageConfig;
|
|
|
|
/**
|
|
* Implements hook_help().
|
|
*/
|
|
function block_content_help($route_name, RouteMatchInterface $route_match) {
|
|
switch ($route_name) {
|
|
case 'help.page.block_content':
|
|
$field_ui = \Drupal::moduleHandler()->moduleExists('field_ui') ? \Drupal::url('help.page', array('name' => 'field_ui')) : '#';
|
|
$output = '';
|
|
$output .= '<h3>' . t('About') . '</h3>';
|
|
$output .= '<p>' . t('The Custom Block module allows you to create custom <em>block types</em> and <em>content-containing blocks</em>, and provides a <a href=":block-library">Custom block library</a> listing all of them. Custom block types have fields; see the <a href=":field-help">Field module help</a> for more information. Once created, custom blocks can be placed in regions just like blocks provided by other modules; see the <a href=":blocks">Block module help page</a> for details. For more information, see the <a href=":online-help">online documentation for the Custom Block module</a>.', array(':block-library' => \Drupal::url('entity.block_content.collection'), ':block-content' => \Drupal::url('entity.block_content.collection'), ':field-help' => \Drupal::url('help.page', array('name' => 'field')), ':blocks' => \Drupal::url('help.page', array('name' => 'block')), ':online-help' => 'https://www.drupal.org/documentation/modules/block_content')) . '</p>';
|
|
$output .= '<h3>' . t('Uses') . '</h3>';
|
|
$output .= '<dl>';
|
|
$output .= '<dt>' . t('Creating and managing custom block types') . '</dt>';
|
|
$output .= '<dd>' . t('Users with the <em>Administer blocks</em> permission can create and edit custom block types with fields and display settings, from the <a href=":types">Custom block types</a> page in the Custom block library. For more information about managing fields and display settings, see the <a href=":field-ui">Field UI module help</a>.', array(':types' => \Drupal::url('entity.block_content_type.collection'), ':field-ui' => $field_ui)) . '</dd>';
|
|
$output .= '<dt>' . t('Creating custom blocks') . '</dt>';
|
|
$output .= '<dd>' . t('Users with the <em>Administer blocks</em> permission can create, edit, and delete custom blocks of each custom block type you have defined, from the <a href=":block-library">Custom block library</a> page. Custom blocks are shown in the <em>Place blocks</em> list on the <a href=":blocks">Block layout page</a>; see the <a href=":block_help">Block module help</a> for more information about placing blocks.', array(':blocks' => \Drupal::url('block.admin_display'), ':block-library' => \Drupal::url('entity.block_content.collection'), ':block_help' => \Drupal::url('help.page', array('name' => 'block')))) . '</dd>';
|
|
$output .= '</dl>';
|
|
return $output;
|
|
|
|
case 'entity.block_content.collection':
|
|
$output = '<p>' . t('Blocks in the block library belong to <a href=":types">block types</a>, each with its own fields and display settings. After creating a block, place it in a region from the <a href=":blocks">Block layout page</a>.', array(':types' => \Drupal::url('entity.block_content_type.collection'), ':blocks' => \Drupal::url('block.admin_display'))) . '</p>';
|
|
return $output;
|
|
|
|
case 'entity.block_content_type.collection':
|
|
$output = '<p>' . t('Each block type has its own fields and display settings. Create blocks of each type on the <a href=":block-library">Block library page</a>.', array(':block-library' => \Drupal::url('entity.block_content.collection'))) . '</p>';
|
|
return $output;
|
|
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_theme().
|
|
*/
|
|
function block_content_theme($existing, $type, $theme, $path) {
|
|
return array(
|
|
'block_content_add_list' => array(
|
|
'variables' => array('content' => NULL),
|
|
'file' => 'block_content.pages.inc',
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Implements hook_entity_type_alter().
|
|
*/
|
|
function block_content_entity_type_alter(array &$entity_types) {
|
|
/** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
|
|
// 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 = entity_create('field_config', array(
|
|
'field_storage' => FieldStorageConfig::loadByName('block_content', 'body'),
|
|
'bundle' => $block_type_id,
|
|
'label' => $label,
|
|
'settings' => array('display_summary' => FALSE),
|
|
));
|
|
$field->save();
|
|
|
|
// Assign widget settings for the 'default' form mode.
|
|
entity_get_form_display('block_content', $block_type_id, 'default')
|
|
->setComponent('body', array(
|
|
'type' => 'text_textarea_with_summary',
|
|
))
|
|
->save();
|
|
|
|
// Assign display settings for 'default' view mode.
|
|
entity_get_display('block_content', $block_type_id, 'default')
|
|
->setComponent('body', array(
|
|
'label' => 'hidden',
|
|
'type' => 'text_default',
|
|
))
|
|
->save();
|
|
}
|
|
|
|
return $field;
|
|
}
|