Version 8
🤸♀️ User guide
Push
Version 1.0.0 or later
First-time configuration
After installing and activating the plugin you have to generate VAPID Keys. They are used to authorize Subscribers, and without them, the integration will not work.
Click the link in admin notification or head over to Settings -> Carriers -> Push.
.png?alt=media&token=81a8bf40-8beb-4f29-a481-29517d34042e)
Next, press Generate button and Save changes.
.png?alt=media&token=097e86e2-077b-4adb-b522-43b349ff43cf)
Plugin configuration
Permission Pop-Up mode
By default pop-up asking for permission to receive Push Notifications will be shown after clicking the "Subscribe" button (Manual mode). You can change it to show a pop-up to Users immediately after the first click on the page (Automatic mode).
Subscribing by logged-in Users
To gain more control over subscriptions you can check the option, that only logged-in users can subscribe to receive Push Notifications. This mode is recommended if you want to send more personal Notifications, e.g. about changing order status.
The "Subscribe" button
You can display the "Subscribe" button on any of your pages using
[notification-push-subscribe-button] Shortcode. You can customize it with several attributes:id- set the id attribute to the buttonclass- set the additional classes to the buttonlabel- set the text of the buttongranted_label- set the text of the button if permission is already granteddenied_label- set the text of button if permission was revoked
You can also use the following code to display the button from PHP:
1
use BracketSpace\Notification\Push\Frontend\SubscibeButton;
2
3
SubscibeButton::render();
Copied!
The "Subscribe" button is available to be used in both Manual and Automatic mode.
Managing subscriptions
There is no way to determine who is the subscriber if a subscription is not connected with the user. This situation can happen if the
Subscribing by logged-in Users option is not checked. In this case, the site administrator cannot remove every user subscription on their demand. Fortunately, users can revoke permission by themselves:You can see user subscriptions on the user list in the admin dashboard.
.png?alt=media&token=7cfe63d2-7a17-4b89-b0f5-28c4caff3a92)
In the user edit view, you can see details about its subscriptions, or remove any of them separately.
.png?alt=media&token=25f6cf5d-88b0-4370-81e1-488637f3c079)
Notification Recipients
There are two plugin-specific recipients
Every subscriber
This Recipient will try to send Notification to every subscriber, no matter if they are connected with a specific user or not.
User
This Recipient will try to send Notification to every browser in which the given user subscribed for receiving notifications. The list shows users which are subscribed at least once.
Last modified 6mo ago