|
| 1 | +# Elementor Stubs |
| 2 | + |
| 3 | +This package provides stub declarations for [Elementor](https://elementor.com/) core functions, classes, interfaces, and global variables. These stubs can help plugin and theme developers leverage static analysis tools like [Psalm](https://getpsalm.org/) and plugins like Intellisense, Intelephense. |
| 4 | + |
| 5 | +The stubs are generated directly from the [source](https://wordpress.org/plugins/elementor/) using [stubs generator](https://github.com/GiacoCorsiglia/php-stubs-generator). Needless to say, this library repackages a subset of Elementor code, which is the work of the Elementor plugin developers. |
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +Require this package as a dev-dependency with [Composer](https://getcomposer.org): |
| 10 | + |
| 11 | +``` |
| 12 | +composer require --dev arifpavel/elementor-stubs |
| 13 | +``` |
| 14 | + |
| 15 | +Alternatively, you may download `elementor-stubs.php` directly. |
| 16 | + |
| 17 | +## Usage with Psalm |
| 18 | + |
| 19 | +Update your Psalm config to include the section: |
| 20 | + |
| 21 | +```xml |
| 22 | +<stubs> |
| 23 | + <file name="vendor/arifpavel/elementor-stubs/elementor-stubs.php" /> |
| 24 | +</stubs> |
| 25 | +``` |
| 26 | + |
| 27 | +Furthermore, ensure Elementor core code is _not_ included under `<projectFiles>`. |
| 28 | + |
| 29 | +## Usage for Intellisense |
| 30 | + |
| 31 | +If your editor has trouble parsing all of Elementor classes, functionc, etc, you may find the stubs useful for enabling code completion and related features. For example, [here](https://github.com/bmewburn/vscode-intelephense/issues/113) are instructions for usage with VSCode's [Intelephense](https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client) extension. Or in a local workspace for intelephense create a ```.php``` file and add |
| 32 | +``{ |
| 33 | + "intelephense.stubs": [ |
| 34 | + "/vendor/arifpavel/elementor-stubs/elementor-stubs.php" |
| 35 | + ] |
| 36 | +}`` |
| 37 | + |
| 38 | +## Versioning |
| 39 | + |
| 40 | +This package is versioned to match the Elementor version from which the stubs are generated. If any fixes to stubs are required, subsequent releases will be versioned as `ELEMENTOR_VERSION.X`. |
| 41 | + |
| 42 | +## Generating stubs for a different WordPress version |
| 43 | + |
| 44 | +You should be running PHP 7.1 or later to follow these steps, so any function definitions that are polyfills for older versions of PHP are excluded from the stubs. Additionally, the Stubs Generator package at least requires PHP 7.1. |
| 45 | + |
| 46 | +1. Clone this repository and `cd` into it. |
| 47 | +2. Download Elementor plugin source from wordpress.org & place it inside this project. |
| 48 | +3. Run `composer install` |
| 49 | +4. Run `./generate.sh` |
| 50 | + |
| 51 | +The `elementor-stubs.php` file should now be updated. Feel free to submit a Pull Request if you'd like to see a release for a newer version. If things have fallen behind, please generate stubs for each missing version in a distinct commit so we can have a continuous release history. |
| 52 | + |
| 53 | +### Credits |
| 54 | + |
| 55 | +This package is highly dependent on GiacoCorsiglia's stub packages. |
| 56 | + |
| 57 | +### License |
| 58 | +[GPLv2](LICENSE) |
0 commit comments