Skip to content

getting-started.md

Latest commit

 

History

History
195 lines (148 loc) · 4.23 KB

getting-started.md

File metadata and controls

195 lines (148 loc) · 4.23 KB
Raw

Getting Started

Installation

Via Composer:

composer require stracker-phil/wpdi

Or, download WPDI and include it in your plugin:

require_once __DIR__ . '/wpdi/src/Scope.php';

Basic Setup

1. Create Your Plugin

<?php
/**
 * Plugin Name: My Plugin
 */

if ( ! defined( 'ABSPATH' ) ) {
    exit;
}

// When installed via composer:
require_once __DIR__ . '/vendor/autoload.php';

// When downloaded into a sub-folder:
require_once __DIR__ . '/wpdi/src/Scope.php';

class My_Plugin extends WPDI\Scope {
    protected function bootstrap( WPDI\Resolver $r ): void {
        $app = $r->get( My_Application::class );
        $app->run();
    }
}

My_Plugin::boot( __FILE__ );

2. Create Your Application

<?php
// src/My_Application.php

class My_Application {
    private My_Service $service;

    public function __construct( My_Service $service ) {
        $this->service = $service;
    }

    public function run(): void {
        add_action( 'init', array( $this, 'on_init' ) );
    }

    public function on_init(): void {
        $this->service->do_work();
    }
}

3. Create Your Services

<?php
// src/My_Service.php

class My_Service {
    private My_Config $config;

    public function __construct( My_Config $config ) {
        $this->config = $config;
    }

    public function do_work(): void {
        if ( $this->config->is_enabled() ) {
            // Business logic
        }
    }
}
<?php
// src/My_Config.php

class My_Config {
    public function is_enabled(): bool {
        return get_option( 'my_plugin_enabled', true );
    }
}

How It Works

  1. Auto-Discovery - WPDI scans src/ for PHP classes (customizable)
  2. Autowiring - Analyzes constructor parameters via reflection
  3. Dependency Injection - Instantiates and injects dependencies automatically

Customizing Autowiring Paths

By default, WPDI discovers classes from the src/ directory. Override autowiring_paths() to customize:

Single Custom Path

class My_Plugin extends WPDI\Scope {
    protected function autowiring_paths(): array {
        return array( 'lib' );  // Use lib/ instead of src/
    }

    protected function bootstrap( WPDI\Resolver $r ): void {
        $app = $r->get( My_Application::class );
        $app->run();
    }
}

Multiple Modules

class Multi_Module_Plugin extends WPDI\Scope {
    protected function autowiring_paths(): array {
        return array(
            'modules/auth/src',
            'modules/payment/src',
            'shared/src'
        );
    }

    protected function bootstrap( WPDI\Resolver $r ): void {
        // Services from all paths are available
        $auth = $r->get( Auth_Service::class );
    }
}

Disable Auto-Discovery

class Config_Only_Plugin extends WPDI\Scope {
    protected function autowiring_paths(): array {
        return array();  // No auto-discovery, only wpdi-config.php
    }

    protected function bootstrap( WPDI\Resolver $r ): void {
        // Only manually configured services available
    }
}

Notes:

  • Paths are relative to your plugin/theme directory
  • Non-existent paths are silently skipped
  • Later paths override earlier ones if classes have the same name
  • See Configuration for advanced scenarios

Directory Structure

my-plugin/
├── my-plugin.php          # Scope class (entry point)
├── wpdi-config.php        # Optional: interface bindings, external classes
├── wpdi/                   # WPDI library
└── src/                    # Your classes (auto-discovered)
    ├── My_Application.php
    ├── My_Service.php
    └── My_Config.php

File Naming (PSR-4)

Class names must match file names exactly:

✅ My_Service.php      → class My_Service
✅ Payment_Gateway.php → class Payment_Gateway
❌ class-my-service.php (old WP style - not discovered)

Next Steps