← Back to staticMethod.*

Error Identifier: staticMethod.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 Logger
{
    public static function log(string $message): void
    {
        echo $message;
    }
}

$result = Logger::log('hello');

Why is it reported? #

The return value of a static method that returns void is being used. A void return type means the method does not return a meaningful value. Attempting to use this non-existent return value is a logic error – the variable will always contain null.

How to fix it #

Do not use the return value of a void method. Call it as a standalone statement instead:

 <?php declare(strict_types = 1);
 
-$result = Logger::log('hello');
+Logger::log('hello');

If a return value is needed, change the method to return a meaningful value:

 <?php declare(strict_types = 1);
 
 class Logger
 {
-    public static function log(string $message): void
+    public static function log(string $message): bool
     {
         echo $message;
+        return true;
     }
 }

 $result = Logger::log('hello');

How to ignore this error #

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

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