7.x bootstrap.inc drupal_check_memory_limit($required, $memory_limit = NULL)

Compares the memory required for an operation to the available memory.

Parameters

$required: The memory required for the operation, expressed as a number of bytes with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8bytes, 9mbytes).

$memory_limit: (optional) The memory limit for the operation, expressed as a number of bytes with optional SI or IEC binary unit prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8bytes, 9mbytes). If no value is passed, the current PHP memory_limit will be used. Defaults to NULL.

Return value

TRUE if there is sufficient memory to allow the operation, or FALSE otherwise.

1 call to drupal_check_memory_limit()
BootstrapMiscTestCase::testCheckMemoryLimit in modules/simpletest/tests/bootstrap.test
Tests that the drupal_check_memory_limit() function works as expected.

File

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

Code

function drupal_check_memory_limit($required, $memory_limit = NULL) {
  if (!isset($memory_limit)) {
    $memory_limit = ini_get('memory_limit');
  }

  // There is sufficient memory if:
  // - No memory limit is set.
  // - The memory limit is set to unlimited (-1).
  // - The memory limit is greater than the memory required for the operation.
  return !$memory_limit || $memory_limit == -1 || parse_size($memory_limit) >= parse_size($required);
}