README

PHP stub declarations for the WPForms Lite plugin to enhance IDE completion and static analysis capabilities. Generated using php-stubs/generator directly from the source code.

🚀 Features

• Complete function, class, and interface declarations
• Constant definitions for proper static analysis
• IDE autocompletion support
• PHPStan integration
• Regular updates with latest WPForms Lite versions

📋 Requirements

• PHP >= 7.4
• Composer for dependency management

📦 Installation

Via Composer (Recommended)

# Install as a development dependency
composer require --dev mralaminahamed/wpforms-lite-stubs

# Or specify a version
composer require --dev mralaminahamed/wpforms-lite-stubs:^1.0

Manual Installation

Download the stub files directly:

• wpforms-stubs.stub
• wpforms-constants-stubs.stub

🔧 Basic Configuration

To use these stubs with PHPStan or your IDE, see our Usage Guide for detailed instructions.

🔍 Quick Usage Example

<?php
// Your code will now have full IDE support
$wpforms = wpforms();

// Constants are properly defined
if (WPFORMS_VERSION) {
    // Your implementation
}

// Classes and interfaces are available
class MyForm extends WPForms\WPForms {
    // Your implementation
}

For advanced usage examples, see the Usage Guide.

📁 Package Structure

phpstan-wpforms-lite-stubs/
├── configs/                            # Configuration files for stub generation
├── docs/                               # Detailed documentation
│   ├── usage.md                        # Usage guide
│   └── contributing.md                 # Contribution guidelines
├── wpforms-constants-stubs.stub        # Constants stub file
├── wpforms-stubs.stub                  # Main stubs file with classes and functions
├── source/                             # Source for generating stubs
└── tests/                              # Test files
    ├── bootstrap.php                   # Test bootstrap
    ├── ConstantsTest.php               # Constants tests
    └── WPFormsTest.php                 # WPForms tests

🛠 Development

For information on building stubs, running tests, and contributing to the project, please see our Contributing Guide.

📚 Documentation

For more detailed information, check out our documentation:

• Usage Guide
• Contributing Guide
• WPForms Documentation
• PHPStan Documentation
• PHP Stubs Generator Documentation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• WPForms Team for the WPForms Lite plugin
• php-stubs/generator for the stub generation tools
• All contributors to this project

💬 Support

For bug reports and feature requests, please use the GitHub Issues.

For questions and discussions, please use the GitHub Discussions.