How do I programmatically set the view title?

Question

In D8, I have a need to dynamically set the title of a views page display.

I've tried implementing both hook_views_pre_render and hook_views_post_build and setting the value of $view->build_info['title'], but Drupal seems to be ignoring it when setting the page title.

It seems like the code in Views where the title is set is in Drupal\views\Plugin\views\display\Page::execute()

The #title property on the render array in that method IS receiving my overwritten value from one of my hooks, but it's still ignore and is using the manually specified title on the display config.

What is going on!?

Answer 1

If someone else is looking for an answer, this is how I achieved this. I implemented hook_views_pre_render() where I called ViewExecutable::setTitle(). This allowed me to set the page title.

function MYMODULE_views_pre_render(ViewExecutable $view) {
  if ($view->id() == 'ABC') {
    $view->setTitle('MY CUSTOM TITLE');
  }
}

Answer 2

If you want to change page title too you can use this snippet

\Drupal::routeMatch()->getRouteObject()->setDefault('_title', $title);

Hope this helps.

Answer 3

Setting only the _title property to set the page title tag was not enough in my case.

Overriding the title_callback property did the trick :-)

$title = 'something';
$route = \Drupal::routeMatch()->getCurrentRouteMatch()->getRouteObject();
$route->setDefault('_title_callback', function() use ($title) {
  return $title;
});

Answer 4

Implemented using hook_views_post_render(). In this example the contextual filter is just added to the title.

/**
 * Implements hook_views_post_render().
 */
function THEME_views_post_render(&$view) {
    /** @var \Drupal\views\ViewExecutable $view */
    if ($view->id() === 'events' && isset($view->args[0])) {
        // Get year from contextual argument of the view.
        $year = $view->args[0];

        // Prefix year to title.
        $title = (string) t('@year Events', ['@year' => $year]);

        // Set view and page titles.
        $view->setTitle($title);
        \Drupal::routeMatch()->getRouteObject()->setDefault(
            '_title',
            $title
        );
    }
}

Answer 5

Here is our solution to add markup to the view title:

function my_module_views_post_render(ViewExecutable $view, array &$output, CachePluginBase $cache) {
  $output['#post_render'][] = function ($content, array &$element) {
    $element['#title']['#markup'] = 'test - <em>My new Title</em>';
    return $content;
  };
}

Tested on Drupal 10.2.7.