RenameFailureUnchecked

warning native off by default

Group: Probable bugs

Renaming a file can fail. Check the result before returning success from the publication operation. This inspection is disabled by default because the intended policy or use can vary.

Example

<?php
function bad($a,$b){rename($a,$b);return true;}

Reported:

• line 2: Check rename success before returning success.

Detection

• Resolved rename result is discarded immediately before containing function returns literal true. Restrict to proven success return rather than arbitrary success-named consumers; guarded/returned rename results excluded.
• Resolve builtin functions, classes, constants and methods; user-defined lookalikes are excluded. Follow only bounded local proof in one lexical scope.
• Emit one finding per violating operation, not per supporting evidence statement. When the proof is inconclusive, nothing is reported.

Exceptions (no report)

• Do not report unresolved or shadowed builtin names, unknown values, or incomplete receiver/type provenance. Unknown calls, aliases escaping, and intervening writes invalidate local proof. Similar code outside the stated detection contract is not a finding.
• Both standard suppression forms suppress this native ID.

Fix

None. Choosing a repair requires intent or additional runtime information.

PHP versions

Available throughout supported PHP 5.3–8.5 where the referenced builtin/extension is available. Respect syntax/version-specific receiver contracts; unavailable APIs are not this rule’s concern.

Configure

In custos.json:

{
  "rules": {
    "RenameFailureUnchecked": {
      "enabled": true
    }
  }
}

Suppress

Before the statement or declaration (or the first statement of the file):

// @custos-ignore RenameFailureUnchecked