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許可證的條款發布。請參閱許可證以獲取完整許可。