| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
XML-RPC protocol support for WordPress
| File Size: | 5102 lines (151 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
wp_xmlrpc_server:: (92 methods):
__construct()
serve_request()
sayHello()
addTwoNumbers()
login_pass_ok()
login()
escape()
get_custom_fields()
set_custom_fields()
initialise_blog_option_info()
wp_getUsersBlogs()
minimum_args()
_prepare_taxonomy()
_prepare_term()
_convert_date()
_convert_date_gmt()
_prepare_post()
_prepare_post_type()
_prepare_media_item()
_prepare_page()
_prepare_comment()
wp_newPost()
_is_greater_than_one()
_insert_post()
wp_editPost()
wp_deletePost()
wp_getPost()
wp_getPosts()
wp_newTerm()
wp_editTerm()
wp_deleteTerm()
wp_getTerm()
wp_getTerms()
wp_getTaxonomy()
wp_getTaxonomies()
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()
wp_getMediaItem()
wp_getMediaLibrary()
wp_getPostFormats()
wp_getPostType()
wp_getPostTypes()
blogger_getUsersBlogs()
_multisite_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()
Class: wp_xmlrpc_server - X-Ref
WordPress XMLRPC server implementation.| __construct() X-Ref |
| Register all of the XMLRPC methods that XMLRPC server understands. 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 |
| Set up 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. Contains: return: array. Contains: |
| minimum_args( $args, $count ) X-Ref |
| Checks if the method received at least the minimum number of arguments. param: string|array $args Sanitize single string or array of strings. param: int $count Minimum number of arguments. return: boolean if $args contains at least $count arguments. |
| _prepare_taxonomy( $taxonomy, $fields ) X-Ref |
| Prepares taxonomy data for return in an XML-RPC object. param: object $taxonomy The unprepared taxonomy data param: array $fields The subset of taxonomy fields to return return: array The prepared taxonomy data |
| _prepare_term( $term ) X-Ref |
| Prepares term data for return in an XML-RPC object. param: array|object $term The unprepared term data return: array The prepared term data |
| _convert_date( $date ) X-Ref |
| Convert a WordPress date string to an IXR_Date object. param: string $date return: IXR_Date |
| _convert_date_gmt( $date_gmt, $date ) X-Ref |
| Convert a WordPress GMT date string to an IXR_Date object. param: string $date_gmt param: string $date return: IXR_Date |
| _prepare_post( $post, $fields ) X-Ref |
| Prepares post data for return in an XML-RPC object. param: array $post The unprepared post data param: array $fields The subset of post type fields to return return: array The prepared post data |
| _prepare_post_type( $post_type, $fields ) X-Ref |
| Prepares post data for return in an XML-RPC object. param: object $post_type Post type object param: array $fields The subset of post fields to return return: array The prepared post type data |
| _prepare_media_item( $media_item, $thumbnail_size = 'thumbnail' ) X-Ref |
| Prepares media item data for return in an XML-RPC object. param: object $media_item The unprepared media item data param: string $thumbnail_size The image size to use for the thumbnail URL return: array The prepared media item data |
| _prepare_page( $page ) X-Ref |
| Prepares page data for return in an XML-RPC object. param: object $page The unprepared page data return: array The prepared page data |
| _prepare_comment( $comment ) X-Ref |
| Prepares comment data for return in an XML-RPC object. param: object $comment The unprepared comment data return: array The prepared comment data |
| wp_newPost( $args ) X-Ref |
| Create a new post for any registered post type. param: array $args Method parameters. Contains: return: string post_id |
| _is_greater_than_one( $count ) X-Ref |
| Helper method for filtering out elements from an array. param: int $count Number to compare to one. |
| _insert_post( $user, $content_struct ) X-Ref |
| Helper method for wp_newPost and wp_editPost, containing shared logic. param: WP_User $user The post author if post_author isn't set in $content_struct. param: array $content_struct Post data to insert. |
| wp_editPost( $args ) X-Ref |
| Edit a post for any registered post type. The $content_struct parameter only needs to contain fields that should be changed. All other fields will retain their existing values. param: array $args Method parameters. Contains: return: true on success |
| wp_deletePost( $args ) X-Ref |
| Delete a post for any registered post type. param: array $args Method parameters. Contains: return: true on success |
| wp_getPost( $args ) X-Ref |
| Retrieve a post. param: array $args Method parameters. Contains: return: array contains (based on $fields parameter): |
| wp_getPosts( $args ) X-Ref |
| Retrieve posts. param: array $args Method parameters. Contains: return: array contains a collection of posts. |
| wp_newTerm( $args ) X-Ref |
| Create a new term. param: array $args Method parameters. Contains: return: string term_id |
| wp_editTerm( $args ) X-Ref |
| Edit a term. param: array $args Method parameters. Contains: return: bool True, on success. |
| wp_deleteTerm( $args ) X-Ref |
| Delete a term. param: array $args Method parameters. Contains: return: boolean|IXR_Error If it suceeded true else a reason why not |
| wp_getTerm( $args ) X-Ref |
| Retrieve a term. param: array $args Method parameters. Contains: return: array contains: |
| wp_getTerms( $args ) X-Ref |
| Retrieve all terms for a taxonomy. param: array $args Method parameters. Contains: return: array terms |
| wp_getTaxonomy( $args ) X-Ref |
| Retrieve a taxonomy. param: array $args Method parameters. Contains: return: array (@see get_taxonomy()) |
| wp_getTaxonomies( $args ) X-Ref |
| Retrieve all taxonomies. param: array $args Method parameters. Contains: return: array taxonomies |
| wp_getPage($args) X-Ref |
| Retrieve page. param: array $args Method parameters. Contains: return: array |
| wp_getPages($args) X-Ref |
| Retrieve Pages. param: array $args Method parameters. Contains: return: array |
| wp_newPage($args) X-Ref |
| Create new page. param: array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()} 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_term()} 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. Besides the common blog_id, username, and password arguments, it takes a filter array as last argument. Accepted 'filter' keys are 'status', 'post_id', 'offset', and 'number'. The defaults are as follows: - 'status' - Default is ''. Filter by status (e.g., 'approve', 'hold') - 'post_id' - Default is ''. The post where the comment is posted. Empty string shows all comments. - 'number' - Default is 10. Total number of media items to retrieve. - 'offset' - Default is 0. See {@link WP_Query::query()} for more. param: array $args Method parameters. return: array. Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents |
| wp_deleteComment($args) X-Ref |
| Delete a comment. By default, the comment will be moved to the trash instead of deleted. See {@link wp_delete_comment()} for more information on this behavior. param: array $args Method parameters. Contains: return: mixed {@link wp_delete_comment()} |
| wp_editComment($args) X-Ref |
| Edit comment. Besides the common blog_id, username, and password arguments, it takes a comment_id integer and a content_struct array as last argument. The allowed keys in the content_struct array are: - 'author' - 'author_url' - 'author_email' - 'content' - 'date_created_gmt' - 'status'. Common statuses are 'approve', 'hold', 'spam'. See {@link get_comment_statuses()} for more details param: array $args. Contains: 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 |
| wp_getMediaItem($args) X-Ref |
| Retrieve a media item by ID param: array $args Method parameters. Contains: return: array. Associative array containing: |
| wp_getMediaLibrary($args) X-Ref |
| Retrieves a collection of media library items (or attachments) Besides the common blog_id, username, and password arguments, it takes a filter array as last argument. Accepted 'filter' keys are 'parent_id', 'mime_type', 'offset', and 'number'. The defaults are as follows: - 'number' - Default is 5. Total number of media items to retrieve. - 'offset' - Default is 0. See {@link WP_Query::query()} for more. - 'parent_id' - Default is ''. The post where the media item is attached. Empty string shows all media items. 0 shows unattached media items. - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf') param: array $args Method parameters. Contains: return: array. Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents |
| wp_getPostFormats( $args ) X-Ref |
| Retrieves a list of post formats used by the site param: array $args Method parameters. Contains: return: array |
| wp_getPostType( $args ) X-Ref |
| Retrieves a post type param: array $args Method parameters. Contains: return: array contains: |
| wp_getPostTypes( $args ) X-Ref |
| Retrieves a post types param: array $args Method parameters. Contains: return: array |
| 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 |
| _multisite_getUsersBlogs($args) X-Ref |
| Private function for retrieving a users blogs for multisite setups |
| 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. The 'content_struct' argument must contain: - title - description - mt_excerpt - mt_text_more - mt_keywords - mt_tb_ping_urls - categories Also, it can optionally contain: - wp_slug - wp_password - wp_page_parent_id - wp_page_order - wp_author_id - post_status | page_status - can be 'draft', 'private', 'publish', or 'pending' - mt_allow_comments - can be 'open' or 'closed' - mt_allow_pings - can be 'open' or 'closed' - date_created_gmt - dateCreated - wp_post_thumbnail param: array $args Method parameters. Contains: 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 |
| Generated: Fri May 25 03:56:23 2012 | Hosted by follow the white rabbit. |