PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
File::getCondition() now accepts a 3rd argument that allows for the closest matching token to be returned
Generic.PHP.DisallowRequestSuperglobal to ban the use of the $_REQUEST superglobal
Generic.ControlStructures.InlineControlStructure no longer shows errors for while and for statements without a body
PSR12.ControlStructures.BooleanOperatorPlacement can now be configured to enforce a specific operator position
allowOnly property to first to enforce all boolean operators to be at the start of a lineallowOnly property to last to enforce all boolean operators to be at the end of a linePSR12.Files.ImportStatement now auto-fixes import statements by removing the leading slash
Squiz.ControlStructures.ForLoopDeclaration now has a setting to ignore newline characters
FALSE, so newlines are not allowed within for definitionsignoreNewlines setting in a ruleset.xml file to changeSquiz.PHP.InnerFunctions now handles multiple nested anon classes correctlyT_FN token has been made available for older versions
T_FN represents the fn string used for arrow functionsT_FN_ARROW token typefn will have a T_FN token for the function name, but have no scope information1_000 would tokenize as T_LNUMBER (1), T_STRING (_000)
T_LNUMBER (1_000)
File::getMethodParameters() now supports arrow functionsFile::getMethodProperties() now supports arrow functionsFixer::changeCodeBlockIndent() to change the indent of a code block while auto-fixing
Generic.Files.ExecutableFile sniff
Generic.CodeAnalysis.EmptyPhpStatement now reports unnecessary semicolons after control structure closing braces
Generic.PHP.LowerCaseKeyword now enforces that the fn keyword is lowercase
Generic.WhiteSpace.ScopeIndent now supports static arrow functionsPEAR.Functions.FunctionCallSignature now adjusts the indent of function argument contents during auto-fixing
PSR2.Methods.FunctionCallSignature
PSR2.ControlStructures.ControlStructureSpacing now checks whitespace before the closing parenthesis of multi-line control structures
PSR12.Functions.ReturnTypeDeclaration now checks the return type of arrow functions
PSR12.Traits.UseDeclaration now ensures all trait import statements are grouped together
Squiz.Functions.LowercaseFunctionKeywords now enforces that the fn keyword is lowercase
--report=diff and -vvv command line argumentsPEAR.Functions.FunctionCallSignature.FirstArgumentPosition
PSR2.Methods.FunctionCallSignature.FirstArgumentPosition
PSR12.ControlStructures.BooleanOperatorPlacement no longer complains when multiple expressions appear on the same line
PSR12.Files.FileHeader no longer ignores comments preceding a use, namespace, or declare statementPSR12.Files.FileHeader now allows a hashbang line at the top of the filePHP_CodeSniffer has included an in-progress PSR-12 standard since 3.3.0, but this release includes the completed standard. You can now check your code using the PSR-12 standard:
phpcs --standard=PSR12 /path/to/code
Most of the errors found can also be automatically fixed by PHPCBF:
phpcbf --standard=PSR12 /path/to/code
T_NULLABLE inside property types, as it is elsewhereFile::getMemberProperties() method, which now contains a type array index
?
type_token array indextype_end_token array indexnullable_type array index will also be set to TRUE
--filter=gitstaged to check these filesphpcs.xsd schema now validates phpcs-only and phpcbf-only attributes correctly
File class now throw RuntimeException instead of TokenizerException
RuntimeExpection but now correctly throw TokenizerException
File::getMethodParameters() method now returns more information, and supports closure USE groups
type_hint_end_token array indexdefault_token array indexdefault_equal_token array indexcomma_token array indexreference_token array indexvariadic_token array indexT_LIST token and it's opening and closing parentheses now contain references to each other in the tokens array
T_ANON_CLASS token and it's opening and closing parentheses now contain references to each other in the tokens array
T_BAD_CHARACTER token has been made available for older versions
Squiz.WhiteSpace.FunctionSpacing
info report to see blank lines before/after functionsSquiz.WhiteSpace.MemberVarSpacing
info report to see blank lines before member varsGeneric.ControlStructures.DisallowYodaConditions sniff
Generic.PHP.RequireStrictTypes sniff
Generic.WhiteSpace.SpreadOperatorSpacingAfter sniff
PSR12.Classes.AnonClassDeclaration sniff
PSR12.Classes.ClosingBrace sniff
PSR12.ControlStructures.BooleanOperatorPlacement sniff
PSR12.ControlStructures.ControlStructureSpacing sniff
PSR12.Files.DeclareStatement sniff
PSR12.Files.FileHeader sniff
PSR12.Files.ImportStatement sniff
PSR12.Files.OpenTag sniff
PSR12.Functions.ReturnTypeDeclaration sniff
PSR12.Properties.ConstantVisibility sniff
PSR12.Traits.UseDeclaration sniff
Generic.Files.LineLength ignoreComments property now ignores comments at the end of a line
Generic.Files.LineLength now only ignores unwrappable comments when the comment is on a line by itself
Generic.Functions.FunctionCallArgumentSpacing no longer checks spacing around assignment operators inside function calls
Squiz.WhiteSpace.OperatorSpacing sniff to enforce spacing around assignment operators
Generic.Functions.FunctionCallArgumentSpacing.NoSpaceBeforeEquals error has been removed
Squiz.WhiteSpace.OperatorSpacing.NoSpaceBefore insteadGeneric.Functions.FunctionCallArgumentSpacing.NoSpaceAfterEquals error has been removed
Squiz.WhiteSpace.OperatorSpacing.NoSpaceAfter insteadGeneric.WhiteSpace.ScopeIndent no longer performs exact indents checking for chained method calls
PEAR.WhiteSpace.ObjectOperatorIndent now supports multi-level chained statements
multilevel setting to TRUE in a ruleset.xml file to enable this behaviourPSR2.ControlStructures.ControlStructureSpacing now allows whitespace after the opening parenthesis if followed by a comment
PSR2.Classes.PropertyDeclaration now enforces a single space after a property type keyword
Squiz.Commenting.BlockComment no longer requires blank line before comment if it's the first content after the PHP open tag
Squiz.Functions.FunctionDeclarationArgumentSpacing now has more accurate error messages
SpaceAfterDefault error code to SpaceAfterEquals, which reflects the real errorSquiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a reference operator
SpacingAfterReference error message in a ruleset.xml fileSquiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a variadic operator
SpacingAfterVariadic error message in a ruleset.xml fileSquiz.Functions.MultiLineFunctionDeclaration now has improved fixing for the FirstParamSpacing and UseFirstParamSpacing errorsSquiz.Operators.IncrementDecrementUsage now suggests pre-increment of variables instead of post-increment
Squiz.PHP.DisallowMultipleAssignments now has a second error code for when assignments are found inside control structure conditions
Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure
Squiz.PHP.DisallowMultipleAssignments.Found
Squiz.WhiteSpace.FunctionSpacing now applies beforeFirst and afterLast spacing rules to nested functions
Squiz.WhiteSpace.OperatorSpacing now has improved handling of parse errors
Squiz.WhiteSpace.OperatorSpacing now checks spacing around the instanceof operator
Squiz.WhiteSpace.OperatorSpacing can now enforce a single space before assignment operators
ignoreSpacingBeforeAssignments sniff property to FALSE to enable checkingTRUE, so spacing before assignments is not checked by defaultSquiz.Arrays.ArrayDeclaration now has improved handling of syntax errorsThe PEAR installable version of PHPCS was missing some files, which have been re-included in this release. The result of these omissions were:
code report was not previously available for PEAR installsGeneric.Formatting.SpaceBeforeCast sniff was not previously available for PEAR installsGeneric.WhiteSpace.LanguageConstructSpacing sniff was not previously available for PEAR installsThanks to Juliette Reinders Folmer for the patch
T_PHPCS_SET tokens now contain sniffCode, sniffProperty, and sniffPropertyValue indexes
Generic.Commenting.DocComment error messages now contain the name of the comment tag that caused the error
Generic.ControlStructures.InlineControlStructure now handles syntax errors correctly
Generic.Debug.JSHint now longer requires rhino and can be run directly from the npm install
Generic.Files.LineEndings no longer adds superfluous new line at the end of JS and CSS files
Generic.Formatting.DisallowMultipleStatements no longer tries fix lines containing phpcs:ignore statements
Generic.Functions.FunctionCallArgumentSpacing now has improved performance and anonymous class support
Generic.WhiteSpace.ScopeIndent now respects changes to the exact property using phpcs:set mid-way through a file
exact rule for only some parts of a fileGeneric.WhiteSpace.ScopeIndent now disables exact indent checking inside all arrays
PEAR.Classes.ClassDeclaration now has improved handling of PHPCS annotations and tab indentsPSR12.Classes.ClassInstantiation has changed it's error code from MissingParenthesis to MissingParentheses
PSR12.Keywords.ShortFormTypeKeywords now ignores all spacing inside type casts during both checking and fixing
Squiz.Classes.LowercaseClassKeywords now examines the class keyword for anonymous classes
Squiz.ControlStructures.ControlSignature now has improved handling of parse errors
Squiz.Commenting.PostStatementComment fixer no longer adds a blank line at the start of a JS file that begins with a comment
Squiz.WhiteSpace.SuperfluousWhitespace sniffSquiz.Commenting.PostStatementComment now ignores comments inside control structure conditions, such as FOR loops
Squiz.ControlStructures.ForLoopDeclaration sniffSquiz.Commenting.FunctionCommentThrowTag now has improved support for unknown exception types and namespaces
Squiz.ControlStructures.ForLoopDeclaration has improved whitespace, closure, and empty expression support
SpacingAfterSecondNoThird error code has been removed as part of these fixesSquiz.CSS.ClassDefinitionOpeningBraceSpace now handles comments and indentation correctly
Squiz.CSS.ClassDefinitionClosingBrace now handles comments, indentation, and multiple statements on the same line correctly
Squiz.CSS.Opacity now handles comments correctly
Squiz.CSS.SemicolonSpacing now handles comments and syntax errors correctly
Squiz.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly
Squiz.PHP.LowercasePHPFunctions now handles use statements, namespaces, and comments correctly
Squiz.WhiteSpace.FunctionSpacing now fixes function spacing correctly when a function is the first content in a file
Squiz.WhiteSpace.SuperfluousWhitespace no longer throws errors for spacing between functions and properties in anon classes
Zend.Files.ClosingTag no longer adds a semi-colon during fixing of a file that only contains a comment
Zend.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly
The Generic.Formatting.NoSpaceAfterCast sniff has been deprecated and will be removed in version 4.
The functionality of this sniff is now available in the Generic.Formatting.SpaceAfterCast sniff. Include the Generic.Formatting.SpaceAfterCast sniff and set the spacing property to 0 to retain the existing functionality. As soon as possible, replace all instances of the old sniff code with the new sniff code and property setting in your ruleset.xml files. The existing sniff will continue to work until version 4 has been released.
T_BITWISE_NOT added for the bitwise not operator
T_NONE
T_NONE tokens with a tilde as the contents must now also look for T_BITWISE_NOT
T_NONE as well as T_BITWISE_NOT to support older PHP_CodeSniffer versionsT_BINARY_CAST
b in b"some string with $var" would be a T_BINARY_CAST, but only when the string contained a varb is always tokenized as T_BINARY_CAST
(binary) from T_STRING_CAST to T_BINARY_CAST
extend="true" to the property tag
<property name="forbiddenFunctionNames" type="array" extend="true">
$XDG_CACHE_HOME is set and points to a valid directory, it will be used for caching instead of the system temp directoryFile:: getMethodProperties() method now includes a has_body array index in the return value
File::getTokensAsString() method now throws an exception if the $start param is invalid
$length param is invalid, an empty string will be returnedGeneric.CodeAnalysis.EmptyPHPStatement sniff
Generic.Formatting.SpaceBeforeCast sniff
Generic.VersionControl.GitMergeConflict sniff
Generic.WhiteSpace.IncrementDecrementSpacing sniff
PSR12.Functions.NullableTypeDeclaration sniff
Generic.NamingConventions.CamelCapsFunctionName
PEAR.NamingConventions.ValidFunctionName
PSR1.Methods.CamelCapsMethodName
PSR2.Methods.MethodDeclaration
Squiz.Scope.MethodScope
Squiz.Scope.StaticThisUsage
Generic.CodeAnalysis.UnusedFunctionParameter now only skips functions with empty bodies when the class implements an interface
Generic.CodeAnalysis.UnusedFunctionParameter now has additional error codes to indicate where unused params were found
FoundInExtendedClass: when the class extends anotherFoundInImplementedInterface: when the class implements an interfaceFound: used in all other cases, including closuresBeforeLastUsed: the unused param was positioned before the last used param in the function signatureAfterLastUsed: the unused param was positioned after the last used param in the function signatureFound
FoundBeforeLastUsed
FoundAfterLastUsed
FoundInExtendedClass
FoundInExtendedClassBeforeLastUsed
FoundInExtendedClassAfterLastUsed
FoundInImplementedInterface
FoundInImplementedInterfaceBeforeLastUsed
FoundInImplementedInterfaceAfterLastUsed
Generic.Classes.DuplicateClassName now inspects traits for duplicate names as well as classes and interfaces
Generic.Files.InlineHTML now ignores a BOM at the start of the file
Generic.PHP.CharacterBeforePHPOpeningTag now ignores a BOM at the start of the file
Generic.Formatting.SpaceAfterCast now has a setting to specify how many spaces are required after a type cast
spacing setting in a ruleset.xml file to changeGeneric.Formatting.SpaceAfterCast now has a setting to ignore newline characters after a type cast
ignoreNewlines setting in a ruleset.xml file to changeGeneric.Formatting.SpaceAfterNot now has a setting to specify how many spaces are required after a NOT operator
spacing setting in a ruleset.xml file to changeGeneric.Formatting.SpaceAfterNot now has a setting to ignore newline characters after the NOT operator
ignoreNewlines setting in a ruleset.xml file to changePEAR.Functions.FunctionDeclaration now checks spacing before the opening parenthesis of functions with no body
PEAR.Functions.FunctionDeclaration now enforces no space before the semicolon in functions with no body
PSR2.Classes.PropertyDeclaration now checks the order of property modifier keywords
PSR2.Methods.MethodDeclaration now checks method declarations inside traits
Squiz.Commenting.InlineComment now has better detection of comment block boundariesSquiz.Classes.ClassFileName now checks that a trait name matches the filename
Squiz.Classes.SelfMemberReference now supports scoped declarations and anonymous classes
Squiz.Classes.SelfMemberReference now fixes multiple errors at once, increasing fixer performance
Squiz.Functions.LowercaseFunctionKeywords now checks abstract and final prefixes, and auto-fixes errors
Squiz.Objects.ObjectMemberComma.Missing has been renamed to Squiz.Objects.ObjectMemberComma.Found
Squiz.WhiteSpace.ObjectOperatorSpacing is now more tolerant of parse errorsSquiz.WhiteSpace.ObjectOperatorSpacing now fixes errors more efficiently
Version 2.9.2 will be the final release of the PHP_CodeSniffer 2.9 branch, first released over 4 years ago. All developers still using version 2 are strongly encouraged to migrate to version 3.
Version 3 was first released as stable on the 4th of May 2017 and is a large refactoring of the code base that breaks backwards compatibility for all custom sniffs and custom reports. An upgrade guide for sniff and report developers is available here: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Version-3.0-Upgrade-Guide
Note: If you only use the built-in coding standards (such as PEAR or PSR2), or you have a custom ruleset.xml file that only makes use of the sniffs and reports distributed with PHP_CodeSniffer, you do not need to make any changes to begin using PHP_CodeSniffer version 3.
--report=info) now has improved formatting for metrics that span multiple lines
.bak files when looking for test cases
Generic.PHP.NoSilencedErrors error messages now contain a code snippet to show the context of the error
Squiz.Arrays.ArrayDeclaration no longer reports errors for a comma on a line new after a here/nowdoc
SpaceBeforeComma error message has been changed to only have one data value instead of twoSquiz.Commenting.FunctionComment no longer errors when trying to fix indents of multi-line param commentsSquiz.Formatting.OperatorBracket now correctly fixes statements that contain stringsSquiz.PHP.CommentedOutCode now ignores more @-style annotations and includes better comment block detection