Function to list all the blocks

Question

I am searching for a function that list all the blocks that are enabled in a theme. Is there any function for this purpose?

Answer 1

The function block_admin_display_prepare_blocks() is the function used in the block module admin page for this purpose, but it's not part of the documented API, so you cannot absolutely rely on it. You would need code along the following lines:

module_load_include('inc', 'block', 'block.admin');
global $theme_key;
$blocks = block_admin_display_prepare_blocks($theme_key);
...

This will return all blocks, unlike block_list() which only returns those for the current user and for the current page.

Answer 2

You try with the following code.

global $theme;
$all_regions = system_region_list($theme);
$blocks = array();

foreach (array_keys($all_regions) as $region) {
   $blocks += block_list($region);
}

Answer 3

I used Alfred Armstrong's code to write a quick and dirty test function:

  function is_block_visible($block_name) {
    module_load_include('inc', 'block', 'block.admin');
    global $theme_key;
    $blocks = block_admin_display_prepare_blocks($theme_key);
    foreach ($blocks as $block) {
      if ($block['delta'] == $block_name && $block['region'] != -1) {
        sdpm("The block '" . $block['delta'] . "' is visible in the '" . $block['region'] . "' region.");
      }
    }
  }

What I would like to do, but can't get to give me anything but WSOD or a zero length array is to use the block_list() function which I understand returns a list of visible blocks on the current page for the current user. Any help to get that to work would be greatly appreciated. Nat