baxtian/timber-stubs

Based on giacocorsiglia/wordpress-stubs and paulthewalton/acf-stubs. Timber function, class, and global variable declaration stubs for easier static analysis.

1.22.1 2023-06-25 21:26 UTC

Requires (Dev)

• ext-gettext: *
• composer/composer: ^2.4
• php-stubs/generator: ^0.8.1
• wpackagist-plugin/timber-library: ^1.22

GPL-2.0+

• Juan Sebastián Echeverry

• twig
• wordpress
• static analysis
• timber

README

This package provides stub declarations for Timber 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 Timber code, which is the work of Timber developers. Granted, it's a useless subset without the real thing!

Many thanks to GiacoCorsiglia, who did all the hard work on giacocorsiglia/wordpress-stubs, from which this is shamelessly ripped off and to Paul Walton who created the Advanced Custom Fields Stubs that is the base using for this stub.

Installation

Require this package as a dev-dependency with Composer:

composer require --dev baxtian/timber-stubs

Alternatively, you may download timber-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 ACF version from which the stubs are generated. If any fixes to stubs are required, subsequent releases will be versioned as TIMBER_VERSION.X.

Generating stubs for a different Timber version

You should be running PHP 8.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 8.1.

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

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