-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
330 lines (212 loc) · 15.5 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
=== {eac}SoftwareRegistry Custom Hooks ===
Plugin URI: https://swregistry.earthasylum.com/software-registry-hooks/
Author: [EarthAsylum Consulting](https://www.earthasylum.com)
Stable tag: 2.0.11
Last Updated: 15-Apr-2024
Requires at least: 5.8
Tested up to: 6.6
Requires PHP: 7.4
Contributors: kevinburkholder
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl.html
Tags: software registration, software registry, software license, license manager, registration hooks, {eac}SoftwareRegistry
GitHub URI: https://github.com/EarthAsylum/eacSoftwaReregistry-custom-hooks
{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](https://swregistry.earthasylum.com/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.
**{eac}SoftwareRegistry Custom Hooks** allow you to write PHP code for any 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.
Although this extension includes some pre-built customizations, the main purpose is to allow you (or your programmer) to further customize the Software Registration Server. The extensions included provide all of the ground-work needed so you only need to focus on the actual customizations you need to make.
> This custom hooks extension is a developer-level extension which uses *your* PHP code. To add customizations beyond what is provided requires PHP programming knowledge and basic understanding of WordPress actions and filters.
= Implementing Custom Hooks =
To implement your customizations:
1. Copy the `/eacSoftwareRegistry/Customhooks` folder from this plugin folder to your development environment.
2. Modify the appropriate extension(s) [`custom_hooks_*.extension.php`] found in the `Customhooks` folder.
3. Upload the `/eacSoftwareRegistry/Customhooks` folder from your development environment to your WordPress theme folder (preferably a child theme - see: [Child Themes](https://developer.wordpress.org/themes/advanced-topics/child-themes/)).
Example directory structure
/wp-content/themes/my-awesome-theme
/eacSoftwareRegistry
/CustomHooks
custom_hooks_admin_options.extension.php
custom_hooks_api_request.extension.php
custom_hooks_api_response.extension.php
custom_hooks_client_messages.extension.php
custom_hooks_new_registration.extension.php
The only code changes needed are in the appropriate method(s), within the `try...catch` block.
For example, if you wanted to customize the assignment of a new registration key, you would modify `custom_hooks_new_registration.extension.php`; find the `new_registry_key()` method, and make your changes where you see `/* custom code here */`:
/**
* new_registry_key handler
*
* @param string $newRegistrationKey The key value (uuid) assigned to a new registration
* @return string
*/
public function new_registry_key(string $newRegistrationKey): string
{
global $wp, $wpdb;
try {
/* custom code here */
return $newRegistrationKey;
} catch (\Throwable $e) {$this->plugin->logError($e);return $newRegistrationKey;}
}
> In some cases, default code is provided as both example and preference. If not needed, defaults should be removed or disabled.
= WordPress Administration =
From the administrator settings screen (found at *Software Registry » Settings » Hooks*), you may enable or disable each hook independently or as a group (by each extension).
+ Each extension is disabled by default and must be enabled from the settings screen.
+ For each filter that is customized, the individual hook must be enabled from the settings screen.
For example, after modifying the `new_registry_key()` method (above), you must go to the settings screen, enable the *New Registration Hooks* extension and then enable the *New Registration Key* hook.
= List of Available Hooks =
Administrator settings `eacSoftwareRegistry/Customhooks/custom_hooks_admin_options.extension.php`
'eacSoftwareRegistry_settings_timezones'
'eacSoftwareRegistry_settings_status_codes'
'eacSoftwareRegistry_settings_post_status'
'eacSoftwareRegistry_settings_initial_terms'
'eacSoftwareRegistry_settings_full_terms'
'eacSoftwareRegistry_settings_refresh_intervals'
'eacSoftwareRegistry_settings_license_levels'
'eacSoftwareRegistry_admin_email_headers'
'eacSoftwareRegistry_admin_email_style'
'eacSoftwareRegistry_admin_email_message'
API Requests `eacSoftwareRegistry/Customhooks/custom_hooks_api_request.extension.php`
'eacSoftwareRegistry_api_request_parameters' // pre-coded to log the api request parameters
'eacSoftwareRegistry_api_create_registration'
'eacSoftwareRegistry_api_activate_registration'
'eacSoftwareRegistry_api_revise_registration'
'eacSoftwareRegistry_api_renew_registration'
'eacSoftwareRegistry_api_deactivate_registration'
'eacSoftwareRegistry_api_refresh_registration'
'eacSoftwareRegistry_api_verify_registration'
API Responses `eacSoftwareRegistry/Customhooks/custom_hooks_api_response.extension.php`
'eacSoftwareRegistry_api_registration_values' // pre-coded to log the api response values
'eacSoftwareRegistry_validate_registration'
'eacSoftwareRegistry_is_valid_registration'
'eacSoftwareRegistry_update_registration_post'
Client Message Hooks `eacSoftwareRegistry/Customhooks/custom_hooks_client_messages.extension.php`
'eacSoftwareRegistry_api_registration_notices'
'eacSoftwareRegistry_api_registration_message'
'eacSoftwareRegistry_client_registry_translate' // pre-coded to remove certain values passed to the client
'eacSoftwareRegistry_client_registry_html'
'eacSoftwareRegistry_client_email_headers'
'eacSoftwareRegistry_client_email_style'
'eacSoftwareRegistry_client_email_message'
'eacSoftwareRegistry_client_email_footer'
New registration `eacSoftwareRegistry/Customhooks/custom_hooks_new_registration.extension.php`
'eacSoftwareRegistry_new_registry_key'
= Custom Hook Method Arguments =
$newRegistrationKey // The key value (uuid) assigned to a new registration
$requestParams // The parameter array passed through the API. May include:
'registry_key' => string // UUID,
'registry_status' => string, // 'pending', 'trial', 'active', 'inactive', 'expired', 'terminated', 'invalid'
'registry_effective' => string, // effective date
'registry_expires' => string, // expiration date
'registry_name' => string, // registrant's full name
'registry_email' => string, // registrant's email address
'registry_company' => string, // registrant's company/organization name
'registry_address' => string, // registrant's full address (textarea)
'registry_phone' => string, // registrant's telephone
'registry_product' => string, // your product name/id ((your_productid))
'registry_title' => string, // your product title
'registry_description' => string, // your product description
'registry_version' => string, // your product version (when registered)
'registry_license' => string, // 'L1'(Lite), 'L2'(Basic), 'L3'(Standard), 'L4'(Professional), 'L5'(Enterprise), 'LD'(Developer)
'registry_count' => int, // number of licenses (users/seats/devices)
'registry_variations' => array, // associative array of name/value pairs
'registry_options' => array, // indexed array of registry options
'registry_domains' => array, // array of valid/registered domains
'registry_sites' => array, // array of valid/registered sites/uris
'registry_transid' => string, // external transaction id
'registry_timezone' => string, // standard timezone string (client timezone)
'registry_paydue' => float, // amount to be paid/billed,
'registry_payamount' => float, // amount paid,
'registry_paydate' => string, // date paid
'registry_payid' => string, // transaction id/check #, etc.
'registry_nextpay' => string, // next payment/renewal date
$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
== Installation ==
**{eac}SoftwareRegistry Custom Hooks** is an extension plugin to and requires installation and registration of [{eac}SoftwareRegistry](https://swregistry.earthasylum.com/).
= Automatic Plugin Installation =
Due to the nature of this plugin, it is NOT available from the WordPress Plugin Repository and can not be installed from the WordPress Dashboard » *Plugins* » *Add New* » *Search* feature.
= Upload via WordPress Dashboard =
Installation of this plugin can be managed from the WordPress Dashboard » *Plugins* » *Add New* page. Click the [Upload Plugin] button, then select the eacsoftwareregistry-custom-hooks.zip file from your computer.
See [Managing Plugins -> Upload via WordPress Admin](https://wordpress.org/support/article/managing-plugins/#upload-via-wordpress-admin)
= Manual Plugin Installation =
You can install the plugin manually by extracting the eacsoftwareregistry-custom-hooks.zip file and uploading the 'eacsoftwareregistry-custom-hooks' folder to the 'wp-content/plugins' folder on your WordPress server.
See [Managing Plugins -> Manual Plugin Installation](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation-1)
= Settings =
Options for this extension will be added to the *Software Registry » Settings » Hooks* tab.
== Screenshots ==
1. {eac}SoftwareRegistry Custom Hooks
2. {eac}SoftwareRegistry Administrator Hooks
3. {eac}SoftwareRegistry API Request Hooks
4. {eac}SoftwareRegistry API Response Hooks
5. {eac}SoftwareRegistry Client Hooks
6. {eac}SoftwareRegistry New Registration Hooks
== Other Notes ==
= See Also =
+ [{eac}SoftwareRegistry – Software Registration Server](https://swregistry.earthasylum.com/software-registration-server/)
+ [Implementing the Software Registry SDK](https://swregistry.earthasylum.com/software-registry-sdk/)
= Consulting =
If you are unable to perform the customizations as outlined, yet need your Software Registration Server customized, we are more than happy to discuss and provide a quote to do these customizations for you. You may contact us at [support@earthasylum.com](mailto:support@earthasylum.com)
== Copyright ==
= Copyright © 2019-2024, EarthAsylum Consulting, distributed under the terms of the GNU GPL. =
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should receive a copy of the GNU General Public License along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
== Changelog ==
= Version 2.0.11 – April 15, 2024 =
+ Added new/missing filters
+ 'eacSoftwareRegistryclient_email_footer'
+ 'eacSoftwareRegistry_api_renew_registration'
+ Compatible with WordPress 6.5.
= Version 2.0.10 – February 15, 2024 =
+ Update for Github hosting.
= Version 2.0.9 – May 1, 2023 =
+ Renamed classes.
+ Allow 'license_count' to pass in html table.
= Version 2.0.8 – April 17, 2023 =
+ Added 'refresh' api request.
+ Tested with {eac}SoftwareRegistry v1.3, {eac}Doojigger v2.3, and WordPress 6.2.
= Version 2.0.7 – April 12, 2023 =
+ Removed custom code from client_messages.
= Version 2.0.6 – April 7, 2023 =
+ Updated custom_hooks_client_messages.extension for {eac}SoftwaReregistry Software Taxonomy.
= Version 2.0.5 – November 15, 2022 =
+ Updated for {eac}SoftwareRegistry v1.2 and {eac}Doojigger v2.0.
+ Uses 'options_settings_page' action to register options.
+ Moved plugin_action_links_ hook to eacSoftwareRegistry_load_extensions filter.
+ Improved plugin loader and updater.
= Version 2.0.4 – September 24, 2022 =
+ Fixed potential PHP notice on load (plugin_action_links_).
+ Fixed registry status and license array.
+ Added settings_refresh_intervals filter.
= Version 2.0.3 – September 9, 2022 =
+ Added support for new 'registry_title' value.
+ Added upgrade notice trait for plugins page.
= Version 2.0.2 – August 30, 2022 =
+ Added auto-update with plugin_update trait.
= Version 2.0.1 – August 24, 2022 =
+ Updated to / Requires {eac}Doojigger 1.2
+ Added 'Settings' and 'Docs' links on plugins page.
= Version 2.0.0 – July 29, 2022 =
+ Fundamental change for security. No longer supports online code editing, instead provides functionality and framework for customizations stored in a (child) theme sub-folder.
= Version 1.0.2 – July 15, 2022 =
+ Cosmetic changes for WordPress submission.
+ Updated default hooks.
= 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.
== Upgrade Notice ==
Updating this plugin will overwrite all code in the `eacsoftwareregistry-custom-hooks` plugin directory. Your customizations should be placed in your (child) theme folder.
= 2.0.6 =
This version requires {eac}SoftwareRegistry v1.3+