wp stubs

WordPress存根

该仓库包含可与静态分析工具一起使用的自动生成的WordPress存根。

常问问题

• 为什么这不是“在此处插入退出项目>”？

该项目的目的是：

• 在同一分支/版本中具有多个版本的WP
• 没有用于全球群体的存根，而是有常数存根
• 具有超简单的“覆盖”方法。通过在fixtures.php文件中声明存根，可以覆盖函数，类和接口的WordPress声明。这样，很容易修复WordPress中错误的DOCBLOCKS，并使用静态分析仪支持的“高级” DOC块（考虑数组形状，类型别名，条件返回类型…）

这是如何工作的

每天，github操作工作流都调用wp.org api来查找新的WordPress版本。

如果找到新版本，它将为它们生成并保存存根（使用https://github.com/php-stubs/generator），同时还更新了“最新”存根。

如何使用

主要用途是用于静态分析工具，例如诗篇：

方法1：获取所有WordPress版本

步骤：

1. 需要此项目（ inpsyde/wp-stubs ）在您的作曲家的"require-dev"属性中
2. 创建一个psalm.xml配置文件（请参阅文档）
3. 在诗篇配置中，添加以下行：

   < stubs >
       < file name = " vendor/inpsyde/wp-stubs/stubs/latest.php " />
   </ stubs >

您可以用特定的WP版本替换latest.php 。请参阅/stubs目录中的可用版本。

注意：在该文件夹中，像5.9这样的两个数字版本号不一定表示WordPress版本5.9 ，而是5.9.*系列中的最新版本。因此，如果您使用Composer需要WordPress并具有5.9.* ，使用stubs/5.9.php文件将与当前安装的版本匹配。

“存根”文件夹包含许多版本的存根，因此您可以选择，但是也可以使用一个CI脚本，该脚本加载不同的版本以测试不同的存根。

但是，包装尺寸可能会变得巨大，如果不排除IDE的分析，它可能会影响IDE性能。

方法2：获取特定版本

先决条件：

在您的composer.json中，声明这样的存储库：

{
  "repositories" : [
    {
      "type" : " composer " ,
      "url" : " https://raw.githubusercontent.com/inpsyde/wp-stubs/main " ,
      "only" : [
        " inpsyde/wp-stubs-versions "
      ]
    }
  ]
}

注意INPSYDE开发人员：私人Packagist中的INPSYDE组织反映了上述存储库，因此对于Inpsyde的私人存储库，考虑到私人Packagist可能已经添加到了Repo的composer.json 。

步骤：

1. 在您的作曲家的"require-dev"属性中需要“版本化的”项目，例如{ "require": { "inpsyde/wp-stubs-versions": "dev-latest" } } 。 （请注意软件包名称的如何-versions ）
2. 创建一个psalm.xml配置文件（请参阅文档）
3. 在诗篇配置中，添加以下行：

   < stubs >
       < file name = " vendor/inpsyde/wp-stubs-versions/latest.php " />
   </ stubs >

使用这种方法，最新版本将是唯一的版本作曲家下载。

最低要求

生成存根的代码需要PHP 8.0+。但是，当食用包装时，除了能够运行WordPress之外，没有最低要求。

执照

该存储库是一个免费软件，并根据MIT许可证的条款发布。请参阅许可证以获取完整许可。