3 * WordPress Export Administration API
6 * @subpackage Administration
10 * Version number for the export format.
12 * Bump this when something changes that might affect compatibility.
16 define( 'WXR_VERSION', '1.2' );
19 * Generates the WXR export file for download.
24 * @global WP_Post $post
26 * @param array $args Filters defining what should be included in the export.
28 function export_wp( $args = array() ) {
31 $defaults = array( 'content' => 'all', 'author' => false, 'category' => false,
32 'start_date' => false, 'end_date' => false, 'status' => false,
34 $args = wp_parse_args( $args, $defaults );
37 * Fires at the beginning of an export, before any headers are sent.
41 * @param array $args An array of export arguments.
43 do_action( 'export_wp', $args );
45 $sitename = sanitize_key( get_bloginfo( 'name' ) );
46 if ( ! empty( $sitename ) ) {
49 $date = date( 'Y-m-d' );
50 $wp_filename = $sitename . 'wordpress.' . $date . '.xml';
52 * Filter the export filename.
56 * @param string $wp_filename The name of the file for download.
57 * @param string $sitename The site name.
58 * @param string $date Today's date, formatted.
60 $filename = apply_filters( 'export_wp_filename', $wp_filename, $sitename, $date );
62 header( 'Content-Description: File Transfer' );
63 header( 'Content-Disposition: attachment; filename=' . $filename );
64 header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ), true );
66 if ( 'all' != $args['content'] && post_type_exists( $args['content'] ) ) {
67 $ptype = get_post_type_object( $args['content'] );
68 if ( ! $ptype->can_export )
69 $args['content'] = 'post';
71 $where = $wpdb->prepare( "{$wpdb->posts}.post_type = %s", $args['content'] );
73 $post_types = get_post_types( array( 'can_export' => true ) );
74 $esses = array_fill( 0, count($post_types), '%s' );
75 $where = $wpdb->prepare( "{$wpdb->posts}.post_type IN (" . implode( ',', $esses ) . ')', $post_types );
78 if ( $args['status'] && ( 'post' == $args['content'] || 'page' == $args['content'] ) )
79 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_status = %s", $args['status'] );
81 $where .= " AND {$wpdb->posts}.post_status != 'auto-draft'";
84 if ( $args['category'] && 'post' == $args['content'] ) {
85 if ( $term = term_exists( $args['category'], 'category' ) ) {
86 $join = "INNER JOIN {$wpdb->term_relationships} ON ({$wpdb->posts}.ID = {$wpdb->term_relationships}.object_id)";
87 $where .= $wpdb->prepare( " AND {$wpdb->term_relationships}.term_taxonomy_id = %d", $term['term_taxonomy_id'] );
91 if ( 'post' == $args['content'] || 'page' == $args['content'] || 'attachment' == $args['content'] ) {
92 if ( $args['author'] )
93 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_author = %d", $args['author'] );
95 if ( $args['start_date'] )
96 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date >= %s", date( 'Y-m-d', strtotime($args['start_date']) ) );
98 if ( $args['end_date'] )
99 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date < %s", date( 'Y-m-d', strtotime('+1 month', strtotime($args['end_date'])) ) );
102 // Grab a snapshot of post IDs, just in case it changes during the export.
103 $post_ids = $wpdb->get_col( "SELECT ID FROM {$wpdb->posts} $join WHERE $where" );
106 * Get the requested terms ready, empty unless posts filtered by category
109 $cats = $tags = $terms = array();
110 if ( isset( $term ) && $term ) {
111 $cat = get_term( $term['term_id'], 'category' );
112 $cats = array( $cat->term_id => $cat );
113 unset( $term, $cat );
114 } elseif ( 'all' == $args['content'] ) {
115 $categories = (array) get_categories( array( 'get' => 'all' ) );
116 $tags = (array) get_tags( array( 'get' => 'all' ) );
118 $custom_taxonomies = get_taxonomies( array( '_builtin' => false ) );
119 $custom_terms = (array) get_terms( $custom_taxonomies, array( 'get' => 'all' ) );
121 // Put categories in order with no child going before its parent.
122 while ( $cat = array_shift( $categories ) ) {
123 if ( $cat->parent == 0 || isset( $cats[$cat->parent] ) )
124 $cats[$cat->term_id] = $cat;
126 $categories[] = $cat;
129 // Put terms in order with no child going before its parent.
130 while ( $t = array_shift( $custom_terms ) ) {
131 if ( $t->parent == 0 || isset( $terms[$t->parent] ) )
132 $terms[$t->term_id] = $t;
134 $custom_terms[] = $t;
137 unset( $categories, $custom_taxonomies, $custom_terms );
141 * Wrap given string in XML CDATA tag.
145 * @param string $str String to wrap in XML CDATA tag.
148 function wxr_cdata( $str ) {
149 if ( ! seems_utf8( $str ) ) {
150 $str = utf8_encode( $str );
152 // $str = ent2ncr(esc_html($str));
153 $str = '<![CDATA[' . str_replace( ']]>', ']]]]><![CDATA[>', $str ) . ']]>';
159 * Return the URL of the site
163 * @return string Site URL.
165 function wxr_site_url() {
166 // Multisite: the base URL.
167 if ( is_multisite() )
168 return network_home_url();
169 // WordPress (single site): the blog URL.
171 return get_bloginfo_rss( 'url' );
175 * Output a cat_name XML tag from a given category object
179 * @param object $category Category Object
181 function wxr_cat_name( $category ) {
182 if ( empty( $category->name ) )
185 echo '<wp:cat_name>' . wxr_cdata( $category->name ) . '</wp:cat_name>';
189 * Output a category_description XML tag from a given category object
193 * @param object $category Category Object
195 function wxr_category_description( $category ) {
196 if ( empty( $category->description ) )
199 echo '<wp:category_description>' . wxr_cdata( $category->description ) . '</wp:category_description>';
203 * Output a tag_name XML tag from a given tag object
207 * @param object $tag Tag Object
209 function wxr_tag_name( $tag ) {
210 if ( empty( $tag->name ) )
213 echo '<wp:tag_name>' . wxr_cdata( $tag->name ) . '</wp:tag_name>';
217 * Output a tag_description XML tag from a given tag object
221 * @param object $tag Tag Object
223 function wxr_tag_description( $tag ) {
224 if ( empty( $tag->description ) )
227 echo '<wp:tag_description>' . wxr_cdata( $tag->description ) . '</wp:tag_description>';
231 * Output a term_name XML tag from a given term object
235 * @param object $term Term Object
237 function wxr_term_name( $term ) {
238 if ( empty( $term->name ) )
241 echo '<wp:term_name>' . wxr_cdata( $term->name ) . '</wp:term_name>';
245 * Output a term_description XML tag from a given term object
249 * @param object $term Term Object
251 function wxr_term_description( $term ) {
252 if ( empty( $term->description ) )
255 echo '<wp:term_description>' . wxr_cdata( $term->description ) . '</wp:term_description>';
259 * Output list of authors with posts
263 * @global wpdb $wpdb WordPress database abstraction object.
265 * @param array $post_ids Array of post IDs to filter the query by. Optional.
267 function wxr_authors_list( array $post_ids = null ) {
270 if ( !empty( $post_ids ) ) {
271 $post_ids = array_map( 'absint', $post_ids );
272 $and = 'AND ID IN ( ' . implode( ', ', $post_ids ) . ')';
278 $results = $wpdb->get_results( "SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_status != 'auto-draft' $and" );
279 foreach ( (array) $results as $result )
280 $authors[] = get_userdata( $result->post_author );
282 $authors = array_filter( $authors );
284 foreach ( $authors as $author ) {
285 echo "\t<wp:author>";
286 echo '<wp:author_id>' . intval( $author->ID ) . '</wp:author_id>';
287 echo '<wp:author_login>' . wxr_cdata( $author->user_login ) . '</wp:author_login>';
288 echo '<wp:author_email>' . wxr_cdata( $author->user_email ) . '</wp:author_email>';
289 echo '<wp:author_display_name>' . wxr_cdata( $author->display_name ) . '</wp:author_display_name>';
290 echo '<wp:author_first_name>' . wxr_cdata( $author->first_name ) . '</wp:author_first_name>';
291 echo '<wp:author_last_name>' . wxr_cdata( $author->last_name ) . '</wp:author_last_name>';
292 echo "</wp:author>\n";
297 * Ouput all navigation menu terms
301 function wxr_nav_menu_terms() {
302 $nav_menus = wp_get_nav_menus();
303 if ( empty( $nav_menus ) || ! is_array( $nav_menus ) )
306 foreach ( $nav_menus as $menu ) {
308 echo '<wp:term_id>' . intval( $menu->term_id ) . '</wp:term_id>';
309 echo '<wp:term_taxonomy>nav_menu</wp:term_taxonomy>';
310 echo '<wp:term_slug>' . wxr_cdata( $menu->slug ) . '</wp:term_slug>';
311 wxr_term_name( $menu );
317 * Output list of taxonomy terms, in XML tag format, associated with a post
321 function wxr_post_taxonomy() {
324 $taxonomies = get_object_taxonomies( $post->post_type );
325 if ( empty( $taxonomies ) )
327 $terms = wp_get_object_terms( $post->ID, $taxonomies );
329 foreach ( (array) $terms as $term ) {
330 echo "\t\t<category domain=\"{$term->taxonomy}\" nicename=\"{$term->slug}\">" . wxr_cdata( $term->name ) . "</category>\n";
336 * @param bool $return_me
337 * @param string $meta_key
340 function wxr_filter_postmeta( $return_me, $meta_key ) {
341 if ( '_edit_lock' == $meta_key )
345 add_filter( 'wxr_export_skip_postmeta', 'wxr_filter_postmeta', 10, 2 );
347 echo '<?xml version="1.0" encoding="' . get_bloginfo('charset') . "\" ?>\n";
350 <!-- This is a WordPress eXtended RSS file generated by WordPress as an export of your site. -->
351 <!-- It contains information about your site's posts, pages, comments, categories, and other content. -->
352 <!-- You may use this file to transfer that content from one site to another. -->
353 <!-- This file is not intended to serve as a complete backup of your site. -->
355 <!-- To import this information into a WordPress site follow these steps: -->
356 <!-- 1. Log in to that site as an administrator. -->
357 <!-- 2. Go to Tools: Import in the WordPress admin panel. -->
358 <!-- 3. Install the "WordPress" importer from the list. -->
359 <!-- 4. Activate & Run Importer. -->
360 <!-- 5. Upload this file using the form provided on that page. -->
361 <!-- 6. You will first be asked to map the authors in this export file to users -->
362 <!-- on the site. For each author, you may choose to map to an -->
363 <!-- existing user on the site or to create a new user. -->
364 <!-- 7. WordPress will then import each of the posts, pages, comments, categories, etc. -->
365 <!-- contained in this file into your site. -->
367 <?php the_generator( 'export' ); ?>
369 xmlns:excerpt="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/excerpt/"
370 xmlns:content="http://purl.org/rss/1.0/modules/content/"
371 xmlns:wfw="http://wellformedweb.org/CommentAPI/"
372 xmlns:dc="http://purl.org/dc/elements/1.1/"
373 xmlns:wp="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/"
377 <title><?php bloginfo_rss( 'name' ); ?></title>
378 <link><?php bloginfo_rss( 'url' ); ?></link>
379 <description><?php bloginfo_rss( 'description' ); ?></description>
380 <pubDate><?php echo date( 'D, d M Y H:i:s +0000' ); ?></pubDate>
381 <language><?php bloginfo_rss( 'language' ); ?></language>
382 <wp:wxr_version><?php echo WXR_VERSION; ?></wp:wxr_version>
383 <wp:base_site_url><?php echo wxr_site_url(); ?></wp:base_site_url>
384 <wp:base_blog_url><?php bloginfo_rss( 'url' ); ?></wp:base_blog_url>
386 <?php wxr_authors_list( $post_ids ); ?>
388 <?php foreach ( $cats as $c ) : ?>
389 <wp:category><wp:term_id><?php echo intval( $c->term_id ); ?></wp:term_id><wp:category_nicename><?php echo wxr_cdata( $c->slug ); ?></wp:category_nicename><wp:category_parent><?php echo wxr_cdata( $c->parent ? $cats[$c->parent]->slug : '' ); ?></wp:category_parent><?php wxr_cat_name( $c ); ?><?php wxr_category_description( $c ); ?></wp:category>
391 <?php foreach ( $tags as $t ) : ?>
392 <wp:tag><wp:term_id><?php echo intval( $t->term_id ); ?></wp:term_id><wp:tag_slug><?php echo wxr_cdata( $t->slug ); ?></wp:tag_slug><?php wxr_tag_name( $t ); ?><?php wxr_tag_description( $t ); ?></wp:tag>
394 <?php foreach ( $terms as $t ) : ?>
395 <wp:term><wp:term_id><?php echo wxr_cdata( $t->term_id ); ?></wp:term_id><wp:term_taxonomy><?php echo wxr_cdata( $t->taxonomy ); ?></wp:term_taxonomy><wp:term_slug><?php echo wxr_cdata( $t->slug ); ?></wp:term_slug><wp:term_parent><?php echo wxr_cdata( $t->parent ? $terms[$t->parent]->slug : '' ); ?></wp:term_parent><?php wxr_term_name( $t ); ?><?php wxr_term_description( $t ); ?></wp:term>
397 <?php if ( 'all' == $args['content'] ) wxr_nav_menu_terms(); ?>
400 /** This action is documented in wp-includes/feed-rss2.php */
401 do_action( 'rss2_head' );
404 <?php if ( $post_ids ) {
406 * @global WP_Query $wp_query
410 // Fake being in the loop.
411 $wp_query->in_the_loop = true;
413 // Fetch 20 posts at a time rather than loading the entire table into memory.
414 while ( $next_posts = array_splice( $post_ids, 0, 20 ) ) {
415 $where = 'WHERE ID IN (' . join( ',', $next_posts ) . ')';
416 $posts = $wpdb->get_results( "SELECT * FROM {$wpdb->posts} $where" );
419 foreach ( $posts as $post ) {
420 setup_postdata( $post );
421 $is_sticky = is_sticky( $post->ID ) ? 1 : 0;
425 /** This filter is documented in wp-includes/feed.php */
426 echo apply_filters( 'the_title_rss', $post->post_title );
428 <link><?php the_permalink_rss() ?></link>
429 <pubDate><?php echo mysql2date( 'D, d M Y H:i:s +0000', get_post_time( 'Y-m-d H:i:s', true ), false ); ?></pubDate>
430 <dc:creator><?php echo wxr_cdata( get_the_author_meta( 'login' ) ); ?></dc:creator>
431 <guid isPermaLink="false"><?php the_guid(); ?></guid>
432 <description></description>
433 <content:encoded><?php
435 * Filter the post content used for WXR exports.
439 * @param string $post_content Content of the current post.
441 echo wxr_cdata( apply_filters( 'the_content_export', $post->post_content ) );
443 <excerpt:encoded><?php
445 * Filter the post excerpt used for WXR exports.
449 * @param string $post_excerpt Excerpt for the current post.
451 echo wxr_cdata( apply_filters( 'the_excerpt_export', $post->post_excerpt ) );
453 <wp:post_id><?php echo intval( $post->ID ); ?></wp:post_id>
454 <wp:post_date><?php echo wxr_cdata( $post->post_date ); ?></wp:post_date>
455 <wp:post_date_gmt><?php echo wxr_cdata( $post->post_date_gmt ); ?></wp:post_date_gmt>
456 <wp:comment_status><?php echo wxr_cdata( $post->comment_status ); ?></wp:comment_status>
457 <wp:ping_status><?php echo wxr_cdata( $post->ping_status ); ?></wp:ping_status>
458 <wp:post_name><?php echo wxr_cdata( $post->post_name ); ?></wp:post_name>
459 <wp:status><?php echo wxr_cdata( $post->post_status ); ?></wp:status>
460 <wp:post_parent><?php echo intval( $post->post_parent ); ?></wp:post_parent>
461 <wp:menu_order><?php echo intval( $post->menu_order ); ?></wp:menu_order>
462 <wp:post_type><?php echo wxr_cdata( $post->post_type ); ?></wp:post_type>
463 <wp:post_password><?php echo wxr_cdata( $post->post_password ); ?></wp:post_password>
464 <wp:is_sticky><?php echo intval( $is_sticky ); ?></wp:is_sticky>
465 <?php if ( $post->post_type == 'attachment' ) : ?>
466 <wp:attachment_url><?php echo wxr_cdata( wp_get_attachment_url( $post->ID ) ); ?></wp:attachment_url>
468 <?php wxr_post_taxonomy(); ?>
469 <?php $postmeta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d", $post->ID ) );
470 foreach ( $postmeta as $meta ) :
472 * Filter whether to selectively skip post meta used for WXR exports.
474 * Returning a truthy value to the filter will skip the current meta
475 * object from being exported.
479 * @param bool $skip Whether to skip the current post meta. Default false.
480 * @param string $meta_key Current meta key.
481 * @param object $meta Current meta object.
483 if ( apply_filters( 'wxr_export_skip_postmeta', false, $meta->meta_key, $meta ) )
487 <wp:meta_key><?php echo wxr_cdata( $meta->meta_key ); ?></wp:meta_key>
488 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>
492 $_comments = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved <> 'spam'", $post->ID ) );
493 $comments = array_map( 'get_comment', $_comments );
494 foreach ( $comments as $c ) : ?>
496 <wp:comment_id><?php echo intval( $c->comment_ID ); ?></wp:comment_id>
497 <wp:comment_author><?php echo wxr_cdata( $c->comment_author ); ?></wp:comment_author>
498 <wp:comment_author_email><?php echo wxr_cdata( $c->comment_author_email ); ?></wp:comment_author_email>
499 <wp:comment_author_url><?php echo esc_url_raw( $c->comment_author_url ); ?></wp:comment_author_url>
500 <wp:comment_author_IP><?php echo wxr_cdata( $c->comment_author_IP ); ?></wp:comment_author_IP>
501 <wp:comment_date><?php echo wxr_cdata( $c->comment_date ); ?></wp:comment_date>
502 <wp:comment_date_gmt><?php echo wxr_cdata( $c->comment_date_gmt ); ?></wp:comment_date_gmt>
503 <wp:comment_content><?php echo wxr_cdata( $c->comment_content ) ?></wp:comment_content>
504 <wp:comment_approved><?php echo wxr_cdata( $c->comment_approved ); ?></wp:comment_approved>
505 <wp:comment_type><?php echo wxr_cdata( $c->comment_type ); ?></wp:comment_type>
506 <wp:comment_parent><?php echo intval( $c->comment_parent ); ?></wp:comment_parent>
507 <wp:comment_user_id><?php echo intval( $c->user_id ); ?></wp:comment_user_id>
508 <?php $c_meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id = %d", $c->comment_ID ) );
509 foreach ( $c_meta as $meta ) :
511 * Filter whether to selectively skip comment meta used for WXR exports.
513 * Returning a truthy value to the filter will skip the current meta
514 * object from being exported.
518 * @param bool $skip Whether to skip the current comment meta. Default false.
519 * @param string $meta_key Current meta key.
520 * @param object $meta Current meta object.
522 if ( apply_filters( 'wxr_export_skip_commentmeta', false, $meta->meta_key, $meta ) ) {
527 <wp:meta_key><?php echo wxr_cdata( $meta->meta_key ); ?></wp:meta_key>
528 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>