Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-29 23:57:41 +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

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

@ -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 * @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 * @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 * @since 2.1.0
* *
* @param WP_Term $category Category Object * @param WP_Term $category Category Object.
*/ */
function wxr_cat_name( $category ) { function wxr_cat_name( $category ) {
if ( empty( $category->name ) ) { 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 * @since 2.1.0
* *
* @param WP_Term $category Category Object * @param WP_Term $category Category Object.
*/ */
function wxr_category_description( $category ) { function wxr_category_description( $category ) {
if ( empty( $category->description ) ) { 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 * @since 2.3.0
* *
* @param WP_Term $tag Tag Object * @param WP_Term $tag Tag Object.
*/ */
function wxr_tag_name( $tag ) { function wxr_tag_name( $tag ) {
if ( empty( $tag->name ) ) { 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 * @since 2.3.0
* *
* @param WP_Term $tag Tag Object * @param WP_Term $tag Tag Object.
*/ */
function wxr_tag_description( $tag ) { function wxr_tag_description( $tag ) {
if ( empty( $tag->description ) ) { 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 * @since 2.9.0
* *
* @param WP_Term $term Term Object * @param WP_Term $term Term Object.
*/ */
function wxr_term_name( $term ) { function wxr_term_name( $term ) {
if ( empty( $term->name ) ) { 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 * @since 2.9.0
* *
* @param WP_Term $term Term Object * @param WP_Term $term Term Object.
*/ */
function wxr_term_description( $term ) { function wxr_term_description( $term ) {
if ( empty( $term->description ) ) { 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 * @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 * @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 * @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 * @since 2.3.0
*/ */
@ -424,8 +424,12 @@ function export_wp( $args = array() ) {
} }
/** /**
* @param bool $return_me * Determines whether to selectively skip post meta used for WXR exports.
* @param string $meta_key *
* @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 * @return bool
*/ */
function wxr_filter_postmeta( $return_me, $meta_key ) { function wxr_filter_postmeta( $return_me, $meta_key ) {

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @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. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.