block.module

Version 1.435 (checked in on 2010/11/23 at 16:12:15 by webchick)

Controls the visual building blocks a page is constructed with.

Functions & methods

NameDescription
block_admin_pathsImplements hook_admin_paths().
block_block_configureImplements hook_block_configure().
block_block_infoImplements hook_block_info().
block_block_list_alterImplements hook_block_list_alter().
block_block_saveImplements hook_block_save().
block_block_viewImplements hook_block_view().
block_custom_block_formDefine the custom block form.
block_custom_block_getReturns information from database about a user-created (custom) block.
block_custom_block_saveSaves a user-created block in the database.
block_flush_cachesImplements hook_flush_caches().
block_form_system_performance_settings_alterImplements hook_form_FORM_ID_alter().
block_form_user_profile_form_alterImplements hook_form_FORM_ID_alter().
block_get_blocks_by_regionGet a renderable array of a region containing all enabled blocks.
block_helpImplements hook_help().
block_listReturn all blocks in the specified region for the current user.
block_loadLoad a block object from the database.
block_menuImplements hook_menu().
block_menu_deleteImplements hook_menu_delete().
block_modules_uninstalledImplements hook_modules_uninstalled().
block_page_buildImplements hook_page_build().
block_permissionImplements hook_permission().
block_themeImplements hook_theme().
block_themes_enabledInitialize blocks for enabled themes.
block_theme_initializeAssign an initial, default set of blocks for a theme.
block_user_presaveImplements hook_user_presave().
block_user_role_deleteImplements hook_user_role_delete().
template_preprocess_blockProcess variables for block.tpl.php
_block_custom_themeTheme callback for the block configuration pages.
_block_get_cache_idAssemble the cache_id to use for a given block.
_block_get_renderable_arrayGet an array of blocks suitable for drupal_render().
_block_load_blocksLoad blocks information from the database.
_block_rehashUpdate the 'block' DB table with the blocks currently exported by modules.
_block_render_blocksRender the content and subject for a set of blocks.
_block_themes_accessMenu item access callback - only admin or enabled themes can be accessed.

Constants

NameDescription
BLOCK_CUSTOM_DISABLEDHide this block by default but let individual users show it.
BLOCK_CUSTOM_ENABLEDShow this block by default, but let individual users hide it.
BLOCK_CUSTOM_FIXEDUsers cannot control whether or not they see this block.
BLOCK_REGION_NONEDenotes that a block is not enabled in any region and should not be shown.
BLOCK_VISIBILITY_LISTEDShow this block on only the listed pages.
BLOCK_VISIBILITY_NOTLISTEDShow this block on every page except the listed pages.
BLOCK_VISIBILITY_PHPShow this block if the associated PHP code returns TRUE.