WordPress.org

Plugin Directory

WordPress Development Kit Plugin

Add support for premium plugins and add-on packs to your WooCommerce offerings. Includes subscription validation.

This plugin provides a premium plugin update and listing system as well as a subscription validation mechanism for plugin authors. I use it for the "latest versions" listings, download listings, and the inline update system for the add-on packs at Store Locator Plus. The plugin will list all the latest versions and serve updates. If you enter a WooCommerce subscription product ID and enter plugin slugs on the settings page, those listed slugs will only install updates if the incoming query can validate the uid and sid provided.

Part of the free WordPress Development Kit that I have been putting together to help automate the dozen-plus free and premium plugins that I have been creating over the years. This is one more cog in the system that helps cut down on manual page updates that show things like change logs, latest news, and other details the customer base finds relevant or useful. You can learn more via my WordPress Development Kit articles. This plugin will do more as my WordPress Development Kit and related processes are refined. Special thanks to WordCamp Atlanta for planting the seeds that grew into this project. If you've not been to a local WordCamp you should attend one soon.

Usage

Set the location of your production plugins.json file via the Settings/WP Dev Kit menu item in the admin panel of your site. You can learn more about the plugins.json format from the WP Dev Kit repository on Bitbucket. Yup, it is also GPL and a public repo so go ahead and check it out.

The plugins.json is a simple text file that lists your plugin slugs and version information. Put the plugins.json plus the readme.txt file from your plugin, renamed _readme.txt into a directory on your server. Now use the shortcodes noted below and the plugin information from your readme will be rendered in your page when using details mode. List mode will list all of the plugins that appear in your plugins.json file.

Go to a page or post and use the wpdevkit shortcode.

Actions [wpdevkit action="list"] to list out the production plugins metadata in a stylized format. [wpdevkit action="filelist"] to create a download list of files [wpdevkit action="show_subscription"] output a user ID and subscription key for users logged in on your plugin sales site.

Styles (default: formatted) [wpdevkit action='list' style='formatted'] list the details in an HTML formatted layout [wpdevkit action="list" style="raw"] to list out the production plugins metadata in a print_r array format (ugly mode).

Types (default: basic) [wpdevkit action='list' type='basic'] list basic details = version, updated, directory, wp versions [wpdevkit action='list' type='detailed'] list all details = version, updated, directory, wp versions, description

Slug (default: none = list ALL) [wpdevkit action="list" slug="wordpress-dev-kit-plugin"] to list out the production metadata in a stylized format for a single product.

Target (default: production) [wpdevkit action="list" slug="wordpress-dev-kit-plugin" target="production"] to list out the production metadata for production builds. [wpdevkit action="list" slug="wordpress-dev-kit-plugin" target="prerelease"] to list out the production metadata for prerelease builds.

Example

You can see the current iteration of the plugin in action on my site. The Current Releases section is updated automatically whenever I use my WP Dev Kit to publish a release to the public WordPress Plugin Directory or when premium add-ons are published to my site. WP Dev Kit uses Grunt tasks and the plugins.json file to automate my production. This plugin ties into that automated production system to create things like the WordPress shortcodes above to create formatted output on my site with no direct editing required.

Updater System

Includes premium plugin update system that can be queried by any premium plugins using the WordPress pre_set_site_transient_update_plugins and plugins_api hooks. This provides inline admin-panel updates to premium add-on packs. Your premium add-on plugins must use a standard updates class that uses these built-in WordPress hooks to query your website that is running this WordPress Dev Kit plugin. If it is implemented properly, your premium add-on packs will query this plugin, which reads the JSON file data stored on your WordPress server, and sends back the most current plugin version data. If a new version of your premium plugin is available this plugin can also handle serving the files from the specified production directory. You must code your premium plugins accordingly and keep your plugins.json and zip files updated on the specified production directory (a WP Dev Kit setting) on your server. The query URL for the update sytem is your website's Admin AJAX URL, for example a VVV install using the trunk install with this plugin would have a URL of http://local.wordpress-trunk.dev/wp-admin/admin-ajax.php with an action of wpdk_updater.

Here is a code snippet the utilizes the target release (production/prerelease), the subscription validation system, and records other attributes for all update requests. $this->update_request_path = $this->base_path . '?action=wpdk_updater' . '&surl=' . urlencode(site_url()) . '&uid=' . $this->slplus->options_nojs['premium_user_id'] . '&sid=' . $this->slplus->options_nojs['premium_subscription_id'] . '&target=' . $this->slplus->options_nojs['build_target'] . '&slug='.$slug . '&current_version=' . $version; }

Logs Update Requests

All version checks are logged in the server in an update_history table kept outside of the core WordPress tables.

Validate Woocommerce Subscriptions

Version 1.0 adds the ability to specify a Woocommerce subscription product ID and a list of plugin slugs to be validated against an active subscription. The update request must send a UID (user ID) and SID (subscription ID) parameter to the update system. The UID and SID will be validated against known active subscriptions and only allow an update file to be retrieved if the specified UID has a valid subscription.

Related Links

Requires: 4.4 or higher
Compatible up to: 4.5.1
Last Updated: 2 days ago
Active Installs: 60+

Ratings

5 out of 5 stars

Support

0 of 1 support threads in the last two months have been marked resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1