Function __global->run_cleanup_tools

Definitions

sources/caches3.php

  • Run the specified software cleanup tools.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$cleanup_tools ?array No No Null N/A N/A The cleanup tools to run (null: all)

Returns

  • Any messages returned
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Run the specified software cleanup tools.
 *
 * @param  ?array $cleanup_tools The cleanup tools to run (null: all)
 * @return Tempcode Any messages returned
 */
function run_cleanup_tools(?array $cleanup_tools = null) : object