function hide

Hides an element from later rendering.

The first time render() or drupal_render() is called on an element tree, as each element in the tree is rendered, it is marked with a #printed flag and the rendered children of the element are cached. Subsequent calls to render() or drupal_render() will not traverse the child tree of this element again: they will just use the cached children. So if you want to hide an element, be sure to call hide() on the element before its parent tree is rendered for the first time, as it will have no effect on subsequent renderings of the parent tree.

Parameters

$element: The element to be hidden.

Return value

The element.

See also

render()

show()

9 calls to hide()
comment.tpl.php in drupal/core/modules/comment/templates/comment.tpl.php
Default theme implementation for comments.
comment.tpl.php in drupal/core/themes/bartik/templates/comment.tpl.php
Bartik's theme implementation for comments.
node.tpl.php in drupal/core/modules/node/templates/node.tpl.php
Default theme implementation to display a node.
node.tpl.php in drupal/core/themes/bartik/templates/node.tpl.php
Bartik's theme implementation to display a node.
Rss::render in drupal/core/modules/node/lib/Drupal/node/Plugin/views/row/Rss.php
Render a row object. This usually passes through to a theme template of some form, but not always.

... See full list

1 string reference to 'hide'
TwigFactory::get in drupal/core/lib/Drupal/Core/Template/TwigFactory.php
Returns a fully initialized Twig_Environment object.

File

drupal/core/includes/common.inc, line 5590
Common functions that many Drupal modules will need to reference.

Code

function hide(&$element) {
  $element['#printed'] = TRUE;
  return $element;
}