mccomaschris/lockr-stubs

Based on paulthewalton/acf-stubs. Lockr plugin function, class, and global variable declaration stubs for easier static analysis.

Maintainers

Details

github.com/mccomaschris/lockr-stubs

Source

Issues

Installs: 17

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

3.0.4 2021-12-09 21:07 UTC

Requires (Dev)

GPL-2.0+ 5a81cc4789073af8ca14d60c28deb7d7234d11c6

  • Christopher McComas <mccomas.chris.woop@gmail.com>

wordpressstatic analysislockr

This package is auto-updated.

Last update: 2025-03-10 04:06:39 UTC

README

This package provides stub declarations for WordPress Advanced Custom Fields (ACF) Lockr core functions, classes, interfaces, and global variables. These stubs can help plugin and theme developers leverage static analysis tools.

The stubs are generated directly from the source using giacocorsiglia/stubs-generator. Needless to say, this library repackages a subset of WordPress ACF Lockr code, which is the work of the WordPress core ACF developers Lockr. Granted, it's a useless subset without the real thing!

Many thanks to GiacoCorsiglia and paulthewalton, who did all the hard work on giacocorsiglia/wordpress-stubs and acf-stubs, from which this is shamelessly ripped off.

Installation

Require this package as a dev-dependency with Composer:

composer require --dev mccomaschris/lockr-stubs

Alternatively, you may download lockr-stubs.php directly.

Usage for Intellisense

From Wordpress Stubs:

If your editor has trouble parsing all of WordPress, you may find the stubs useful for enabling code completion and related features. For example, here are instructions for usage with VSCode's Intelephense extension. (In my experience, however, Intelephense parses WordPress core just fine.)

Versioning

This package is versioned to match the Lockr version from which the stubs are generated. If any fixes to stubs are required, subsequent releases will be versioned as LOCKR_VERSION.X.

Generating stubs for a different Lockr version

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.

  1. Clone this repository and cd into it.
  2. Update "wpackagist-plugin/lockr": "X.X.X" in composer.json with your desired version.
  3. Run composer update
  4. Run ./generate.sh

The lockr-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.