szepeviktor / phpstan-wordpress
WordPress extensions for PHPStan
Fund package maintenance!
szepeviktor
Installs: 3 159 591
Dependents: 553
Suggesters: 20
Security: 0
Stars: 265
Watchers: 11
Forks: 26
Open Issues: 9
Type:phpstan-extension
Requires
- php: ^7.2 || ^8.0
- php-stubs/wordpress-stubs: ^4.7 || ^5.0 || ^6.0
- phpstan/phpstan: ^1.10.31
- symfony/polyfill-php73: ^1.12.0
Requires (Dev)
- composer/composer: ^2.1.14
- dealerdirect/phpcodesniffer-composer-installer: ^1.0
- 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: ^1.0
- wp-coding-standards/wpcs: 3.1.0 as 2.3.0
Suggests
- swissspidy/phpstan-no-private: Detect usage of internal core functions, classes and methods
- dev-master
- 2.x-dev
- v1.3.5
- v1.3.4
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.7
- v1.1.6
- v1.1.5
- v1.1.4
- v1.1.3
- v1.1.2
- v1.1.1
- v1.1.0
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- v0.7.7
- v0.7.6
- v0.7.5
- v0.7.4
- v0.7.3
- v0.7.2
- v0.7.1
- v0.7.0
- v0.6.6
- v0.6.5
- v0.6.4
- v0.6.3
- v0.6.2
- v0.6.1
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- 0.2.1
- 0.2.0
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
This package is auto-updated.
Last update: 2024-10-10 07:59:28 UTC
README
Important
Hello everyone! This is Viktor who runs this PHPStan extension. I am planning to stop contributing to the WordPress ecosystem because it is extremely difficult and no one asks me to join his team as I am a thinker, a devops person, a tool maker (not a builder).
Please support my work to avoid abandoning this package.
Thank you!
WordPress extensions for PHPStan
Static analysis for the WordPress ecosystem.
Installation
Add this package to your project.
composer require --dev szepeviktor/phpstan-wordpress
Make PHPStan find it automatically using phpstan/extension-installer
.
composer require --dev phpstan/extension-installer
Or manually include it in your phpstan.neon
.
includes: - vendor/szepeviktor/phpstan-wordpress/extension.neon
Configuration
Needs no extra configuration. 😃 Simply configure PHPStan - for example - this way.
parameters: level: 5 paths: - plugin.php - inc/
Please read PHPStan Config Reference.
💡 Use Composer autoloader or a custom autoloader!
Usage
Just start the analysis: vendor/bin/phpstan analyze
then fix an error and GOTO 10
!
You find further information in the examples
directory
e.g. examples/phpstan.neon.dist
Usage in WooCommerce webshops
Please see WooCommerce Stubs
What this extension does
- Makes it possible to run PHPStan on WordPress plugins and themes
- Loads
php-stubs/wordpress-stubs
package - Provides dynamic return type extensions for many core functions
- Defines some core constants
- Handles special functions and classes e.g.
is_wp_error()
- Validates the optional docblock that precedes a call to
apply_filters()
and treats the type of its first@param
as certain
Usage of an apply_filters()
docblock
WordPress core - and the wider WordPress ecosystem - uses PHPDoc docblocks
in a non-standard manner to document the parameters passed to apply_filters()
.
Example:
/** * Filters the page title when creating an HTML drop-down list of pages. * * @param string $title Page title. * @param WP_Post $page Page data object. */ $title = apply_filters( 'list_pages', $title, $page );
This extension understands these docblocks when they're present in your code
and uses them to instruct PHPStan to treat the return type of the filter as certain,
according to the first @param
tag. In the example above this means PHPStan treats the type of $title
as string
.
To make the best use of this feature,
ensure that the type of the first @param
tag in each of these such docblocks is accurate and correct.
Make your code testable
- Write clean OOP code: 1 class per file, no other code in class files outside
class Name { ... }
- Structure your code: uniform class names (WPCS or PSR-4), keep classes in a separate directory
inc/
- Add proper PHPDoc blocks to classes, properties, methods, functions, and calls to
apply_filters()
- Choose your main plugin file parts.
- Avoid using core constants, use core functions
- Avoid bad parts of PHP
- functions:
eval
,extract
,compact
,list
- type juggling:
$a = '15'; if ($a) ...
- functions:
- If you need robust code try avoiding all kinds of type juggling (e.g.
if
needs a boolean), see Variable handling functions - If you are not bound by PHP 5 consider following Neutron Standard
- Do not enable
exit_error
inWP_CLI::launch
orWP_CLI::runcommand
to keep your code testable
Dirty corner (FAQ)
WordPress uses conditional function and class definition for override purposes.
Use sed
command to exclude function stubs when they are previously defined.
sed -i -e 's#function is_gd_image#function __is_gd_image#' vendor/php-stubs/wordpress-stubs/wordpress-stubs.php