function format_date

Formats a date, using a date type or a custom date format string.

Parameters

$timestamp: A UNIX timestamp to format.

$type: (optional) The format to use, one of:

  • One of the built-in formats: 'short', 'medium', 'long', 'html_datetime', 'html_date', 'html_time', 'html_yearless_date', 'html_week', 'html_month', 'html_year'.
  • The name of a date type defined by a module in hook_date_format_types(), if it's been assigned a format.
  • The machine name of an administrator-defined date format.
  • 'custom', to use $format.

Defaults to 'medium'.

$format: (optional) If $type is 'custom', a PHP date format string suitable for input to date(). Use a backslash to escape ordinary text, so it does not get interpreted as date format characters.

$timezone: (optional) Time zone identifier, as described at http://php.net/manual/timezones.php Defaults to the time zone used to display the page.

$langcode: (optional) Language code to translate to. Defaults to the language used to display the page.

Return value

A translated date string in the requested format.

See also

\Drupal\Component\Datetime\Date::format()

Related topics

Formatting
Functions to format numbers, strings, dates, etc.
68 calls to format_date()
CommentPreviewTest::testCommentEditPreviewSave in drupal/core/modules/comment/lib/Drupal/comment/Tests/CommentPreviewTest.php
Tests comment edit, preview, and save.
comment_admin_overview in drupal/core/modules/comment/comment.admin.inc
Form constructor for the comment overview administration form.
comment_tokens in drupal/core/modules/comment/comment.tokens.inc
Implements hook_tokens().
Date::buildOptionsForm in drupal/core/modules/views/lib/Drupal/views/Plugin/views/field/Date.php
Default options form that provides the label widget that all fields should have.
Date::render in drupal/core/modules/views/lib/Drupal/views/Plugin/views/field/Date.php
Render the field.

... See full list

File

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

Code

function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
  return Drupal::service('date')
    ->format($timestamp, $type, $format, $timezone, $langcode);
}