https://github.com/micc83/wp-heartbeat-notify
Based on WordPress 3.6 heartbeat API, Wp Hearbeat Notify, display a realtime custom message to your visitor each time a new post is published with a link redirecting to it. Still in beta version, this plugin has been full tested only on WordPress 3.6-beta3.
https://github.com/micc83/wp-heartbeat-notify
Last synced: about 1 year ago
JSON representation
Based on WordPress 3.6 heartbeat API, Wp Hearbeat Notify, display a realtime custom message to your visitor each time a new post is published with a link redirecting to it. Still in beta version, this plugin has been full tested only on WordPress 3.6-beta3.
- Host: GitHub
- URL: https://github.com/micc83/wp-heartbeat-notify
- Owner: micc83
- Created: 2013-06-20T07:18:50.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2014-04-17T06:56:07.000Z (about 12 years ago)
- Last Synced: 2025-04-06T19:07:22.610Z (about 1 year ago)
- Language: PHP
- Size: 206 KB
- Stars: 51
- Watchers: 10
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wp-heartbeat-notify
#### WordPress realtime new post notifications based on heartbeat API
Based on **WordPress 3.6 heartbeat API**, Wp Heartbeat Notify, display a realtime custom message to your visitor each time a new post is published with a link redirecting to it. Still in beta version, this plugin has been **full tested only on WordPress 3.6-beta3**.
## Install
Just upload `wp-heartbeat-notify` to your WordPress `wp-content/plugin/` folder. Go to *Plugins->Installed plugins* WordPress menu and activate it. That's it... You just have to write a new article to see it in action (Clearly, the notification will not be displayed to the user who created the event. So, for the purposes of testing, I suggest you open another browser where you're not logged in).
## Purpose
This is probably the first, or at least one of the first WordPress plugin that makes use of the Heartbeat API. Its purpose is almost purely didactic and I hope that the solution that I have implemented it can be useful for developing new ideas.
The plugin, however, is fully functional and can increase the functionality with a few lines of code, as described below.
## Under the hood
The functioning of the plugin is quite simple.
* All scripts and styles necessary for the functioning of heartbeat are queued
* To generate a notification you hook onto an action or a filter of WordPress and you create a transient that match the length of the heartbeat rate
* wp-heartbeat-notify, every few seconds, check the presence of transient and output the content as a notification
Easy... Isn't it?
## Add new notice
To add a new notice, as stated before, you just have to hook into an action or filter and run `Wp_Heartbeat_Notify::notify( $args )` as in the following example:
### Add a notice on registered users comments
```php
// Let's hook into Comment publication
add_filter ( 'comment_post', 'notify_new_comment' );
function notify_new_comment( $comment_id ) {
// Retrieve the comment
$comment = get_comment( $comment_id );
// Check if the user is registered
if ( ! $comment->user_id > 0 )
return;
// Get the comment link
$comment_link = get_comment_link( $comment_id );
// Here's the magic
Wp_Heartbeat_Notify::notify( array(
'title' => 'New Comment by ' . $comment->comment_author,
'content' => 'There\'s a new comment, why don\'t you give it a look?',
'type' => 'info'
) );
}
```
## Support and contacts
If you need support you can find me on [twitter](https://twitter.com/Micc1983) or comment on the dedicated page on my [website](http://codeb.it/).