Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-31 13:37:51 +01:00
Code Issues Projects Releases Wiki Activity

More better phpdoc for XMLRPC functions. See #15238 props koke.

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

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

@ -1035,10 +1035,21 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* 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.
*
* @since 2.7.0
*
* @param array $args Method parameters.
* @return array
* @return array. Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents
*/
function wp_getComments($args) {
$raw_args = $args;
@ -1082,6 +1093,7 @@ class wp_xmlrpc_server extends IXR_Server {
$comments_struct = array();
// FIXME: we already have the comments, why query them again?
for ( $i = 0; $i < $num_comments; $i++ ) {
$comment = wp_xmlrpc_server::wp_getComment(array(
$raw_args[0], $raw_args[1], $raw_args[2], $comments[$i]->comment_ID,
@ -1093,11 +1105,19 @@ class wp_xmlrpc_server extends IXR_Server {
}
/**
* Remove comment.
* 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.
*
* @since 2.7.0
*
* @param array $args Method parameters.
* @param array $args Method parameters. Contains:
* - blog_id
* - username
* - password
* - comment_id
* @return mixed {@link wp_delete_comment()}
*/
function wp_deleteComment($args) {
@ -1128,9 +1148,25 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* 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
*
* @since 2.7.0
*
* @param array $args Method parameters.
* @param array $args. Contains:
* - blog_id
* - username
* - password
* - comment_id
* - content_struct
* @return bool True, on success.
*/
function wp_editComment($args) {