← Back to varTag.*

Error Identifier: varTag.differentVariable

Every error reported by PHPStan has an error identifier. Here’s a list of all error identifiers. In PHPStan Pro you can see the error identifier next to each error and filter errors by their identifiers.

Code example #

<?php declare(strict_types = 1);

function doFoo(): void
{
    /** @var int $foo */
    $test = someFunction();
}

Why is it reported? #

The variable name specified in the @var PHPDoc tag does not match the variable being assigned on the next line. In this example, the @var tag references $foo, but the actual assignment is to $test. This is almost always a copy-paste mistake or a typo.

PHPStan also reports this when the @var tag references a variable that does not match any variable in a foreach loop, static declaration, or global statement:

<?php declare(strict_types = 1);

function doBar(array $list): void
{
    /** @var int $foo */
    foreach ($list as $key => $val) {
        // $foo does not match $list, $key, or $val
    }
}

How to fix it #

Correct the variable name in the @var tag to match the actual variable:

 <?php declare(strict_types = 1);
 
 function doFoo(): void
 {
-    /** @var int $foo */
+    /** @var int $test */
     $test = someFunction();
 }

Or use a @var tag without a variable name when there is only one variable being assigned:

 <?php declare(strict_types = 1);
 
 function doFoo(): void
 {
-    /** @var int $foo */
+    /** @var int */
     $test = someFunction();
 }

How to ignore this error #

You can use the identifier varTag.differentVariable to ignore this error using a comment:

// @phpstan-ignore varTag.differentVariable
codeThatProducesTheError();

You can also use only the identifier key to ignore all errors of the same type in your configuration file in the ignoreErrors parameter:

parameters:
	ignoreErrors:
		-
			identifier: varTag.differentVariable

Rules that report this error #

• PHPStan\Rules\PhpDoc\WrongVariableNameInVarTagRule [1] [2] [3] [4]

Edit this page on GitHub