Function Commandr_fs->remove_file

Definitions

sources/commandr_fs.php

  • Remove a file. Equivalent to Unix "rm".
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$to_remove array No No required parameter N/A N/A The file to remove

Returns

  • Success?
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Remove a file. Equivalent to Unix "rm".
 *
 * @param  array $to_remove The file to remove
 * @return boolean Success?
 */
public function remove_file(array $to_remove) : bool