forked from BracketSpace/Notification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
249 lines (184 loc) · 10.3 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
=== Notification ===
Contributors: Kubitomakita
Donate link: https://www.paypal.me/underDEV/
Tags: notification, notify, email, mail
Requires at least: 3.6
Tested up to: 4.8
Stable tag: 3.1.1
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Customisable email notifications with developer friendly API for custom triggers
== Description ==
This plugin allows you to send custom email notifications about various events in WordPress. It also comes with a simple API by which you can add literally **any** trigger action.
In messages you can use defined merge tags which will be later changed to content applicable for trigger.
There is also option to disable the notifications for specific post, comment or user in case you don't want to send notification for a secret article.
> [See Notification homepage](https://notification.underdev.it) and check Developer docs
https://www.youtube.com/watch?v=usdBMPjdiuw
= Default recipients =
Plugin comes with few registered by default recipient types:
* Email address - free type email address
* Administrator - takes an email from General Settings page
* User - takes an email from WordPress user profile
* Merge tag - email rendered by merge tag
= Default triggers =
These are already defined in plugin's core and are ready to use. You can enable or disable them on the Settings page.
Any Post Type:
* Published post notification
* Updated post notification
* Post send for review (pending post) notification
* Post moved to trash notification
Comment / Pingback / Trackback:
* New comment notification
* Comment approved notification
* Comment unapproved notification
* Comment marked as spam notification
* Comment moved to trash notification
User:
* User registered
* User profile updated
* User logged in
* User deleted
Media:
* Media added
* Media updated
* Media deleted
Feel free to suggest new core triggers in support forum
= Useful links =
* [Homepage](https://notification.underdev.it)
* [Support plugin developement](https://www.paypal.me/underDEV/)
* [GitHub repository](https://github.com/Kubitomakita/Notification)
* [Report a bug](https://github.com/Kubitomakita/Notification/issues/new)
== Installation ==
= Requirements =
This plugin require at least PHP 5.3.0.
= Plugin install =
Download and install this plugin from Plugins -> Add New admin screen.
= Distributing in a plugin or theme =
Notification can be loaded also as a part of any plugin or theme. To do it just include plugins's `load.php` file. It will figure out if it's loaded from theme or from plugin.
[See the detailed guide](https://notification.underdev.it/including-notification-plugin-theme/)
== Frequently Asked Questions ==
= How to change notification email headers? =
There's no such option at the moment. Please use some other plugin to adjust wp_mail() headers.
= How to register my triggers? =
With `register_trigger()` function. [See the detailed guide](https://notification.underdev.it/registering-new-triggers/)
= How do I fire my trigger to send an email? =
With `notification()` function. [See the detailed guide](https://notification.underdev.it/sending-notifications/)
= Can I deregister trigger I don't want to use? =
Yes, with `deregister_trigger()` function. [See the detailed guide](https://notification.underdev.it/deregistering-triggers/)
= Can I bundle the plugin with my plugin or theme? =
Yes, you can. [See the detailed guide](https://notification.underdev.it/including-notification-plugin-theme/)
== Screenshots ==
1. Trigger edit screen
2. All triggers
3. Settings
== Changelog ==
= 3.1.1 =
* [Fixed] Bug with directories/files names, thanks to Gregory Rick
= 3.1 =
* [Added] `notification/notify` filter which control if notification should be sent or not
* [Added] `notification/settings` action which accepts Settings API class as a parameter
* [Added] `post_author_email` merge tag for all comment types triggers, thanks to Wayne Davies
* [Added] Ongoing check of PHP and WP version, thanks to Max (@max-kk)
* [Added] Option to strip shortcodes from Notification subject and content, thanks to @Laracy
* [Added] Notification : Signature extension to extension directory
* [Changed] Settings and Singleton are now loaded from Composer libraries
* [Changed] Gulp default task to build, and added watch task which boots up BS
* [Changed] Action priority when default recipients and triggers are registered from 50 to 9
* [Changed] Action priority when settings are initialized from 15 to 8
* [Changed] Updated Composer libraries
* [Changed] Values for default trigger options from strings/arrays to null
* [Fixed] Bug when Text editor was active and the trigger was changed
* [Fixed] Post Visibility setting on other post types than Notification
* [Fixed] Default recipient merge_tag value. All recipient inputs are now dynamically refreshed
* [Fixed] Not cached exception in plugin's table when requiring this plugin from inside of another plugin or theme, thanks to Max (@max-kk)
= 3.0 =
* [Fixed] Ignore tags which has been passed to `notification` but hasn't be registered in the trigger
* [Fixed] Conflict with Advanced Custom Fields
* [Added] Filters for post and comment types to output disbale metabox. `notification/disable/post_types_allowed` and `notification/disable/comment_types_allowed`, default to saved general settings
* [Added] Extensions screen
* [Added] While registering triggers you can now provide a default title and recipients
* [Changed] bbPress post types are no longer available in the settings. Triggers for bbPress are provided by addon https://github.com/Kubitomakita/notification-bbpress
* [Changed] Place where merge tags metabox actions are executed
* [Changed] Chosen to Selectize.js
= 2.4 =
* [Fixed] Bug with "Can't use method return value in write context" in Settings class, thanks to @rozv
* [Fixed] Settings priorities, now every CPT registered not later than init 15 will be catched by the plugin, thanks to @rozv
* [Fixed] Double protocol in links added via TinyMCE insert link feature, thanks to Jozsef
* [Fixed] Notices in Notification validation method
* [Fixed] Empty Recipient value, ie. Administrator
* [Added] Post type triggers can be disabled for an user
* [Added] Database Upgrader
* [Added] User triggers - registered, profile updated, logged in, deleted
* [Added] Taxonomies merge tags for post types
* [Added] Media triggers - added, updated, deleted
* [Changed] Post updated notification is now triggered only if the post has been published before, suggested by nepali65
* [Changed] Content Type triggers setting has been changed to Enabled triggers
= 2.3.1 =
* [Fixed] Bug with not activated "Disable" option
= 2.3 =
* [Changed] Removed unused default post controls
* [Changed] Better error handling, plugin will not die now unless WP_DEBUG is active
* [Changed] Role class parse_value() method now must define 3rd parameter $human_readable
* [Added] Role recipient
* [Added] Option to disable notification for specific post (and in future for user or comment), thanks to Jeff Lehman
* [Changed] string, integer and float merge tags used in the message subject are now rendered
= 2.2 =
* [Added] `notification/metabox/trigger/tags/before` and `notification/metabox/trigger/tags/after` actions to merge tags metabox
* [Added] `notification/metabox/recipients/before` and `notification/metabox/recipients/after` actions to recipients metabox
* [Added] `notification/metabox/trigger/before` and `notification/metabox/trigger/after` actions to trigger metabox
* [Fixed] Settings register action priority
* [Fixed] Post type trashed template
* [Changed] Gulpfile to not include any browser
* [Fixed] Comment type added template
* [Changed] Comment added trigger now is Akismet compatibile, thanks to Nels Johnson
* [Changed] Core triggers current type global to anonymous functions, thanks to Bartosz Romanowski @toszcze
= 2.1 =
* [Fixed] Warning when no post or comment type are selected in the settings. Thanks to JoeHana
* [Fixed] post published trigger
* [Changed] Post type name in trigger title is now singular
* [Added] {author_login} merge tag to each post trigger
* [Added] Promo video: https://www.youtube.com/watch?v=usdBMPjdiuw
= 2.0.1 =
* [Fixed] Issue with not sent emails because of wrong current post type while registering notification action. Thanks to Karl Camenzuli
= 2.0 =
* [Fixed]: Correct choice selected for WP User recipient after saving notification. Thanks to whitwye
* [Added]: Settings API
* [Added]: Setting - what to remove upon plugin removal
* [Added]: Plugin cleanup procedure
* [Added]: Plugin deactivation feedback popup
* [Added]: Conditional tag `is_notification_defined()` to check if notification will be send
* [Added]: Post permalink to comment triggers
* [Changed]: Notifications class is now singleton and partialy moved to Admin class
* [Changed]: Notification trigger metabox is now under the subject
* [Changed]: On the single Notification edit screen there are only allowed metaboxes displayed
* [Changed]: You can now controll what post types and comment types trigger use via plugin Settings
= 1.4 =
* [Fixed]: Missing 3rd argument on page publish
* [Fixed]: Namespace issue for PHP < 5.3
* [Fixed]: Constant notification on post edit. Thanks to @pehbeh
* [Changed]: Allow for merge tags empty values. Thanks to kokoq
* [Added]: Admin notice: beg for a review. It will display only if there's at least one notification set, on the Notification plugin screens and can be dismissed easly.
= 1.3.1 =
* [Fixed]: Error with "Can't use function return value in write context" in empty() function. Thanks to Błażej Zabłotny
= 1.3 =
* [Added]: PHP version check
* [Changed]: Typos in readme.txt file thanks to justyn-clark (https://github.com/Kubitomakita/Notification/pull/1)
= 1.2 =
* [Added]: New User recipient (takes WordPress users)
* [Added]: Post/Page updated trigger
* [Added]: Template for triggers. You can now load default template for user
* [Changed]: Default post published trigger for posts and pages - it was triggered every time post was updated
* [Changed]: In Notifications table values are now parsed before displaying
* [Changed]: Readme file
= 1.1.2 =
* Changed priority for main init action from 10 to 5
* Added 'notification/cpt/capability_type' filter for capability mapping
= 1.1 =
* Added ability to distribute in any plugin or theme
= 1.0 =
* Release
== Upgrade Notice ==
= 1.1 =
* Added ability to distribute in any plugin or theme
= 1.0 =
* Release