Download the PHP package pantheon-systems/pantheon-content-publisher-wordpress without Composer

Pantheon Content Publisher for WordPress

Contributors: getpantheon, a11rew, anaispantheor, roshnykunjappan, mklasen, jazzs3quence, swb1192 Tags: pantheon, content, google docs, acf Requires at least: 5.7
Tested up to: 6.9
Stable tag: 1.4.0-dev
Requires PHP: 8.1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Pantheon Content Publisher

Publish WordPress content from Google Docs with Pantheon Content Cloud.
Report bug · Request feature · Check out PCC Docs

Table of contents

• Table of contents
• Quick start
• Custom post types
• ACF Integration
• Development
• Repository Actions
• Requirements
• Bugs and feature requests
• Documentation
• Versioning
• Changelog

Quick start

The Pantheon Content Publisher plugin can be installed like any other WordPress Plugin, from your WordPress Dashboard, go to Plugins -> Add Plugin and search for: Pantheon Content Publisher, click the Install Now button and then click Activate.

After the plugin is active, set up your connection to Pantheon Content Publisher and Google Drive via the settings page in the WordPress admin dashboard.

Alternately you can download and install the plugin manually:

• Download the latest release.

or

• Clone the repo: git clone https://github.com/pantheon-systems/pantheon-content-publisher-wordpress.git in your wp-content/plugins folder

or soon

• Install via Composer: composer require pantheon-systems/pantheon-content-publisher-wordpress

If installing from source, make sure to follow the build instructions in the Development section below

Custom post types

The plugin supports publishing content to any public post type registered on your WordPress site, not just the default Post and Page types.

For more details on configuring WordPress with Content Publisher, see the WordPress Tutorial.

Selecting a post type

When creating or editing a collection in the plugin settings, you can choose which WordPress post type the collection's documents should be published as. The dropdown lists all public post types available on your WordPress site.

You can also select "Chosen by the author" to allow document authors to control the post type on a per-document basis using the wp-post-type metadata field.

The wp-post-type metadata field

When a collection is configured with "Chosen by the author", the plugin reads a metadata field called wp-post-type from each document to determine which post type to use.

To set the post type for a document, add a metadata field in the Content Publisher dashboard (or the Google Docs add-on) with the system name wp-post-type. The value should be the slug of the desired post type (e.g. post, page).

The list of allowed values must be configured manually by the administrator in the Content Publisher dashboard or the Google Docs add-on. The plugin does not automatically synchronize the available post types.

Fallback behavior

The plugin falls back to the default post type in the following cases:

1. The collection is set to "Chosen by the author" but the document does not have a wp-post-type metadata field.
2. The wp-post-type metadata field is present but empty.
3. The wp-post-type value does not match any public post type registered on the WordPress site.

Changing the post type setting on a collection only affects future publishes and does not modify previously published content.

ACF Integration

The plugin can sync Content Publisher metadata fields to Advanced Custom Fields (ACF). When a document is published, mapped ACF fields are automatically populated with the corresponding metadata values.

Requirements

The ACF plugin (free or Pro) must be installed and active. If ACF is not detected, the Integration tab displays a warning and mappings are skipped during publish.

Configuring field mappings

1. Navigate to Settings > Pantheon Content Publisher in the WordPress admin.
2. Click the Integration tab.
3. Select a post type tab — each tab shows ACF fields from the field groups assigned to that post type.
4. For each ACF field you want to map, enter the exact Content Publisher metadata field name in the text input. Field names are case-sensitive and must match exactly as defined in your Content Publisher collection.
5. Leave a field blank to skip it.
6. Click Save Mapping.

Mappings are scoped per post type. When a document is published, only the mappings for the target post type are applied.

Error visibility

Sync errors (missing metadata fields, unresolved users, ACF inactive) are displayed in the Integration tab under a "Errors from last sync" banner. Errors auto-clear after one hour.

Development

1. composer i && npm i to install dependencies.
2. npm run watch / npm run dev / npm run prod to build assets. Since version 1.3.0 npm run build:vite to build assets and dist/build folder.
3. Read through our contributing guidelines for additional information. Included are directions for opening issues, coding standards and miscellaneous notes.

Repository Actions

This repository takes advantage of the following workflows to automate the release & testing processes:

• PHPCS
• PHPCompatibility
• Release Drafter
• PR Labeler
• A custom workflow that builds release artifacts

These workflows will build a release draft and keep it up-to-date as new PRs are merged. Once a release is published, a ready-to-install zip file will be generated and attached to the newly-published release. To take advantage of these automations, make sure to read the available config files and workflow recipes, available in the .github folder in the root of this repository.

Examples: (read the config files for full configuration)

• feature/<branch-name> or feat/<branch-name> adds the feature label to your PR
• PRs labeled feature will be categorized in the "🚀 Features" section of the release
• PRs labeled major/minor/patch will bump the major/minor/patch version number of the release

Requirements

Pantheon Content Publisher is dependent on:

• Minimum PHP version 8.1
• Minimum WordPress version 5.7

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Documentation is available at pcc.pantheon.io/docs.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Pantheon Content Publisher is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Changelog

You may find changelogs for each version of Pantheon Content Publisher released in the Releases section of this repository.