{eac}SoftwareRegistry Custom Hooks

Document Header

Homepage:https://swregistry.earthasylum.com/ Author:EarthAsylum Consulting Current Version:1.0.1 Last Updated:18-Jun-2022 Requires WordPress Version:5.4.0 Compatible up to:5.9.3 Requires PHP Version:7.2 Contributors:Kevin Burkholder Donate link:https://www.earthasylum.com/donate/ License:GPLv3 or later License URI:https://www.gnu.org/licenses/gpl.html Tags:software registration, software registry, software license, {eac}SoftwareRegistry

{eac}SoftwareRegistry custom hooks - Add PHP code for the many hooks (filters and actions) available in the Software Registration Server.

Description

{eac}SoftwareRegistry Custom Hooks is an extension plugin to {eac}SoftwareRegistry Software Registration Server.

Using the many hooks available in the Software Registration Server, you can customize the registration server options, incoming API requests, outgoing API responses, and client emails and notifications.

Registry hooks allow you to enter PHP code for each of the available filters. Through these hooks, you can customize your registration server, validate and/or modify API request and response data, or trigger other actions or functions.

* Default hooks are provided as example and preference. If not needed, defaults should be removed.

Included in the Extras folder is Hooks/registry_hooks_coded.extension.php, a shell program with all of the available actions and filters. You can use this to hard code your hooks and replace the registry hook extensions. Simply code your hooks in registry_hooks_coded.extension.php and replace the Extensions/Hooks folder with the Extras/Hooks folder. Be sure to keep a copy of registry_hooks_coded.extension.php so it is available if/when you upgrade or re-install this extension.

List of Available Hooks

Administrator settings

'eacSoftwareRegistry_settings_timezones'
'eacSoftwareRegistry_settings_status_codes'
'eacSoftwareRegistry_settings_post_status'
'eacSoftwareRegistry_settings_initial_terms'
'eacSoftwareRegistry_settings_full_terms'
'eacSoftwareRegistry_settings_license_levels'
'eacSoftwareRegistry_admin_email_headers'
'eacSoftwareRegistry_admin_email_style'
'eacSoftwareRegistry_admin_email_message'

New registration

'eacSoftwareRegistry_new_registry_key'

API Requests

'eacSoftwareRegistry_api_request_parameters'
'eacSoftwareRegistry_api_create_registration'
'eacSoftwareRegistry_api_activate_registration'
'eacSoftwareRegistry_api_revise_registration'
'eacSoftwareRegistry_api_deactivate_registration'
'eacSoftwareRegistry_api_verify_registration'

API Responses

'eacSoftwareRegistry_api_registration_values'
'eacSoftwareRegistry_validate_registration'
'eacSoftwareRegistry_is_valid_registration'
'eacSoftwareRegistry_update_registration_post'

Client Message Hooks

'eacSoftwareRegistry_api_registration_notices'
'eacSoftwareRegistry_api_registration_message'
'eacSoftwareRegistry_client_registry_translate'
'eacSoftwareRegistry_client_registry_html'
'eacSoftwareRegistry_client_email_headers'
'eacSoftwareRegistry_client_email_style'
'eacSoftwareRegistry_client_email_message'

API Function Arguments

$newRegistrationKey     // The key value (uuid) assigned to a new registration

$requestParams          // The parameter array passed through the API. May include:
- registry_product      // Registered product
- registry_description  // Registered product description
- registry_version      // Registered product version
- registry_license      // 'developer', 'basic', 'pro', 'unlimited'
- registry_count        // Number of licenses (users/seats/devices) included
- registry_status       // 'pending', 'trial', 'active', 'inactive', 'expired', 'terminated'
- registry_effective    // Effective date (Y-m-d)
- registry_expires      // Expiration date (Y-m-d) or term (30 days, 1 year,...)
- registry_name         // Full name
- registry_email        // Valid email address
- registry_company      // Company/Organization name
- registry_address      // Full postal address (textarea)
- registry_variations   // Registrar variations (key=>value associative array)
- registry_options      // Registrar options (indexed array)
- registry_domains      // Registered domain name(s) (indexed array)
- registry_sites        // Registered site URL(s) (indexed array)

$apiAction              // One of 'create', 'activate', 'revise', 'deactivate', 'verify' or 'update' (non-api)

$registration           // The registration data array with above registry values

$wpPost                 // WP_Post object

$postValues             // Array of values passed to wp_insert_post(), including 'meta_input' array with above registry values
Top
Installation

Copy the 'eacSoftwareRegistryHooks' folder to your WordPress 'plugins' folder or install the 'eacSoftwareRegistryHooks.zip' file through the WordPress Plugins upload page.

Top
Screen Shots
  1. {eac}SoftwareRegistry Administrator Hooks <span class='eac-product'>{<span class='eac-brand'>eac</span>}SoftwareRegistry</span> Administrator

  2. {eac}SoftwareRegistry API Request Hooks <span class='eac-product'>{<span class='eac-brand'>eac</span>}SoftwareRegistry</span> API Request

  3. {eac}SoftwareRegistry API Response Hooks <span class='eac-product'>{<span class='eac-brand'>eac</span>}SoftwareRegistry</span> API Response

  4. {eac}SoftwareRegistry Client Hooks <span class='eac-product'>{<span class='eac-brand'>eac</span>}SoftwareRegistry</span> Client

Top
Other Notes

See Also

Top Top
Change Log

Version 1.0.1 – June 18, 2022

  • Fix update_registration_post conflict.
  • Updated hooks/filters.

Version 1.0.0 – May 4, 2022

  • Initial public release.
Top

    Write a Reply or Comment

    Your email address will not be published.


    You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>