function layout_suppress

1 layout.module layout_suppress($suppress = NULL)

Suppress the layout.

This function should be called from within another module's page callback when the layout should not be displayed, that is, content only. This can be useful for modules that implement popup pages or other special pages where the default layout would be distracting.

@since 1.21.0 Function added.

Parameters

bool $suppress: If set to TRUE, the layout will be suppressed.

Return value

bool: TRUE if the layout can be suppressed, FALSE otherwise.

1 call to layout_suppress()

layout_route_handler in core/modules/layout/layout.module: Route handler callback; Execute the current route item or wrap in a layout.

File

core/modules/layout/layout.module, line 661: The Layout module creates pages and wraps existing pages in layouts.

Code

function layout_suppress($suppress = NULL) {
  $suppression_static = &backdrop_static(__FUNCTION__, FALSE);

  if (isset($suppress)) {
    $suppression_static = $suppress;
  }

  return $suppression_static;
}