docs.modx.pro
  1. Extras
  2. PageBuilder
  3. Recipes
  4. Shared blocks

Shared blocks ​

Result: an edit to the master shows up on linked pages. Requires PageBuilder Pro and capability library (a shared section library).

Before you start ​

  1. Two published resources whose template contains [[!PageBuilder]].
  2. Capability library is on.
  3. The source page already has a filled section.

Steps ​

  1. Build the section on the source page.
  2. Save as shared block. The current section is linked to the master at once (libraryLocalFields is empty).
  3. On the other page open Pull from another page. The source is the draft, not the published copy.
  4. Link rewrites the source section into a shared block and clears its fields. The content stays on the master. The target gets libraryId, linked, and an empty libraryLocalFields. The source resource needs the save permission. Copy inserts sections with no link.
  5. Mark fields that should differ per page in the local-fields checklist (settings.libraryLocalFields).
  6. Save on the resource publishes the page. Matching fields write to the master on pbOnBeforeSave.

The catalog tab Shared blocks stays visible when the list is empty. Insert from there always links the section to the master (libraryId, linked, empty data). A copy with no link exists only in Copy mode.

On the site the master merges with local fields. Without libraryLocalFields, local keys override the master. A Library write clears the pagebuilder/* HTML cache.

Example fields ​

Source section hero, Title Shared heading. After Save as shared block the local-fields list is empty, so the title is shared.

On the second page choose Link. In settings.libraryLocalFields mark title when that page needs its own heading. The other fields stay on the master. Copy inserts the same hero with no libraryId.

What to check ​

Change a master field that is not in libraryLocalFields and save the source resource. The linked page shows the same value. A field on the local list of the second page is left as you set it.

Rollback ​

Pull with Copy, or delete the library item in the CMP. Processor: mgr/library/pull.

See also ​