-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
295 lines (236 loc) · 21.6 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
=== Push Notification for Post and BuddyPress ===
Contributors: murali-indiacitys
Author URI: https://www.muraliwebworld.com
Tags: push notification,mobile app,progressive web app,buddypress,firebase
Donate link: https://www.muraliwebworld.com/support-to-push-notification-plugin-for-buddypress-and-for-post/
Requires at least: 5.0
Tested up to: 6.6
Requires PHP: 7.4
Stable tag: 2.00
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Send free push notifications for post/custom post, BuddyPress from WordPress sites or using mobile app webview and to generate PWA.
== Description ==
It sends push notifications to desktop, android/ios mobile apps using Firebase Cloud Messaging (FCM) Firebase API http v1 or Onesignal or Progressier as notification provider. It has REST API facility to integrate with native/hybrid Android/iOS mobile apps for push notifications. It sends notification whenever new WordPress post, custom post types, new BuddyPress activities, comments published. It has facility to generate PWA - Progressive Web App.
**Plugin features:-**
= Push notifications providers =
Plugin allows to choose different push notification providers
1. Firebase (Free push notifications for desktop, PWA and mobile apps)
2. Onesignal (Free push notification for desktop, PWA and mobile apps)
3. Progressier (Push notifications for PWA)
4. webtoapp (Push notifications for Mobile apps)
(Plugin allows to send push notifications to both Firebase/Onesignal and webtoapp users simultaneously)
Plugin sends Push notifications for following,
1. New post/custom post type published (including bbpress).
2. New BuddyPress activities published.
3. New BuddyPress group activity published (only to members of group).
4. Notifications for BuddyPress mentions in activities.(only to recipient).
5. BuddyPress group invite sent (only to recipient).
6. BuddyPress group details updated.
7. New Buddypress comments published.
8. New BuddyPress message or private messages (only to recipient).
(It is also compatible with Bettermessages plugin).
9. New BuddyPress member joined.
10. For Friend request in BuddyPress (only to recipient).
11. Friendship accepted in BuddyPress (only to requestor).
12. User avatar change in BuddyPress.
13. Cover image change in BuddyPress.
14. Supports Push notifications for BuddyBoss and Better Messages plugins
15. Woocommerce custom post type push notifications.
16. Ability to process more than 200,000 subscribers unlimited push notifications using background action scheduler.
= Admin only push notifications (only to administrators) =
1. When contact form(contactform7 plugin) submitted.
2. When new user registered in site.
= Notifications only for loggedin users =
Enable/Disable option in admin settings to send push notifications using Firebase httpv1 or Onesignal only for loggedin users.
= Custom popup and Bell prompt to subscribe push notifications with subscription options =
Enable/Disable custom prompt with icon to subscribe/unsubscribe push notifications in front end in admin settings.
Choose Horizontal or Vertical custom prompt style and customize the text, color and button.
Enable/Disable Bell prompt icon to subscribe/unsubscribe notifications. Front end users will be able to subscribe to particular category like post, activity, comments, friendship request/accept, other options while subscribing for first time or if user wants to update subscribe options from bell prompt at any time it is needed.
= Shortcodes =
Use shortcode [member name] and [group name] in push notification title and custom content to display user name in title/content in push notifications, similarly for BuddyPress group activities [group name] place holder is available to display group name in title/content in push notifications.
For front end users Shortcode [subscribe_PNFPB_push_notification] is available to Subscribe/Unsubscribe push notifications
= Subscribe/Unsubscribe various push notifications in front end =
Front end push notification menu is available for BuddyPress Front end users to subscribe/unsubscribe various push notifications according to their choices. This menu is available in user profile - settings area. For other users, shortcode is available to display subscription menu for Front end users to subscribe/unsubscribe various push notifications according to their choices.
= Scheduling Push notification =
It allows Scheduled Push notifications to send push notifications hourly(every hour), twice daily(2 times per day), daily, weekly as per WordPress CRON. It also provides option to schedule push notification in background using action scheduler, this will be useful to send notification more than 100000 subscribers simultaneously in background mode.
Push notification scheduling is available for On demand/One time, WordPress Post, BuddyPress activities, BuddyPress group activities and for BuddyPress comments.
= REST API =
REST API to connect mobile native/hybrid apps to send push notification from WordPress site to both mobile apps and WordPress sites.
Using this REST API WordPress site gets Firebase Push Notification subscription token from Mobile app(Android/Ios).
This allows to send push notifications to WordPress site users as well as to Native mobile app Android/ios users.
REST API url is https:/<domain>/wp-json/PNFPBpush/v1/subscriptiontoken
= HOW TO USE PLUGIN API TO INTEGRATE MOBILE APP PUSH NOTIFICATION =
[Android app code to integrate with this plugin](https://github.com/muraliwebworld/android-app-to-integrate-push-notification-wordpress-plugin/)
[IOS app code to integrate with this plugin](https://github.com/muraliwebworld/ios-swift-app-to-integrate-push-notification-wordpress-plugin/)
Refer video tutorial under "How to use this plugin" section to configure Firebase options in plugin admin area.
= PWA =
This plugin has facility to generate Progressive Web App (PWA). It also supports Progressier PWA.
Go to plugin settings page to enable/disable PWA app and to customize PWA app with app name, app icon, app theme color, background color for PWA and list of pages to be included in offline cache for web app offline mode.
= Extra settings for NGINX server =
If server is NGINX and not able to create dynamic service worker file https:/<domain>/pnfpb_icpush_pwa_sw.js & PWA manifest json file https:/<domain>/pnfpbmanifest.json then go to plugin settings->nginx tab, enable static file creation option, it will create required static service worker file, PWA manifest json files in root folder. This option is applicable only if hosting/server is based on NGINX and not creating dynamic service worker file, manifest json files. By default, this plugin creates dynamic service worker file and PWA manifest json file.
This plugin uses Firebase Cloud Messaging to send push notification using Firebase registration credentials which is free of cost.
= Plugin Demo site =
[Test PNFPB plugin here](https://www.muraliwebworld.com/)
= Video tutorial showing how to configure Firebase for this plugin =
[youtube https://www.youtube.com/watch?v=02oymYLt3qo]
== Installation ==
Following are steps to configure the plugin,
1. Download the plugin
2. Activate the plugin
3. Go to settings of the plugin (in admin menu -> Settings -> Push Notification using FCM)
4. Enable/Disable push notification when new item published in following,
4.a. new post types published,
4.b. new custom post types published,
4.c. BuddyPress activities,
4.d. BuddyPress Group members,
4.e. BuddyPress messages,
4.f. BuddyPress comments
4.g. New BuddyPress member joined
4.h. Friend request in BuddyPress
4.i. Friendship accepted in BuddyPress
4.j. User avatar change in BuddyPress
4.k. Cover image change in BuddyPress
4.l. Group invite
4.m. Group details update
4.n. Contactform7 submitted (Admin notification)
4.o. New user registration (Admin notification)
= Scheduling push notifications =
5.Optionally it allows to Schedule push notifications for post types,BuddyPress new activities, BuddyPress new Group activities and for BuddyPress new comments. Push notifications can be scheduled in following schedules. Go to admin settings and schedule it accordingly.Schedule push notifications in Hourly, twice daily,daily,weekly schedules.
6.When BuddyPress Group Members option is enabled, it will send push notification only to users who joined in Group/to Particular group members.
7.When Buddypress private message notification is enabled, Private message notification will be sent only to the recipient id sent by sender.
= Firebase configuration =
** Video tutorial showing how to configure Firebase for this plugin **
[youtube https://www.youtube.com/watch?v=02oymYLt3qo]
8. Configure Firebase settings as per below steps,
= Firebase configuration setup in plugin admin settings =
Sign in to Firebase, then open your project, click settings icon & select Project settings
= To get Firebase server key (for field 1 in admin firebase settings) =
project settings > cloud messaging tab > get server key or add server key button to get server key
= To get Firebase config fields (for fields 2 to 8 in admin firebase settings) =
If you do not have web app, Create a new web app. After creating a new app, it will show firebase config fields
Project settings > General under your apps section > click on config button to view configuration fields
= To get Firebase public key (for field 9 in admin firebase settings) =
Open the Cloud Messaging tab of the Firebase console Settings pane and scroll to the Web configuration section.
In the Web Push certificates tab, click Generate Key Pair. The console displays a notice that the key pair was generated, and displays the public key string and date added.
(If you already Generated key pair then no need to generate it again)
= Progressive Web App (PWA) settings =
9. Go to PWA settings in plugin admin area and fill all required fields to customize and generate PWA app with offline facility.If pages are included for offline cache then users will be able to view those pages in offline mode without internet if page is not stored in cache then default offline page will be displayed.if all urls needs to be excluded from offline PWA cache then enable exclude all urls option in PWA settings.
10. Go to on-demand push notification admin panel to send push notification from admin panel to all subscribers whenever it required.
After saving below fields, it will ask to allow notification for this website in browser default popup, click on allow notification to get notifications
Push notifications will better work in normal browser not in cognito private browser as it requires service worker registrations to display push notification.
After completing above steps, push notification will be displayed based on option selected for posts/buddypress while publishing posts or custom post types or during new BuddyPress activities or comments.
11.For front end users Shortcode [subscribe_PNFPB_push_notification] is available to Subscribe/Unsubscribe push notifications for following
11.1. Subscribe all notifications
11.2. Subscribe to all new post/new BuddyPress activity notifications
11.3. Subscribe to all new comments for post,BuddyPress activities notifications
11.4. Subscribe to new comments notifications only from My BuddyPress activities or My post based on Post Author id/BuddyPress activity Author id
11.5. New BuddyPress member joined
11.6. Friend request in BuddyPress
11.7. Friendship accepted in BuddyPress
11.8. User avatar change in BuddyPress
11.9. Cover image change in BuddyPress
11.10. Unsubscribe all notifications
12. Shortcode [PNFPB_PWA_PROMPT] to create button to install PWA. If user clicks this button, it will show default prompt to install PWA. This shortcode can be placed anywhere or in sidebar according to convenience.
== Frequently Asked Questions ==
= Do you have any questions? =
[Submit or contact us with your question here](https://www.muraliwebworld.com/groups/wordpress-plugins-by-muralidharan-indiacitys-com-technologies/forum/topic/push-notification-for-post-and-buddypress/) (or) [Please contact us here with your query.](https://indiacitys.com/#contact) (or) Submit your question in plugin forum
== Screenshots ==
1. Push notification in Mobile
2. Desktop push notification
3. Plugin settings for push notification in admin area
4. Plugin settings for push notification with BuddyPress options in admin area
5. Shortcode push notification options for front-end users to opt for various notifications
6. BuddyPress Group members can subscribe/remove push notification for every group
7. Admin page showing list of tokens subscribed
8. Progressive Web App admin settings page
9. On demand push notification page in plugin settings area
10.Customize plugin buttons
11.API for mobile app which are using webview
12.Special settings for NGINX based server
== Changelog ==
= 2.00 version October 08 2024 =
* Plugin now supports webtoapp push notification provider for mobile apps inaddition Firebase/Onesignal/Progressier.
* If post notification is already scheduled, it will display status message in post editor screen indicating it is already scheduled. Users must enable schedule if it needs to be re-scheduled.
* Resolved problem to include featured image of post in scheduling post push notification.
* All post push notifications will be saved under admin notifications tab to resend or re-schedule notifications again.
* Resolved duplicate notification for one time push notifications from admin page.
* Plugin Admin left sidebar menus are updated to sync with menu names in plugin admin settings page.
* Plugin admin menu for one time push notification is renamed as send push notification.
* Added new webtoapp option in plugin admin settings to send push notifications to mobile apps using webtoapp provider.
* Added new data field "click_action": "FLUTTER_NOTIFICATION_CLICK" for Flutter mobile app users. click_action url shall be used from push notifications in flutter mobile app to navigate to particular page after clicking on notifications in mobile.
= 1.98 version August 12 2024 =
* Added schedule push notification facility for post inside post editor.
* Post notifications will be saved in notification tab from this release to resend/schedule later.
* Custom post types are included under front end subscriptions in Notification Bell prompt/ custom prompt, shortcode and in BuddyPress front end notification settings.
* Added new option to Replace prior notification to avoid many notifications in notification center.
* Added new option not to re-notify users when notification are replaced.
* Added Progressier as additional push notification provider along with Firebase or Onesignal.
* Added Progressier PWA support.
* Progressier push notification supports post / custom post, Buddypress activities / group activities, comments, friendship accept/request and Private messages, Frontend BuddyPress notification settings.
* PNFPB PWA - added option to add IOS splash screens for IOS PWA app
* PNFPB PWA - modified to display custom prompt for PWA installation for ios users with instructions
* User Avatar will be included in all push notifications.
* Resolved problem related to un-subscribe/subscribe various push notification options for Firebase httpv1 notifications.
* Compatible with WordPress 6.6
= 1.94 version June 29 2024 =
* Security fix
* Bug fix: Removed progress bar if browser is already subscribed
* Bug fix: Resolved problem related to un-subscribe push notification for BuddyPress group
= 1.93 version June 19 2024 =
* New admin option for custom prompt push notification to hide notification confirmation message.
* Added new admin field to customize notification confirmation for custom prompt notification.
* Bug fix: Resolved problem for BuddyBoss push notification on activities.
* Bug fix: Update to make this plugin compatible with vikinger community theme.
= 1.91 version June 13 2024 =
* Bug fix: Resolved problem related to custom prompt for push notification subscription when push notification providers are changed like Firebase/Onesignal/Others.
* Bug fix: Resolved problems related to conversion of legacy Firebase subscription tokens to http v1 Firebase version.
* Bug fix: Resolved problems related to push notifications containing special characters, white space or regional language characters.
= 1.89 version June 08 2024 =
* Bug fix: Fixed loop problem related to httpv1 firebase push notification.
[Old release version details are available here](https://www.pnfpb.com/release-notes-pnfpb-plugin-push-notification-for-post-and-buddypress/)
== Upgrade Notice ==
* Plugin now supports webtoapp push notification provider for mobile apps inaddition Firebase/Onesignal/Progressier.
* If post notification is already scheduled, it will display status message in post editor screen indicating it is already scheduled. Users must enable schedule if it needs to be re-scheduled.
* Resolved problem to include featured image of post in scheduling post push notification.
* All post push notifications will be saved under admin notifications tab to resend or re-schedule notifications again.
* Resolved duplicate notification for one time push notifications from admin page.
* Plugin Admin left sidebar menus are updated to sync with menu names in plugin admin settings page.
* Plugin admin menu for one time push notification is renamed as send push notification.
* Added new webtoapp option in plugin admin settings to send push notifications to mobile apps using webtoapp provider.
* Added new data field "click_action": "FLUTTER_NOTIFICATION_CLICK" for Flutter mobile app users. click_action url shall be used from push notifications in flutter mobile app to navigate to particular page after clicking on notifications in mobile.
* Resolved problem to include featured image of post in scheduling post push notification.
* Compatible with WordPress 6.6
* Added schedule push notification facility for post inside post editor.
* Post notifications will be saved in notification tab from this release to resend/schedule later.
* Custom post types are included under front end subscriptions in Notification Bell prompt/ custom prompt, shortcode and in BuddyPress front end notification settings.
* Added new option to Replace prior notification to avoid many notifications in notification center.
* Added new option not to re-notify users when notification are replaced.
* Added Progressier as additional push notification provider along with Firebase or Onesignal.
* Added Progressier PWA support.
* Progressier push notification supports post/custom post, Buddypress activities/group activities, comments, friendship accept/request and Private messages, Frontend BuddyPress notification settings.
* PNFPB PWA - added option to add IOS splash screens for IOS PWA app
* PNFPB PWA - modified to display custom prompt for PWA installation for ios users with instructions
* User Avatar will be included in all push notifications.
* Resolved problem related to un-subscribe/subscribe various push notification options for Firebase httpv1 notifications.
* Security fix
* Bug fix: Removed progress bar if browser is already subscribed
* Bug fix: Resolved problem related to un-subscribe push notification for BuddyPress group
* New admin option for custom prompt push notification to hide notification confirmation message.
* Added new admin field to customize notification confirmation for custom prompt notification.
* Bug fix: Resolved problem for BuddyBoss push notification on activities.
* Bug fix: Update to make this plugin compatible with vikinger community theme.
* Bug fix: Fixed loop problem related to httpv1 firebase push notification.
* New features: PWA new features - New admin PWA tabs for PWA Desktop, Mobile screenshot images, PWA Protocol handler and re-designed PWA admin settings tab.
* Update: Changes to Service worker refresh to reflect changes immediately without waiting, so that PWA changes will be reflected immediately (applicable only for apache servers without NGINX). If NGINX is used then it depends on NGINX cache time in the server.
* Update: Latest httpv1 Firebase version push notification will work without legacy Firebase server key.
* Update: Post/Custom post notification logic changed to trigger based on action transition_post_status instead of save_post to avoid duplicate post notification.
* Update: PWA is now available for all push notification providers onesignal/Firebase push notification.
* Update: Re-designed admin panel for push notification settings.
* Updated logic to have click url in one time custom push notification and for all push notifications using httpv1 Firebase api version.
* Regenerated pot file for text domain to have latest text strings.
* BuddyBoss users - Frontend push notification settings for various notifications are available under user profile - account - push notification subscription, users will be able to control notifications for Firebase/Onesignal push notifications.
* Onesignal push notifications updates based on Frontend notifications settings. If Frontend settings are switched off then notification will be sent to all users for general BuddyPress activities/comments. For group activities,it will be sent only to group users based on frontend settings ON/OFF. Similarly other notifications will work according Front end settings enabled/disabled and based on user subscription settings.
* New feature: Frontend push notification settings for onesignal push notification for BuddyPress frontend users. Frontend user will be able to subscribe/unsubscribe various BuddyPress related push notifications. Frontend push notification menu is available in BuddyPress user profile -> settings -> push notification subscription.
* New feature: BuddyPress group push notifications with subscribe/unsubscribe group push notifications for every group are available for Onesignal push notifications.
[Old release version details are available here](https://www.pnfpb.com/release-notes-pnfpb-plugin-push-notification-for-post-and-buddypress/)