mirror of
https://github.com/kennethreitz-archive/wordpress-skeleton.git
synced 2026-06-20 15:40:58 +00:00
Kenneth Reitz
80 lines
4.8 KiB
Plaintext
80 lines
4.8 KiB
Plaintext
=== HookPress ===
|
|
Contributors: mitchoyoshitaka
|
|
Author: mitcho (Michael Yoshitaka Erlewine)
|
|
Author URI: http://mitcho.com/
|
|
Plugin URI: http://mitcho.com/code/yarpp/
|
|
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=66G4DATK4999L&item_name=mitcho%2ecom%2fcode%2fhookpress%3a%20donate%20to%20Michael%20Yoshitaka%20Erlewine&no_shipping=0&no_note=1&tax=0¤cy_code=USD&lc=US&charset=UTF%2d8
|
|
Tags: hook, filter, action, plugin, webhook, webhooks, notification, internal
|
|
Requires at least: 2.8
|
|
Tested up to: 2.9.9
|
|
Stable tag: 0.1.8
|
|
|
|
HookPress turns all of your WordPress-internal hooks into webhooks. Possible uses include generating push notifications or using non-PHP web technology to extend WordPress.
|
|
|
|
== Description ==
|
|
|
|
Webhooks are a simple paradigm for developing instant notifications and mashups based on simple HTTP requests. With HookPress you can set up webhooks so that a specified URL (a public service or something you set up) is requested when certain WordPress actions occur. Possible uses include generating push notifications or using non-PHP web technology to extend WordPress.
|
|
|
|
**To learn about the various hooks WordPress provides**, please consult the WordPress Plugin API's [Action Reference](http://codex.wordpress.org/Plugin_API/Action_Reference) and [Filter Reference](http://codex.wordpress.org/Plugin_API/Filter_Reference). Not all hooks are supported yet, but more are in the works.
|
|
|
|
**To learn more about webhooks**, take a look at [the webhooks blog](http://blog.webhooks.org) as well as [The Pushbutton Web](http://dashes.com/anil/2009/07/the-pushbutton-web-realtime-becomes-real.html) by Anil Dash. Webhooks champion Jeff Lindsay's [excellent slides](http://www.slideshare.net/progrium/using-web-hooks) are a particularly good place to start.
|
|
|
|
**To write and host a target script** you can of course use your own server but you might also consider [Scriptlets](http://www.scriptlets.org/). A dead-simple tool which logs any requests thrown at it, `test.php`, is included with HookPress as a great way to test requests generated by your webhooks.
|
|
|
|
== Installation ==
|
|
|
|
Upload the HookPress plugin to your blog's `wp-content/plugins/` directory and activate. In the admin section, go to Settings > Webhooks to add new webhooks.
|
|
|
|
== Frequently Asked Questions ==
|
|
|
|
If you have a feature request or question, please use the <a href='http://wordpress.org/tags/hookpress'>HookPress support forum</a>.
|
|
|
|
= How does HookPress affect performance? =
|
|
|
|
HookPress currently makes requests synchronously so can measurably affect performance. I highly recommend using a caching plugin such as [WP-SuperCache](http://ocaoimh.ie/wp-super-cache/) to stem the performance hit. If your filters' results are time-sensitive or dependent on external data sources as well, make sure to set an appropriate cache expiration time.
|
|
|
|
== Localizations ==
|
|
|
|
HookPress is now localizable. If you would like to localize HookPress, [please contact me first](mailto:hookpress@mitcho.com) to claim your language before starting to work.
|
|
|
|
== Changelog ==
|
|
|
|
= 0.1.8 =
|
|
* Added more filtersÑnow covers basic + comment filters
|
|
* Marking as compatible through 2.9.9, because it should be.
|
|
* Added version checking and beta offers to the options screen.
|
|
= 0.1.7 =
|
|
* Now supports basically all actions. (Still no actions with no arguments.)
|
|
* Added more filter optionsÑnow covers all basic database read filters.
|
|
= 0.1.6 =
|
|
* Added another batch of actions. (Still no actions with no arguments, though... something to consider.)
|
|
* Fixed hooks which referred to the users and links tables.
|
|
= 0.1.5 =
|
|
* Now enforces sending the first field in filters and highlights the first field.
|
|
* Added FAQ note on performance concerns and caching.
|
|
= 0.1.4 =
|
|
* Bugfix: hooks with ID 0 can now be deleted
|
|
* Made HookPress fully localizable - please email before you start localizing to claim your language.
|
|
= 0.1.3 =
|
|
* A small bugfix to the filters list for `save_pre`
|
|
* Initial support for filters with an short list of supported filters
|
|
* Updated `test.php` to return first parameter (to trivially support filters)
|
|
= 0.1.2 =
|
|
* Added support for the `post_url` field
|
|
* Added support for `parent_*` post fields for `save_post` which are sent in case the post is a revision of a previous draft.
|
|
* Fixes a PHP error which displayed on install
|
|
* Disallowed redirects on the webhook - corrects duplicate records when used with PostBin
|
|
= 0.1.1 =
|
|
* Fixed namespace collision with [Yet Another Related Posts Plugin](http://mitcho.com/code/yarpp/).
|
|
* Minor documentation changes.
|
|
= 0.1 =
|
|
* Initial release
|
|
* supports webhooks based on WP actions
|
|
|
|
= Future plans =
|
|
|
|
* Editing webhooks (rather than deleting and adding)
|
|
* More custmization on a per-webhook basis
|
|
|
|
If you have a feature request or question, please use the <a href='http://wordpress.org/tags/hookpress'>HookPress support forum</a>.
|