pedro-mendonca / glotpress-stubs

为静态分析提供的 GlotPress 函数和类声明占位符。

4.0.1 2024-09-25 23:59 UTC

README

为静态分析提供的 GlotPress 函数和类声明占位符。

Packagist version Packagist stats License Sponsor

本包提供了 GlotPress 函数、类和接口的占位符声明。
这些占位符可以帮助插件和主题开发者利用静态分析工具,如 PHPStan,这些工具无法解析 GlotPress,因为它不是干净的 OOP 代码。

占位符直接从 源代码 使用 php-stubs/generator 生成。

需求

  • PHP >=7.2

安装

使用 Composer 将此包作为开发依赖项。

composer require --dev pedro-mendonca/glotpress-stubs

或者您可以直接下载 glotpress-stubs.php

在 PHPStan 中的使用

在 PHPStan 配置文件中包含所有占位符。
如果您已经使用 WordPress 扩展,可以移除 # WordPress Stubs 行。

parameters:
    scanFiles:
        # WordPress Stubs
        - %rootDir%/../../php-stubs/wordpress-stubs/wordpress-stubs.php
        # GlotPress Stubs
        - %rootDir%/../../pedro-mendonca/glotpress-stubs/glotpress-stubs.php