block.module
Version
1.347 (checked in on 2009/07/01 at 08:04:19 by dries)
Description
Controls the boxes that are displayed around the main content.
Constants
Name | Description |
|---|---|
| BLOCK_CACHE_GLOBAL | The block is the same for every user on every page where it is visible. |
| BLOCK_CACHE_PER_PAGE | The block can change depending on the page being viewed. |
| BLOCK_CACHE_PER_ROLE | The block can change depending on the roles the user viewing the page belongs to. This is the default setting, used when the block does not specify anything. |
| BLOCK_CACHE_PER_USER | The block can change depending on the user viewing the page. This setting can be resource-consuming for sites with large number of users, and thus should only be used when BLOCK_CACHE_PER_ROLE is not sufficient. |
| BLOCK_NO_CACHE | The block should not get cached. This setting should be used: for simple blocks (notably those that do not perform any db query), where querying the db cache would be more expensive than directly generating the content. for blocks that change too... |
| BLOCK_REGION_NONE | Denotes that a block is not enabled in any region and should not be shown. |
Functions
| Name | Description |
|---|---|
| block_block_configure | Implement hook_block_configure(). |
| block_block_list | Implement hook_block_list(). |
| block_block_list_alter | Implement hook_block_list_alter(). |
| block_block_save | Implement hook_block_save(). |
| block_block_view | Implement hook_block_view(). |
| block_box_form | Define the custom block form. |
| block_box_get | |
| block_box_save | |
| block_flush_caches | Implement hook_flush_caches(). |
| block_form_system_performance_settings_alter | Implement hook_form_FORM_ID_alter(). |
| block_form_system_themes_form_alter | Implement hook_form_FORM_ID_alter(). |
| block_get_blocks_by_region | Get a renderable array of a region containing all enabled blocks. |
| block_help | Implement hook_help(). |
| block_initialize_theme_blocks | Assign an initial, default set of blocks for a theme. |
| block_list | Return all blocks in the specified region for the current user. |
| block_menu | Implement hook_menu(). |
| block_page_alter | Implement hook_page_alter(). |
| block_perm | Implement hook_perm(). |
| block_system_themes_form_submit | Initialize blocks for enabled themes. |
| block_theme | Implement hook_theme(). |
| block_user_form | Implement hook_user_form(). |
| block_user_validate | Implement hook_user_validate(). |
| template_preprocess_block | Process variables for block.tpl.php |
| _block_get_cache_id | Assemble the cache_id to use for a given block. |
| _block_load_blocks | Load blocks information from the database. |
| _block_rehash | Update the 'block' DB table with the blocks currently exported by modules. |
| _block_render_blocks | Render the content and subject for a set of blocks. |
| _block_themes_access | Menu item access callback - only admin or enabled themes can be accessed. |