function block_content_add_body_field

Adds the default body field to a block type.

Parameters

string $block_type_id: Id of the block type.

string $label: (optional) The label for the body instance. Defaults to 'Body'

Return value

\Drupal\field\Entity\FieldConfig A Body field object.

File

core/modules/block_content/block_content.module, line 83

Code

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,
                'allowed_formats' => [],
            ],
        ]);
        $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;
}