function block_list

Returns all blocks in the specified region for the current user.

@todo Now that the block table has a primary key, we should use that as the array key instead of MODULE_DELTA.

Parameters

$region: The name of a region.

Return value

An array of block objects, indexed with the module name and block delta concatenated with an underscore, thus: MODULE_DELTA. If you are displaying your blocks in one or two sidebars, you may check whether this array is empty to see how many columns are going to be displayed.

1 call to block_list()
block_get_blocks_by_region in modules/block/block.module
Gets a renderable array of a region containing all enabled blocks.
1 string reference to 'block_list'
block_page_build in modules/block/block.module
Implements hook_page_build().

File

modules/block/block.module, line 677

Code

function block_list($region) {
    $blocks =& drupal_static(__FUNCTION__);
    if (!isset($blocks)) {
        $blocks = _block_load_blocks();
    }
    // Create an empty array if there are no entries.
    if (!isset($blocks[$region])) {
        $blocks[$region] = array();
    }
    else {
        $blocks[$region] = _block_render_blocks($blocks[$region]);
    }
    return $blocks[$region];
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.