README

A modern WordPress theme framework built with Laravel components, designed for developers who want to build powerful WordPress themes with a clean, object-oriented architecture.

Features

• Laravel Integration: Leverages popular Laravel components (Container, Validation, Pagination, View, etc.)
• ACF Support: Seamless integration with Advanced Custom Fields via Corcel
• Flexible Routing: Custom routing system with FastRoute integration
• Module System: Organized module-based architecture for theme components
• Template Hierarchy: Brain Hierarchy integration for intelligent template loading
• WordPress REST API: Easy API endpoint creation
• Debugging: Tracy integration for advanced debugging
• Scaffolding: Generate modules, templates, and components with CLI tools

Requirements

• PHP: 8.2 or higher
• WordPress: 5.0 or higher
• Composer: 2.0 or higher

Installation

Via Composer

composer create-project sixmonkey/sloth my-theme

Manual Installation

1. Clone or download this repository into your WordPress theme directory
2. Run composer install to install dependencies
3. Configure your theme as needed

Quick Start

1. Theme Activation

Activate the theme in your WordPress admin panel. The framework will automatically bootstrap and register all service providers.

2. Creating a Module

Use the scaffolder to create a new module:

php sloth-cli.php make:module MyModule

This creates:

• src/Module/MyModule/
• src/Module/MyModule/Module.php
• src/_view/Module/my-module/
• SCSS files and ACF configuration

3. Defining Routes

Create a routes.php file in your theme root:

<?php

use Sloth\Facades\Route;

// Basic route
Route::get('/about', [
    'controller' => 'PageController',
    'action' => 'about',
]);

// With parameters
Route::get('/blog/{slug}', [
    'controller' => 'BlogController',
    'action' => 'show',
]);

4. Creating Controllers

Controllers go in Theme/Controller/:

<?php

namespace Theme\Controller;

use Sloth\Controller\Controller;

class PageController extends Controller
{
    public function about(): void
    {
        $this->view('about', [
            'title' => 'About Us',
        ]);
    }
}

5. Using Models

<?php

use Sloth\Model\Post;

// Get a post by ID
$post = Post::find(123);

// Get posts by category
$posts = Post::where('category', 'news')
    ->orderBy('date', 'DESC')
    ->limit(10)
    ->get();

// Custom post type
$projects = \Sloth\Model\Post::type('project')
    ->status('publish')
    ->get();

6. Using the View System

<?php

use Sloth\Facades\View;

// Render a view
View::make('partials.header', ['title' => 'Welcome']);

// With layout
View::make('content.page')
    ->layout('layouts.main')
    ->with(['title' => 'Page Title']);

7. Validation

<?php

use Sloth\Facades\Validation;

$validator = Validation::make($request->all(), [
    'name'  => 'required|min:3|max:255',
    'email' => 'required|email',
    'url'   => 'url|nullable',
]);

if ($validator->fails()) {
    $errors = $validator->errors();
}

Configuration

Environment Variables

Create a .env file in your theme root:

APP_ENV=local
WP_DEBUG=true
DATABASE_HOST=localhost
DATABASE_NAME=wordpress
DATABASE_USER=root
DATABASE_PASSWORD=

Custom Configuration

Add configuration files in src/config/:

<?php

return [
    'setting_name' => 'value',
    'another_setting' => true,
];

Access configuration via:

<?php

use Sloth\Facades\Configure;

$value = Configure::get('config_file.setting_name');

Directory Structure

sloth/
├── src/
│   ├── Core/           # Core framework classes
│   ├── Model/          # WordPress model extensions
│   ├── Route/          # Routing system
│   ├── View/           # View system
│   ├── Controller/     # Base controllers
│   ├── Facades/        # Facade classes
│   ├── Module/         # Module system
│   ├── Field/          # Custom ACF fields
│   ├── _view/          # Twig templates
│   └── config/         # Configuration files
├── tests/              # PHPUnit tests
├── docs/               # Additional documentation
├── composer.json       # Dependencies
└── phpunit.xml         # Test configuration

Available Facades

Artisan Commands

# Create a new module
php sloth-cli.php make:module ModuleName

# Install the theme
php sloth-cli.php install

# Generate documentation
composer run docs

Development

Running Tests

composer test

Static Analysis

composer analyse

Code Style

# Check code style
composer cs-check

# Auto-fix code style
composer cs-fix

Generate Documentation

composer docs

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

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

Credits

• Ben Kremer
• Jochen Wichmann
• Max Leistner

Links

• Documentation
• Issue Tracker
• Packagist