Navigation

Best Practices

File Structure

Follow PSR-4 standards:

src/
├── Core/              # Core plugin functionality
├── Admin/             # WordPress admin area code
├── Frontend/          # Public-facing code
├── Services/          # Business logic and services
├── Interfaces/        # Contracts and interfaces
├── Models/            # Data models
└── Providers/         # Service providers

Naming Conventions

Classes:

Use PascalCase: DatabaseService, UserController
Suffix interfaces with Interface: LoggerInterface, CacheInterface
Suffix abstract classes with Abstract: AbstractProvider

Namespaces:

Match directory structure: MyPlugin\Services\DatabaseService
Vendor prefix: YourVendor\PluginName\...

Files:

One class per file
File name matches class name: DatabaseService.php

Service Registration

Register your services using a service provider src/Providers/PluginServiceProvider pattern for organizing service registration.

Avoiding Common Pitfalls

1. Don't Store Container Globally

// ❌ Bad
global $my_container;
$my_container = new Container();

// ✅ Good - use the static getInstance() method
$container = Container::getInstance();

2. Don't Use Container as Service Locator

// ❌ Bad
class MyService {
  public function __construct(Container $container) {
      $this->logger = $container->get(LoggerInterface::class);
  }
}

// ✅ Good
class MyService {
  public function __construct(
      private LoggerInterface $logger
  ) {}
}

3. Don't Bind in Random Places

// ❌ Bad - scattered bindings
add_action('init', function() use ($container) {
  $container->bind(SomeService::class);
});

// ✅ Good - centralized service provider
class PluginServiceProvider {
  public function register(Container $container): void {
      $container->bind(SomeService::class);
  }
}