Admin

Install

composer require pushword/admin

The default installer wires the bundle automatically. Custom installations can use vendor/pushword/admin/install.php as a reference.

The admin is available at https://example.com/admin/.

Create a user with ROLE_SUPER_ADMIN if the project does not have one:

php bin/console pw:user:create

For block-based editing, install the Admin Block Editor.

Editing a page

The body is edited in Monaco, with a toolbar above it and a word/line count below. Formatting is a toggle: pressing a button a second time removes what it added, and with nothing selected it applies to the word under the cursor.

Pasting a URL onto selected text links that text instead of replacing it. The toolbar’s last two buttons open the editor fullscreen and the markdown cheatsheet.

The same editor, toolbar included, backs the markdown mode of admin-block-editor.

Parent page

In the settings panel, search by page title, slug, path or a URL on a configured host. Choices show the title and host/path separately; an exact slug comes before its children and other matches. Only pages on the edited page’s host are offered, and the page cannot be its own parent.

Saving and recovering changes

Ctrl+S saves without leaving the form. There is no timed autosave: a save publishes (it rewrites the flat markdown, regenerates the Open Graph image, purges the static cache, and turns a half-typed slug into a redirect page).

Instead, while you type, the form state is kept in your browser’s localStorage, and reopening the page offers it back:

You left unsaved changes here 7 minutes ago, kept in this browser. Restore them · Discard

Restore them puts back only the fields you had changed (body included), without saving; untouched fields keep the page’s current values. If someone saved one of your fields since, the offer says so:

You left unsaved changes here 7 minutes ago, kept in this browser. The page has been saved since, on fields you changed: restoring puts your version back over it.

The copy is dropped on a successful save or on Discard. It stays in that browser, is offered only to the account that typed it, and is cleared on sign-out. It is unrelated to the Draft toggle (a publication state stored in the database).

A site overriding @pwAdmin/page/edit.html.twig has to carry over the unsaved_changes_banner.html.twig include and the form’s data-pw-unsaved-key attribute, or the recovery has nowhere to render.

Customize the admin

Admin is built on EasyAdmin. Page, redirection, media and user form fields are configuration-driven; list and search fields are not.

You can also customize the admin menu to add, remove or reorder menu items.

Inspect the effective configuration instead of copying defaults that may change:

php bin/console debug:config pushword_admin

Override admin_page_form_fields, admin_redirection_form_fields, admin_media_form_fields or admin_user_form_fields in pushword_admin. Bundles can alter the resolved lists with the pushword.admin.load_field event; the Admin Block Editor is an example.

You can customize fields per site, but when creating a new page, Pushword does not yet know its site and uses the first site’s configuration (or the global configuration).

Writing a page form field

A field is a class extending Pushword\Admin\FormField\AbstractField, whose getEasyAdminField() returns the EasyAdmin field to render. The three association fields — parent page, variant of, translations — are autocompletes: their candidates come from EasyAdmin’s autocomplete endpoint as you type.

If your field filters its candidates on the page being edited (“not myself”, “same host”), read that page with Pushword\Admin\FormField\PageFormSubjectTrait, not $this->admin->getSubject(): EasyAdmin rebuilds the fields against an empty subject to answer an autocomplete request, so the list would offer the page itself and every host’s pages.

use Pushword\Admin\FormField\PageFormSubjectTrait;

class MyPageField extends AbstractField
{
    use PageFormSubjectTrait;

    public function getEasyAdminField(): ?FieldInterface
    {
        $page = $this->pageFormSubject();

        return AssociationField::new('myAssociation')
            ->onlyOnForms()
            ->setCrudController(PageCrudController::class)
            ->autocomplete()
            ->setQueryBuilder(fn (QueryBuilder $qb): QueryBuilder => $qb
                ->andWhere('entity.host = :host')
                ->setParameter('host', $page->host));
    }
}

->setCrudController(PageCrudController::class)->autocomplete() is what makes the field fetch on demand; without it every candidate page is hydrated whole, mainContent included, to build a <select>.