README

PHPNomad packaged as a single installable WordPress plugin. This bundle ships every PHPNomad package together with the WordPress integration layer, so other plugins can depend on PHPNomad through WordPress's built-in Plugin Dependencies feature instead of shipping their own vendored copy.

Requirements

• PHP 8.2 or higher
• WordPress 6.5 or higher (for the Plugin Dependencies feature)

What's Bundled

Core Foundation

• phpnomad/core - Core interfaces and base functionality for the PHPNomad framework
• phpnomad/framework - Framework orchestration and bootstrapping
• phpnomad/utils - Shared utility helpers, including Arr and Str

Configuration & Loading

• phpnomad/config - Configuration management abstraction
• phpnomad/array-json-config - Array and JSON configuration providers
• phpnomad/json-config-integration - Integration layer for JSON configuration
• phpnomad/loader - Class and file loading utilities

Dependency Injection & Design Patterns

• phpnomad/di - Dependency injection abstraction
• phpnomad/di-container - Concrete DI container implementation
• phpnomad/singleton - Singleton pattern implementation
• phpnomad/decorator - Decorator pattern utilities
• phpnomad/facade - Facade pattern implementation
• phpnomad/registry - Registry pattern for managing objects

Database & Data Management

• phpnomad/db - Database abstraction layer
• phpnomad/datastore - Generic datastore interfaces
• phpnomad/mysql-integration - MySQL-specific database integration

HTTP & REST API

• phpnomad/http - HTTP request/response handling
• phpnomad/rest - REST API framework
• phpnomad/fastroute-rest-integration - FastRoute integration for REST routing
• phpnomad/fetch - HTTP client abstraction
• phpnomad/guzzle-fetch - Guzzle HTTP client integration

Authentication & Security

• phpnomad/auth - Authentication and authorization framework
• phpnomad/firebase-jwt-integration - JWT token handling via Firebase JWT
• phpnomad/privacy - Privacy and data protection utilities

Templating & Content

• phpnomad/template - Template rendering abstraction
• phpnomad/twig-integration - Twig templating engine integration
• phpnomad/markdown - Markdown processing abstraction
• phpnomad/league-markdown-integration - League CommonMark integration

Events & Background Tasks

• phpnomad/event - Event dispatching abstraction
• phpnomad/symfony-event-dispatcher-integration - Symfony EventDispatcher integration
• phpnomad/tasks - Background task scheduling and execution

Caching

• phpnomad/cache - Caching abstraction layer
• phpnomad/symfony-cache-integration - Symfony Cache component integration

CLI & Console

• phpnomad/console - Console command framework
• phpnomad/symfony-console-integration - Symfony Console integration

Email

• phpnomad/email - Email sending abstraction
• phpnomad/php-mail-integration - PHP mail function integration

Internationalization

• phpnomad/translate - Translation and localization abstraction

Asset Management

• phpnomad/asset - CSS/JS asset registration and enqueueing

Utilities & Helpers

• phpnomad/mutator - Data mutation and transformation utilities
• phpnomad/logger - Logging interfaces and utilities
• phpnomad/update - Plugin/theme update management
• phpnomad/enum-polyfill - PHP enum polyfill for older PHP versions

WordPress Integration

• phpnomad/wordpress-integration - WordPress adapters that wire PHPNomad's abstractions to WordPress APIs

Using PHPNomad as a Dependency

If you're building a plugin that depends on PHPNomad, use WordPress's built-in Plugin Dependencies feature (introduced in WordPress 6.5) so PHPNomad is installed and activated before your plugin loads.

Declaring the Dependency

Add the Requires Plugins header to your plugin's main PHP file:

/**
 * Plugin Name: My Plugin
 * Requires Plugins: phpnomad
 */

Using the phpnomad_ready Action

To make sure PHPNomad is fully loaded before your plugin initializes, hook into the phpnomad_ready action:

add_action('phpnomad_ready', function () {
    // PHPNomad is now loaded and ready to use.
    // Initialize your plugin here.
});

This action fires immediately after PHPNomad's Composer autoloader is loaded, so every PHPNomad class and interface is available by the time your callback runs.

How It Works

• WordPress prevents your plugin from being activated if PHPNomad is not installed
• Users see a clear indication that PHPNomad must be installed first
• PHPNomad cannot be deactivated or deleted while your plugin is active
• If PHPNomad is removed via FTP or deployment, WordPress displays a notice about missing dependencies

Important Notes

• The Requires Plugins header uses the plugin slug (phpnomad), not the file path
• This feature does not enforce version requirements or loading order
• Continue to use function_exists(), class_exists(), interface_exists(), and version checks where your plugin relies on specific functionality
• For more information, see Plugin Dependencies in WordPress 6.5

Documentation

Full PHPNomad documentation lives at phpnomad.com.

License

GPLv3 or later.