On Page®
Receives and syncs structured data from On Page® into WordPress, exposing a REST API under /wp-json/onpage/v1.
Install
No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:
wp plugin install https://github.com/onpage-dev/wordpress-plugin/archive/refs/heads/main.zipOn Page® WordPress Plugin
Lets WordPress receive and sync structured data from On Page®. The plugin is a backend for WordPress: it exposes a REST API and waits for a client to push data to it. A client is any program that calls that API. The plugin never pulls data.
The plugin:
- exposes a REST API that receives data from any client
- creates and updates post types, ACF fields, taxonomies, terms and content
- publishes on WordPress collections that are managed centrally on On Page®
- supports multilingual sites through WPML
Version
Current version: 1.0.0. The project follows Semantic Versioning.
- Changes in each version: CHANGELOG.md
- How to cut a release: RELEASE.md
- Published versions: GitHub Releases.
To install, upload the
onpage-X.Y.Z.zipattached to a release under Plugins in WordPress.
Requirements
- WordPress 7.1 or later
- PHP 8.2 or later
- Advanced Custom Fields, active. Without ACF the REST API stays disabled.
- WooCommerce and WPML are optional. You only need them for the WooCommerce endpoints and for multilingual content.
Documentation
The docs live in docs/. See docs/README.md for the full index.
Writing a client? Start with docs/dev/integration-guide.md. It covers the REST contract, the order of calls, complete PHP examples and the error reference.
| Document | Who it is for |
|---|---|
| docs/user/ | site admins: what the plugin does, installation and configuration |
| docs/dev/ | plugin and client developers: internals, design, technical analysis |
| docs/API.md | full REST API reference, endpoint by endpoint |
Contributing
See CONTRIBUTING.md for the local environment, the tests and how to send a change. To report a security problem, follow SECURITY.md.
License
GPL-2.0-or-later, same as WordPress.