WordPress.org

Make WordPress Core

Ticket #15151: patch-15151-2-doc.diff

File patch-15151-2-doc.diff, 2.7 KB (added by koke, 3 years ago)

Added documentation. Also corrected default value for parent_id

  • wp-includes/class.wp-xmlrpc-server.php

    diff --git a/wp-includes/class.wp-xmlrpc-server.php b/wp-includes/class.wp-xmlrpc-server.php
    index fac23ea..decec33 100644
    a b class wp_xmlrpc_server extends IXR_Server { 
    14841484        } 
    14851485 
    14861486        /** 
    1487          * Retrieve media item. 
     1487         * Retrieve a media item by ID 
    14881488         * 
    14891489         * @since 3.1.0 
    1490          * @todo Docment this! 
    14911490         * 
    1492          * @param array $args Method parameters. 
    1493          * @return array 
     1491         * @param array $args Method parameters. Contains:  
     1492         *  - blog_id 
     1493         *  - username 
     1494         *  - password 
     1495         *  - attachment_id 
     1496         * @return array. Assocciative array containing:  
     1497         *  - 'date_created_gmt' 
     1498         *  - 'parent' 
     1499         *  - 'link' 
     1500         *  - 'thumbnail' 
     1501         *  - 'title' 
     1502         *  - 'caption' 
     1503         *  - 'description' 
     1504         *  - 'metadata' 
    14941505         */ 
    14951506        function wp_getMediaItem($args) { 
    14961507                $this->escape($args); 
    class wp_xmlrpc_server extends IXR_Server { 
    15331544        } 
    15341545 
    15351546        /** 
    1536          * Retrieve media library items. 
    1537          * 
     1547         * Retrieves a collection of media library items (or attachments) 
     1548         *  
     1549         * Besides the common blog_id, username, and password arguments, it takes a filter  
     1550         * array as last argument. 
     1551         *  
     1552         * Accepted 'filter' keys are 'parent_id', 'mime_type', 'offset', and 'number'. 
     1553         *  
     1554         * The defaults are as follows: 
     1555         * - 'number' - Default is 5. Total number of media items to retrieve. 
     1556         * - 'offset' - Default is 0. See {@link WP_Query::query()} for more. 
     1557         * - 'parent_id' - Default is ''. The post where the media item is attached. Empty string shows all media items. 0 shows unattached media items. 
     1558         * - 'mime_type' - Default is ''. Filter by mime type (e.g., 'image/jpeg', 'application/pdf') 
     1559         *  
    15381560         * @since 3.1.0 
    1539          * @todo Document this. 
    15401561         * 
    1541          * @param array $args Method parameters. 
    1542          * @return array 
     1562         * @param array $args Method parameters. Contains: 
     1563         *  - blog_id 
     1564         *  - username 
     1565         *  - password 
     1566         *  - filter 
     1567         * @return array. Contains a collection of media items. See {@link wp_xmlrpc_server::wp_getMediaItem()} for a description of each item contents 
    15431568         */ 
    15441569        function wp_getMediaLibrary($args) { 
    15451570                $raw_args = $args; 
    class wp_xmlrpc_server extends IXR_Server { 
    15581583 
    15591584                do_action('xmlrpc_call', 'wp.getMediaLibrary'); 
    15601585 
    1561                 $parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : 0 ; 
    1562                 $mime_type = ( isset($struct['mime_type']) ) ? absint($struct['mime_type']) : '' ;               
     1586                $parent_id = ( isset($struct['parent_id']) ) ? absint($struct['parent_id']) : '' ; 
     1587                $mime_type = ( isset($struct['mime_type']) ) ? $struct['mime_type'] : '' ; 
    15631588                $offset = ( isset($struct['offset']) ) ? absint($struct['offset']) : 0 ; 
    15641589                $number = ( isset($struct['number']) ) ? absint($struct['number']) : -1 ; 
    15651590