function drupal_set_title

drupal_set_title($title = NULL, $output = CHECK_PLAIN)

Sets the title of the current page.

The title is displayed on the page and in the title bar.

Parameters

$title: Optional string value to assign to the page title; or if set to NULL (default), leaves the current title unchanged.

$output: Optional flag - normally should be left as CHECK_PLAIN. Only set to PASS_THROUGH if you have already removed any possibly dangerous code from $title using a function like check_plain() or filter_xss(). With this flag the string will be passed through unchanged.

Return value

The updated title of the current page.

File

includes/bootstrap.inc, line 2138
Functions that need to be loaded on every Drupal request.

Code

function drupal_set_title($title = NULL, $output = CHECK_PLAIN) {
  $stored_title = &drupal_static(__FUNCTION__);

  if (isset($title)) {
    $stored_title = ($output == PASS_THROUGH) ? $title : check_plain($title);
  }

  return $stored_title;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!bootstrap.inc/function/drupal_set_title/7.x