skaut/wordpress-stubs

WordPress 函数和类的高质量存根

2.8.1 2023-12-23 22:25 UTC

README

Packagist Version GitHub Actions Workflow Status Packagist Downloads Packagist License Packagist Dependency Version

该仓库包含用于与 phanphpstan 一起使用的 WordPress 函数和类的存根。由于存根都包含类型信息,这允许对代码库进行更好的类型检查。

替代方案

php-stubs/wordpress-stubs

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

安装

$ 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
	  - ...

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

完整性

存根并不完整。如果您发现任何缺失的函数或类,请 提交一个问题