Same name and namespace in other branches
  1. 4.6.x includes/common.inc \format_interval()
  2. 5.x includes/common.inc \format_interval()
  3. 6.x includes/common.inc \format_interval()
  4. 7.x includes/common.inc \format_interval()

Format a time interval with the requested granularity.

Parameters

$timestamp: The length of the interval in seconds.

$granularity: How many different units to display in the string.

Return value

A translated string representation of the interval.

Related topics

13 calls to format_interval()
aggregator_view in modules/aggregator.module
statistics_top_pages in modules/statistics.module
Menu callback; presents the "top pages" page.
statistics_top_referrers in modules/statistics.module
Menu callback; presents the "referrer" page.
statistics_top_visitors in modules/statistics.module
Menu callback; presents the "top visitors" page.
system_cron_settings in modules/system.module
Return the cron status and errors for admin/settings.

... See full list

5 string references to 'format_interval'
aggregator_form_feed in modules/aggregator.module
Generate a form to add/edit feed sources.
aggregator_settings in modules/aggregator.module
Implementation of hook_settings().
poll_form in modules/poll.module
Implementation of hook_form().
statistics_settings in modules/statistics.module
Implementation of hook_settings().
system_view_general in modules/system.module

File

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

Code

function format_interval($timestamp, $granularity = 2) {
  $units = array(
    '1 year|%count years' => 31536000,
    '1 week|%count weeks' => 604800,
    '1 day|%count days' => 86400,
    '1 hour|%count hours' => 3600,
    '1 min|%count min' => 60,
    '1 sec|%count sec' => 1,
  );
  $output = '';
  foreach ($units as $key => $value) {
    $key = explode('|', $key);
    if ($timestamp >= $value) {
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
      $granularity--;
    }
    if ($granularity == 0) {
      break;
    }
  }
  return $output ? $output : t('0 sec');
}