Ticket #36338: 36338.4.diff

src/wp-admin/includes/export.php

@@ -23 +23 @@
  * @global wpdb    $wpdb
  * @global WP_Post $post
  *
- * @param array $args Filters defining what should be included in the export.
+ * @param array $args {
+ *     Optional. Default is to export all content, but note that post content will be exported only 
+ *     if its 'can_export' = 'true' and its status is not 'auto-draft'.
+ *
+ *     @type string $content        If set, only content of this post type will be exported. 
+ *                                  Default is all post types for which 'can_export' = 'true'. Accepts 'all',
+ *                                  'post', 'page', 'attachment' or a defined custom post type. 
+ *                                  Note 1: if an invalid custom post type is supplied, every post type 
+ *                                  for which 'can_export' = 'true' will be exported instead. 
+ *                                  Note 2: if a valid custom post type is supplied but its 
+ *                                  'can_export' = 'false' then 'posts' will be exported instead.
+ *                                  Note 3: when 'all' is supplied, only post types for which 
+ *                                  'can_export' = 'true' will be exported.
+ *     @type string $author         If set, only content by this author will be exported. Default is 
+ *                                  all authors. Used only when $content is 'post', 'page' or 'attachment'.
+ *     @type string $category       If set, only content assigned to $category will be exported. Default is 
+ *                                  all categories. Used only when $content is 'post'.
+ *     @type string $start_date     If set, this will be the start date. Default is earliest date. Date 
+ *                                  format is 'Y-m-d'. Used only when $content is 'post', 'page' or 
+ *                                  'attachment'.
+ *     @type string $end_date       If set, this will be the end date. Default is latest date. Date format 
+ *                                  is 'Y-m-d'. Used only when $content is 'post', 'page' or 'attachment'.
+ *     @type string $status         If set, only content of this status will be exported. Default is all 
+ *                                  status' except 'auto-draft'. Accepts 'publish', 'pending', 'draft', 
+ *                                  'auto-draft', 'future', 'private', 'inherit', 'trash'. Used only 
+ *                                  when $content is 'post' or 'page'.
+ * }
  */
 function export_wp( $args = array() ) {
         global $wpdb, $post;