Acorn

https://github.com/roots/acorn
Admin
Acorn is a PHP framework from Roots that brings Laravel components into WordPress themes and...
Tokens:159,340
Snippets:1,252
Trust Score:9.5
License:MIT
Update:8 hours ago
Show doc for...
Tokens:
Raw
### view() usage examples

Source: https://github.com/roots/acorn

Shows how to get the view factory, render an existing view, or render a raw file path.

```php
use Roots\view;

$factory = view();                                  // the view factory
echo view('partials.header', ['title' => 'Hello']); // existing view
echo view('/absolute/path/to/template.blade.php');  // raw file
```

--------------------------------

### Example: wp acorn make:composer

Source: https://github.com/roots/acorn

Command-line example for creating a view composer with the --views option to specify view names.

```bash
wp acorn make:composer Post --views="partials.post partials.card"
```

--------------------------------

### acorn:init command examples

Source: https://github.com/roots/acorn

Example invocations of the acorn:init command. The first initializes default paths. The second initializes config and storage paths with a custom base directory.

```bash
wp acorn acorn:init
```

```bash
wp acorn acorn:init config storage --base=/srv/www/example.com
```

--------------------------------

### AcornInstallCommand signature and methods

Source: https://github.com/roots/acorn

Defines the acorn:install command signature and its protected methods. The installer prompts for autoload dump script, initialization, and starring the repo, each bypassed with --no-interaction or forced with --autoload/--init. Returns static::SUCCESS (0).

```php
protected $signature = 'acorn:install
                        {--autoload : Install the Acorn autoload dump script}
                        {--init : Initialize Acorn}';

public function handle(): int;
protected function askToInstallScript();
protected function installAutoloadDump();
protected function askToInitialize();
protected function askToStar();
```

--------------------------------

### withMiddleware example with WordPress and alias

Source: https://github.com/roots/acorn

Customizes middleware by appending a WordPress middleware and adding an alias for signed routes. The callback receives a Roots\Acorn\Configuration\Middleware instance.

```php
Application::configure()
    ->withMiddleware(function (Roots\Acorn\Configuration\Middleware $middleware) {
        $middleware->wordpress(append: My\Middleware\CacheHeaders::class);
        $middleware->alias('signed', ValidateSignature::class);
    })
    ->boot();
```

--------------------------------

### withRouting example with WordPress

Source: https://github.com/roots/acorn

Configures routing with a custom web routes file and enables WordPress request handling. The wordpress parameter triggers handleWordPressRequests() on the application.

```php
use Roots\Acorn\Application;

Application::configure()
    ->withRouting(
        web: 'routes/web.php',
        wordpress: true,
    )
    ->boot();
```

--------------------------------

### Example composer with data and overrides

Source: https://github.com/roots/acorn

Example composer class extending `Roots\Acorn\View\Composer`. `with()` provides navigation data, `override()` sets a title, and `$except` excludes 'secret' from extraction.

```php
namespace App\View\Composers;

use Roots\Acorn\View\Composer;

class Navigation extends Composer
{
    protected $except = ['secret'];

    public function with(): array
    {
        return ['nav' => get_nav_menu_items('primary')];
    }

    public function override(): array
    {
        return ['title' => get_the_title()];
    }
}
```

--------------------------------

### Global view() usage example

Source: https://github.com/roots/acorn

Example of using the global view() helper to render a view with data.

```php
echo view('posts.card', ['post' => $post]);
```

--------------------------------

### closest() example - find composer.json or .env

Source: https://github.com/roots/acorn

Walks up the directory tree from the given path, returning the first existing {dir}/{file} path or null when none is found. Respects open_basedir and requires directory readability.

```php
use Roots\Acorn\Filesystem\Filesystem;

$files = new Filesystem();

$composerJson = $files->closest(get_theme_file_path(), 'composer.json');
$envPath      = $files->closest(getcwd(), '.env');   // null when absent
```

--------------------------------

### asset() usage examples

Source: https://github.com/roots/acorn

Shows how to call asset() with default and named manifests. The returned object reports existence; use $style->exists() to check and fall back to $style->uri().

```php
use Roots\asset;

$style = asset('styles/app.css');                 // default manifest
$logo  = asset('logo.svg', 'customManifest');     // named manifest

// error handling: the returned object reports existence
if (! $style->exists()) {
    // fall back to the raw key $style->uri()
}
```

--------------------------------

### bundle() function example

Source: https://github.com/roots/acorn

Enqueues a bundle by its ID using the default manifest. Throws BundleNotFoundException if the bundle is not in the manifest.

```php
use Roots\bundle;

add_action('wp_enqueue_scripts', fn () => bundle('app')->enqueue());
```

--------------------------------

### Blade component class example

Source: https://github.com/roots/acorn

Example Blade component class extending Roots\Acorn\View\Component, using the view() method to render a component view.

```php
namespace App\View\Components;

use Roots\Acorn\View\Component;

class Alert extends Component
{
    public function __construct(public string $type = 'info') {}

    public function render()
    {
        return $this->view('components.alert', ['type' => $this->type]);
    }
}
```

--------------------------------

### Custom base path and routing with configure()

Source: https://github.com/roots/acorn

Configures Acorn with a custom base path and routing, enabling web routes and WordPress integration. Must be chained with ->boot() to start the application.

```php
$app = Roots\Acorn\Application::configure(get_template_directory())
    ->withRouting(
        web: 'routes/web.php',
        wordpress: true,
    )
    ->boot();
```

--------------------------------

### Basic asset usage

Source: https://github.com/roots/acorn

Shows how to create an asset via the asset() helper and access its URI, path, and existence. The output comments show example values.

```php
use Roots\asset;

$style = asset('styles/app.css');

echo $style;                          // https://example.com/app/themes/sage/public/styles/app.css
echo $style->path();                  // /srv/www/example.com/web/app/themes/sage/public/...
var_dump($style->exists());           // bool
```

--------------------------------

### PhpAsset usage example

Source: https://github.com/roots/acorn

Loads a PHP config asset using requireOnce() and handles a missing file with require() in a try-catch block.

```php
use Roots\Acorn\Assets\Asset\PhpAsset;

$config = (new PhpAsset('/app/theme-options.php', '/theme-options.php'))->requireOnce();

try {
    $config = (new PhpAsset('/missing.php', '/missing.php'))->require();
} catch (Illuminate\Contracts\Filesystem\FileNotFoundException $e) {
    // handle missing asset
}
```

--------------------------------

### getRelativePath() example

Source: https://github.com/roots/acorn

Returns the ../-relative path from basePath to targetPath. Equal paths yield '' and Windows drive-relative results are prefixed with './'.

```php
$files->getRelativePath('/app/theme/', '/app/theme/views/partials/header.blade.php');
// 'views/partials/header.blade.php'
```

--------------------------------

### HandleExceptions class with methods

Source: https://github.com/roots/acorn

Overrides the foundation exception bootstrapper. bootstrap() reserves memory and installs handlers only when debugging is enabled and no custom handler exists. handleError() delegates to parent, re-throws caught Throwable unless the acorn/throw_error_exception filter returns false. isDebug() checks config('app.debug', WP_DEBUG). hasHandler() checks for a fatal-error-handler.php file. renderHttpResponse() flushes output buffers before rendering.

```php
class HandleExceptions extends FoundationHandleExceptionsBootstrapper
{
    public function bootstrap(Application $app);
    public function handleError($level, $message, $file = '', $line = 0, $context = []);  // @throws \ErrorException
    protected function isDebug();
    protected function hasHandler();
    protected function renderHttpResponse(Throwable $e);
}
```

--------------------------------

### Access Sage container with app('sage')

Source: https://github.com/roots/acorn

Retrieves the Sage instance from the container. The commented lines show an example of registering a filter hook using the Sage filter helper.

```php
$sage = app('sage');

// Registered hook pairs, e.g.:
// add_filter('body_class', app('sage')->filter('body_class'), 10);
```

--------------------------------

### RootsBudMiddleware class definition

Source: https://github.com/roots/acorn

Class skeleton for RootsBudMiddleware. Constructor accepts an optional dev origin; handle() transforms the manifest config. Companion setup requires Bud to write hmr.json and send the X-Bud-Dev-Origin header during development.

```php
class RootsBudMiddleware
{
    protected $devOrigin;

    public function __construct(?string $devOrigin = null);
    public function handle($config);
    protected function getBudDevUri(string $path): ?string;
    protected function getDevOriginHeader();
}
```

--------------------------------

### create() / boot()

Source: https://github.com/roots/acorn

Finalizes the application configuration. create() returns the underlying Application instance, while boot() boots the Acorn application with the recorded configuration.

```APIDOC
## create() / boot()

### Description
- `create()` — returns the underlying `Roots\Acorn\Application`.
- `boot()` — returns `$this->app->bootAcorn($this->config)` (the booted `Application`).

### Method
create / boot

### Parameters
None

### Response
- `create()`: Returns `Roots\Acorn\Application`.
- `boot()`: Returns the booted `Application`.
```

--------------------------------

### JsonAsset toArray example

Source: https://github.com/roots/acorn

Demonstrates loading a JSON asset and accessing its decoded array data. Uses the toArray() method to get the contents as an array.

```php
use Roots\Acorn\Assets\Asset\JsonAsset;

$data = (new JsonAsset('/path/to/data.json', '/data.json'))->toArray();
echo $data['title'];
```

--------------------------------

### Example using AcfFields trait in a composer

Source: https://github.com/roots/acorn

Example composer class using the AcfFields trait to expose fields in the view data.

```php
use Roots\Acorn\View\Composer;
use Roots\Acorn\View\Composers\Concerns\AcfFields;

class About extends Composer
{
    use AcfFields;

    public function with(): array
    {
        return ['fields' => $this->fields()];
    }
}
```

--------------------------------

### Standard WordPress bootstrap with configure()->boot()

Source: https://github.com/roots/acorn

Boots Acorn with default configuration, as used by the bin/acorn script. Chains the static factory to bootAcorn().

```php
Roots\Acorn\Application::configure()->boot();
```

--------------------------------

### withProviders(array $providers = [], bool $withBootstrapProviders = true)

Source: https://github.com/roots/acorn

Registers additional service providers and optionally merges bootstrap providers. Records the providers in the builder configuration.

```APIDOC
## withProviders(array $providers = [], bool $withBootstrapProviders = true)

### Description
Merges into the `RegisterProviders` bootstrap state and records them in the builder config. Returns `$this`.

### Method
withProviders

### Parameters
#### Parameters
- **$providers** (array) - Optional - Default: `[]` - Additional service provider class names.
- **$withBootstrapProviders** (bool) - Optional - Default: `true` - When true, merges providers found in the bootstrap providers path (`getBootstrapProvidersPath()`).

### Response
Returns `$this` (ApplicationBuilder instance).
```

--------------------------------

### ComposerScripts clearCompiled override

Source: https://github.com/roots/acorn

Extends Illuminate\Foundation\ComposerScripts and overrides the clearCompiled hook to run acorn config:clear before clear-compiled. Registered with Composer as Roots\Acorn\ComposerScripts::postAutoloadDump, installed by acorn:install.

```php
class ComposerScripts extends FoundationComposerScripts
{
    protected static function clearCompiled()
    {
        $console = new Console(new Filesystem(), getcwd());

        $console->configClear();
        $console->clearCompiled();
    }
}
```

--------------------------------

### AcornInitCommand methods

Source: https://github.com/roots/acorn

Constructor and methods for the acorn:init command. handle() throws Exception. initPath() creates directories and calls usePaths(). createPath() ensures directory existence and copies stub contents.

```php
public function __construct(Filesystem $files, Application $app);
public function handle();            // @throws Exception
protected function defaultPaths();
protected function initPath($key, $path);
protected function createPath($path);
```

--------------------------------

### AcornInitCommand signature and description

Source: https://github.com/roots/acorn

Signature and description for the acorn:init command. Accepts a repeatable path argument and a --base option. Initializes required paths in the base directory.

```php
protected $signature = <<<'SIGNATURE'
    acorn:init
    {path?* : Application path to initialize in the base directory}
    {--base= : Application base directory}
    SIGNATURE;

protected $description = 'Initializes required paths in the base directory.';
```

--------------------------------

### Static Factory: configure()

Source: https://github.com/roots/acorn

Creates an ApplicationBuilder instance pre-wired with paths, kernels, events, commands, providers, middleware, and exceptions. Conventionally chained to `->boot()` to bootstrap the application.

```APIDOC
## Static Factory: configure()

### Description
Creates an ApplicationBuilder instance pre-wired with paths, kernels, events, commands, providers, middleware, and exceptions. Conventionally chained to `->boot()` to bootstrap the application.

### Method
Static Factory

### Signature
```php
public static function configure(?string $basePath = null)
```

### Parameters
- `$basePath` (string|null) - Optional - Explicit base path; when omitted, `ApplicationBuilder::inferBasePath()` is used.

### Returns
`Roots\Acorn\Configuration\ApplicationBuilder`

### Examples
Standard WordPress bootstrap:
```php
Roots\Acorn\Application::configure()->boot();
```

Custom base path plus routing:
```php
$app = Roots\Acorn\Application::configure(get_template_directory())
    ->withRouting(
        web: 'routes/web.php',
        wordpress: true,
    )
    ->boot();
```
```

--------------------------------

### SvgAsset usage example

Source: https://github.com/roots/acorn

Creates an SvgAsset instance and outputs its data URL, which includes the SVG mediatype.

```php
use Roots\Acorn\Assets\Asset\SvgAsset;

$svg = new SvgAsset('/path/to/icon.svg', '/img/icon.svg');
echo $svg->dataUrl();   // data:image/svg+xml;charset=UTF-8,...
```

--------------------------------

### withMiddleware(?callable $callback = null)

Source: https://github.com/roots/acorn

Applies middleware configuration to the HTTP kernel after it resolves, including global middleware, groups, aliases, and priority settings. Returns the builder instance.

```APIDOC
## withMiddleware(?callable $callback = null)

### Description
After the HTTP kernel resolves, applies the middleware configuration: global middleware, groups, aliases, priority, and priority appends/prepends, via the kernel's `setGlobalMiddleware()`, `setMiddlewareGroups()`, `setMiddlewareAliases()`, `setMiddlewarePriority()`, `addToMiddlewarePriorityAfter()`, `addToMiddlewarePriorityBefore()` methods. Returns `$this`.

### Method
withMiddleware

### Parameters
#### Parameters
- **$callback** (callable|null) - Optional - Default: `null` - Receives a fresh `Roots\Acorn\Configuration\Middleware` instance for customization.

### Response
Returns `$this` (ApplicationBuilder instance).

### Request Example
```php
Application::configure()
    ->withMiddleware(function (Roots\Acorn\Configuration\Middleware $middleware) {
        $middleware->wordpress(append: My\Middleware\CacheHeaders::class);
        $middleware->alias('signed', ValidateSignature::class);
    })
    ->boot();
```
```

--------------------------------

### GetsFreshApplication trait methods

Source: https://github.com/roots/acorn

Rebuilds a fresh Application from the current booted instance, preserving class, base path, configured paths, providers, and routing options, then boots it. getFreshConfiguration additionally bootstraps the console kernel and returns all config.

```php
trait GetsFreshApplication
{
    protected function getFreshApplication();
    protected function getFreshConfiguration();
    protected function getApplicationPaths(Application $app);
}
```

--------------------------------

### Blade usage of global asset()

Source: https://github.com/roots/acorn

Example of using the global asset() helper inside a Blade template to output a script tag.

```blade
<script src="{{ asset('scripts/app.js') }}"></script>
```

--------------------------------

### bootloader() function implementation

Source: https://github.com/roots/acorn

Deprecated. Boots and returns the application. Use Application::configure()->boot() instead.

```php
function bootloader(?ApplicationContract $app = null): Application
{
    return Application::configure()->boot();
}
```

--------------------------------

### Resolve a package for a provider

Source: https://github.com/roots/acorn

Example usage of getPackage() to retrieve the composer package name for a given provider. Returns an empty string if not found.

```php
use Roots\Acorn\PackageManifest;

$package = app(PackageManifest::class)->getPackage('App\\Providers\\AppServiceProvider');

if ($package) {
    // $package is the composer package name, e.g. 'roots/sage'
}
```

--------------------------------

### withKernels()

Source: https://github.com/roots/acorn

Registers the Acorn HTTP and Console kernels as singletons in the application container. Returns the builder instance for chaining.

```APIDOC
## withKernels()

### Description
Registers the Acorn kernels as singletons:
- `Illuminate\Contracts\Http\Kernel` → `Roots\Acorn\Http\Kernel`
- `Illuminate\Contracts\Console\Kernel` → `Roots\Acorn\Console\Kernel`

Returns `$this`.

### Method
withKernels

### Parameters
None

### Response
Returns `$this` (ApplicationBuilder instance).
```

--------------------------------

### Constructor: __construct($basePath = null)

Source: https://github.com/roots/acorn

Creates a new Acorn application instance. Resolves the environment path, loads global helpers, and delegates to the parent constructor.

```APIDOC
## Constructor: __construct($basePath = null)

### Description
Creates a new Acorn application instance. Resolves the environment path, loads global helpers, and delegates to the parent constructor.

### Method
Constructor

### Signature
```php
public function __construct($basePath = null)
```

### Parameters
- `$basePath` (string|null) - Optional - Base path of the application. When given, trailing slashes are trimmed and stored in `$this->basePath`.

### Example
```php
$app = new Roots\Acorn\Application(get_theme_file_path());
```
```

--------------------------------

### Typical kernel usage from trait Bootable

Source: https://github.com/roots/acorn

Shows how to instantiate the console kernel and handle an incoming console command, then terminate and exit with the status code.

```php
$kernel = $this->make(ConsoleKernelContract::class);
$status = $kernel->handle($input = new ArgvInput(), new ConsoleOutput());
$kernel->terminate($input, $status);
exit($status);
```

--------------------------------

### ServiceProvider class definition

Source: https://github.com/roots/acorn

Defines the final ServiceProvider class that extends Illuminate\Support\ServiceProvider and provides a static method to get default providers.

```php
final class ServiceProvider extends ServiceProviderBase
{
    public static function defaultProviders()
    {
        return new DefaultProviders();
    }
}
```

--------------------------------

### handleWordPressRequests()

Source: https://github.com/roots/acorn

Sets an internal flag to register the WordPress catch-all route during HTTP boot. Returns the application instance for chaining.

```APIDOC
## handleWordPressRequests()

### Description
Sets an internal flag to register the WordPress catch-all route during HTTP boot. Returns the application instance for chaining.

### Method
handleWordPressRequests

### Return Value
- `$this` (self) - The application instance.
```

--------------------------------

### withPaths($app, $config, $storage, $resources, $public, $bootstrap, $lang, $database)

Source: https://github.com/roots/acorn

Configures the application paths for various directories. This method is part of the ApplicationBuilder chain and allows setting custom paths for app, config, storage, resources, public, bootstrap, lang, and database directories.

```APIDOC
## withPaths($app, $config, $storage, $resources, $public, $bootstrap, $lang, $database)

### Description
Configures the application paths for various directories. This method is part of the ApplicationBuilder chain and allows setting custom paths for app, config, storage, resources, public, bootstrap, lang, and database directories.

### Method
Builder chain method

### Parameters
- `$app` (string) - Required - Path to the app directory
- `$config` (string) - Required - Path to the config directory
- `$storage` (string) - Required - Path to the storage directory
- `$resources` (string) - Required - Path to the resources directory
- `$public` (string) - Required - Path to the public directory
- `$bootstrap` (string) - Required - Path to the bootstrap directory
- `$lang` (string) - Required - Path to the lang directory
- `$database` (string) - Required - Path to the database directory

### Response
Returns the ApplicationBuilder instance for chaining.
```

--------------------------------

### Typical kernel usage in Bootable::bootHttp()

Source: https://github.com/roots/acorn

Resolves the HTTP kernel from the container, bootstraps it with the request, then handles, sends, and terminates the response.

```php
// inside trait Bootable::bootHttp()
$kernel = $this->make(HttpKernelContract::class);
$kernel->bootstrap($request);

// ... later, when WordPress yields control:
$response = $kernel->handle($request);
$response->send();
$kernel->terminate($request, $response);
```

--------------------------------

### defaultPaths() builds path array

Source: https://github.com/roots/acorn

Returns default application paths for app, config, storage, resources, public, lang, database, and bootstrap. Bootstrap defaults to storage/framework.

```php
$paths = [];
foreach (['app', 'config', 'storage', 'resources', 'public', 'lang', 'database'] as $path) {
    $paths[$path] = $this->normalizeApplicationPath($path);
}
$paths['bootstrap'] = $this->normalizeApplicationPath($path, "{$paths['storage']}/framework");
```

--------------------------------

### Cached composer example using Cacheable

Source: https://github.com/roots/acorn

Shows a composer that caches data for 60 minutes using the Cacheable trait. The with() method returns cached data via cache('popular-posts', callable).

```php
use Roots\Acorn\View\Composer;
use Roots\Acorn\View\Composers\Concerns\Cacheable;

class PopularPosts extends Composer
{
    use Cacheable;

    protected $cache_expiration = 60;

    public function with(): array
    {
        return $this->cache('popular-posts', fn () => [
            'posts' => get_posts(['posts_per_page' => 5, 'orderby' => 'comment_count']),
        ]);
    }
}
```

--------------------------------

### Paths::defaultPaths()

Source: https://github.com/roots/acorn

Returns the default application paths for app, config, storage, resources, public, lang, database, and bootstrap. The bootstrap path defaults to the storage path plus '/framework'.

```APIDOC
## `defaultPaths()`

### Description
Returns the default application paths:

```php
$paths = [];
foreach (['app', 'config', 'storage', 'resources', 'public', 'lang', 'database'] as $path) {
    $paths[$path] = $this->normalizeApplicationPath($path);
}
$paths['bootstrap'] = $this->normalizeApplicationPath($path, "{$paths['storage']}/framework");
```

### Method
Instance method

### Returns
- **array** - Associative array of default paths
```

--------------------------------

### Iterate a bundle without enqueueing

Source: https://github.com/roots/acorn

Uses the Roots\bundle helper to get a bundle and iterate over CSS source URLs, printing each with a newline. The css() method returns a Collection when no callable is passed.

```php
use Roots\bundle;

$bundle = bundle('app');

$bundle->css()->each(fn ($src) => print($src . PHP_EOL));
```

--------------------------------

### usePaths(array $paths)

Source: https://github.com/roots/acorn

Batch configures paths. Supported keys: app, bootstrap, config, database, lang, public, resources, storage, environment. Throws an exception for unknown keys.

```APIDOC
## usePaths(array $paths)

### Description
Batch configures paths. Supported keys: app, bootstrap, config, database, lang, public, resources, storage, environment. Throws an exception for unknown keys.

### Method
usePaths

### Parameters
#### Request Body
- `$paths` (array) - Required - Associative array of path types to set.

### Return Value
- `void` - No return value.
```

--------------------------------

### BladeDirective class for @asset directive

Source: https://github.com/roots/acorn

Backs the @asset(...) Blade directive, compiling to <?= \Roots\asset(...); ?>. The example shows usage in a Blade template to output asset URLs.

```php
class BladeDirective
{
    public function __invoke($expression)
    {
        return sprintf('<?= %s(%s); ?>', '\Roots\asset', $expression);
    }
}
```

```blade
<link rel="stylesheet" href="@asset('styles/app.css')">
<script src="@asset('scripts/app.js')" defer></script>
```

--------------------------------

### Sage::__construct

Source: https://github.com/roots/acorn

Constructs a new Sage instance with the required dependencies for filesystem, view finding, view factory, and container.

```APIDOC
## Sage::__construct

### Description
Constructs a new Sage instance with the required dependencies for filesystem, view finding, view factory, and container.

### Method
Constructor

### Signature
```php
public function __construct(
    Filesystem $files,
    ViewFinder $sageFinder,
    FileViewFinder $fileFinder,
    ViewFactory $view,
    ContainerContract $app,
);
```

### Parameters
- `$files` (Roots\Acorn\Filesystem\Filesystem) - Required - Acorn filesystem.
- `$sageFinder` (Roots\Acorn\Sage\ViewFinder) - Required - View locator for template hierarchies.
- `$fileFinder` (Roots\Acorn\View\FileViewFinder) - Required - View name/path conversion.
- `$view` (Illuminate\Contracts\View\Factory) - Required - Blade view factory.
- `$app` (Illuminate\Contracts\Container\Container) - Required - Application container.
```

--------------------------------

### Bootable trait methods

Source: https://github.com/roots/acorn

Methods provided by the Bootable concern for booting Acorn in console, WP-CLI, and HTTP contexts.

```php
public function bootAcorn(array $bootConfiguration = []): static
protected function bootConsole(): void
protected function bootWpCli(): void
protected function bootHttp(): void
protected function enableHttpsInConsole(): void
protected function registerWordPressRoute(int $initialObLevel): void
protected function registerRequestHandler(Request $request, ?\Illuminate\Routing\Route $route): void
public function handleRequest(Request $request): void
public function getBootConfiguration(): array
```

--------------------------------

### bootloader(?ApplicationContract $app = null): Application

Source: https://github.com/roots/acorn

Boots and returns the application. This function is deprecated; use `Application::configure()->boot()` instead.

```APIDOC
## bootloader(?ApplicationContract $app = null): Application

### Description
Boots and returns the application. This function is deprecated; use `Application::configure()->boot()` instead.

### Method
Function call

### Endpoint
`Roots\bootloader()`

### Parameters
- `$app` (ApplicationContract|null) - Optional - Application instance.

### Returns
`Roots\Acorn\Application`

### Deprecation
Use `Application::configure()->boot()` instead.
```

--------------------------------

### Instantiate Application with base path

Source: https://github.com/roots/acorn

Creates a new Acorn application instance using a base path, typically the theme file path. The constructor trims trailing slashes and stores the path in $this->basePath.

```php
$app = new Roots\Acorn\Application(get_theme_file_path());
```

--------------------------------

### ComposerMakeCommand signature and methods

Source: https://github.com/roots/acorn

Defines the make:composer command with its name, description, type, and protected methods. Generates a view composer in App\View\Composers. Options: --force to overwrite, --views to inject space-separated view names into the DummyViews placeholder.

```php
protected $name = 'make:composer';
protected $description = 'Create a new view composer class';
protected $type = 'Composer';

protected function getStub();                // stubs/composer.stub
protected function getDefaultNamespace($rootNamespace);  // {root}\View\Composers
protected function buildClass($name);        // @throws FileNotFoundException
protected function replaceViews($stub, $views);
protected function getOptions();             // --force, --views
```

--------------------------------

### __construct(Filesystem $files, array $composerPaths, $manifestPath)

Source: https://github.com/roots/acorn

Initializes the PackageManifest with a filesystem instance, an array of composer paths to scan, and the path where the cached manifest will be written. The composer paths are typically assembled from the 'acorn/composer_paths' filter and active plugins.

```APIDOC
## __construct(Filesystem $files, array $composerPaths, $manifestPath)

### Description
Initializes the PackageManifest with a filesystem instance, an array of composer paths to scan, and the path where the cached manifest will be written. The composer paths are typically assembled from the 'acorn/composer_paths' filter and active plugins.

### Parameters
- **$files** (Illuminate\Filesystem\Filesystem) - Required - Filesystem (Acorn's `Filesystem` subtype).
- **$composerPaths** (string[]) - Required - Composer-json directories to scan (theme root, content root, base path, plugin dirs).
- **$manifestPath** (string) - Required - Where the cached manifest is written (the app's cached packages path).
```

--------------------------------

### withRouting($using, $web, $api, $commands, $channels, $pages, $health, $apiPrefix = 'api', $then, $wordpress = false)

Source: https://github.com/roots/acorn

Configures routing for the application, including web, API, commands, channels, pages, health, and optional WordPress integration. This method is part of the ApplicationBuilder chain.

```APIDOC
## withRouting($using, $web, $api, $commands, $channels, $pages, $health, $apiPrefix = 'api', $then, $wordpress = false)

### Description
Configures routing for the application, including web, API, commands, channels, pages, health, and optional WordPress integration. This method is part of the ApplicationBuilder chain.

### Method
Builder chain method

### Parameters
- `$using` (callable) - Required - Callback to define routes
- `$web` (string) - Required - Path to web routes file
- `$api` (string) - Required - Path to API routes file
- `$commands` (string) - Required - Path to commands routes file
- `$channels` (string) - Required - Path to channels routes file
- `$pages` (string) - Required - Path to pages routes file
- `$health` (string) - Required - Path to health routes file
- `$apiPrefix` (string) - Optional - API route prefix, default 'api'
- `$then` (callable) - Required - Callback after routes are loaded
- `$wordpress` (bool) - Optional - Enable WordPress integration, default false

### Response
Returns the ApplicationBuilder instance for chaining.
```

--------------------------------

### Namespace and version methods

Source: https://github.com/roots/acorn

Methods for detecting and setting the application namespace and retrieving the version string. getNamespace() throws RuntimeException when no PSR-4 namespace matches the app path.

```php
public function getNamespace()   // @throws RuntimeException
protected function getAppComposer(): string
public function useNamespace($namespace)
public function version()
```

--------------------------------

### Customizing boot order by subclassing the kernel

Source: https://github.com/roots/acorn

Shows how to subclass the Acorn HTTP kernel to reorder or substitute bootstrappers, since $bootstrappers is protected.

```php
namespace App\Http;

use Roots\Acorn\Http\Kernel as AcornKernel;

class Kernel extends AcornKernel
{
    protected $bootstrappers = [
        // reorder or substitute bootstrappers here
    ];
}
```

--------------------------------

### getGlobalMiddleware()

Source: https://github.com/roots/acorn

Returns the global middleware stack, applying any prepends, appends, removals, and replacements, then removing duplicates. Defaults include TrustHosts, TrustProxies, HandleCors, ValidatePostSize, and ConvertEmptyStringsToNull, with TrustHosts only if trustHosts is set.

```APIDOC
## getGlobalMiddleware()

### Description
Returns the global middleware stack, applying any prepends, appends, removals, and replacements, then removing duplicates. Defaults include TrustHosts, TrustProxies, HandleCors, ValidatePostSize, and ConvertEmptyStringsToNull, with TrustHosts only if trustHosts is set.

### Method
`getGlobalMiddleware()`

### Returns
- **array** - The global middleware stack.
```

--------------------------------

### getMiddlewareGroups()

Source: https://github.com/roots/acorn

Returns the middleware groups: 'web', 'api', 'wordpress', plus any custom groups. The 'web' group includes AddQueuedCookiesToResponse, StartSession (Acorn), ShareErrorsFromSession, SubstituteBindings, and auth.session when authenticated sessions are enabled. The 'api' group includes EnsureFrontendRequestsAreStateful when statefulApi() is used, throttle:{limiter} when throttleApi() is used, and SubstituteBindings. The 'wordpress' group is the same as 'web'.

```APIDOC
## getMiddlewareGroups()

### Description
Returns the middleware groups: 'web', 'api', 'wordpress', plus any custom groups. The 'web' group includes AddQueuedCookiesToResponse, StartSession (Acorn), ShareErrorsFromSession, SubstituteBindings, and auth.session when authenticated sessions are enabled. The 'api' group includes EnsureFrontendRequestsAreStateful when statefulApi() is used, throttle:{limiter} when throttleApi() is used, and SubstituteBindings. The 'wordpress' group is the same as 'web'.

### Method
`getMiddlewareGroups()`

### Returns
- **array** - The middleware groups.
```

--------------------------------

### withMiddleware($callback)

Source: https://github.com/roots/acorn

Registers middleware for the application. The callback receives a Middleware object that supports various methods for managing middleware.

```APIDOC
## withMiddleware($callback)

### Description
Registers middleware for the application. The callback receives a Middleware object that supports various methods for managing middleware.

### Method
Builder chain method

### Parameters
- `$callback` (callable) - Required - Callback that receives a Middleware object

### Response
Returns the ApplicationBuilder instance for chaining.

### Middleware Object Methods
The Middleware object passed to the callback supports the following methods:
- `append` - Append middleware
- `prepend` - Prepend middleware
- `remove` - Remove middleware
- `replace` - Replace middleware
- `group` - Group middleware
- `alias` - Alias middleware
- `priority` - Set middleware priority
- `appendToPriority` - Append to priority
- `prependToPriority` - Prepend to priority
- `redirectGuestsTo` - Redirect guests to a route
- `redirectUsersTo` - Redirect users to a route
- `authenticatedSessions` - Configure authenticated sessions
- `statefulApi` - Configure stateful API
- `throttleApi` - Configure API throttling
- `trustHosts` - Trust hosts
- `trustProxies` - Trust proxies
- `wordpress(append, prepend, remove, replace)` - WordPress-specific middleware management
```

--------------------------------

### withExceptions($using)

Source: https://github.com/roots/acorn

Configures exception handling for the application. This method is part of the ApplicationBuilder chain.

```APIDOC
## withExceptions($using)

### Description
Configures exception handling for the application. This method is part of the ApplicationBuilder chain.

### Method
Builder chain method

### Parameters
- `$using` (callable) - Required - Callback to configure exception handling

### Response
Returns the ApplicationBuilder instance for chaining.
```

--------------------------------

### build()

Source: https://github.com/roots/acorn

Builds the merged package manifest by scanning each composer path, reading 'vendor/composer/installed.json' and the root 'composer.json', mapping packages to their 'extra.acorn' / 'extra.laravel' configuration, accumulating 'dont-discover' exclusions, and writing the result via write().

```APIDOC
## build()

### Description
Builds the merged package manifest by scanning each composer path, reading 'vendor/composer/installed.json' and the root 'composer.json', mapping packages to their 'extra.acorn' / 'extra.laravel' configuration, accumulating 'dont-discover' exclusions, and writing the result via write().

### Parameters
None.

### Return Value
- **void** - Writes the merged manifest to the manifest path.
```

--------------------------------

### Enable WordPress routing with withRouting

Source: https://github.com/roots/acorn

Configures the Acorn application to register the WordPress catch-all route. Requires the Roots\Acorn\Application class and sets wordpress: true.

```php
use Roots\Acorn\Application;

Application::configure()
    ->withRouting(
        web: 'routes/web.php',
        wordpress: true,          // registers the catch-all
    )
    ->boot();
```

--------------------------------

### view() function implementation

Source: https://github.com/roots/acorn

Returns the view factory when called with no arguments; otherwise makes a view from an existing view name or a file path.

```php
function view($view = null, $data = [], $mergeData = [])
{
    $factory = \app(ViewFactory::class);

    if (func_num_args() === 0) {
        return $factory;
    }

    return $factory->exists($view)
        ? $factory->make($view, $data, $mergeData)
        : $factory->file($view, $data, $mergeData);
}
```

--------------------------------

### withRouting(...)

Source: https://github.com/roots/acorn

Configures route registration for the application, including web, API, console, channels, pages, and health routes. Supports WordPress request handling and custom route callbacks.

```APIDOC
## withRouting(...)

### Description
Delegates to `parent::withRouting(...)`, then records the routing options into the builder config (available to `getBootConfiguration()`).

### Method
withRouting

### Parameters
#### Parameters
- **$using** (Closure|null) - Optional - Default: `null` - Closure receiving the router for custom route registration.
- **$web** (array|string|null) - Optional - Default: `null` - Path to `routes/web.php` — auto-detected from `base_path('routes/web.php')` when omitted.
- **$api** (array|string|null) - Optional - Default: `null` - Path to `routes/api.php`.
- **$commands** (string|null) - Optional - Default: `null` - Path to `routes/console.php`.
- **$channels** (string|null) - Optional - Default: `null` - Path to `routes/channels.php`.
- **$pages** (string|null) - Optional - Default: `null` - Path for Livewire pages.
- **$health** (string|null) - Optional - Default: `null` - Health-check route URI.
- **$apiPrefix** (string) - Optional - Default: `'api'` - Prefix applied to API routes.
- **$then** (callable|null) - Optional - Default: `null` - Callback run after route registration.
- **$wordpress** (bool) - Optional - Default: `false` - When `true`, enables WordPress request handling on the application (`handleWordPressRequests()`).

### Response
Returns `$this` (ApplicationBuilder instance).

### Request Example
```php
use Roots\Acorn\Application;

Application::configure()
    ->withRouting(
        web: 'routes/web.php',
        wordpress: true,
    )
    ->boot();
```
```

--------------------------------

### packageDiscover()

Source: https://github.com/roots/acorn

Runs the `acorn package:discover` command and returns the process exit code.

```APIDOC
## packageDiscover()

### Description
Runs the `acorn package:discover` command and returns the process exit code.

### Method
`packageDiscover()`

### Return Value
`int` - Process exit code.
```

--------------------------------

### withCommands()

Source: https://github.com/roots/acorn

Registers console commands for the application. This method is part of the ApplicationBuilder chain.

```APIDOC
## withCommands()

### Description
Registers console commands for the application. This method is part of the ApplicationBuilder chain.

### Method
Builder chain method

### Parameters
None

### Response
Returns the ApplicationBuilder instance for chaining.
```

--------------------------------

### Register WordPress catch-all route

Source: https://github.com/roots/acorn

Registers the catch-all 'wordpress' route with the 'wordpress' middleware. The route matches any path and returns an empty response.

```php
Route::any('{any?}', fn () => tap(response(''), function (Response $response) use ($initialObLevel) { ... }))
    ->middleware('wordpress')
    ->where('any', '.*')
    ->name('wordpress');
```

--------------------------------

### bootstrapPath($path = '')

Source: https://github.com/roots/acorn

Returns the bootstrap path, which is storagePath('framework') plus the given path unless a custom bootstrap path was set.

```APIDOC
## bootstrapPath($path = '')

### Description
Returns the bootstrap path, which is storagePath('framework') plus the given path unless a custom bootstrap path was set.

### Method
bootstrapPath

### Parameters
#### Query Parameters
- `$path` (string) - Optional - The path to append.

### Return Value
- `string` - The full bootstrap path.
```

--------------------------------

### __construct(string $id, array $bundle, string $path, string $uri = '/')

Source: https://github.com/roots/acorn

Creates a new Bundle instance, normalizing the bundle definition and extracting a webpack-style runtime chunk. The constructor sets up the bundle ID, file paths, and URI prefix used for enqueueing.

```APIDOC
## __construct(string $id, array $bundle, string $path, string $uri = '/')

### Description
Creates a new Bundle instance, normalizing the bundle definition and extracting a webpack-style runtime chunk. The constructor sets up the bundle ID, file paths, and URI prefix used for enqueueing.

### Method
Constructor

### Parameters
#### Parameters
- **$id** (string) - Required - Bundle ID (used in enqueue handles as `{id}/{handle}`).
- **$bundle** (array) - Required - Bundle definition; keys include `js` (list or assoc), `mjs`, `css`, `dependencies`. Missing arrays default to `[]`.
- **$path** (string) - Required - Local path prefix for files.
- **$uri** (string) - Optional - Default: `'/'` - Remote URI prefix for files.

### Response
No return value.
```

--------------------------------

### Exceptions class extends FoundationExceptions

Source: https://github.com/roots/acorn

Empty subclass of Illuminate\Foundation\Configuration\Exceptions. Inherits all configuration methods (e.g., report, render, respond, shouldRenderJsonWhen, dontReport, dontFlash, level, stopIgnoring). Passed to the withExceptions() callback.

```php
class Exceptions extends FoundationExceptions
{
    //
}
```

--------------------------------

### Paths::normalizeApplicationPath()

Source: https://github.com/roots/acorn

Protected method that resolves a path by checking environment variables, constants, and existing directories. Returns the normalized path string.

```APIDOC
## `normalizeApplicationPath()`

### Description
Protected. Resolves, in order: the `ACORN_{KEY}_PATH` environment variable (absolute, or relative to `basePath()`), the `ACORN_{KEY}_PATH` constant, then `findPath()`. `findPath()` returns the first existing directory among the app's current value (`appPath()` / `{path}Path()`), `basePath($path)`, and `get_theme_file_path($path)`, falling back to `fallbackPath()` (`storage` → WordPress-content cache directory, see below).

### Method
Protected instance method

### Parameters
- **path** (string) - Required - The path key to normalize
- **default** (?string) - Optional - Default value if path cannot be resolved

### Returns
- **string** - The normalized path
```

--------------------------------

### environmentPath()

Source: https://github.com/roots/acorn

Returns the directory containing the closest .env file walked up from the base path, or the base path if none exists.

```APIDOC
## environmentPath()

### Description
Returns the directory containing the closest .env file walked up from the base path, or the base path if none exists.

### Method
environmentPath

### Return Value
- `string` - The directory path.
```

--------------------------------

### withKernels()

Source: https://github.com/roots/acorn

Registers the application kernels. This method is part of the ApplicationBuilder chain.

```APIDOC
## withKernels()

### Description
Registers the application kernels. This method is part of the ApplicationBuilder chain.

### Method
Builder chain method

### Parameters
None

### Response
Returns the ApplicationBuilder instance for chaining.
```

--------------------------------

### editorStyles()

Source: https://github.com/roots/acorn

Registers each stylesheet with WordPress's add_editor_style(). External sources are passed as-is, while manifest sources are converted to theme-relative paths.

```APIDOC
## editorStyles()

### Description
Registers each stylesheet with WordPress's add_editor_style(). External sources are passed as-is, while manifest sources are converted to theme-relative paths.

### Method
editorStyles

### Returns
$this

### Example
```php
bundle('app')->editorStyles()
```
```

--------------------------------

### config/app.php providers array using ServiceProvider::defaultProviders()

Source: https://github.com/roots/acorn

Shows how to configure the providers array in config/app.php by merging default providers with package, application, and added service providers.

```php
'providers' => ServiceProvider::defaultProviders()->merge([
    // Package Service Providers...
])->merge([
    // Application Service Providers...
])->merge([
    // Added Service Providers (Do not remove this line)...
])->toArray(),
```

--------------------------------

### Publish configs command

Source: https://github.com/roots/acorn

Command to publish Acorn configuration files using the acorn-configs tag.

```bash
wp acorn vendor:publish --tag=acorn-configs
```

--------------------------------

### VendorPublishCommand extends base and overrides publishItem and callAcornInit

Source: https://github.com/roots/acorn

Extends Laravel's VendorPublishCommand. When a publish target lives under the Acorn package directory, the target is remapped to the app base path and acorn:init is invoked first (with confirmation) if the target directory does not exist. Throws an exception if confirmation is declined.

```php
class VendorPublishCommand extends FoundationVendorPublishCommand
{
    protected function publishItem($from, $to);
    protected function callAcornInit($from, $to);
}
```

--------------------------------

### Component view() method implementation

Source: https://github.com/roots/acorn

Implementation of the view() method that calls the Roots\view() helper with the same signature semantics.

```php
public function view($view = null, $data = [], $mergeData = [])
{
    return view($view, $data, $mergeData);
}
```
Tokens:
Raw