function drupal_register_shutdown_function

Registers a function for execution on shutdown.

Wrapper for register_shutdown_function() that catches thrown exceptions to avoid "Exception thrown without a stack frame in Unknown".

Parameters

callable $callback: The shutdown function to register.

...: Additional arguments to pass to the shutdown function.

Return value

array Array of shutdown functions to be executed.

See also

register_shutdown_function()

Related topics

File

core/includes/bootstrap.inc, line 513

Functions that need to be loaded on every Drupal request.

Code

function &drupal_register_shutdown_function($callback = NULL) {

  // We cannot use drupal_static() here because the static cache is reset during
  // batch processing, which breaks batch handling.
  static $callbacks = [];
  if (isset($callback)) {

    // Only register the internal shutdown function once.
    if (empty($callbacks)) {
      register_shutdown_function('_drupal_shutdown_function');
    }
    $args = func_get_args();

    // Remove $callback from the arguments.
    unset($args[0]);

    // Save callback and arguments
    $callbacks[] = [
      'callback' => $callback,
      'arguments' => $args,
    ];
  }
  return $callbacks;
}