How can I programmatically create a block type?

Question

I want to create a block type that has a couple of fields, a template and attached JavaScript.

I want that the user in my site will be able to create blocks of this type just like they create a custom block: through /block/add/myBlockType.

I would like ideally to have it all done programmatically but I dont mind manually creating my block type though "admin/structure/block/block-content/types" or with configuration files.

The thing is I have been scraping google for two days already and I don't manage to figure out how to programmatically create a block type

And this that the information is not easily found on Google makes me think that instead I need to create my type with configuration and then apply my plugin on creation of a new block but im still not sure how to do that and what my plugin needs to extend.

How can I do that?

Answer 1

I had the same issue and I hope I have resolved it.

Your algorithm is next:

1. Create your own module
2. Create file <your_module>.install
3. There must be at least one hook hook_install (I have used two: hook_install and hook_uninstall)
4. Inside install hook:
   • create a new block type
   • create fieldStorageConfig
   • create fieldConfig
   • set component for form and view display

My code:

<?php

use Drupal\block_content\Entity\BlockContentType;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;

function <your_module_name>_install() {
  $newBlockType = BlockContentType::create([
    'id' => <your_id>,
    'label' => 'Custom block type',
    'description' => "A custom block type",
  ]);
  $newBlockType->save();

  $blockId = $newBlockType->id();

  block_content_add_field($blockId, 'Icon', 'custom_block_icon', 'image', 'image', 'image_image');
  block_content_add_field($blockId, 'Count', 'custom_block_count', 'integer', 'number_integer', 'number');
  block_content_add_field($blockId, 'Description', 'custom_block_description', 'text', 'text_default', 'text_textfield');

}
function block_content_add_field(
  $blockTypeId,
  $label,
  $componentName,
  $fieldStorageType,
  $viewDisplayType = 'text_default',
  $formDisplayType = 'text_textarea_with_summary') {
    // Add or remove the body field, as needed.
    $field = FieldConfig::loadByName('block_content', $blockTypeId, $componentName);
    if (empty($field)) {
      $fieldStorage = FieldStorageConfig::loadByName('block_content', $componentName);
      if (empty($fieldStorage)) {
        $fieldStorage = FieldStorageConfig::create([
          'field_name' => $componentName,
          'entity_type' => 'block_content',
          'type' => $fieldStorageType,
        ]);
        $fieldStorage->save();
      }

      $field = FieldConfig::create([
        'field_storage' => $fieldStorage,
        'bundle' => $blockTypeId,
        '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', $blockTypeId)
        ->setComponent($componentName, [
          'type' => $formDisplayType,
        ])
        ->save();

      // Assign display settings for default view mode.
      $display_repository->getViewDisplay('block_content', $blockTypeId)
        ->setComponent($componentName, [
          'label' => 'hidden',
          'type' => $viewDisplayType,
        ])
        ->save();
    }

    return $field;
}

Result: the new custom block type with 3 fields.

Answer 2

You can create content block type using configuration files:
In you module should have config/install/block_content.type.YOUR_BLOCK_TYPE_MACHINE_NAME.yml see the following example from core for Basic block core/profiles/standard/config/install/block_content.type.basic.yml .

Here is an example to create new type called My Block Type

1. Go to admin/structure/block/block-content/types Create by clicking on Add custom block type

2. Create fields you want by Manage Fields

3. To export your configuration Go to admin/config/development/configuration/single/export And Create a config file in your Module and put in it the result: YOURMODULENAME/config/install/block_content.type.my_block_type.yml

4. And also you should export fields associated to your block type: the same way you did with block type config: Go to admin/config/development/configuration/single/export choose Field as configuration type and choose all Configuration name with name block_content.my_block_type.FIELD_NAME like the body field below and then the Field Storage configuration.

Or you can export configuration using Drupal console like the following:

drupal config:export:entity block_content my_block_type --module="YOURMODULENAME" --optional-config --remove-uuid --remove-config-hash --include-module-dependencies

Answer 3

An easier way to do this would be to:

1. Add block_content module as a dependency to your custom module
2. Create the configuration you want and export it, pay attention to the config files created for step 3 below.
3. Add the exported config to your module under your_module/config/install. You can use config_devel for that to make your life easier.
4. Enable your module.

This goes more towards the Drupal 7 Features, but it is quite easier to handle and to maintain.

The .info.yml file will have these lines in the end if you use config_devel:

dependecies:
  - block_content

config_devel:
  - block_content.type.html_block
  - language.content_settings.block_content.html_block
  - field.field.block_content.html_block.body
  - core.entity_view_display.block_content.html_block.default
  - core.entity_form_display.block_content.html_block.default

I had to add 5 files in my case (one field, with translations enabled).