Home › API reference

Definition

drupal_set_title($title = NULL, $output = CHECK_PLAIN)
drupal/includes/path.inc, line 215

Description

Set the title of the current page, for display 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.

Code

function drupal_set_title($title = NULL, $output = CHECK_PLAIN) {
  static $stored_title;

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

  return $stored_title;
}