pronamic / wp-orbis-deals

dev-main 2026-10-05 18:58 UTC

Requires

• automattic/jetpack-autoloader: ^3.0

Requires (Dev)

• deployer/deployer: ^7.5
• pronamic/wp-coding-standards: ^2.0
• wp-cli/dist-archive-command: *
• wp-cli/wp-cli-bundle: *

GPL-2.0-or-later

Published on Packagist.org on 2026-10-05 18:58 UTC

README

The Orbis Deals plugin extends your Orbis environment with the option to add deals.

Table of contents

• Features
• Requirements
• Installation
• Usage
• REST API
• Templates
• Development
• Links

Features

• Deals post type (orbis_deal) with a public archive at /deals/.
• Deal details meta box to link a deal to an Orbis organization and set a price and status.
• Statuses: pending, won and lost. Status changes are logged as comments on the deal.
• Deal lines: quantity, description and amount per line, shown below the deal content.
• Admin columns for organization, price and status.
• Posts 2 Posts connections between deals and organizations, and between deals and persons.
• Filter by status with the orbis_deal_status query variable, for example /deals/?orbis_deal_status=won.
• Translations: Dutch (nl_NL) included.

Requirements

• PHP 7.2 or higher
• WordPress 5.2 or higher
• Orbis
• Posts 2 Posts

Installation

Download the latest orbis-deals.zip from the releases page and upload it via Plugins → Add New → Upload Plugin in WordPress.

Usage

1. Go to Deals → Add New in the WordPress admin.
2. Enter a title and description.
3. In the Deal Details meta box, select the organization, enter the price and choose a status.
4. Publish the deal.

When you change the status to Won or Lost, a comment is added to the deal with the new status and the user who changed it.

REST API

The plugin registers routes in the orbis/v1 namespace:

Method	Route	Description
GET	/wp-json/orbis/v1/deals/{post_id}	Get a deal and its lines.
POST	/wp-json/orbis/v1/deals/{post_id}	Update the lines of a deal.

Templates

The plugin includes templates for the deals archive and the deal details. To override the archive, add an archive-orbis_deal.php file to your theme. The plugin template is used only when the theme does not have one.

Template	Description
archive-orbis_deal.php	Deals archive.
deal-details.php	Deal details.
deal-lines.php	Deal lines, appended to the content.
deals-stats.php	Deal statistics.

Development

Clone the repository and install the dependencies:

git clone https://github.com/pronamic/wp-orbis-deals.git
cd wp-orbis-deals
composer install
npm install

Start a local WordPress environment with @wordpress/env. It installs Orbis, Posts 2 Posts, Pronamic Client and Query Monitor:

npx wp-env start

Composer scripts

Command	Description
composer phpcs	Check the code against the Pronamic coding standards.
composer phpcbf	Fix coding standard violations automatically.
composer build	Build the plugin and create a distribution archive in build/.
composer make-pot	Update the .pot and .po translation files.

Links

• Pronamic
• Orbis
• Issues

Pronamic · GPL-2.0-or-later