Community Documentation

xmlrpc

5 common.inc xmlrpc($url)
6 common.inc xmlrpc($url)
7 common.inc xmlrpc($url, $args, $options = array())
8 common.inc xmlrpc($url, $args, $options = array())

Performs one or more XML-RPC request(s).

Usage example:

<?php
$result = xmlrpc('http://example.com/xmlrpc.php', array(
  'service.methodName' => array($parameter, $second, $third),
));
?>

Parameters

$url: An absolute URL of the XML-RPC endpoint.

$args: An associative array whose keys are the methods to call and whose values are the arguments to pass to the respective method. If multiple methods are specified, a system.multicall is performed.

$options: (optional) An array of options to pass along to drupal_http_request().

Return value

For one request: Either the return value of the method on success, or FALSE. If FALSE is returned, see xmlrpc_errno() and xmlrpc_error_msg(). For multiple requests: An array of results. Each result will either be the result returned by the method called, or an xmlrpc_error object if the call failed. See xmlrpc_error().

▾ 5 functions call xmlrpc()

XMLRPCBasicTestCase::testListMethods in modules/simpletest/tests/xmlrpc.test
Ensure that a basic XML-RPC call with no parameters works.
XMLRPCBasicTestCase::testMethodSignature in modules/simpletest/tests/xmlrpc.test
Ensure that system.methodSignature returns an array of signatures.
XMLRPCMessagesTestCase::testAlterListMethods in modules/simpletest/tests/xmlrpc.test
Ensure that hook_xmlrpc_alter() can hide even builtin methods.
XMLRPCMessagesTestCase::testSizedMessages in modules/simpletest/tests/xmlrpc.test
Make sure that XML-RPC can transfer large messages.
XMLRPCValidator1IncTestCase::testValidator1 in modules/simpletest/tests/xmlrpc.test
Run validator1 tests.

File

includes/common.inc, line 7823
Common functions that many Drupal modules will need to reference.

Code

<?php
function xmlrpc($url, $args, $options = array()) {
  require_once DRUPAL_ROOT . '/includes/xmlrpc.inc';
  return _xmlrpc($url, $args, $options);
}
?>

Comments

Example

This is how you would use drupal's xmlrpc to call another drupal site

$result = xmlrpc('http://drupal-install-domain.com/xmlrpc.php', array(
    array('system.method', $param1, $param2, $param3),
));

Example: system.listMethods

This works (note the empty array() of parameters):
$methods = xmlrpc($url, array('system.listMethods' => array()));

Login or register to post comments