Move several extensions to WP stubs (#235)

* remove get_posts extension

* remove get_approved_comments extension

* remove get_sites extension

* remove get_terms extension

* ignore phpcs warning about mkdir

* sync with master

* remove get_post extension

* add error identifiers

* add see tags

* remove unnecessary in_array()

* sort use statements

* use ::class

* register HookDocBlock as service

* Upgrade ruleset (#230)

* fix

* fix cs

* update CI

* fix/update extension for wp_parse_url

* rename variables with reserved names

* remove else statement

* fix TravisCI badge

* raise phpstan constraint

* remove echo key extension

* remove obsolete redirect_canonical extension

* remove wp_die extension

* remove _get_list_table extension

* Remove WP_Theme magic properties extension

* Update required php-stubs/wordpress-stubs

---------

Co-authored-by: Viktor Szépe <[email protected]>

Author: IanDelMar

.travis.yml

@@ -8,22 +8,17 @@ os:
 dist: "bionic"
 
 php:
+- "8.3"
+- "8.2"
+- "8.1"
 - "8.0"
 - "7.4"
-- "7.2"
 
 env:
-- TYPOS_VERSION="1.16.22"
+- TYPOS_VERSION="1.22.9"
 
 jobs:
     include:
-    -
-        php: "8.1"
-        script:
-        - "composer test:syntax -- --no-progress"
-        - "composer test:phpunit -- --verbose"
-        # - "composer test:cs -- -s"
-        - "composer test:phpstan -- --ansi --no-progress"
     -
         name: "With lowest deps"
         php: "7.4"

README.md

@@ -12,7 +12,7 @@ Thank you!
 [![Packagist stats](https://img.shields.io/packagist/dt/szepeviktor/phpstan-wordpress.svg)](https://packagist.org/packages/szepeviktor/phpstan-wordpress/stats)
 [![Packagist](https://img.shields.io/packagist/v/szepeviktor/phpstan-wordpress.svg?color=239922&style=popout)](https://packagist.org/packages/szepeviktor/phpstan-wordpress)
 [![Tweet](https://img.shields.io/badge/Tweet-share-d5d5d5?style=social&logo=twitter)](https://twitter.com/intent/tweet?text=Static%20analysis%20for%20WordPress&url=https%3A%2F%2Fgithub.com%2Fszepeviktor%2Fphpstan-wordpress)
-[![Build Status](https://travis-ci.com/szepeviktor/phpstan-wordpress.svg?branch=master)](https://travis-ci.com/github/szepeviktor/phpstan-wordpress)
+[![Build Status](https://app.travis-ci.com/szepeviktor/phpstan-wordpress.svg?token=CgYVxsSdNVnRNCDNV3qG&branch=master)](https://app.travis-ci.com/szepeviktor/phpstan-wordpress)
 [![PHPStan](https://img.shields.io/badge/PHPStan-enabled-239922)](https://github.com/phpstan/phpstan)
 
 Static analysis for the WordPress ecosystem.

composer.json

@@ -12,8 +12,8 @@
     ],
     "require": {
         "php": "^7.2 || ^8.0",
-        "php-stubs/wordpress-stubs": "^6.2.1",
-        "phpstan/phpstan": "^1.10.31",
+        "php-stubs/wordpress-stubs": "^6.6.2",
+        "phpstan/phpstan": "^1.11.0",
         "symfony/polyfill-php73": "^1.12.0"
     },
     "require-dev": {
@@ -22,7 +22,8 @@
         "php-parallel-lint/php-parallel-lint": "^1.1",
         "phpstan/phpstan-strict-rules": "^1.2",
         "phpunit/phpunit": "^8.0 || ^9.0",
-        "szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset": "^0.11"
+        "szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset": "^1.0",
+        "wp-coding-standards/wpcs": "3.1.0 as 2.3.0"
     },
     "suggest": {
         "swissspidy/phpstan-no-private": "Detect usage of internal core functions, classes and methods"

extension.neon

@@ -1,44 +1,10 @@
 services:
     -
-        class: SzepeViktor\PHPStan\WordPress\WpThemeMagicPropertiesClassReflectionExtension
-        tags:
-            - phpstan.broker.propertiesClassReflectionExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\EchoKeyDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\GetApprovedCommentsDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\GetListTableDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\RedirectCanonicalDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
+        class: SzepeViktor\PHPStan\WordPress\HookDocBlock
     -
         class: SzepeViktor\PHPStan\WordPress\EscSqlDynamicFunctionReturnTypeExtension
         tags:
             - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\GetTermsDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\GetPostDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\GetPostsDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\GetSitesDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
     -
         class: SzepeViktor\PHPStan\WordPress\ShortcodeAttsDynamicFunctionReturnTypeExtension
         tags:
@@ -51,10 +17,6 @@ services:
         class: SzepeViktor\PHPStan\WordPress\WpParseUrlFunctionDynamicReturnTypeExtension
         tags:
             - phpstan.broker.dynamicFunctionReturnTypeExtension
-    -
-        class: SzepeViktor\PHPStan\WordPress\WpDieDynamicFunctionReturnTypeExtension
-        tags:
-            - phpstan.broker.dynamicFunctionReturnTypeExtension
     -
         class: SzepeViktor\PHPStan\WordPress\HookDocsVisitor
         tags:

phpstan.neon.dist

@@ -3,8 +3,9 @@ includes:
     - vendor/phpstan/phpstan-strict-rules/rules.neon
 parameters:
     level: 9
-    # WpThemeMagicPropertiesClassReflectionExtension needs WP_Theme
     scanFiles:
+        # AssertWpErrorTypeSpecifyingExtension needs WP_Error
+        # AssertNotWpErrorTypeSpecifyingExtension needs WP_Error
         - vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
     paths:
         - bootstrap.php

src/ApplyFiltersDynamicFunctionReturnTypeExtension.php

@@ -11,18 +11,17 @@
 use PhpParser\Node\Expr\FuncCall;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\FunctionReflection;
-use PHPStan\Type\FileTypeMapper;
-use PHPStan\Type\Type;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\Type;
 
 class ApplyFiltersDynamicFunctionReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
 {
     /** @var \SzepeViktor\PHPStan\WordPress\HookDocBlock */
     protected $hookDocBlock;
 
-    public function __construct(FileTypeMapper $fileTypeMapper)
+    public function __construct(HookDocBlock $hookDocBlock)
     {
-        $this->hookDocBlock = new HookDocBlock($fileTypeMapper);
+        $this->hookDocBlock = $hookDocBlock;
     }
 
     public function isFunctionSupported(FunctionReflection $functionReflection): bool
@@ -38,7 +37,13 @@ public function isFunctionSupported(FunctionReflection $functionReflection): boo
         );
     }
 
-    // phpcs:ignore SlevomatCodingStandard.Functions.UnusedParameter
+    /**
+     * @see https://developer.wordpress.org/reference/functions/apply_filters/
+     * @see https://developer.wordpress.org/reference/functions/apply_filters_deprecated/
+     * @see https://developer.wordpress.org/reference/functions/apply_filters_ref_array/
+     *
+     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter
+     */
     public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): Type
     {
         $default = new MixedType();

src/AssertNotWpErrorTypeSpecifyingExtension.php

@@ -39,7 +39,7 @@ public function specifyTypes(MethodReflection $methodReflection, MethodCall $nod
     {
         $expr = $node->getArgs()[0]->value;
         $typeBefore = $scope->getType($expr);
-        $type = TypeCombinator::remove($typeBefore, new ObjectType('WP_Error'));
+        $type = TypeCombinator::remove($typeBefore, new ObjectType(\WP_Error::class));
 
         return $this->typeSpecifier->create($expr, $type, TypeSpecifierContext::createTruthy());
     }

src/AssertWpErrorTypeSpecifyingExtension.php

@@ -38,7 +38,11 @@ public function specifyTypes(MethodReflection $methodReflection, MethodCall $nod
     {
         $args = $node->getArgs();
 
-        return $this->typeSpecifier->create($args[0]->value, new ObjectType('WP_Error'), TypeSpecifierContext::createTruthy());
+        return $this->typeSpecifier->create(
+            $args[0]->value,
+            new ObjectType(\WP_Error::class),
+            TypeSpecifierContext::createTruthy()
+        );
     }
 
     public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void