Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-21 20:35:00 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Various docblock improvements in Export Administration API, as per docs standards.

Browse Source 
See #55646.

Built from https://develop.svn.wordpress.org/trunk@53792


git-svn-id: http://core.svn.wordpress.org/trunk@53351 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-07-29 08:14:12 +00:00
parent 839d20f9c5
commit d853d1ece2
2 changed files with 46 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
wp-admin/includes/export.php
View File

@ -31,27 +31,27 @@ define( 'WXR_VERSION', '1.2' );
* @param array $args {
* Optional. Arguments for generating the WXR export file for download. Default empty array.
*
* @type string $content Type of content to export. If set, only the post content of this post type
* will be exported. Accepts 'all', 'post', 'page', 'attachment', or a defined
* custom post. If an invalid custom post type is supplied, every post type for
* which `can_export` is enabled will be exported instead. If a valid custom post
* type is supplied but `can_export` is disabled, then 'posts' will be exported
* instead. When 'all' is supplied, only post types with `can_export` enabled will
* be exported. Default 'all'.
* @type string $author Author to export content for. Only used when `$content` is 'post', 'page', or
* 'attachment'. Accepts false (all) or a specific author ID. Default false (all).
* @type string $category Category (slug) to export content for. Used only when `$content` is 'post'. If
* set, only post content assigned to `$category` will be exported. Accepts false
* or a specific category slug. Default is false (all categories).
* @type string $start_date Start date to export content from. Expected date format is 'Y-m-d'. Used only
* when `$content` is 'post', 'page' or 'attachment'. Default false (since the
* beginning of time).
* @type string $end_date End date to export content to. Expected date format is 'Y-m-d'. Used only when
* `$content` is 'post', 'page' or 'attachment'. Default false (latest publish date).
* @type string $status Post status to export posts for. Used only when `$content` is 'post' or 'page'.
* Accepts false (all statuses except 'auto-draft'), or a specific status, i.e.
* 'publish', 'pending', 'draft', 'auto-draft', 'future', 'private', 'inherit', or
* 'trash'. Default false (all statuses except 'auto-draft').
* @type string $content Type of content to export. If set, only the post content of this post type
* will be exported. Accepts 'all', 'post', 'page', 'attachment', or a defined
* custom post. If an invalid custom post type is supplied, every post type for
* which `can_export` is enabled will be exported instead. If a valid custom post
* type is supplied but `can_export` is disabled, then 'posts' will be exported
* instead. When 'all' is supplied, only post types with `can_export` enabled will
* be exported. Default 'all'.
* @type string $author Author to export content for. Only used when `$content` is 'post', 'page', or
* 'attachment'. Accepts false (all) or a specific author ID. Default false (all).
* @type string $category Category (slug) to export content for. Used only when `$content` is 'post'. If
* set, only post content assigned to `$category` will be exported. Accepts false
* or a specific category slug. Default is false (all categories).
* @type string $start_date Start date to export content from. Expected date format is 'Y-m-d'. Used only
* when `$content` is 'post', 'page' or 'attachment'. Default false (since the
* beginning of time).
* @type string $end_date End date to export content to. Expected date format is 'Y-m-d'. Used only when
* `$content` is 'post', 'page' or 'attachment'. Default false (latest publish date).
* @type string $status Post status to export posts for. Used only when `$content` is 'post' or 'page'.
* Accepts false (all statuses except 'auto-draft'), or a specific status, i.e.
* 'publish', 'pending', 'draft', 'auto-draft', 'future', 'private', 'inherit', or
* 'trash'. Default false (all statuses except 'auto-draft').
* }
*/
function export_wp( $args = array() ) {
@ -189,7 +189,7 @@ function export_wp( $args = array() ) {
}
/**
* Wrap given string in XML CDATA tag.
* Wraps given string in XML CDATA tag.
*
* @since 2.1.0
*
@ -207,7 +207,7 @@ function export_wp( $args = array() ) {
}
/**
* Return the URL of the site
* Returns the URL of the site.
*
* @since 2.5.0
*
@ -224,11 +224,11 @@ function export_wp( $args = array() ) {
}
/**
* Output a cat_name XML tag from a given category object
* Outputs a cat_name XML tag from a given category object.
*
* @since 2.1.0
*
* @param WP_Term $category Category Object
* @param WP_Term $category Category Object.
*/
function wxr_cat_name( $category ) {
if ( empty( $category->name ) ) {
@ -239,11 +239,11 @@ function export_wp( $args = array() ) {
}
/**
* Output a category_description XML tag from a given category object
* Outputs a category_description XML tag from a given category object.
*
* @since 2.1.0
*
* @param WP_Term $category Category Object
* @param WP_Term $category Category Object.
*/
function wxr_category_description( $category ) {
if ( empty( $category->description ) ) {
@ -254,11 +254,11 @@ function export_wp( $args = array() ) {
}
/**
* Output a tag_name XML tag from a given tag object
* Outputs a tag_name XML tag from a given tag object.
*
* @since 2.3.0
*
* @param WP_Term $tag Tag Object
* @param WP_Term $tag Tag Object.
*/
function wxr_tag_name( $tag ) {
if ( empty( $tag->name ) ) {
@ -269,11 +269,11 @@ function export_wp( $args = array() ) {
}
/**
* Output a tag_description XML tag from a given tag object
* Outputs a tag_description XML tag from a given tag object.
*
* @since 2.3.0
*
* @param WP_Term $tag Tag Object
* @param WP_Term $tag Tag Object.
*/
function wxr_tag_description( $tag ) {
if ( empty( $tag->description ) ) {
@ -284,11 +284,11 @@ function export_wp( $args = array() ) {
}
/**
* Output a term_name XML tag from a given term object
* Outputs a term_name XML tag from a given term object.
*
* @since 2.9.0
*
* @param WP_Term $term Term Object
* @param WP_Term $term Term Object.
*/
function wxr_term_name( $term ) {
if ( empty( $term->name ) ) {
@ -299,11 +299,11 @@ function export_wp( $args = array() ) {
}
/**
* Output a term_description XML tag from a given term object
* Outputs a term_description XML tag from a given term object.
*
* @since 2.9.0
*
* @param WP_Term $term Term Object
* @param WP_Term $term Term Object.
*/
function wxr_term_description( $term ) {
if ( empty( $term->description ) ) {
@ -314,7 +314,7 @@ function export_wp( $args = array() ) {
}
/**
* Output term meta XML tags for a given term object.
* Outputs term meta XML tags for a given term object.
*
* @since 4.6.0
*
@ -345,7 +345,7 @@ function export_wp( $args = array() ) {
}
/**
* Output list of authors with posts
* Outputs list of authors with posts.
*
* @since 3.1.0
*
@ -384,7 +384,7 @@ function export_wp( $args = array() ) {
}
/**
* Output all navigation menu terms
* Outputs all navigation menu terms.
*
* @since 3.1.0
*/
@ -405,7 +405,7 @@ function export_wp( $args = array() ) {
}
/**
* Output list of taxonomy terms, in XML tag format, associated with a post
* Outputs list of taxonomy terms, in XML tag format, associated with a post.
*
* @since 2.3.0
*/
@ -424,8 +424,12 @@ function export_wp( $args = array() ) {
}
/**
* @param bool $return_me
* @param string $meta_key
* Determines whether to selectively skip post meta used for WXR exports.
*
* @since 3.3.0
*
* @param bool $return_me Whether to skip the current post meta. Default false.
* @param string $meta_key Meta key.
* @return bool
*/
function wxr_filter_postmeta( $return_me, $meta_key ) {

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.1-alpha-53791';
$wp_version = '6.1-alpha-53792';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.