Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

The beginings of better phpdoc for XMLRPC functions. See #15238 props koke.

Browse Source 
git-svn-id: http://svn.automattic.com/wordpress/trunk@17646 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi 2011-04-18 07:23:47 +00:00
parent d4731da5c4
commit 50299d53c0
1 changed files with 47 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
wp-includes/class-wp-xmlrpc-server.php
View File

@ -382,8 +382,15 @@ class wp_xmlrpc_server extends IXR_Server {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param array $args Method parameters. * @param array $args Method parameters. Contains:
* @return array * - username
* - password
* @return array. Contains:
* - 'isAdmin'
* - 'url'
* - 'blogid'
* - 'blogName'
* - 'xmlrpc' - url of xmlrpc endpoint
*/ */
function wp_getUsersBlogs( $args ) { function wp_getUsersBlogs( $args ) {
global $current_site; global $current_site;
@ -435,7 +442,11 @@ class wp_xmlrpc_server extends IXR_Server {
* *
* @since 2.2.0 * @since 2.2.0
* *
* @param array $args Method parameters. * @param array $args Method parameters. Contains:
* - blog_id
* - page_id
* - username
* - password
* @return array * @return array
*/ */
function wp_getPage($args) { function wp_getPage($args) {
@ -536,7 +547,11 @@ class wp_xmlrpc_server extends IXR_Server {
* *
* @since 2.2.0 * @since 2.2.0
* *
* @param array $args Method parameters. * @param array $args Method parameters. Contains:
* - blog_id
* - username
* - password
* - num_pages
* @return array * @return array
*/ */
function wp_getPages($args) { function wp_getPages($args) {
@ -582,7 +597,7 @@ class wp_xmlrpc_server extends IXR_Server {
* *
* @since 2.2.0 * @since 2.2.0
* *
* @param array $args Method parameters. * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()}
* @return unknown * @return unknown
*/ */
function wp_newPage($args) { function wp_newPage($args) {
@ -2073,10 +2088,36 @@ class wp_xmlrpc_server extends IXR_Server {
/** /**
* Create a new post. * 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
* *
* @since 1.5.0 * @since 1.5.0
* *
* @param array $args Method parameters. * @param array $args Method parameters. Contains:
* - blog_id
* - username
* - password
* - content_struct
* - publish
* @return int * @return int
*/ */
function mw_newPost($args) { function mw_newPost($args) {