Document hook_block_access

It might be good to have a little better example here. Something like if the block is the user login block and the current user is not anonymous, disable access (silly condition since it already does this, but it would at least give something more tangible).

Please also take a look at the guidelines for documenting hooks:
http://drupal.org/node/1354#hooks

In particular, probably the first line should say "Define access for a block", and the second paragraph should say "This hook is invoked ..." rather than "It is called". It also needs an @return describing what to return and under what conditions.

Also... I definitely agree with #2 - the example should use the global $user I would think, and do something plausible rather than just returning FALSE.

Finally, there should only be one space between the @see and what follows it... and the second @see seems to point to a method that does not exist?

The Examples project is for giving examples of how to develop modules using various hooks. It is not a substitute for having good hook documentation, including a reasonably realistic example function body.

Anyway, this patch looks much better to me! At least, I thought it was understandable and follows our documentation guidelines. Thanks!

We need to get someone else who is familiar with the new block/plugin system to review the documentation for accuracy and function body to make sure it would do what it says it is doing. I have no idea.

+++ b/core/modules/block/block.api.phpundefined
@@ -99,5 +99,29 @@ function hook_block_view_NAME_alter(array &$build, \Drupal\block\BlockInterface
+ * @param \Drupal\block\BlockInterface $block
...
+function hook_block_access(\Drupal\block\BlockInterface $block) {

This should be \Drupal\block\Plugin\Core\Entity\Block $block, which we've done elsewhere. Ideally it'd be \Drupal\Core\Entity\EntityInterface, but we're not doing that anywhere else.

+++ b/core/modules/block/block.api.phpundefined
@@ -99,5 +99,29 @@ function hook_block_view_NAME_alter(array &$build, \Drupal\block\BlockInterface
+ * @return boolean

@return bool

+++ b/core/modules/block/block.api.phpundefined
@@ -99,5 +99,29 @@ function hook_block_view_NAME_alter(array &$build, \Drupal\block\BlockInterface
+  // Example code that would prevent displaying the 'Powered by drupal' block in

Powered by Drupal, capital D

+++ b/core/modules/block/block.api.phpundefined
@@ -99,5 +99,29 @@ function hook_block_view_NAME_alter(array &$build, \Drupal\block\BlockInterface
+  if ($block->get('plugin') == 'system_powered_by_block' && $block->get('region') <> 'footer') {

This is a fine example, except we use !=, not <>

Both of those things must have been docs we missed in the conversion, but this one is good.

Thanks for the new patch and the review! I'll get it committed shortly.

Please file separate issues for a) the other BlockInterface docs and b) @param boolean / @return boolean [I'm not sure if there are @param boolean instances in core but I imagine there are if there are @return boolean], if you haven't already.

Committed and pushed to 8.x. Thanks!