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 * Filters 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>\n";
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>\n";
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>\n";
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>\n";
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>\n";
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 "\t\t<wp:term_description>" . wxr_cdata( $term->description ) . "</wp:term_description>\n";
259 * Output term meta XML tags for a given term object.
263 * @param WP_Term $term Term object.
265 function wxr_term_meta( $term ) {
268 $termmeta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->termmeta WHERE term_id = %d", $term->term_id ) );
270 foreach ( $termmeta as $meta ) {
272 * Filters whether to selectively skip term meta used for WXR exports.
274 * Returning a truthy value to the filter will skip the current meta
275 * object from being exported.
279 * @param bool $skip Whether to skip the current piece of term meta. Default false.
280 * @param string $meta_key Current meta key.
281 * @param object $meta Current meta object.
283 if ( ! apply_filters( 'wxr_export_skip_termmeta', false, $meta->meta_key, $meta ) ) {
284 printf( "\t\t<wp:termmeta>\n\t\t\t<wp:meta_key>%s</wp:meta_key>\n\t\t\t<wp:meta_value>%s</wp:meta_value>\n\t\t</wp:termmeta>\n", wxr_cdata( $meta->meta_key ), wxr_cdata( $meta->meta_value ) );
290 * Output list of authors with posts
294 * @global wpdb $wpdb WordPress database abstraction object.
296 * @param array $post_ids Array of post IDs to filter the query by. Optional.
298 function wxr_authors_list( array $post_ids = null ) {
301 if ( !empty( $post_ids ) ) {
302 $post_ids = array_map( 'absint', $post_ids );
303 $and = 'AND ID IN ( ' . implode( ', ', $post_ids ) . ')';
309 $results = $wpdb->get_results( "SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_status != 'auto-draft' $and" );
310 foreach ( (array) $results as $result )
311 $authors[] = get_userdata( $result->post_author );
313 $authors = array_filter( $authors );
315 foreach ( $authors as $author ) {
316 echo "\t<wp:author>";
317 echo '<wp:author_id>' . intval( $author->ID ) . '</wp:author_id>';
318 echo '<wp:author_login>' . wxr_cdata( $author->user_login ) . '</wp:author_login>';
319 echo '<wp:author_email>' . wxr_cdata( $author->user_email ) . '</wp:author_email>';
320 echo '<wp:author_display_name>' . wxr_cdata( $author->display_name ) . '</wp:author_display_name>';
321 echo '<wp:author_first_name>' . wxr_cdata( $author->first_name ) . '</wp:author_first_name>';
322 echo '<wp:author_last_name>' . wxr_cdata( $author->last_name ) . '</wp:author_last_name>';
323 echo "</wp:author>\n";
328 * Ouput all navigation menu terms
332 function wxr_nav_menu_terms() {
333 $nav_menus = wp_get_nav_menus();
334 if ( empty( $nav_menus ) || ! is_array( $nav_menus ) )
337 foreach ( $nav_menus as $menu ) {
339 echo '<wp:term_id>' . intval( $menu->term_id ) . '</wp:term_id>';
340 echo '<wp:term_taxonomy>nav_menu</wp:term_taxonomy>';
341 echo '<wp:term_slug>' . wxr_cdata( $menu->slug ) . '</wp:term_slug>';
342 wxr_term_name( $menu );
348 * Output list of taxonomy terms, in XML tag format, associated with a post
352 function wxr_post_taxonomy() {
355 $taxonomies = get_object_taxonomies( $post->post_type );
356 if ( empty( $taxonomies ) )
358 $terms = wp_get_object_terms( $post->ID, $taxonomies );
360 foreach ( (array) $terms as $term ) {
361 echo "\t\t<category domain=\"{$term->taxonomy}\" nicename=\"{$term->slug}\">" . wxr_cdata( $term->name ) . "</category>\n";
367 * @param bool $return_me
368 * @param string $meta_key
371 function wxr_filter_postmeta( $return_me, $meta_key ) {
372 if ( '_edit_lock' == $meta_key )
376 add_filter( 'wxr_export_skip_postmeta', 'wxr_filter_postmeta', 10, 2 );
378 echo '<?xml version="1.0" encoding="' . get_bloginfo('charset') . "\" ?>\n";
381 <!-- This is a WordPress eXtended RSS file generated by WordPress as an export of your site. -->
382 <!-- It contains information about your site's posts, pages, comments, categories, and other content. -->
383 <!-- You may use this file to transfer that content from one site to another. -->
384 <!-- This file is not intended to serve as a complete backup of your site. -->
386 <!-- To import this information into a WordPress site follow these steps: -->
387 <!-- 1. Log in to that site as an administrator. -->
388 <!-- 2. Go to Tools: Import in the WordPress admin panel. -->
389 <!-- 3. Install the "WordPress" importer from the list. -->
390 <!-- 4. Activate & Run Importer. -->
391 <!-- 5. Upload this file using the form provided on that page. -->
392 <!-- 6. You will first be asked to map the authors in this export file to users -->
393 <!-- on the site. For each author, you may choose to map to an -->
394 <!-- existing user on the site or to create a new user. -->
395 <!-- 7. WordPress will then import each of the posts, pages, comments, categories, etc. -->
396 <!-- contained in this file into your site. -->
398 <?php the_generator( 'export' ); ?>
400 xmlns:excerpt="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/excerpt/"
401 xmlns:content="http://purl.org/rss/1.0/modules/content/"
402 xmlns:wfw="http://wellformedweb.org/CommentAPI/"
403 xmlns:dc="http://purl.org/dc/elements/1.1/"
404 xmlns:wp="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/"
408 <title><?php bloginfo_rss( 'name' ); ?></title>
409 <link><?php bloginfo_rss( 'url' ); ?></link>
410 <description><?php bloginfo_rss( 'description' ); ?></description>
411 <pubDate><?php echo date( 'D, d M Y H:i:s +0000' ); ?></pubDate>
412 <language><?php bloginfo_rss( 'language' ); ?></language>
413 <wp:wxr_version><?php echo WXR_VERSION; ?></wp:wxr_version>
414 <wp:base_site_url><?php echo wxr_site_url(); ?></wp:base_site_url>
415 <wp:base_blog_url><?php bloginfo_rss( 'url' ); ?></wp:base_blog_url>
417 <?php wxr_authors_list( $post_ids ); ?>
419 <?php foreach ( $cats as $c ) : ?>
421 <wp:term_id><?php echo intval( $c->term_id ); ?></wp:term_id>
422 <wp:category_nicename><?php echo wxr_cdata( $c->slug ); ?></wp:category_nicename>
423 <wp:category_parent><?php echo wxr_cdata( $c->parent ? $cats[$c->parent]->slug : '' ); ?></wp:category_parent>
424 <?php wxr_cat_name( $c );
425 wxr_category_description( $c );
426 wxr_term_meta( $c ); ?>
429 <?php foreach ( $tags as $t ) : ?>
431 <wp:term_id><?php echo intval( $t->term_id ); ?></wp:term_id>
432 <wp:tag_slug><?php echo wxr_cdata( $t->slug ); ?></wp:tag_slug>
433 <?php wxr_tag_name( $t );
434 wxr_tag_description( $t );
435 wxr_term_meta( $t ); ?>
438 <?php foreach ( $terms as $t ) : ?>
440 <wp:term_id><?php echo wxr_cdata( $t->term_id ); ?></wp:term_id>
441 <wp:term_taxonomy><?php echo wxr_cdata( $t->taxonomy ); ?></wp:term_taxonomy>
442 <wp:term_slug><?php echo wxr_cdata( $t->slug ); ?></wp:term_slug>
443 <wp:term_parent><?php echo wxr_cdata( $t->parent ? $terms[$t->parent]->slug : '' ); ?></wp:term_parent>
444 <?php wxr_term_name( $t );
445 wxr_term_description( $t );
446 wxr_term_meta( $t ); ?>
449 <?php if ( 'all' == $args['content'] ) wxr_nav_menu_terms(); ?>
452 /** This action is documented in wp-includes/feed-rss2.php */
453 do_action( 'rss2_head' );
456 <?php if ( $post_ids ) {
458 * @global WP_Query $wp_query
462 // Fake being in the loop.
463 $wp_query->in_the_loop = true;
465 // Fetch 20 posts at a time rather than loading the entire table into memory.
466 while ( $next_posts = array_splice( $post_ids, 0, 20 ) ) {
467 $where = 'WHERE ID IN (' . join( ',', $next_posts ) . ')';
468 $posts = $wpdb->get_results( "SELECT * FROM {$wpdb->posts} $where" );
471 foreach ( $posts as $post ) {
472 setup_postdata( $post );
473 $is_sticky = is_sticky( $post->ID ) ? 1 : 0;
477 /** This filter is documented in wp-includes/feed.php */
478 echo apply_filters( 'the_title_rss', $post->post_title );
480 <link><?php the_permalink_rss() ?></link>
481 <pubDate><?php echo mysql2date( 'D, d M Y H:i:s +0000', get_post_time( 'Y-m-d H:i:s', true ), false ); ?></pubDate>
482 <dc:creator><?php echo wxr_cdata( get_the_author_meta( 'login' ) ); ?></dc:creator>
483 <guid isPermaLink="false"><?php the_guid(); ?></guid>
484 <description></description>
485 <content:encoded><?php
487 * Filters the post content used for WXR exports.
491 * @param string $post_content Content of the current post.
493 echo wxr_cdata( apply_filters( 'the_content_export', $post->post_content ) );
495 <excerpt:encoded><?php
497 * Filters the post excerpt used for WXR exports.
501 * @param string $post_excerpt Excerpt for the current post.
503 echo wxr_cdata( apply_filters( 'the_excerpt_export', $post->post_excerpt ) );
505 <wp:post_id><?php echo intval( $post->ID ); ?></wp:post_id>
506 <wp:post_date><?php echo wxr_cdata( $post->post_date ); ?></wp:post_date>
507 <wp:post_date_gmt><?php echo wxr_cdata( $post->post_date_gmt ); ?></wp:post_date_gmt>
508 <wp:comment_status><?php echo wxr_cdata( $post->comment_status ); ?></wp:comment_status>
509 <wp:ping_status><?php echo wxr_cdata( $post->ping_status ); ?></wp:ping_status>
510 <wp:post_name><?php echo wxr_cdata( $post->post_name ); ?></wp:post_name>
511 <wp:status><?php echo wxr_cdata( $post->post_status ); ?></wp:status>
512 <wp:post_parent><?php echo intval( $post->post_parent ); ?></wp:post_parent>
513 <wp:menu_order><?php echo intval( $post->menu_order ); ?></wp:menu_order>
514 <wp:post_type><?php echo wxr_cdata( $post->post_type ); ?></wp:post_type>
515 <wp:post_password><?php echo wxr_cdata( $post->post_password ); ?></wp:post_password>
516 <wp:is_sticky><?php echo intval( $is_sticky ); ?></wp:is_sticky>
517 <?php if ( $post->post_type == 'attachment' ) : ?>
518 <wp:attachment_url><?php echo wxr_cdata( wp_get_attachment_url( $post->ID ) ); ?></wp:attachment_url>
520 <?php wxr_post_taxonomy(); ?>
521 <?php $postmeta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d", $post->ID ) );
522 foreach ( $postmeta as $meta ) :
524 * Filters whether to selectively skip post meta used for WXR exports.
526 * Returning a truthy value to the filter will skip the current meta
527 * object from being exported.
531 * @param bool $skip Whether to skip the current post meta. Default false.
532 * @param string $meta_key Current meta key.
533 * @param object $meta Current meta object.
535 if ( apply_filters( 'wxr_export_skip_postmeta', false, $meta->meta_key, $meta ) )
539 <wp:meta_key><?php echo wxr_cdata( $meta->meta_key ); ?></wp:meta_key>
540 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>
544 $_comments = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved <> 'spam'", $post->ID ) );
545 $comments = array_map( 'get_comment', $_comments );
546 foreach ( $comments as $c ) : ?>
548 <wp:comment_id><?php echo intval( $c->comment_ID ); ?></wp:comment_id>
549 <wp:comment_author><?php echo wxr_cdata( $c->comment_author ); ?></wp:comment_author>
550 <wp:comment_author_email><?php echo wxr_cdata( $c->comment_author_email ); ?></wp:comment_author_email>
551 <wp:comment_author_url><?php echo esc_url_raw( $c->comment_author_url ); ?></wp:comment_author_url>
552 <wp:comment_author_IP><?php echo wxr_cdata( $c->comment_author_IP ); ?></wp:comment_author_IP>
553 <wp:comment_date><?php echo wxr_cdata( $c->comment_date ); ?></wp:comment_date>
554 <wp:comment_date_gmt><?php echo wxr_cdata( $c->comment_date_gmt ); ?></wp:comment_date_gmt>
555 <wp:comment_content><?php echo wxr_cdata( $c->comment_content ) ?></wp:comment_content>
556 <wp:comment_approved><?php echo wxr_cdata( $c->comment_approved ); ?></wp:comment_approved>
557 <wp:comment_type><?php echo wxr_cdata( $c->comment_type ); ?></wp:comment_type>
558 <wp:comment_parent><?php echo intval( $c->comment_parent ); ?></wp:comment_parent>
559 <wp:comment_user_id><?php echo intval( $c->user_id ); ?></wp:comment_user_id>
560 <?php $c_meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id = %d", $c->comment_ID ) );
561 foreach ( $c_meta as $meta ) :
563 * Filters whether to selectively skip comment meta used for WXR exports.
565 * Returning a truthy value to the filter will skip the current meta
566 * object from being exported.
570 * @param bool $skip Whether to skip the current comment meta. Default false.
571 * @param string $meta_key Current meta key.
572 * @param object $meta Current meta object.
574 if ( apply_filters( 'wxr_export_skip_commentmeta', false, $meta->meta_key, $meta ) ) {
579 <wp:meta_key><?php echo wxr_cdata( $meta->meta_key ); ?></wp:meta_key>
580 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>