arifpavel/elementor-stubs

Elementor 函数、类和全局变量声明存根，以便于更轻松地进行静态分析。

维护者

详细信息

github.com/arifpavel/elementor-stubs

主页

源代码

问题

安装次数: 11,667

依赖项: 0

建议者: 0

安全: 0

星星: 3

关注者: 2

分支: 2

开放性问题: 1

3.1.4.1 2021-04-05 11:32 UTC

Requires (Dev)

GPL-2.0+ 69f022cc861e29003011fff99acbb2a79f06f0eb

  • Arif Pavel <pavelpatiya.woop@gmail.com>

static analysiselementor

This package is auto-updated.

Last update: 2024-09-05 20:31:04 UTC

README

此包为 Elementor 核心函数、类、接口和全局变量提供存根声明。这些存根可以帮助插件和主题开发者利用 Psalm 和 Intellisense、Intelephense 等静态分析工具。

存根直接使用 存根生成器 从 源代码 生成。不言而喻，这个库重新打包了 Elementor 代码的一部分，这是 Elementor 插件开发者的工作。

安装

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

composer require --dev arifpavel/elementor-stubs

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

与 Psalm 一起使用

更新您的 Psalm 配置以包含该部分

<stubs>
    <file name="vendor/arifpavel/elementor-stubs/elementor-stubs.php" />
</stubs>

此外，请确保 Elementor 核心代码不在 <projectFiles> 之下。

Intellisense 的使用

如果您的编辑器在解析 Elementor 的所有类、函数等时遇到困难，您可能会发现这些存根对启用代码补全和相关功能很有用。例如，有关在 VSCode 的 Intelephense 扩展中使用的说明请参阅 此处。或者，在 intelephense 的本地工作区中创建一个 .php 文件并添加 { "intelephense.stubs": [ "/vendor/arifpavel/elementor-stubs/elementor-stubs.php" ] }

版本控制

此包的版本与生成存根的 Elementor 版本相匹配。如果需要修复存根，后续版本将作为 ELEMENTOR_VERSION.X 版本发布。

为不同的 WordPress 版本生成存根

您应运行 PHP 7.1 或更高版本以遵循这些步骤，因此任何针对旧版 PHP 的填充函数定义都已被排除在存根之外。此外，存根生成器包至少需要 PHP 7.1。

  1. 克隆此存储库并 cd 进入它。
  2. 从 wordpress.org 下载 Elementor 插件源并将其放置在此项目内部。
  3. 运行 composer install
  4. 运行 ./generate.sh

现在应更新 elementor-stubs.php 文件。如果您想看到针对较新版本的发布，请随时提交拉取请求。如果落后了，请为每个缺失的版本在不同的提交中生成存根，这样我们就可以有一个连续的发布历史。

鸣谢

此包高度依赖于 GiacoCorsiglia 的存根包。

许可证

GPLv2