php-stubs/acf-pro-stubs

Advanced Custom Fields PRO stubs for static analysis.

v6.3.10 2024-11-06 12:26 UTC

Requires

• php-stubs/wordpress-stubs: ^4.7 || ^5.0 || ^6.0

Requires (Dev)

• php: ~7.1 || ^8.0
• php-stubs/generator: ^0.8
• phpdocumentor/reflection-docblock: ^5.3

Suggests

• symfony/polyfill-php73: Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
• szepeviktor/phpstan-wordpress: WordPress extensions for PHPStan

MIT

• wordpress
• static analysis
• acf
• PHPStan

README

It provides stub declarations for ACF Pro core functions, classes and interfaces. These stubs can help plugin and theme developers leverage static analysis tools like PHPStan.

The stubs are generated from wpengine/advanced-custom-fields-pro using php-stubs/generator.

Requirements

• PHP ^8.0

Installation

Require this package as a development dependency with Composer.

composer require --dev php-stubs/acf-pro-stubs

Alternatively you may download acf-pro-stubs.php directly.

Versioning

This package is versioned to match the ACF Pro version from which the stubs are generated.

Updating stubs

1. Run modern PHP version
2. Clone this repository and cd into it
3. Insert your ACF Pro license to auth.json in the project root
4. Run composer install
5. Install operating system level packages apt-get install xmlstarlet unzip git
6. Run ./release-latest-versions.sh

This will update acf-pro-stubs.php per version, tag and commit it.