layout_builder.api.php 1.1 KB

12345678910111213141516171819202122232425262728293031
  1. <?php
  2. /**
  3. * @file
  4. * Hooks provided by the Layout Builder module.
  5. */
  6. /**
  7. * @defgroup layout_builder_access Layout Builder access
  8. * @{
  9. * In determining access rights for the Layout Builder UI,
  10. * \Drupal\layout_builder\Access\LayoutBuilderAccessCheck checks if the
  11. * specified section storage plugin (an implementation of
  12. * \Drupal\layout_builder\SectionStorageInterface) grants access.
  13. *
  14. * By default, the Layout Builder access check requires the 'configure any
  15. * layout' permission. Individual section storage plugins may override this by
  16. * setting the 'handles_permission_check' annotation key to TRUE. Any section
  17. * storage plugin that uses 'handles_permission_check' must provide its own
  18. * complete routing access checking to avoid any access bypasses.
  19. *
  20. * This access checking is only enforced on the routing level (not on the entity
  21. * or field level) with additional form access restrictions. All HTTP API access
  22. * to Layout Builder data is currently forbidden.
  23. *
  24. * @see https://www.drupal.org/project/drupal/issues/2942975
  25. */
  26. /**
  27. * @} End of "defgroup layout_builder_access".
  28. */