Function __global->rename

Definitions

sources_custom/phpstub.php

  • Renames a file.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$oldname PATH No No required parameter N/A N/A Old name
$newname PATH No No required parameter N/A N/A New name
$context ?resource No No Null N/A N/A A stream context to attach to (null: no special context)

Returns

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

Preview

Code (PHP)

/**
 * Renames a file.
 *
 * @param  PATH $oldname Old name
 * @param  PATH $newname New name
 * @param  ?resource $context A stream context to attach to (null: no special context)
 * @return boolean Success status
 */
function rename(string $oldname, string $newname, $context = null) : bool