WordPress.org

Make WordPress Core

Changeset 17646


Ignore:
Timestamp:
04/18/11 07:23:47 (3 years ago)
Author:
westi
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/class-wp-xmlrpc-server.php

    r17554 r17646  
    383383     * @since 2.6.0 
    384384     * 
    385      * @param array $args Method parameters. 
    386      * @return array 
     385     * @param array $args Method parameters. Contains: 
     386     *  - username 
     387     *  - password 
     388     * @return array. Contains: 
     389     *  - 'isAdmin' 
     390     *  - 'url' 
     391     *  - 'blogid' 
     392     *  - 'blogName' 
     393     *  - 'xmlrpc' - url of xmlrpc endpoint 
    387394     */ 
    388395    function wp_getUsersBlogs( $args ) { 
     
    436443     * @since 2.2.0 
    437444     * 
    438      * @param array $args Method parameters. 
     445     * @param array $args Method parameters. Contains: 
     446     *  - blog_id 
     447     *  - page_id 
     448     *  - username 
     449     *  - password 
    439450     * @return array 
    440451     */ 
     
    537548     * @since 2.2.0 
    538549     * 
    539      * @param array $args Method parameters. 
     550     * @param array $args Method parameters. Contains: 
     551     *  - blog_id 
     552     *  - username 
     553     *  - password 
     554     *  - num_pages 
    540555     * @return array 
    541556     */ 
     
    583598     * @since 2.2.0 
    584599     * 
    585      * @param array $args Method parameters. 
     600     * @param array $args Method parameters. See {@link wp_xmlrpc_server::mw_newPost()} 
    586601     * @return unknown 
    587602     */ 
     
    20742089    /** 
    20752090     * Create a new post. 
     2091     *  
     2092     * The 'content_struct' argument must contain: 
     2093     *  - title 
     2094     *  - description 
     2095     *  - mt_excerpt 
     2096     *  - mt_text_more 
     2097     *  - mt_keywords 
     2098     *  - mt_tb_ping_urls 
     2099     *  - categories 
     2100     *  
     2101     * Also, it can optionally contain: 
     2102     *  - wp_slug 
     2103     *  - wp_password 
     2104     *  - wp_page_parent_id 
     2105     *  - wp_page_order 
     2106     *  - wp_author_id 
     2107     *  - post_status | page_status - can be 'draft', 'private', 'publish', or 'pending' 
     2108     *  - mt_allow_comments - can be 'open' or 'closed' 
     2109     *  - mt_allow_pings - can be 'open' or 'closed' 
     2110     *  - date_created_gmt 
     2111     *  - dateCreated 
    20762112     * 
    20772113     * @since 1.5.0 
    20782114     * 
    2079      * @param array $args Method parameters. 
     2115     * @param array $args Method parameters. Contains: 
     2116     *  - blog_id 
     2117     *  - username 
     2118     *  - password 
     2119     *  - content_struct 
     2120     *  - publish 
    20802121     * @return int 
    20812122     */ 
Note: See TracChangeset for help on using the changeset viewer.