You are here

Home » API reference » Drupal 9

layout_builder.api.php in Drupal 9

Same filename and directory in other branches
  1. 8 core/modules/layout_builder/layout_builder.api.php
  2. 10 core/modules/layout_builder/layout_builder.api.php

Hooks provided by the Layout Builder module.

File

core/modules/layout_builder/layout_builder.api.php
View source 
<?php

/**
 * @file
 * Hooks provided by the Layout Builder module.
 */

/**
 * @defgroup layout_builder_access Layout Builder access
 * @{
 * In determining access rights for the Layout Builder UI,
 * \Drupal\layout_builder\Access\LayoutBuilderAccessCheck checks if the
 * specified section storage plugin (an implementation of
 * \Drupal\layout_builder\SectionStorageInterface) grants access.
 *
 * By default, the Layout Builder access check requires the 'configure any
 * layout' permission. Individual section storage plugins may override this by
 * setting the 'handles_permission_check' annotation key to TRUE. Any section
 * storage plugin that uses 'handles_permission_check' must provide its own
 * complete routing access checking to avoid any access bypasses.
 *
 * This access checking is only enforced on the routing level (not on the entity
 * or field level) with additional form access restrictions. All HTTP API access
 * to Layout Builder data is currently forbidden.
 *
 * @see https://www.drupal.org/project/drupal/issues/2942975
 */

/**
 * @} End of "defgroup layout_builder_access".
 */