Pattern Syntax: Block

Last updated on
30 April 2025

Valid properties

  • id - module and delta combined in the following format module-delta
  • theme
  • weight
  • region
  • status (0 - disable block, 1 - enable block)
  • title
  • description - alias for info
  • info (block description - only for custom blocks)
  • body (only for custom blocks)
  • format (input format - only for custom blocks)
  • custom (User specific visibility settings)
  • visibility (Page specific visibility settings)
  • pages (use [front] instead of <front> in XML)
  • roles (Role specific visibility settings)

Valid <visibility> values:

  • 0 (Show on every page except the listed pages.)
  • 1 ( Show on only the listed pages.)
  • 2 ( Show if the following PHP code returns TRUE)

Notes

"id" or "info" property is required for update and delete actions. If not provided new block will be created.

<region>-1</region> will also disable block

instead of ID, <module> and <delta> properties can be supplied as well

Module and delta properties for each block can be determined by looking at the path of the "Configure Block" form"
Examples:

 path: admin/build/block/configure/menu/devel

 module: menu
 delta: devel
 
 path: admin/build/block/configure/user/2

 module: user
 delta: 2
 

Help improve this page

Page status: Not set

You can: