Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function dashboard_disable

Implements hook_disable().

Stash a list of blocks enabled on the dashboard, so they can be re-enabled if the dashboard is re-enabled. Then disable those blocks, since the dashboard regions will no longer be defined.

File

modules/dashboard/dashboard.install, line 15

Code

function dashboard_disable () {
 // Stash a list of currently enabled blocks.
 $stashed_blocks = array();
 $result = db_select ('block', 'b')->fields ('b', array(
 'module',
 'delta',
 'region',
 ))
 ->condition ('b.region', dashboard_regions (), 'IN')
 ->execute ();
 foreach ($result as $block) {
 $stashed_blocks[] = array(
 'module' => $block->module,
 'delta' => $block->delta,
 'region' => $block->region,
 );
 }
 variable_set ('dashboard_stashed_blocks', $stashed_blocks);
 // Disable the dashboard blocks.
 db_update ('block')->fields (array(
 'status' => 0,
 'region' => BLOCK_REGION_NONE ,
 ))
 ->condition ('region', dashboard_regions (), 'IN')
 ->execute ();
}

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