You are here

function format_size in Drupal 6

Same name and namespace in other branches
  1. 8 core/includes/common.inc \format_size()
  2. 4 includes/common.inc \format_size()
  3. 5 includes/common.inc \format_size()
  4. 7 includes/common.inc \format_size()
  5. 9 core/includes/common.inc \format_size()

Generate a string representation for the given byte count.

Parameters

$size: A size in bytes.

$langcode: Optional language code to translate to a language other than what is used to display the page.

Return value

A translated string representation of the size.

Related topics

9 calls to format_size()
blogapi_admin_settings in modules/blogapi/blogapi.module
blogapi_metaweblog_new_media_object in modules/blogapi/blogapi.module
Blogging API callback. Inserts a file into Drupal.
color_scheme_form_submit in modules/color/color.module
Submit handler for color change form.
file_save_upload in includes/file.inc
Saves a file upload to a new location.
file_validate_size in includes/file.inc
Check that the file's size is below certain limits. This check is not enforced for the user #1.

... See full list

File

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

Code

function format_size($size, $langcode = NULL) {
  if ($size < 1024) {
    return format_plural($size, '1 byte', '@count bytes', array(), $langcode);
  }
  else {
    $size = round($size / 1024, 2);
    $suffix = t('KB', array(), $langcode);
    if ($size >= 1024) {
      $size = round($size / 1024, 2);
      $suffix = t('MB', array(), $langcode);
    }
    return t('@size @suffix', array(
      '@size' => $size,
      '@suffix' => $suffix,
    ), $langcode);
  }
}