diff --git a/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php b/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php index 4619807c..b40808fe 100644 --- a/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php +++ b/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php @@ -218,9 +218,9 @@ public function process_token( $stackPtr ) { * Transform a wildcard pattern to a usable regex pattern. * * @param string $pattern Pattern. - * @return string + * @return string|null */ - private function test_patterns( $pattern ) { + private function test_patterns( $pattern ): ?string { $pattern = preg_quote( $pattern, '#' ); $pattern = preg_replace( [ '#\\\\\*#', '[\'"]' ], diff --git a/WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php b/WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php index 10381feb..26d11bc7 100644 --- a/WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php +++ b/WordPressVIPMinimum/Sniffs/Classes/DeclarationCompatibilitySniff.php @@ -392,7 +392,7 @@ public function process( File $phpcsFile, $stackPtr ) { * * @return void */ - private function addError( File $phpcsFile, $stackPtr, $currScope, $parentClassName, $methodName, $currentMethodSignature, $parentMethodSignature ) { + private function addError( File $phpcsFile, $stackPtr, $currScope, $parentClassName, $methodName, $currentMethodSignature, $parentMethodSignature ): void { $tokens = $phpcsFile->getTokens(); $currentClassName = '[AnonymousClass]'; if ( $tokens[ $currScope ]['code'] !== T_ANON_CLASS ) { @@ -417,7 +417,7 @@ private function addError( File $phpcsFile, $stackPtr, $currScope, $parentClassN * * @return array */ - private function generateParamList( $methodSignature ) { + private function generateParamList( $methodSignature ): array { $paramList = []; foreach ( $methodSignature as $param => $options ) { $paramName = '$'; diff --git a/WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php b/WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php index 01424cb7..680f7fb2 100644 --- a/WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php +++ b/WordPressVIPMinimum/Sniffs/Constants/RestrictedConstantsSniff.php @@ -173,7 +173,7 @@ public function process_token( $stackPtr ) { * * @return void */ - private function process_unreliable_constant( $stackPtr, $constantName ) { + private function process_unreliable_constant( $stackPtr, $constantName ): void { if ( $this->tokens[ $stackPtr ]['code'] === T_STRING ) { if ( ConstantsHelper::is_use_of_global_constant( $this->phpcsFile, $stackPtr ) === false ) { // Class constant, property, function name or something else which just shares the name. diff --git a/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php b/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php index ff89682e..e8490fce 100644 --- a/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php +++ b/WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php @@ -216,7 +216,7 @@ public function process_token( $stackPtr ) { * * @return bool True if the string partially matches a keyword in $allowedCustomKeywords, false otherwise. */ - private function has_custom_path( $content ) { + private function has_custom_path( $content ): bool { foreach ( $this->allowedKeywords as $keyword ) { if ( strpos( $content, $keyword ) !== false ) { return true; diff --git a/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php b/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php index 58a207c3..e0430d5e 100644 --- a/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php +++ b/WordPressVIPMinimum/Sniffs/Functions/CheckReturnValueSniff.php @@ -86,7 +86,7 @@ public function process_token( $stackPtr ) { * * @return bool */ - private function isFunctionCall( $stackPtr ) { + private function isFunctionCall( $stackPtr ): bool { if ( $this->tokens[ $stackPtr ]['code'] !== T_STRING ) { return false; @@ -106,7 +106,7 @@ private function isFunctionCall( $stackPtr ) { $previous = $this->phpcsFile->findPrevious( $search, $stackPtr - 1, null, true ); // It's a function definition, not a function call, so return false. - return ! ( $this->tokens[ $previous ]['code'] === T_FUNCTION ); + return $this->tokens[ $previous ]['code'] !== T_FUNCTION; } /** @@ -312,7 +312,7 @@ public function reduce_array( $carry, $item ) { * * @return void */ - private function addNonCheckedVariableError( $stackPtr, $variableName, $callee ) { + private function addNonCheckedVariableError( $stackPtr, $variableName, $callee ): void { $message = 'Type of `%s` must be checked before calling `%s()` using that variable.'; $data = [ $variableName, $callee ]; $this->phpcsFile->addError( $message, $stackPtr, 'NonCheckedVariable', $data ); diff --git a/WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php b/WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php index 3f19977a..d47dee6a 100644 --- a/WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php +++ b/WordPressVIPMinimum/Sniffs/Functions/DynamicCallsSniff.php @@ -103,7 +103,7 @@ public function process_token( $stackPtr ) { * * @return void */ - private function collect_variables( $stackPtr ) { + private function collect_variables( $stackPtr ): void { $current_var_name = $this->tokens[ $stackPtr ]['content']; @@ -169,7 +169,7 @@ private function collect_variables( $stackPtr ) { * * @return void */ - private function find_dynamic_calls( $stackPtr ) { + private function find_dynamic_calls( $stackPtr ): void { // No variables detected; no basis for doing anything. if ( empty( $this->variables_arr ) ) { return; diff --git a/WordPressVIPMinimum/Sniffs/Functions/StripTagsSniff.php b/WordPressVIPMinimum/Sniffs/Functions/StripTagsSniff.php index 5c1bb62b..99f49435 100644 --- a/WordPressVIPMinimum/Sniffs/Functions/StripTagsSniff.php +++ b/WordPressVIPMinimum/Sniffs/Functions/StripTagsSniff.php @@ -96,7 +96,7 @@ public function process_first_class_callable( $stackPtr, $group_name, $matched_c * * @return void */ - private function add_warning( $stackPtr, $error_code = 'Used' ) { + private function add_warning( $stackPtr, $error_code = 'Used' ): void { $message = '`strip_tags()` does not strip CSS and JS in between the script and style tags. Use `wp_strip_all_tags()` to strip all tags.'; $this->phpcsFile->addWarning( $message, $stackPtr, $error_code ); } diff --git a/WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php b/WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php index dea2730b..7b914971 100644 --- a/WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php +++ b/WordPressVIPMinimum/Sniffs/Hooks/AlwaysReturnInFilterSniff.php @@ -100,7 +100,7 @@ public function process_token( $stackPtr ) { * * @return void */ - private function processArray( $stackPtr ) { + private function processArray( $stackPtr ): void { $open_close = Arrays::getOpenClose( $this->phpcsFile, $stackPtr ); if ( $open_close === false ) { @@ -135,7 +135,7 @@ private function processArray( $stackPtr ) { * * @return void */ - private function processString( $stackPtr, $start = 0, $end = null ) { + private function processString( $stackPtr, $start = 0, $end = null ): void { $callbackFunctionName = TextStrings::stripQuotes( $this->tokens[ $stackPtr ]['content'] ); @@ -164,7 +164,7 @@ private function processString( $stackPtr, $start = 0, $end = null ) { * * @return void */ - private function processFunction( $stackPtr, $start = 0, $end = null ) { + private function processFunction( $stackPtr, $start = 0, $end = null ): void { $functionName = $this->tokens[ $stackPtr ]['content']; @@ -187,7 +187,7 @@ private function processFunction( $stackPtr, $start = 0, $end = null ) { * * @return void */ - private function processFunctionBody( $stackPtr ) { + private function processFunctionBody( $stackPtr ): void { $filterName = $this->tokens[ $this->filterNamePtr ]['content']; @@ -265,7 +265,7 @@ private function processFunctionBody( $stackPtr ) { * * @return bool */ - private function isInsideIfConditonal( $stackPtr ) { + private function isInsideIfConditonal( $stackPtr ): bool { // This check helps us in situations a class or a function is wrapped // inside a conditional as a whole. Eg.: inside `class_exists`. @@ -302,7 +302,7 @@ private function isInsideIfConditonal( $stackPtr ) { * * @return bool */ - private function hasTerminatingStatement( $scopeStart, $scopeEnd ) { + private function hasTerminatingStatement( $scopeStart, $scopeEnd ): bool { $terminatingPtr = $this->phpcsFile->findNext( [ T_EXIT, T_THROW ], @@ -320,7 +320,7 @@ private function hasTerminatingStatement( $scopeStart, $scopeEnd ) { * * @return bool **/ - private function isReturningVoid( $stackPtr ) { + private function isReturningVoid( $stackPtr ): bool { $nextToReturnTokenPtr = $this->phpcsFile->findNext( Tokens::$emptyTokens, diff --git a/WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php b/WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php index 3334fc4c..716889b9 100644 --- a/WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php +++ b/WordPressVIPMinimum/Sniffs/Hooks/PreGetPostsSniff.php @@ -96,7 +96,7 @@ public function process_token( $stackPtr ) { * * @return void */ - private function processArray( $stackPtr ) { + private function processArray( $stackPtr ): void { $open_close = Arrays::getOpenClose( $this->phpcsFile, $stackPtr ); if ( $open_close === false ) { @@ -120,7 +120,7 @@ private function processArray( $stackPtr ) { * * @return void */ - private function processString( $stackPtr ) { + private function processString( $stackPtr ): void { $callbackFunctionName = substr( $this->tokens[ $stackPtr ]['content'], 1, -1 ); @@ -147,7 +147,7 @@ private function processString( $stackPtr ) { * * @return void */ - private function processFunction( $stackPtr ) { + private function processFunction( $stackPtr ): void { $wpQueryObjectNamePtr = $this->phpcsFile->findNext( [ T_VARIABLE ], @@ -182,7 +182,7 @@ private function processFunction( $stackPtr ) { * * @return void */ - private function processClosure( $stackPtr ) { + private function processClosure( $stackPtr ): void { $wpQueryObjectNamePtr = $this->phpcsFile->findNext( [ T_VARIABLE ], @@ -209,7 +209,7 @@ private function processClosure( $stackPtr ) { * * @return void */ - private function processFunctionBody( $stackPtr, $variableName ) { + private function processFunctionBody( $stackPtr, $variableName ): void { $functionBodyScopeStart = $this->tokens[ $stackPtr ]['scope_opener']; $functionBodyScopeEnd = $this->tokens[ $stackPtr ]['scope_closer']; @@ -250,7 +250,7 @@ private function processFunctionBody( $stackPtr, $variableName ) { * * @return void */ - private function addPreGetPostsWarning( $stackPtr ) { + private function addPreGetPostsWarning( $stackPtr ): void { $message = 'Main WP_Query is being modified without `$query->is_main_query()` check. Needs manual inspection.'; $this->phpcsFile->addWarning( $message, $stackPtr, 'PreGetPosts' ); } @@ -262,7 +262,7 @@ private function addPreGetPostsWarning( $stackPtr ) { * * @return bool */ - private function isParentConditionalCheckingMainQuery( $stackPtr ) { + private function isParentConditionalCheckingMainQuery( $stackPtr ): bool { if ( array_key_exists( 'conditions', $this->tokens[ $stackPtr ] ) === false || is_array( $this->tokens[ $stackPtr ]['conditions'] ) === false @@ -312,7 +312,7 @@ private function isParentConditionalCheckingMainQuery( $stackPtr ) { * * @return bool */ - private function isEarlyMainQueryCheck( $stackPtr ) { + private function isEarlyMainQueryCheck( $stackPtr ): bool { if ( ! $this->isWPQueryMethodCall( $stackPtr, 'is_main_query' ) ) { return false; @@ -365,11 +365,7 @@ private function isEarlyMainQueryCheck( $stackPtr ) { true ); - if ( $next ) { - return true; - } - - return false; + return $next !== false; } /** @@ -380,7 +376,7 @@ private function isEarlyMainQueryCheck( $stackPtr ) { * * @return bool */ - private function isWPQueryMethodCall( $stackPtr, $method = null ) { + private function isWPQueryMethodCall( $stackPtr, $method = null ): bool { $next = $this->phpcsFile->findNext( Tokens::$emptyTokens, $stackPtr + 1, @@ -417,7 +413,7 @@ private function isWPQueryMethodCall( $stackPtr, $method = null ) { * * @return bool */ - private function isPartOfIfConditional( $stackPtr ) { + private function isPartOfIfConditional( $stackPtr ): bool { if ( array_key_exists( 'nested_parenthesis', $this->tokens[ $stackPtr ] ) === true && is_array( $this->tokens[ $stackPtr ]['nested_parenthesis'] ) === true @@ -448,7 +444,7 @@ private function isPartOfIfConditional( $stackPtr ) { * * @return bool */ - private function isInsideIfConditonal( $stackPtr ) { + private function isInsideIfConditonal( $stackPtr ): bool { if ( array_key_exists( 'conditions', $this->tokens[ $stackPtr ] ) === true && is_array( $this->tokens[ $stackPtr ]['conditions'] ) === true diff --git a/WordPressVIPMinimum/Sniffs/Hooks/RestrictedHooksSniff.php b/WordPressVIPMinimum/Sniffs/Hooks/RestrictedHooksSniff.php index c18a2903..ebf54bff 100644 --- a/WordPressVIPMinimum/Sniffs/Hooks/RestrictedHooksSniff.php +++ b/WordPressVIPMinimum/Sniffs/Hooks/RestrictedHooksSniff.php @@ -114,7 +114,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p * * @return string Normalized hook name or an empty string if the hook name could not be determined. */ - private function normalize_hook_name_from_parameter( $parameter ) { + private function normalize_hook_name_from_parameter( $parameter ): string { $allowed_tokens = Tokens::$emptyTokens; $allowed_tokens += [ T_STRING_CONCAT => T_STRING_CONCAT, diff --git a/WordPressVIPMinimum/Sniffs/JS/StringConcatSniff.php b/WordPressVIPMinimum/Sniffs/JS/StringConcatSniff.php index b3d317cb..f7d38484 100644 --- a/WordPressVIPMinimum/Sniffs/JS/StringConcatSniff.php +++ b/WordPressVIPMinimum/Sniffs/JS/StringConcatSniff.php @@ -71,7 +71,7 @@ public function process_token( $stackPtr ) { * * @return void */ - private function addFoundError( $stackPtr, array $data ) { + private function addFoundError( $stackPtr, array $data ): void { $message = 'HTML string concatenation detected, this is a security risk, use DOM node construction or a templating language instead: %s.'; $this->phpcsFile->addError( $message, $stackPtr, 'Found', $data ); } diff --git a/WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php b/WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php index 27cf4aa9..96bc24ca 100644 --- a/WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php +++ b/WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php @@ -128,7 +128,7 @@ public function process_first_class_callable( $stackPtr, $group_name, $matched_c * * @return void */ - private function add_contents_unknown_warning( $stackPtr, $data ) { + private function add_contents_unknown_warning( $stackPtr, $data ): void { $message = '`%s()` is highly discouraged for remote requests, please use `wpcom_vip_file_get_contents()` or `vip_safe_wp_remote_get()` instead. If it\'s for a local file please use WP_Filesystem instead.'; $this->phpcsFile->addWarning( $message, $stackPtr, 'FileGetContentsUnknown', $data ); } diff --git a/WordPressVIPMinimum/Sniffs/Security/StaticStrreplaceSniff.php b/WordPressVIPMinimum/Sniffs/Security/StaticStrreplaceSniff.php index 017c36a5..792b683c 100644 --- a/WordPressVIPMinimum/Sniffs/Security/StaticStrreplaceSniff.php +++ b/WordPressVIPMinimum/Sniffs/Security/StaticStrreplaceSniff.php @@ -82,7 +82,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p * * @return bool */ - private function is_parameter_static_text( $param_info ) { + private function is_parameter_static_text( $param_info ): bool { // List of tokens which can be skipped over without further examination. $static_tokens = [ T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING, diff --git a/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php b/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php index 198051d7..77fb0c82 100644 --- a/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php +++ b/WordPressVIPMinimum/Sniffs/UserExperience/AdminBarRemovalSniff.php @@ -398,7 +398,7 @@ protected function process_css_style( $stackPtr ) { * * @return void */ - private function addHidingDetectedError( $stackPtr ) { + private function addHidingDetectedError( $stackPtr ): void { $message = 'Hiding of the admin bar is not allowed.'; $this->phpcsFile->addError( $message, $stackPtr, 'HidingDetected' ); }