skaut/phan-wordpress-stubs

此包已被弃用且不再维护。作者建议使用skaut/wordpress-stubs包。

WordPress函数和类的优质占位符

1.25.0 2022-04-19 12:27 UTC

README

GitHub Actions

此仓库包含用于与phanphpstan一起使用的WordPress函数和类的占位符。由于所有占位符都具有类型信息,因此这允许对代码库进行更好的类型检查。

替代方案

php-stubs/wordpress-stubs

php-stubs/wordpress-stubs项目使用直接从WordPress源代码导出的占位符。这意味着占位符更完整,更新更快。另一方面,WordPress中许多函数和类的文档编写不佳,数组类型几乎从未正确地进行了类型化(即只是array)。此包包含所有手动创建的占位符,因此它们更加精确。

安装

$ composer require --dev skaut/wordpress-stubs

添加到您的.phan/config.php

return [
	'directory_list' => [
		'vendor/skaut/wordpress-stubs/stubs'
	],
	'exclude_analysis_directory_list' => [
		'vendor/skaut/wordpress-stubs/stubs'
	]
];

添加到您的phpstan.neon

parameters:
	scanDirectories:
	  - vendor/skaut/wordpress-stubs/stubs
	scanFiles:
	  - vendor/skaut/wordpress-stubs/stubs/WordPress/functions.php
	dynamicConstantNames:
	  - WP_DEBUG
	  - ...

(您必须自行列出动态常量)

完整性

占位符并不完整。如果您发现任何缺失的函数或类,请创建一个问题