WordPress.org

Make WordPress Core

Changeset 32579


Ignore:
Timestamp:
05/24/2015 05:18:47 PM (4 years ago)
Author:
DrewAPicture
Message:

In most wp_xmlrpc_server methods that accept an array of arguments, the argument order is important.

With the converstion to hash notations from simple lists in the inline documentation, it's especially important to make that requirement clear.

See #32246.

File:
1 edited

Legend:

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

    r32578 r32579  
    201201     *
    202202     * @param array  $args {
    203      *     Method parameters.
     203     *     Method arguments. Note: arguments must be ordered as documented.
    204204     *
    205205     *     @type int $number1 A number to add.
     
    535535     *
    536536     * @param array $args {
    537      *     Method parameters, in this order:
     537     *     Method arguments. Note: arguments must be ordered as documented.
    538538     *
    539539     *     @type string $username Username.
     
    11021102     *
    11031103     * @param array  $args {
    1104      *     Method parameters, in this order:
     1104     *     Method arguments. Note: arguments must be ordered as documented.
    11051105     *
    11061106     *     @type int    $blog_id (unused)
     
    14361436     *
    14371437     * @param array  $args {
    1438      *     Method parameters, in this order:
     1438     *     Method arguments. Note: arguments must be ordered as documented.
    14391439     *
    14401440     *     @type int    $blog_id        Blog ID (unused).
     
    15051505     *
    15061506     * @param array  $args {
    1507      *     Method parameters, in this order:
     1507     *     Method arguments. Note: arguments must be ordered as documented.
    15081508     *
    15091509     *     @type int    $blog_id  Blog ID (unused).
     
    15621562     *
    15631563     * @param array $args {
    1564      *     Method parameters.
     1564     *     Method arguments. Note: arguments must be ordered as documented.
    15651565     *
    15661566     *     @type int    $blog_id  Blog ID (unused).
     
    16451645     *
    16461646     * @param array $args {
    1647      *     Method parameters.
     1647     *     Method arguments. Note: arguments must be ordered as documented.
    16481648     *
    16491649     *     @type int    $blog_id  Blog ID (unused).
     
    17411741     *
    17421742     * @param array $args {
    1743      *     Method parameters.
     1743     *     Method arguments. Note: arguments must be ordered as documented.
    17441744     *
    17451745     *     @type int    $blog_id        Blog ID (unused).
     
    18261826     *
    18271827     * @param array $args {
    1828      *     Method parameters.
     1828     *     Method arguments. Note: arguments must be ordered as documented.
    18291829     *
    18301830     *     @type int    $blog_id        Blog ID (unused).
     
    19241924     *
    19251925     * @param array  $args {
    1926      *     Method parameters.
     1926     *     Method arguments. Note: arguments must be ordered as documented.
    19271927     *
    19281928     *     @type int    $blog_id      Blog ID (unused).
     
    19861986     *
    19871987     * @param array  $args {
    1988      *     Method parameters, in this order:
     1988     *     Method arguments. Note: arguments must be ordered as documented.
    19891989     *
    19901990     *     @type int    $blog_id (unused)
     
    20522052     *
    20532053     * @param array  $args {
    2054      *     Method parameters, in this order:
     2054     *     Method arguments. Note: arguments must be ordered as documented.
    20552055     *
    20562056     *     @type int    $blog_id (unused)
     
    21322132     *
    21332133     * @param array  $args {
    2134      *     Method parameters, in this order:
     2134     *     Method arguments. Note: arguments must be ordered as documented.
    21352135     *
    21362136     *     @type int    $blog_id (unused)
     
    21912191     *
    21922192     * @param array  $args {
    2193      *     Method parameters, in this order:
     2193     *     Method arguments. Note: arguments must be ordered as documented.
    21942194     *
    21952195     *     @type int    $blog_id (unused)
     
    22522252     *
    22532253     * @param array  $args {
    2254      *     Method parameters, in this order:
     2254     *     Method arguments. Note: arguments must be ordered as documented.
    22552255     *
    22562256     *     @type int    $blog_id (unused)
     
    23292329     *
    23302330     * @param array  $args {
    2331      *     Method parameters, in this order:
     2331     *     Method arguments. Note: arguments must be ordered as documented.
    23322332     *
    23332333     *     @type int    $blog_id (unused)
     
    24042404     *
    24052405     * @param array  $args {
    2406      *     Method parameters, in this order:
     2406     *     Method arguments. Note: arguments must be ordered as documented.
    24072407     *
    24082408     *     @type int    $blog_id (unused)
     
    24492449     *
    24502450     * @param array  $args {
    2451      *     Method parameters, in this order:
     2451     *     Method arguments. Note: arguments must be ordered as documented.
    24522452     *
    24532453     *     @type int    $blog_id (unused)
     
    25272527     *
    25282528     * @param array  $args {
    2529      *     Method parameters, in this order:
     2529     *     Method arguments. Note: arguments must be ordered as documented.
    25302530     *
    25312531     *     @type int    $blog_id (unused)
     
    25732573     *
    25742574     * @param array  $args {
    2575      *     Method parameters, in this order:
     2575     *     Method arguments. Note: arguments must be ordered as documented.
    25762576     *
    25772577     *     @type int    $blog_id (unused)
     
    26212621     * @since 2.2.0
    26222622     *
     2623     * @see wp_xmlrpc_server::mw_newPost()
     2624     *
    26232625     * @param array  $args {
    2624      *     See {@link wp_xmlrpc_server::mw_newPost()}
    2625      *     Method parameters, in this order:
     2626     *     Method arguments. Note: arguments must be ordered as documented.
    26262627     *
    26272628     *     @type int    $blog_id (unused)
     
    26562657     *
    26572658     * @param array  $args {
    2658      *     Method parameters, in this order:
     2659     *     Method arguments. Note: arguments must be ordered as documented.
    26592660     *
    26602661     *     @type int    $blog_id (unused)
     
    27122713     *
    27132714     * @param array  $args {
    2714      *     Method parameters, in this order:
     2715     *     Method arguments. Note: arguments must be ordered as documented.
    27152716     *
    27162717     *     @type int    $blog_id (unused)
     
    27702771     *
    27712772     * @param array  $args {
    2772      *     Method parameters, in this order:
     2773     *     Method arguments. Note: arguments must be ordered as documented.
    27732774     *
    27742775     *     @type int    $blog_id (unused)
     
    28282829     *
    28292830     * @param array  $args {
    2830      *     Method parameters, in this order:
     2831     *     Method arguments. Note: arguments must be ordered as documented.
    28312832     *
    28322833     *     @type int    $blog_id (unused)
     
    28692870     *
    28702871     * @param array  $args {
    2871      *     Method parameters, in this order:
     2872     *     Method arguments. Note: arguments must be ordered as documented.
    28722873     *
    28732874     *     @type int    $blog_id (unused)
     
    29172918     *
    29182919     * @param array  $args {
    2919      *     Method parameters, in this order:
     2920     *     Method arguments. Note: arguments must be ordered as documented.
    29202921     *
    29212922     *     @type int    $blog_id (unused)
     
    29932994     *
    29942995     * @param array  $args {
    2995      *     Method parameters, in this order:
     2996     *     Method arguments. Note: arguments must be ordered as documented.
    29962997     *
    29972998     *     @type int    $blog_id (unused)
     
    30413042     *
    30423043     * @param array  $args {
    3043      *     Method parameters, in this order:
     3044     *     Method arguments. Note: arguments must be ordered as documented.
    30443045     *
    30453046     *     @type int    $blog_id (unused)
     
    30863087     *
    30873088     * @param array  $args {
    3088      *     Method parameters, in this order:
     3089     *     Method arguments. Note: arguments must be ordered as documented.
    30893090     *
    30903091     *     @type int    $blog_id (unused)
     
    31343135     *
    31353136     * @param array  $args {
    3136      *     Method parameters, in this order:
     3137     *     Method arguments. Note: arguments must be ordered as documented.
    31373138     *
    31383139     *     @type int    $blog_id (unused)
     
    31973198     *
    31983199     * @param array  $args {
    3199      *     Method parameters, in this order:
     3200     *     Method arguments. Note: arguments must be ordered as documented.
    32003201     *
    32013202     *     @type int    $blog_id (unused)
     
    32573258     *  - 'content'
    32583259     *  - 'date_created_gmt'
    3259      *  - 'status'. Common statuses are 'approve', 'hold', 'spam'. See {@link get_comment_statuses()} for more details
     3260     *  - 'status'. Common statuses are 'approve', 'hold', 'spam'. See get_comment_statuses() for more details
    32603261     *
    32613262     * @since 2.7.0
    32623263     *
    32633264     * @param array  $args {
    3264      *     Method parameters, in this order:
     3265     *     Method arguments. Note: arguments must be ordered as documented.
    32653266     *
    32663267     *     @type int    $blog_id (unused)
     
    32703271     *     @type array  $content_struct
    32713272     * }
    3272      * @param array $args Contains:
    3273      *  - blog_id (unused)
    3274      *  - username
    3275      *  - password
    3276      *  - comment_id
    3277      *  - content_struct
    32783273     * @return true|IXR_Error True, on success.
    32793274     */
     
    33593354     *
    33603355     * @param array  $args {
    3361      *     Method parameters, in this order:
     3356     *     Method arguments. Note: arguments must be ordered as documented.
    33623357     *
    33633358     *     @type int        $blog_id (unused)
     
    34703465     *
    34713466     * @param array  $args {
    3472      *     Method parameters, in this order:
     3467     *     Method arguments. Note: arguments must be ordered as documented.
    34733468     *
    34743469     *     @type int    $blog_id (unused)
     
    35023497     *
    35033498     * @param array  $args {
    3504      *     Method parameters, in this order:
     3499     *     Method arguments. Note: arguments must be ordered as documented.
    35053500     *
    35063501     *     @type int    $blog_id (unused)
     
    35423537     *
    35433538     * @param array  $args {
    3544      *     Method parameters, in this order:
     3539     *     Method arguments. Note: arguments must be ordered as documented.
    35453540     *
    35463541     *     @type int    $blog_id (unused)
     
    35743569     *
    35753570     * @param array  $args {
    3576      *     Method parameters, in this order:
     3571     *     Method arguments. Note: arguments must be ordered as documented.
    35773572     *
    35783573     *     @type int    $blog_id (unused)
     
    36063601     *
    36073602     * @param array  $args {
    3608      *     Method parameters, in this order:
     3603     *     Method arguments. Note: arguments must be ordered as documented.
    36093604     *
    36103605     *     @type int    $blog_id (unused)
     
    36383633     *
    36393634     * @param array  $args {
    3640      *     Method parameters, in this order:
     3635     *     Method arguments. Note: arguments must be ordered as documented.
    36413636     *
    36423637     *     @type int    $blog_id (unused)
     
    36983693     *
    36993694     * @param array  $args {
    3700      *     Method parameters, in this order:
     3695     *     Method arguments. Note: arguments must be ordered as documented.
    37013696     *
    37023697     *     @type int    $blog_id (unused)
     
    37423737     *
    37433738     * @param array  $args {
    3744      *     Method parameters, in this order:
     3739     *     Method arguments. Note: arguments must be ordered as documented.
    37453740     *
    37463741     *     @type int    $blog_id (unused)
     
    37913786     * The defaults are as follows:
    37923787     * - 'number' - Default is 5. Total number of media items to retrieve.
    3793      * - 'offset' - Default is 0. See {@link WP_Query::query()} for more.
     3788     * - 'offset' - Default is 0. See WP_Query::query() for more.
    37943789     * - 'parent_id' - Default is ''. The post where the media item is attached. Empty string shows all media items. 0 shows unattached media items.
    37953790     * - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf')
     
    37983793     *
    37993794     * @param array  $args {
    3800      *     Method parameters, in this order:
     3795     *     Method arguments. Note: arguments must be ordered as documented.
    38013796     *
    38023797     *     @type int    $blog_id (unused)
     
    38053800     *     @type array  $struct
    38063801     * }
    3807      * @return array|IXR_Error Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents
     3802     * @return array|IXR_Error Contains a collection of media items. See wp_xmlrpc_server::wp_getMediaItem() for a description of each item contents
    38083803     */
    38093804    public function wp_getMediaLibrary($args) {
     
    38443839      *
    38453840     * @param array  $args {
    3846      *     Method parameters, in this order:
     3841     *     Method arguments. Note: arguments must be ordered as documented.
    38473842     *
    38483843     *     @type int    $blog_id (unused)
     
    38923887     * @since 3.4.0
    38933888     *
    3894      * @uses get_post_type_object()
     3889     * @see get_post_type_object()
     3890     *
    38953891     * @param array  $args {
    3896      *     Method parameters, in this order:
     3892     *     Method arguments. Note: arguments must be ordered as documented.
    38973893     *
    38983894     *     @type int    $blog_id (unused)
     
    39593955     * @since 3.4.0
    39603956     *
    3961      * @uses get_post_types()
     3957     * @see get_post_types()
     3958     *
    39623959     * @param array  $args {
    3963      *     Method parameters, in this order:
     3960     *     Method arguments. Note: arguments must be ordered as documented.
    39643961     *
    39653962     *     @type int    $blog_id (unused)
     
    40204017     *
    40214018     * @param array  $args {
    4022      *     Method parameters, in this order:
     4019     *     Method arguments. Note: arguments must be ordered as documented.
    40234020     *
    40244021     *     @type int    $blog_id (unused)
     
    40994096     *
    41004097     * @param array  $args {
    4101      *     Method parameters, in this order:
     4098     *     Method arguments. Note: arguments must be ordered as documented.
    41024099     *
    41034100     *     @type int    $blog_id (unused)
     
    41574154     *
    41584155     * @param array  $args {
    4159      *     Method parameters, in this order:
     4156     *     Method arguments. Note: arguments must be ordered as documented.
    41604157     *
    41614158     *     @type int    $blog_id (unused)
     
    42324229     *
    42334230     * @param array  $args {
    4234      *     Method parameters, in this order:
     4231     *     Method arguments. Note: arguments must be ordered as documented.
    42354232     *
    42364233     *     @type int    $blog_id (unused)
     
    42724269     *
    42734270     * @param array  $args {
    4274      *     Method parameters, in this order:
     4271     *     Method arguments. Note: arguments must be ordered as documented.
    42754272     *
    42764273     *     @type int    $blog_id (unused)
     
    43234320     *
    43244321     * @param array  $args {
    4325      *     Method parameters, in this order:
     4322     *     Method arguments. Note: arguments must be ordered as documented.
    43264323     *
    43274324     *     @type string $appkey (unused)
     
    44124409     *
    44134410     * @param array  $args {
    4414      *     Method parameters, in this order:
     4411     *     Method arguments. Note: arguments must be ordered as documented.
    44154412     *
    44164413     *     @type string $appkey (unused)
     
    44824479     *
    44834480     * @param array  $args {
    4484      *     Method parameters, in this order:
     4481     *     Method arguments. Note: arguments must be ordered as documented.
    44854482     *
    44864483     *     @type int    $blog_id (unused)
     
    45574554     *
    45584555     * @param array  $args {
    4559      *     Method parameters, in this order:
     4556     *     Method arguments. Note: arguments must be ordered as documented.
    45604557     *
    45614558     *     @type int    $blog_id (unused)
     
    46374634     *
    46384635     * @param array  $args {
    4639      *     Method parameters, in this order:
     4636     *     Method arguments. Note: arguments must be ordered as documented.
    46404637     *
    46414638     *     @type int    $blog_id (unused)
     
    49764973     *
    49774974     * @param array  $args {
    4978      *     Method parameters, in this order:
     4975     *     Method arguments. Note: arguments must be ordered as documented.
    49794976     *
    49804977     *     @type int    $blog_id (unused)
     
    52755272     *
    52765273     * @param array  $args {
    5277      *     Method parameters, in this order:
     5274     *     Method arguments. Note: arguments must be ordered as documented.
    52785275     *
    52795276     *     @type int    $blog_id (unused)
     
    54065403     *
    54075404     * @param array  $args {
    5408      *     Method parameters, in this order:
     5405     *     Method arguments. Note: arguments must be ordered as documented.
    54095406     *
    54105407     *     @type int    $blog_id (unused)
     
    55245521     *
    55255522     * @param array  $args {
    5526      *     Method parameters, in this order:
     5523     *     Method arguments. Note: arguments must be ordered as documented.
    55275524     *
    55285525     *     @type int    $blog_id (unused)
     
    55795576     *
    55805577     * @param array  $args {
    5581      *     Method parameters, in this order:
     5578     *     Method arguments. Note: arguments must be ordered as documented.
    55825579     *
    55835580     *     @type int    $blog_id (unused)
     
    56995696     *
    57005697     * @param array  $args {
    5701      *     Method parameters, in this order:
     5698     *     Method arguments. Note: arguments must be ordered as documented.
    57025699     *
    57035700     *     @type int    $blog_id (unused)
     
    57595756     *
    57605757     * @param array  $args {
    5761      *     Method parameters, in this order:
     5758     *     Method arguments. Note: arguments must be ordered as documented.
    57625759     *
    57635760     *     @type int    $blog_id (unused)
     
    58035800     *
    58045801     * @param array  $args {
    5805      *     Method parameters, in this order:
     5802     *     Method arguments. Note: arguments must be ordered as documented.
    58065803     *
    58075804     *     @type int    $post_ID
     
    58525849     *
    58535850     * @param array  $args {
    5854      *     Method parameters, in this order:
     5851     *     Method arguments. Note: arguments must be ordered as documented.
    58555852     *
    58565853     *     @type int    $post_ID
     
    59725969     *
    59735970     * @param array  $args {
    5974      *     Method parameters, in this order:
     5971     *     Method arguments. Note: arguments must be ordered as documented.
    59755972     *
    59765973     *     @type int    $post_ID
     
    60236020     *
    60246021     * @param array  $args {
    6025      *     Method parameters, in this order:
     6022     *     Method arguments. Note: arguments must be ordered as documented.
    60266023     *
    60276024     *     @type string $pagelinkedfrom
Note: See TracChangeset for help on using the changeset viewer.