[ Index ]

PHP Cross Reference of Wordpress 2.9.1

title

Body

[close]

/ -> xmlrpc.php (summary)

XML-RPC protocol support for WordPress

License: GPL v2 <./license.txt>
File Size: 3428 lines (93 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 2 files
 wp-load.php
 wp-admin/includes/admin.php

Defines 1 class

wp_xmlrpc_server:: (62 methods):
  wp_xmlrpc_server()
  serve_request()
  sayHello()
  addTwoNumbers()
  login_pass_ok()
  login()
  escape()
  get_custom_fields()
  set_custom_fields()
  initialise_blog_option_info()
  wp_getUsersBlogs()
  wp_getPage()
  wp_getPages()
  wp_newPage()
  wp_deletePage()
  wp_editPage()
  wp_getPageList()
  wp_getAuthors()
  wp_getTags()
  wp_newCategory()
  wp_deleteCategory()
  wp_suggestCategories()
  wp_getComment()
  wp_getComments()
  wp_deleteComment()
  wp_editComment()
  wp_newComment()
  wp_getCommentStatusList()
  wp_getCommentCount()
  wp_getPostStatusList()
  wp_getPageStatusList()
  wp_getPageTemplates()
  wp_getOptions()
  _getOptions()
  wp_setOptions()
  blogger_getUsersBlogs()
  blogger_getUserInfo()
  blogger_getPost()
  blogger_getRecentPosts()
  blogger_getTemplate()
  blogger_setTemplate()
  blogger_newPost()
  blogger_editPost()
  blogger_deletePost()
  mw_newPost()
  add_enclosure_if_new()
  attach_uploads()
  mw_editPost()
  mw_getPost()
  mw_getRecentPosts()
  mw_getCategories()
  mw_newMediaObject()
  mt_getRecentPostTitles()
  mt_getCategoryList()
  mt_getPostCategories()
  mt_setPostCategories()
  mt_supportedMethods()
  mt_supportedTextFilters()
  mt_getTrackbackPings()
  mt_publishPost()
  pingback_ping()
  pingback_extensions_getPingbacks()

Defines 62 functions

  logIO()

Class: wp_xmlrpc_server  - X-Ref

WordPress XMLRPC server implementation.

Implements compatability for Blogger API, MetaWeblog API, MovableType, and
pingback. Additional WordPress API for managing comments, pages, posts,
options, etc.

Since WordPress 2.6.0, WordPress XMLRPC server can be disabled in the
administration panels.

wp_xmlrpc_server()   X-Ref
Register all of the XMLRPC methods that XMLRPC server understands.

PHP4 constructor and sets up server and method property. Passes XMLRPC
methods through the 'xmlrpc_methods' filter to allow plugins to extend
or replace XMLRPC methods.

return: wp_xmlrpc_server

serve_request()   X-Ref
No description

sayHello($args)   X-Ref
Test XMLRPC API by saying, "Hello!" to client.

param: array $args Method Parameters.
return: string

addTwoNumbers($args)   X-Ref
Test XMLRPC API by adding two numbers for client.

param: array $args Method Parameters.
return: int

login_pass_ok($user_login, $user_pass)   X-Ref
Check user's credentials.

param: string $user_login User's username.
param: string $user_pass User's password.
return: bool Whether authentication passed.

login($username, $password)   X-Ref
Log user in.

param: string $username User's username.
param: string $password User's password.
return: mixed WP_User object if authentication passed, false otherwise

escape(&$array)   X-Ref
Sanitize string or array of strings for database.

param: string|array $array Sanitize single string or array of strings.
return: string|array Type matches $array and sanitized for the database.

get_custom_fields($post_id)   X-Ref
Retrieve custom fields for post.

param: int $post_id Post ID.
return: array Custom fields, if exist.

set_custom_fields($post_id, $fields)   X-Ref
Set custom fields for post.

param: int $post_id Post ID.
param: array $fields Custom fields.

initialise_blog_option_info( )   X-Ref
Setup blog options property.

Passes property through 'xmlrpc_blog_options' filter.


wp_getUsersBlogs( $args )   X-Ref
Retrieve the blogs of the user.

param: array $args Method parameters.
return: array

wp_getPage($args)   X-Ref
Retrieve page.

param: array $args Method parameters.
return: array

wp_getPages($args)   X-Ref
Retrieve Pages.

param: array $args Method parameters.
return: array

wp_newPage($args)   X-Ref
Create new page.

param: array $args Method parameters.
return: unknown

wp_deletePage($args)   X-Ref
Delete page.

param: array $args Method parameters.
return: bool True, if success.

wp_editPage($args)   X-Ref
Edit page.

param: array $args Method parameters.
return: unknown

wp_getPageList($args)   X-Ref
Retrieve page list.

param: array $args Method parameters.
return: unknown

wp_getAuthors($args)   X-Ref
Retrieve authors list.

param: array $args Method parameters.
return: array

wp_getTags( $args )   X-Ref
Get list of all tags

param: array $args Method parameters.
return: array

wp_newCategory($args)   X-Ref
Create new category.

param: array $args Method parameters.
return: int Category ID.

wp_deleteCategory($args)   X-Ref
Remove category.

param: array $args Method parameters.
return: mixed See {@link wp_delete_category()} for return info.

wp_suggestCategories($args)   X-Ref
Retrieve category list.

param: array $args Method parameters.
return: array

wp_getComment($args)   X-Ref
Retrieve comment.

param: array $args Method parameters.
return: array

wp_getComments($args)   X-Ref
Retrieve comments.

param: array $args Method parameters.
return: array

wp_deleteComment($args)   X-Ref
Remove comment.

param: array $args Method parameters.
return: mixed {@link wp_delete_comment()}

wp_editComment($args)   X-Ref
Edit comment.

param: array $args Method parameters.
return: bool True, on success.

wp_newComment($args)   X-Ref
Create new comment.

param: array $args Method parameters.
return: mixed {@link wp_new_comment()}

wp_getCommentStatusList($args)   X-Ref
Retrieve all of the comment status.

param: array $args Method parameters.
return: array

wp_getCommentCount( $args )   X-Ref
Retrieve comment count.

param: array $args Method parameters.
return: array

wp_getPostStatusList( $args )   X-Ref
Retrieve post statuses.

param: array $args Method parameters.
return: array

wp_getPageStatusList( $args )   X-Ref
Retrieve page statuses.

param: array $args Method parameters.
return: array

wp_getPageTemplates( $args )   X-Ref
Retrieve page templates.

param: array $args Method parameters.
return: array

wp_getOptions( $args )   X-Ref
Retrieve blog options.

param: array $args Method parameters.
return: array

_getOptions($options)   X-Ref
Retrieve blog options value from list.

param: array $options Options to retrieve.
return: array

wp_setOptions( $args )   X-Ref
Update blog options.

param: array $args Method parameters.
return: unknown

blogger_getUsersBlogs($args)   X-Ref
Retrieve blogs that user owns.

Will make more sense once we support multiple blogs.

param: array $args Method parameters.
return: array

blogger_getUserInfo($args)   X-Ref
Retrieve user's data.

Gives your client some info about you, so you don't have to.

param: array $args Method parameters.
return: array

blogger_getPost($args)   X-Ref
Retrieve post.

param: array $args Method parameters.
return: array

blogger_getRecentPosts($args)   X-Ref
Retrieve list of recent posts.

param: array $args Method parameters.
return: array

blogger_getTemplate($args)   X-Ref
Retrieve blog_filename content.

param: array $args Method parameters.
return: string

blogger_setTemplate($args)   X-Ref
Updates the content of blog_filename.

param: array $args Method parameters.
return: bool True when done.

blogger_newPost($args)   X-Ref
Create new post.

param: array $args Method parameters.
return: int

blogger_editPost($args)   X-Ref
Edit a post.

param: array $args Method parameters.
return: bool true when done.

blogger_deletePost($args)   X-Ref
Remove a post.

param: array $args Method parameters.
return: bool True when post is deleted.

mw_newPost($args)   X-Ref
Create a new post.

param: array $args Method parameters.
return: int

add_enclosure_if_new($post_ID, $enclosure)   X-Ref
No description

attach_uploads( $post_ID, $post_content )   X-Ref
Attach upload to a post.

param: int $post_ID Post ID.
param: string $post_content Post Content for attachment.

mw_editPost($args)   X-Ref
Edit a post.

param: array $args Method parameters.
return: bool True on success.

mw_getPost($args)   X-Ref
Retrieve post.

param: array $args Method parameters.
return: array

mw_getRecentPosts($args)   X-Ref
Retrieve list of recent posts.

param: array $args Method parameters.
return: array

mw_getCategories($args)   X-Ref
Retrieve the list of categories on a given blog.

param: array $args Method parameters.
return: array

mw_newMediaObject($args)   X-Ref
Uploads a file, following your settings.

Adapted from a patch by Johann Richard.

param: array $args Method parameters.
return: array

mt_getRecentPostTitles($args)   X-Ref
Retrieve the post titles of recent posts.

param: array $args Method parameters.
return: array

mt_getCategoryList($args)   X-Ref
Retrieve list of all categories on blog.

param: array $args Method parameters.
return: array

mt_getPostCategories($args)   X-Ref
Retrieve post categories.

param: array $args Method parameters.
return: array

mt_setPostCategories($args)   X-Ref
Sets categories for a post.

param: array $args Method parameters.
return: bool True on success.

mt_supportedMethods($args)   X-Ref
Retrieve an array of methods supported by this server.

param: array $args Method parameters.
return: array

mt_supportedTextFilters($args)   X-Ref
Retrieve an empty array because we don't support per-post text filters.

param: array $args Method parameters.

mt_getTrackbackPings($args)   X-Ref
Retrieve trackbacks sent to a given post.

param: array $args Method parameters.
return: mixed

mt_publishPost($args)   X-Ref
Sets a post's publish status to 'publish'.

param: array $args Method parameters.
return: int

pingback_ping($args)   X-Ref
Retrieves a pingback and registers it.

param: array $args Method parameters.
return: array

pingback_extensions_getPingbacks($args)   X-Ref
Retrieve array of URLs that pingbacked the given URL.

Specs on http://www.aquarionics.com/misc/archives/blogite/0198.html

param: array $args Method parameters.
return: array

Functions
Functions that are not part of a class:

logIO($io,$msg)   X-Ref
logIO() - Writes logging info to a file.

param: string $io Whether input or output
param: string $msg Information describing logging reason.
return: bool Always return true



Generated: Fri Jan 8 00:19:48 2010 Cross-referenced by PHPXref 0.7