<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53792] trunk/src/wp-admin/includes/export.php: Docs: Various docblock improvements in Export Administration API, as per docs standards.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53792">53792</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53792","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-07-29 08:12:27 +0000 (Fri, 29 Jul 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Various docblock improvements in Export Administration API, as per docs standards.
See <a href="https://core.trac.wordpress.org/ticket/55646">#55646</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesexportphp">trunk/src/wp-admin/includes/export.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesexportphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/export.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/export.php 2022-07-29 03:32:58 UTC (rev 53791)
+++ trunk/src/wp-admin/includes/export.php 2022-07-29 08:12:27 UTC (rev 53792)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,27 +31,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Arguments for generating the WXR export file for download. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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').
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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').
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function export_wp( $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,7 +189,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Wrap given string in XML CDATA tag.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Wraps given string in XML CDATA tag.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -207,7 +207,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return the URL of the site
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the URL of the site.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,11 +224,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output a cat_name XML tag from a given category object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs a cat_name XML tag from a given category object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Term $category Category Object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Term $category Category Object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_cat_name( $category ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $category->name ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,11 +239,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output a category_description XML tag from a given category object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs a category_description XML tag from a given category object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Term $category Category Object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Term $category Category Object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_category_description( $category ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $category->description ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -254,11 +254,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output a tag_name XML tag from a given tag object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs a tag_name XML tag from a given tag object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Term $tag Tag Object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Term $tag Tag Object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_tag_name( $tag ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $tag->name ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -269,11 +269,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output a tag_description XML tag from a given tag object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs a tag_description XML tag from a given tag object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Term $tag Tag Object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Term $tag Tag Object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_tag_description( $tag ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $tag->description ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,11 +284,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output a term_name XML tag from a given term object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs a term_name XML tag from a given term object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Term $term Term Object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Term $term Term Object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_term_name( $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $term->name ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -299,11 +299,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output a term_description XML tag from a given term object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs a term_description XML tag from a given term object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Term $term Term Object
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Term $term Term Object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_term_description( $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $term->description ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -314,7 +314,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output term meta XML tags for a given term object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs term meta XML tags for a given term object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,7 +345,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output list of authors with posts
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs list of authors with posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -384,7 +384,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output all navigation menu terms
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs all navigation menu terms.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -405,7 +405,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Output list of taxonomy terms, in XML tag format, associated with a post
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Outputs list of taxonomy terms, in XML tag format, associated with a post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -424,8 +424,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $return_me
- * @param string $meta_key
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wxr_filter_postmeta( $return_me, $meta_key ) {
</span></span></pre>
</div>
</div>
</body>
</html>