README

The official WooCommerce add-on for FoPost. It posts your products to social media when they are published, go on sale, or come back in stock.

What it does

Trigger	Fires when
Product published	A product moves into the published status for the first time
Product goes on sale	A price change puts the product on sale, and it was not before
Product back in stock	Stock status returns to `instock` after being out

Each trigger is off by default, has its own message template, and can be switched independently.

Install

composer install

Then copy the directory to wp-content/plugins/fopost-woocommerce and activate it. WooCommerce must be active first. A release zip with production dependencies is attached to every GitHub release.

Configure

WooCommerce, Settings, FoPost

Paste a FoPost API key. It is stored on your site and is only ever sent to FoPost.
Pick the workspace and the connected accounts product posts should go to.
In Triggers and Messages, switch on the events you want and edit their copy.

The key is never rendered back into the settings form. Leave the field blank to keep the key you already saved, or tick Remove the stored API key to clear it.

Message placeholders

Placeholder	Value
`{product_name}`	The product title
`{price}`	The regular price, formatted in your shop's currency
`{sale_price}`	The sale price, when there is one
`{permalink}`	The product URL
`{short_description}`	The short description as plain text, trimmed to 280 characters
`{sku}`	The SKU
`{categories}`	The product categories, comma separated

Every value is reduced to plain text before it is substituted, so markup in a product description never reaches a social network.

Filters

Filter	Purpose
`fopost_wc_template_placeholders`	Add or change placeholders. Return plain text values
`fopost_wc_rendered_message`	Change the finished message
`fopost_wc_should_post`	Veto a post before it is queued
`fopost_wc_api_base_url`	Point a staging site at a different API
`fopost_wc_api_timeout`	Per-request timeout, in seconds
`fopost_wc_logged`	React to a recorded delivery attempt

See examples/custom-placeholder.php for working code.

How it delivers

A trigger never calls the API. It queues an Action Scheduler job, which WooCommerce already runs, so publishing a product is never slowed down by a network round trip and a failed delivery is retried. The call itself goes through the FoPost PHP SDK, whose transport is swapped for the WordPress HTTP API so your host's proxy and certificate settings apply.

Every attempt is recorded against the product and listed under WooCommerce, FoPost Activity with the FoPost post ID. Failures also surface as an admin notice.

Development

composer install
composer test    # phpunit, fully offline
composer lint    # phpcs against the project ruleset
make build       # build the distributable zip

The test suite stubs WordPress, WooCommerce and Action Scheduler, so it needs no database and makes no network calls.

Support

Documentation: https://fopost.com/docs
Contact: https://fopost.com/contact
Issues: https://github.com/fopost/fopost-woocommerce/issues

License

WordPress.org requires a GPL-compatible license for hosted plugins, which is why this repository is GPL rather than MIT like the FoPost SDKs.

fopost / woocommerce

Maintainers

Package info

Statistics

Security