Skip to content

Update package development docs with configure script #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
retlehs wants to merge 1 commit into
base: docs
Choose a base branch
from
Open

Update package development docs with configure script #565

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions acorn/package-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date_modified: 2025-10-06 17:00
date_modified: 2026-03-05 12:00
date_published: 2021-10-21 13:21
title: Developing Packages for Acorn
description: Use the Acorn Example Package as a template for creating custom packages and reusable functionality for WordPress with Laravel architecture.
Expand All @@ -24,6 +24,24 @@ We recommend referencing the [Laravel docs on Packages](https://laravel.com/docs

From the [roots/acorn-example-package](https://github.com/roots/acorn-example-package) repo, click the **Use this template** button to create a new repo with the template.

After cloning your new repo, run the configure script to replace the placeholder names with your own:

```shell
$ php configure.php
```

The script will prompt you for your vendor name, package name, namespace, and other details. You can also run it non-interactively:

```shell
$ php configure.php --no-interaction --author-name="Your Name" --author-email="you@example.com" --vendor-slug="your-vendor" --vendor-namespace="YourVendor" --package-slug="your-package" --class-name="YourPackage" --package-description="Your package description"
```

To preview changes without modifying any files, use `--dry-run`:

```shell
$ php configure.php --dry-run
```

## Developing an Acorn package

Once your package is created, clone your new git repo somewhere on your machine that's accessible from a WordPress site with Acorn installed. To work on a package locally, you can require it by defining a new local repository from the `composer.json` file used for your site/theme:
Expand Down Expand Up @@ -58,6 +76,6 @@ $ wp acorn package:discover
roots/sage ....................... DONE
```

::: warning
We have plans to [automate replacing the placeholders in the example package](https://github.com/roots/acorn/issues/271) in the future
::: tip
If you haven't already, run `php configure.php` from the root of your package to replace the placeholder names
:::