README

GlotPress function and class declaration stubs for static analysis.

This package provides stub declarations for GlotPress functions, classes and interfaces.
These stubs can help plugin and theme developers leverage static analysis tools like PHPStan, which are unable to parse GlotPress as it is not clean OOP code.

Stubs are generated directly from the source using php-stubs/generator.

Requirements

• PHP ^7.3 or ^8.0

Installation

Require this package as a development dependency with Composer.

composer require --dev pedro-mendonca/glotpress-stubs

Alternatively you may download glotpress-stubs.php directly.

Usage in PHPStan

Include all stubs in PHPStan configuration file.
You can remove the # WordPress Stubs lines if you already use WordPress extensions for PHPStan.

parameters:
    scanFiles:
        # WordPress Stubs
        - %rootDir%/../../php-stubs/wordpress-stubs/wordpress-stubs.php
        # GlotPress Stubs
        - %rootDir%/../../pedro-mendonca/glotpress-stubs/glotpress-stubs.php