function hook_views_post_render in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/views/views.api.php \hook_views_post_render()

Post-process any rendered data.

This can be valuable to be able to cache a view and still have some level of dynamic output. In an ideal world, the actual output will include HTML comment-based tokens, and then the post process can replace those tokens. This hook can be used by themes.

Example usage. If it is known that the view is a node view and that the primary field will be a nid, you can do something like this:

  <!--post-FIELD-NID-->

And then in the post-render, create an array with the text that should go there:

  strtr($output, array('<!--post-FIELD-1-->' => 'output for FIELD of nid 1');

All of the cached result data will be available in $view->result, as well, so all ids used in the query should be discoverable.

Parameters

\Drupal\views\ViewExecutable $view: The view object about to be processed.

string $output: A flat string with the rendered output of the view.

\Drupal\views\Plugin\views\cache\CachePluginBase $cache: The cache settings.

See also

\Drupal\views\ViewExecutable

Related topics

4 functions implement hook_views_post_render()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

media_library_views_post_render in core/modules/media_library/media_library.module

Implements hook_views_post_render().

test_basetheme_views_post_render in core/modules/system/tests/themes/test_basetheme/test_basetheme.theme

Implements hook_views_post_render().

test_subtheme_views_post_render in core/modules/system/tests/themes/test_subtheme/test_subtheme.theme

Implements hook_views_post_render().

views_test_data_views_post_render in core/modules/views/tests/modules/views_test_data/views_test_data.views_execution.inc

Implements hook_views_post_render().

1 invocation of hook_views_post_render()

ViewExecutable::render in core/modules/views/src/ViewExecutable.php

Renders this view for a certain display.

File

core/modules/views/views.api.php, line 860

Describes hooks and plugins provided by the Views module.

Code

function hook_views_post_render(ViewExecutable $view, &$output, CachePluginBase $cache) {

  // When using full pager, disable any time-based caching if there are fewer
  // than 10 results.
  if ($view->pager instanceof Drupal\views\Plugin\views\pager\Full && $cache instanceof Drupal\views\Plugin\views\cache\Time && count($view->result) < 10) {
    $cache->options['results_lifespan'] = 0;
    $cache->options['output_lifespan'] = 0;
  }
}