← Back to method.*

Error Identifier: method.void

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);

class Foo
{
	public function doFoo(): void
	{
	}
}

$foo = new Foo();
$result = $foo->doFoo();

Why is it reported? #

The return value of a method that returns void is being used. A void return type indicates that the method does not return a meaningful value. Using the result of such a call is a logic error because the value is always null.

How to fix it #

Do not use the return value of a void method:

 <?php declare(strict_types = 1);
 
 $foo = new Foo();
-$result = $foo->doFoo();
+$foo->doFoo();

If you need the method to return a value, change its return type.

How to ignore this error #

You can use the identifier method.void to ignore this error using a comment:

// @phpstan-ignore method.void
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: method.void

Rules that report this error #

• PHPStan\Rules\Classes\ClassAttributesRule [1]
• PHPStan\Rules\Classes\ClassConstantAttributesRule [1]
• PHPStan\Rules\Classes\InstantiationRule [1]
• PHPStan\Rules\Constants\ConstantAttributesRule [1]
• PHPStan\Rules\EnumCases\EnumCaseAttributesRule [1]
• PHPStan\Rules\Functions\ArrowFunctionAttributesRule [1]
• PHPStan\Rules\Functions\CallCallablesRule [1]
• PHPStan\Rules\Functions\CallToFunctionParametersRule [1]
• PHPStan\Rules\Functions\CallUserFuncRule [1]
• PHPStan\Rules\Functions\ClosureAttributesRule [1]
• PHPStan\Rules\Functions\FunctionAttributesRule [1]
• PHPStan\Rules\Functions\ParamAttributesRule [1]
• PHPStan\Rules\Methods\CallMethodsRule [1]
• PHPStan\Rules\Methods\CallStaticMethodsRule [1]
• PHPStan\Rules\Methods\MethodAttributesRule [1]
• PHPStan\Rules\Properties\PropertyAttributesRule [1]
• PHPStan\Rules\Properties\PropertyHookAttributesRule [1]
• PHPStan\Rules\Traits\TraitAttributesRule [1]

Edit this page on GitHub