WPDev.one
Core Class

wp_xmlrpc_server

class wp_xmlrpc_server // Constructor: function Object() { [native code] }

WordPress XMLRPC server implementation.

Methods 106 methods

Method / Return Description
__construct()
void

Registers all of the XMLRPC methods that XMLRPC server understands.

set_is_enabled()
void

Sets wp_xmlrpc_server::$is_enabled property.

__call()
(array

Makes private/protected methods readable for backward compatibility.

Parameters: $name: mixed, $arguments: mixed
serve_request()
void

Serves the XML-RPC request.

sayHello()
string

Tests XMLRPC API by saying, "Hello!" to client.

addTwoNumbers()
int

Tests XMLRPC API by adding two numbers for client.

Parameters: $args: mixed
login()
(WP_User

Logs user in.

Parameters: $username: mixed, $password: mixed
login_pass_ok()
bool

Checks user's credentials. Deprecated.

Parameters: $username: mixed, $password: mixed
escape()
(string

Escapes string or array of strings for database.

Parameters: $data: mixed
error()
void

Sends error response to client.

Parameters: $error: mixed, $message: mixed
get_custom_fields()
array

Retrieves custom fields for post.

Parameters: $post_id: mixed
set_custom_fields()
void

Sets custom fields for post.

Parameters: $post_id: mixed, $fields: mixed
get_term_custom_fields()
array

Retrieves custom fields for a term.

Parameters: $term_id: mixed
set_term_custom_fields()
void

Sets custom fields for a term.

Parameters: $term_id: mixed, $fields: mixed
initialise_blog_option_info()
void

Sets up blog options property.

wp_getUsersBlogs()
(array

Retrieves the blogs of the user.

Parameters: $args: mixed
minimum_args()
bool

Checks if the method received at least the minimum number of arguments.

Parameters: $args: mixed, $count: mixed
_prepare_taxonomy()
array

Prepares taxonomy data for return in an XML-RPC object.

Parameters: $taxonomy: mixed, $fields: mixed
_prepare_term()
array

Prepares term data for return in an XML-RPC object.

Parameters: $term: mixed
_convert_date()
IXR_Date

Converts a WordPress date string to an IXR_Date object.

Parameters: $date: mixed
_convert_date_gmt()
IXR_Date

Converts a WordPress GMT date string to an IXR_Date object.

Parameters: $date_gmt: mixed, $date: mixed
_prepare_post()
array

Prepares post data for return in an XML-RPC object.

Parameters: $post: mixed, $fields: mixed
_prepare_post_type()
array

Prepares post data for return in an XML-RPC object.

Parameters: $post_type: mixed, $fields: mixed
_prepare_media_item()
array

Prepares media item data for return in an XML-RPC object.

Parameters: $media_item: mixed, $thumbnail_size: mixed
_prepare_page()
array

Prepares page data for return in an XML-RPC object.

Parameters: $page: mixed
_prepare_comment()
array

Prepares comment data for return in an XML-RPC object.

Parameters: $comment: mixed
_prepare_user()
array

Prepares user data for return in an XML-RPC object.

Parameters: $user: mixed, $fields: mixed
wp_newPost()
(int

Creates a new post for any registered post type.

Parameters: $args: mixed
_is_greater_than_one()
bool

Helper method for filtering out elements from an array.

Parameters: $count: mixed
_toggle_sticky()
(void

Encapsulates the logic for sticking a post and determining if

Parameters: $post_data: mixed, $update: mixed
_insert_post()
(IXR_Error

Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Parameters: $user: mixed, $content_struct: mixed
wp_editPost()
(true

Edits a post for any registered post type.

Parameters: $args: mixed
wp_deletePost()
(true

Deletes a post for any registered post type.

Parameters: $args: mixed
wp_getPost()
(array

Retrieves a post.

Parameters: $args: mixed
wp_getPosts()
(array

Retrieves posts.

Parameters: $args: mixed
wp_newTerm()
(int

Creates a new term.

Parameters: $args: mixed
wp_editTerm()
(true

Edits a term.

Parameters: $args: mixed
wp_deleteTerm()
(true

Deletes a term.

Parameters: $args: mixed
wp_getTerm()
(array

Retrieves a term.

Parameters: $args: mixed
wp_getTerms()
(array

Retrieves all terms for a taxonomy.

Parameters: $args: mixed
wp_getTaxonomy()
(array

Retrieves a taxonomy.

Parameters: $args: mixed
wp_getTaxonomies()
(array

Retrieves all taxonomies.

Parameters: $args: mixed
wp_getUser()
(array

Retrieves a user.

Parameters: $args: mixed
wp_getUsers()
(array

Retrieves users.

Parameters: $args: mixed
wp_getProfile()
(array

Retrieves information about the requesting user.

Parameters: $args: mixed
wp_editProfile()
(true

Edits user's profile.

Parameters: $args: mixed
wp_getPage()
(array

Retrieves a page.

Parameters: $args: mixed
wp_getPages()
(array

Retrieves Pages.

Parameters: $args: mixed
wp_newPage()
(int

Creates a new page.

Parameters: $args: mixed
wp_deletePage()
(true

Deletes a page.

Parameters: $args: mixed
wp_editPage()
(array

Edits a page.

Parameters: $args: mixed
wp_getPageList()
(array

Retrieves page list.

Parameters: $args: mixed
wp_getAuthors()
(array

Retrieves authors list.

Parameters: $args: mixed
wp_getTags()
(array

Gets the list of all tags.

Parameters: $args: mixed
wp_newCategory()
(int

Creates a new category.

Parameters: $args: mixed
wp_deleteCategory()
(bool

Deletes a category.

Parameters: $args: mixed
wp_suggestCategories()
(array

Retrieves category list.

Parameters: $args: mixed
wp_getComment()
(array

Retrieves a comment.

Parameters: $args: mixed
wp_getComments()
(array

Retrieves comments.

Parameters: $args: mixed
wp_deleteComment()
(bool

Deletes a comment.

Parameters: $args: mixed
wp_editComment()
(true

Edits a comment.

Parameters: $args: mixed
wp_newComment()
(int

Creates a new comment.

Parameters: $args: mixed
wp_getCommentStatusList()
(array

Retrieves all of the comment status.

Parameters: $args: mixed
wp_getCommentCount()
(array

Retrieves comment counts.

Parameters: $args: mixed
wp_getPostStatusList()
(array

Retrieves post statuses.

Parameters: $args: mixed
wp_getPageStatusList()
(array

Retrieves page statuses.

Parameters: $args: mixed
wp_getPageTemplates()
(array

Retrieves page templates.

Parameters: $args: mixed
wp_getOptions()
(array

Retrieves blog options.

Parameters: $args: mixed
_getOptions()
array

Retrieves blog options value from list.

Parameters: $options: mixed
wp_setOptions()
(array

Updates blog options.

Parameters: $args: mixed
wp_getMediaItem()
(array

Retrieves a media item by ID.

Parameters: $args: mixed
wp_getMediaLibrary()
(array

Retrieves a collection of media library items (or attachments).

Parameters: $args: mixed
wp_getPostFormats()
(array

Retrieves a list of post formats used by the site.

Parameters: $args: mixed
wp_getPostType()
(array

Retrieves a post type.

Parameters: $args: mixed
wp_getPostTypes()
(array

Retrieves post types.

Parameters: $args: mixed
wp_getRevisions()
(array

Retrieves revisions for a specific post.

Parameters: $args: mixed
wp_restoreRevision()
(bool

Restores a post revision.

Parameters: $args: mixed
blogger_getUsersBlogs()
(array

Retrieves blogs that user owns.

Parameters: $args: mixed
_multisite_getUsersBlogs()
(array

Private function for retrieving a users blogs for multisite setups.

Parameters: $args: mixed
blogger_getUserInfo()
(array

Retrieves user's data.

Parameters: $args: mixed
blogger_getPost()
(array

Retrieves a post.

Parameters: $args: mixed
blogger_getRecentPosts()
(array

Retrieves the list of recent posts.

Parameters: $args: mixed
blogger_getTemplate()
IXR_Error

Deprecated.

Parameters: $args: mixed
blogger_setTemplate()
IXR_Error

Deprecated.

Parameters: $args: mixed
blogger_newPost()
(int

Creates a new post.

Parameters: $args: mixed
blogger_editPost()
(true

Edits a post.

Parameters: $args: mixed
blogger_deletePost()
(true

Deletes a post.

Parameters: $args: mixed
mw_newPost()
(int

Creates a new post.

Parameters: $args: mixed
add_enclosure_if_new()
void

Adds an enclosure to a post if it's new.

Parameters: $post_id: mixed, $enclosure: mixed
attach_uploads()
void

Attaches an upload to a post.

Parameters: $post_id: mixed, $post_content: mixed
mw_editPost()
(true

Edits a post.

Parameters: $args: mixed
mw_getPost()
(array

Retrieves a post.

Parameters: $args: mixed
mw_getRecentPosts()
(array

Retrieves list of recent posts.

Parameters: $args: mixed
mw_getCategories()
(array

Retrieves the list of categories on a given blog.

Parameters: $args: mixed
mw_newMediaObject()
(array

Uploads a file, following your settings.

Parameters: $args: mixed
mt_getRecentPostTitles()
(array

Retrieves the post titles of recent posts.

Parameters: $args: mixed
mt_getCategoryList()
(array

Retrieves the list of all categories on a blog.

Parameters: $args: mixed
mt_getPostCategories()
(array

Retrieves post categories.

Parameters: $args: mixed
mt_setPostCategories()
(true

Sets categories for a post.

Parameters: $args: mixed
mt_supportedMethods()
array

Retrieves an array of methods supported by this server.

mt_supportedTextFilters()
void

Retrieves an empty array because we don't support per-post text filters.

mt_getTrackbackPings()
(array

Retrieves trackbacks sent to a given post.

Parameters: $post_id: mixed
mt_publishPost()
(int

Sets a post's publish status to 'publish'.

Parameters: $args: mixed
pingback_ping()
(string

Retrieves a pingback and registers it.

Parameters: $args: mixed
pingback_extensions_getPingbacks()
(array

Retrieves an array of URLs that pingbacked the given URL.

Parameters: $url: mixed
pingback_error()
IXR_Error

Sends a pingback error based on the given error code and message.

Parameters: $code: mixed, $message: mixed

Properties

Property / Type Description
$methods
mixed
public
No description available.
$blog_options
mixed
public
No description available.
$error
mixed
public
No description available.
$auth_failed
mixed
public
No description available.
$is_enabled
mixed
public
No description available.

Class Information

Since Version
1.5.0
Source File
wp-includes/class-wp-xmlrpc-server.php
Advertisement