Make WordPress Core

Changeset 55316


Ignore:
Timestamp:
02/13/2023 03:16:55 PM (14 months ago)
Author:
audrasjb
Message:

Docs: Various improvements in XML-RPC Class function descriptions, as per docblocks standards.

See #56792.

File:
1 edited

Legend:

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

    r55308 r55316  
    11<?php
    22/**
    3  * XML-RPC protocol support for WordPress
     3 * XML-RPC protocol support for WordPress.
    44 *
    55 * @package WordPress
     
    6161     * Registers all of the XMLRPC methods that XMLRPC server understands.
    6262     *
    63      * Sets up server and method property. Passes XMLRPC
    64      * methods through the {@see 'xmlrpc_methods'} filter to allow plugins to extend
    65      * or replace XML-RPC methods.
     63     * Sets up server and method property. Passes XMLRPC methods through the
     64     * {@see 'xmlrpc_methods'} filter to allow plugins to extend or replace
     65     * XML-RPC methods.
    6666     *
    6767     * @since 1.5.0
     
    178178
    179179    /**
    180      * Set wp_xmlrpc_server::$is_enabled property.
    181      *
    182      * Determine whether the xmlrpc server is enabled on this WordPress install
     180     * Sets wp_xmlrpc_server::$is_enabled property.
     181     *
     182     * Determines whether the xmlrpc server is enabled on this WordPress install
    183183     * and set the is_enabled property accordingly.
    184184     *
     
    221221
    222222    /**
    223      * Make private/protected methods readable for backward compatibility.
     223     * Makes private/protected methods readable for backward compatibility.
    224224     *
    225225     * @since 4.0.0
     
    246246
    247247    /**
    248      * Test XMLRPC API by saying, "Hello!" to client.
     248     * Tests XMLRPC API by saying, "Hello!" to client.
    249249     *
    250250     * @since 1.5.0
     
    257257
    258258    /**
    259      * Test XMLRPC API by adding two numbers for client.
     259     * Tests XMLRPC API by adding two numbers for client.
    260260     *
    261261     * @since 1.5.0
     
    276276
    277277    /**
    278      * Log user in.
     278     * Logs user in.
    279279     *
    280280     * @since 2.8.0
     
    282282     * @param string $username User's username.
    283283     * @param string $password User's password.
    284      * @return WP_User|false WP_User object if authentication passed, false otherwise
     284     * @return WP_User|false WP_User object if authentication passed, false otherwise.
    285285     */
    286286    public function login( $username, $password ) {
     
    319319
    320320    /**
    321      * Check user's credentials. Deprecated.
     321     * Checks user's credentials. Deprecated.
    322322     *
    323323     * @since 1.5.0
     
    334334
    335335    /**
    336      * Escape string or array of strings for database.
     336     * Escapes string or array of strings for database.
    337337     *
    338338     * @since 1.5.2
     
    357357
    358358    /**
    359      * Send error response to client.
    360      *
    361      * Send an XML error response to the client. If the endpoint is enabled
     359     * Sends error response to client.
     360     *
     361     * Sends an XML error response to the client. If the endpoint is enabled
    362362     * an HTTP 200 response is always sent per the XML-RPC specification.
    363363     *
     
    381381
    382382    /**
    383      * Retrieve custom fields for post.
     383     * Retrieves custom fields for post.
    384384     *
    385385     * @since 2.5.0
     
    410410
    411411    /**
    412      * Set custom fields for post.
     412     * Sets custom fields for post.
    413413     *
    414414     * @since 2.5.0
     
    448448
    449449    /**
    450      * Retrieve custom fields for a term.
     450     * Retrieves custom fields for a term.
    451451     *
    452452     * @since 4.9.0
     
    477477
    478478    /**
    479      * Set custom fields for a term.
     479     * Sets custom fields for a term.
    480480     *
    481481     * @since 4.9.0
     
    510510
    511511    /**
    512      * Set up blog options property.
     512     * Sets up blog options property.
    513513     *
    514514     * Passes property through {@see 'xmlrpc_blog_options'} filter.
     
    679679
    680680    /**
    681      * Retrieve the blogs of the user.
     681     * Retrieves the blogs of the user.
    682682     *
    683683     * @since 2.6.0
     
    869869
    870870    /**
    871      * Convert a WordPress date string to an IXR_Date object.
     871     * Converts a WordPress date string to an IXR_Date object.
    872872     *
    873873     * @param string $date Date string to convert.
     
    882882
    883883    /**
    884      * Convert a WordPress GMT date string to an IXR_Date object.
     884     * Converts a WordPress GMT date string to an IXR_Date object.
    885885     *
    886886     * @param string $date_gmt WordPress GMT date string.
     
    12621262
    12631263    /**
    1264      * Create a new post for any registered post type.
     1264     * Creates a new post for any registered post type.
    12651265     *
    12661266     * @since 3.4.0
     
    13621362
    13631363    /**
    1364      * Encapsulate the logic for sticking a post
    1365      * and determining if the user has permission to do so
     1364     * Encapsulates the logic for sticking a post and determining if
     1365     * the user has permission to do so.
    13661366     *
    13671367     * @since 4.3.0
     
    17071707
    17081708    /**
    1709      * Edit a post for any registered post type.
     1709     * Edits a post for any registered post type.
    17101710     *
    17111711     * The $content_struct parameter only needs to contain fields that
     
    17931793
    17941794    /**
    1795      * Delete a post for any registered post type.
     1795     * Deletes a post for any registered post type.
    17961796     *
    17971797     * @since 3.4.0
     
    18471847
    18481848    /**
    1849      * Retrieve a post.
     1849     * Retrieves a post.
    18501850     *
    18511851     * @since 3.4.0
     
    19421942
    19431943    /**
    1944      * Retrieve posts.
     1944     * Retrieves posts.
    19451945     *
    19461946     * @since 3.4.0
     
    20512051
    20522052    /**
    2053      * Create a new term.
     2053     * Creates a new term.
    20542054     *
    20552055     * @since 3.4.0
     
    21542154
    21552155    /**
    2156      * Edit a term.
     2156     * Edits a term.
    21572157     *
    21582158     * @since 3.4.0
     
    22722272
    22732273    /**
    2274      * Delete a term.
     2274     * Deletes a term.
    22752275     *
    22762276     * @since 3.4.0
     
    23422342
    23432343    /**
    2344      * Retrieve a term.
     2344     * Retrieves a term.
    23452345     *
    23462346     * @since 3.4.0
     
    24122412
    24132413    /**
    2414      * Retrieve all terms for a taxonomy.
     2414     * Retrieves all terms for a taxonomy.
    24152415     *
    24162416     * @since 3.4.0
     
    25072507
    25082508    /**
    2509      * Retrieve a taxonomy.
     2509     * Retrieves a taxonomy.
    25102510     *
    25112511     * @since 3.4.0
     
    25732573
    25742574    /**
    2575      * Retrieve all taxonomies.
     2575     * Retrieves all taxonomies.
    25762576     *
    25772577     * @since 3.4.0
     
    26352635
    26362636    /**
    2637      * Retrieve a user.
     2637     * Retrieves a user.
    26382638     *
    26392639     * The optional $fields parameter specifies what fields will be included
     
    27172717
    27182718    /**
    2719      * Retrieve users.
     2719     * Retrieves users.
    27202720     *
    27212721     * The optional $filter parameter modifies the query used to retrieve users.
     
    28072807
    28082808    /**
    2809      * Retrieve information about the requesting user.
     2809     * Retrieves information about the requesting user.
    28102810     *
    28112811     * @uses get_userdata()
     
    28562856
    28572857    /**
    2858      * Edit user's profile.
     2858     * Edits user's profile.
    28592859     *
    28602860     * @uses wp_update_user()
     
    29472947
    29482948    /**
    2949      * Retrieve page.
     2949     * Retrieves a page.
    29502950     *
    29512951     * @since 2.2.0
     
    29952995
    29962996    /**
    2997      * Retrieve Pages.
     2997     * Retrieves Pages.
    29982998     *
    29992999     * @since 2.2.0
     
    30543054
    30553055    /**
    3056      * Create new page.
     3056     * Creates a new page.
    30573057     *
    30583058     * @since 2.2.0
     
    30913091
    30923092    /**
    3093      * Delete page.
     3093     * Deletes a page.
    30943094     *
    30953095     * @since 2.2.0
     
    31523152
    31533153    /**
    3154      * Edit page.
     3154     * Edits a page.
    31553155     *
    31563156     * @since 2.2.0
     
    32153215
    32163216    /**
    3217      * Retrieve page list.
     3217     * Retrieves page list.
    32183218     *
    32193219     * @since 2.2.0
     
    32803280
    32813281    /**
    3282      * Retrieve authors list.
     3282     * Retrieves authors list.
    32833283     *
    32843284     * @since 2.2.0
     
    33243324
    33253325    /**
    3326      * Get list of all tags
     3326     * Gets the list of all tags.
    33273327     *
    33283328     * @since 2.7.0
     
    33763376
    33773377    /**
    3378      * Create new category.
     3378     * Creates a new category.
    33793379     *
    33803380     * @since 2.2.0
     
    34593459
    34603460    /**
    3461      * Remove category.
     3461     * Deletes a category.
    34623462     *
    34633463     * @since 2.5.0
     
    35103510
    35113511    /**
    3512      * Retrieve category list.
     3512     * Retrieves category list.
    35133513     *
    35143514     * @since 2.2.0
     
    35623562
    35633563    /**
    3564      * Retrieve comment.
     3564     * Retrieves a comment.
    35653565     *
    35663566     * @since 2.7.0
     
    36043604
    36053605    /**
    3606      * Retrieve comments.
     3606     * Retrieves comments.
    36073607     *
    36083608     * Besides the common blog_id (unused), username, and password arguments, it takes a filter
     
    36273627     *     @type array  $3 Optional. Query arguments.
    36283628     * }
    3629      * @return array|IXR_Error Contains a collection of comments. See wp_xmlrpc_server::wp_getComment() for a description of each item contents
     3629     * @return array|IXR_Error Contains a collection of comments. See wp_xmlrpc_server::wp_getComment()
     3630     *                         for a description of each item contents.
    36303631     */
    36313632    public function wp_getComments( $args ) {
     
    36993700
    37003701    /**
    3701      * Delete a comment.
     3702     * Deletes a comment.
    37023703     *
    37033704     * By default, the comment will be moved to the Trash instead of deleted.
     
    37573758
    37583759    /**
    3759      * Edit comment.
     3760     * Edits a comment.
    37603761     *
    37613762     * Besides the common blog_id (unused), username, and password arguments, it takes a
     
    37683769     *  - 'content'
    37693770     *  - 'date_created_gmt'
    3770      *  - 'status'. Common statuses are 'approve', 'hold', 'spam'. See get_comment_statuses() for more details
     3771     *  - 'status'. Common statuses are 'approve', 'hold', 'spam'. See get_comment_statuses() for more details.
    37713772     *
    37723773     * @since 2.7.0
     
    38683869
    38693870    /**
    3870      * Create new comment.
     3871     * Creates a new comment.
    38713872     *
    38723873     * @since 2.7.0
     
    40234024
    40244025    /**
    4025      * Retrieve all of the comment status.
     4026     * Retrieves all of the comment status.
    40264027     *
    40274028     * @since 2.7.0
     
    40584059
    40594060    /**
    4060      * Retrieve comment count.
     4061     * Retrieves comment counts.
    40614062     *
    40624063     * @since 2.5.0
     
    41074108
    41084109    /**
    4109      * Retrieve post statuses.
     4110     * Retrieves post statuses.
    41104111     *
    41114112     * @since 2.5.0
     
    41424143
    41434144    /**
    4144      * Retrieve page statuses.
     4145     * Retrieves page statuses.
    41454146     *
    41464147     * @since 2.5.0
     
    41774178
    41784179    /**
    4179      * Retrieve page templates.
     4180     * Retrieves page templates.
    41804181     *
    41814182     * @since 2.6.0
     
    42124213
    42134214    /**
    4214      * Retrieve blog options.
     4215     * Retrieves blog options.
    42154216     *
    42164217     * @since 2.6.0
     
    42474248
    42484249    /**
    4249      * Retrieve blog options value from list.
     4250     * Retrieves blog options value from list.
    42504251     *
    42514252     * @since 2.6.0
     
    42764277
    42774278    /**
    4278      * Update blog options.
     4279     * Updates blog options.
    42794280     *
    42804281     * @since 2.6.0
     
    43254326
    43264327    /**
    4327      * Retrieve a media item by ID
     4328     * Retrieves a media item by ID.
    43284329     *
    43294330     * @since 3.1.0
     
    43754376
    43764377    /**
    4377      * Retrieves a collection of media library items (or attachments)
     4378     * Retrieves a collection of media library items (or attachments).
    43784379     *
    43794380     * Besides the common blog_id (unused), username, and password arguments, it takes a filter
     
    43984399     *     @type array  $3 Query arguments.
    43994400     * }
    4400      * @return array|IXR_Error Contains a collection of media items. See wp_xmlrpc_server::wp_getMediaItem() for a description of each item contents
     4401     * @return array|IXR_Error Contains a collection of media items.
     4402     *                   See wp_xmlrpc_server::wp_getMediaItem() for
     4403     *                   a description of each item contents.
    44014404     */
    44024405    public function wp_getMediaLibrary( $args ) {
     
    44964499
    44974500    /**
    4498      * Retrieves a post type
     4501     * Retrieves a post type.
    44994502     *
    45004503     * @since 3.4.0
     
    45694572
    45704573    /**
    4571      * Retrieves a post types
     4574     * Retrieves post types.
    45724575     *
    45734576     * @since 3.4.0
     
    46284631
    46294632    /**
    4630      * Retrieve revisions for a specific post.
     4633     * Retrieves revisions for a specific post.
    46314634     *
    46324635     * @since 3.5.0
     
    47214724
    47224725    /**
    4723      * Restore a post revision
     4726     * Restores a post revision.
    47244727     *
    47254728     * @since 3.5.0
     
    47904793
    47914794    /**
    4792      * Retrieve blogs that user owns.
     4795     * Retrieves blogs that user owns.
    47934796     *
    47944797     * Will make more sense once we support multiple blogs.
     
    48414844
    48424845    /**
    4843      * Private function for retrieving a users blogs for multisite setups
     4846     * Private function for retrieving a users blogs for multisite setups.
    48444847     *
    48454848     * @since 3.0.0
     
    48784881
    48794882    /**
    4880      * Retrieve user's data.
     4883     * Retrieves user's data.
    48814884     *
    48824885     * Gives your client some info about you, so you don't have to.
     
    49234926
    49244927    /**
    4925      * Retrieve post.
     4928     * Retrieves a post.
    49264929     *
    49274930     * @since 1.5.0
     
    49784981
    49794982    /**
    4980      * Retrieve list of recent posts.
     4983     * Retrieves the list of recent posts.
    49814984     *
    49824985     * @since 1.5.0
     
    50765079
    50775080    /**
    5078      * Creates new post.
     5081     * Creates a new post.
    50795082     *
    50805083     * @since 1.5.0
     
    51515154
    51525155    /**
    5153      * Edit a post.
     5156     * Edits a post.
    51545157     *
    51555158     * @since 1.5.0
     
    52305233
    52315234    /**
    5232      * Remove a post.
     5235     * Deletes a post.
    52335236     *
    52345237     * @since 1.5.0
     
    52945297
    52955298    /**
    5296      * Create a new post.
     5299     * Creates a new post.
    52975300     *
    52985301     * The 'content_struct' argument must contain:
     
    56665669
    56675670    /**
    5668      * Attach upload to a post.
     5671     * Attaches an upload to a post.
    56695672     *
    56705673     * @since 2.1.0
     
    56905693
    56915694    /**
    5692      * Edit a post.
     5695     * Edits a post.
    56935696     *
    56945697     * @since 1.5.0
     
    60226025
    60236026    /**
    6024      * Retrieve post.
     6027     * Retrieves a post.
    60256028     *
    60266029     * @since 1.5.0
     
    61636166
    61646167    /**
    6165      * Retrieve list of recent posts.
     6168     * Retrieves list of recent posts.
    61666169     *
    61676170     * @since 1.5.0
     
    62906293
    62916294    /**
    6292      * Retrieve the list of categories on a given blog.
     6295     * Retrieves the list of categories on a given blog.
    62936296     *
    62946297     * @since 1.5.0
     
    64686471
    64696472    /**
    6470      * Retrieve the post titles of recent posts.
     6473     * Retrieves the post titles of recent posts.
    64716474     *
    64726475     * @since 1.5.0
     
    65326535
    65336536    /**
    6534      * Retrieve list of all categories on blog.
     6537     * Retrieves the list of all categories on a blog.
    65356538     *
    65366539     * @since 1.5.0
     
    65856588
    65866589    /**
    6587      * Retrieve post categories.
     6590     * Retrieves post categories.
    65886591     *
    65896592     * @since 1.5.0
     
    66876690
    66886691    /**
    6689      * Retrieve an array of methods supported by this server.
     6692     * Retrieves an array of methods supported by this server.
    66906693     *
    66916694     * @since 1.5.0
     
    67016704
    67026705    /**
    6703      * Retrieve an empty array because we don't support per-post text filters.
     6706     * Retrieves an empty array because we don't support per-post text filters.
    67046707     *
    67056708     * @since 1.5.0
     
    67206723
    67216724    /**
    6722      * Retrieve trackbacks sent to a given post.
     6725     * Retrieves trackbacks sent to a given post.
    67236726     *
    67246727     * @since 1.5.0
     
    70617064
    70627065    /**
    7063      * Retrieve array of URLs that pingbacked the given URL.
     7066     * Retrieves an array of URLs that pingbacked the given URL.
    70647067     *
    70657068     * Specs on http://www.aquarionics.com/misc/archives/blogite/0198.html
Note: See TracChangeset for help on using the changeset viewer.