devel:event:xmlrpc_callback_register
This is an old revision of the document!
Table of Contents
This event will be replaced by Remote Plugins |
---|
XMLRPC_CALLBACK_REGISTER
- Description:
- Add XML-RPC callbacks
- DefaultAction:
- None
- Preventable:
- yes
- Added:
- 2008-08-24
The event is signalled by dokuwiki_xmlrpc_server() in lib/exe/xmlrpc.php. You can use this event to register your own XML-RPC callbacks.
Passed Data
The XML-RPC server object.
Plugins handling this event
The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself.
See also
Usage
In the action.php or action plugin you will need to do a 2 step process.
First register the call back hook to a function that will actually add the xml-rpc call.
function register(&$controller) { $controller->register_hook('XMLRPC_CALLBACK_REGISTER', 'BEFORE', $this, 'registerCallback'); }
Second register your function.
function registerCallback(&$event) { $event->data->addCallback( 'report.getReportData', 'plugin:reports:getReportData', array('struct'), 'blah.', true ); }
The addCallback function is as follows. Note that the format for the second parameter is 'plugin:<plugin name>:<function name>'
function addCallback($method, $callback, $args, $help, $public=false)
devel/event/xmlrpc_callback_register.1351019822.txt.gz · Last modified: 2012-10-23 21:17 by Matt2