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.
23 * @param array $args Filters defining what should be included in the export.
25 function export_wp( $args = array() ) {
28 $defaults = array( 'content' => 'all', 'author' => false, 'category' => false,
29 'start_date' => false, 'end_date' => false, 'status' => false,
31 $args = wp_parse_args( $args, $defaults );
34 * Fires at the beginning of an export, before any headers are sent.
38 * @param array $args An array of export arguments.
40 do_action( 'export_wp', $args );
42 $sitename = sanitize_key( get_bloginfo( 'name' ) );
43 if ( ! empty($sitename) ) $sitename .= '.';
44 $filename = $sitename . 'wordpress.' . date( 'Y-m-d' ) . '.xml';
46 header( 'Content-Description: File Transfer' );
47 header( 'Content-Disposition: attachment; filename=' . $filename );
48 header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ), true );
50 if ( 'all' != $args['content'] && post_type_exists( $args['content'] ) ) {
51 $ptype = get_post_type_object( $args['content'] );
52 if ( ! $ptype->can_export )
53 $args['content'] = 'post';
55 $where = $wpdb->prepare( "{$wpdb->posts}.post_type = %s", $args['content'] );
57 $post_types = get_post_types( array( 'can_export' => true ) );
58 $esses = array_fill( 0, count($post_types), '%s' );
59 $where = $wpdb->prepare( "{$wpdb->posts}.post_type IN (" . implode( ',', $esses ) . ')', $post_types );
62 if ( $args['status'] && ( 'post' == $args['content'] || 'page' == $args['content'] ) )
63 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_status = %s", $args['status'] );
65 $where .= " AND {$wpdb->posts}.post_status != 'auto-draft'";
68 if ( $args['category'] && 'post' == $args['content'] ) {
69 if ( $term = term_exists( $args['category'], 'category' ) ) {
70 $join = "INNER JOIN {$wpdb->term_relationships} ON ({$wpdb->posts}.ID = {$wpdb->term_relationships}.object_id)";
71 $where .= $wpdb->prepare( " AND {$wpdb->term_relationships}.term_taxonomy_id = %d", $term['term_taxonomy_id'] );
75 if ( 'post' == $args['content'] || 'page' == $args['content'] ) {
76 if ( $args['author'] )
77 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_author = %d", $args['author'] );
79 if ( $args['start_date'] )
80 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date >= %s", date( 'Y-m-d', strtotime($args['start_date']) ) );
82 if ( $args['end_date'] )
83 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date < %s", date( 'Y-m-d', strtotime('+1 month', strtotime($args['end_date'])) ) );
86 // Grab a snapshot of post IDs, just in case it changes during the export.
87 $post_ids = $wpdb->get_col( "SELECT ID FROM {$wpdb->posts} $join WHERE $where" );
90 * Get the requested terms ready, empty unless posts filtered by category
93 $cats = $tags = $terms = array();
94 if ( isset( $term ) && $term ) {
95 $cat = get_term( $term['term_id'], 'category' );
96 $cats = array( $cat->term_id => $cat );
98 } else if ( 'all' == $args['content'] ) {
99 $categories = (array) get_categories( array( 'get' => 'all' ) );
100 $tags = (array) get_tags( array( 'get' => 'all' ) );
102 $custom_taxonomies = get_taxonomies( array( '_builtin' => false ) );
103 $custom_terms = (array) get_terms( $custom_taxonomies, array( 'get' => 'all' ) );
105 // Put categories in order with no child going before its parent.
106 while ( $cat = array_shift( $categories ) ) {
107 if ( $cat->parent == 0 || isset( $cats[$cat->parent] ) )
108 $cats[$cat->term_id] = $cat;
110 $categories[] = $cat;
113 // Put terms in order with no child going before its parent.
114 while ( $t = array_shift( $custom_terms ) ) {
115 if ( $t->parent == 0 || isset( $terms[$t->parent] ) )
116 $terms[$t->term_id] = $t;
118 $custom_terms[] = $t;
121 unset( $categories, $custom_taxonomies, $custom_terms );
125 * Wrap given string in XML CDATA tag.
129 * @param string $str String to wrap in XML CDATA tag.
132 function wxr_cdata( $str ) {
133 if ( seems_utf8( $str ) == false )
134 $str = utf8_encode( $str );
136 // $str = ent2ncr(esc_html($str));
137 $str = '<![CDATA[' . str_replace( ']]>', ']]]]><![CDATA[>', $str ) . ']]>';
143 * Return the URL of the site
147 * @return string Site URL.
149 function wxr_site_url() {
150 // Multisite: the base URL.
151 if ( is_multisite() )
152 return network_home_url();
153 // WordPress (single site): the blog URL.
155 return get_bloginfo_rss( 'url' );
159 * Output a cat_name XML tag from a given category object
163 * @param object $category Category Object
165 function wxr_cat_name( $category ) {
166 if ( empty( $category->name ) )
169 echo '<wp:cat_name>' . wxr_cdata( $category->name ) . '</wp:cat_name>';
173 * Output a category_description XML tag from a given category object
177 * @param object $category Category Object
179 function wxr_category_description( $category ) {
180 if ( empty( $category->description ) )
183 echo '<wp:category_description>' . wxr_cdata( $category->description ) . '</wp:category_description>';
187 * Output a tag_name XML tag from a given tag object
191 * @param object $tag Tag Object
193 function wxr_tag_name( $tag ) {
194 if ( empty( $tag->name ) )
197 echo '<wp:tag_name>' . wxr_cdata( $tag->name ) . '</wp:tag_name>';
201 * Output a tag_description XML tag from a given tag object
205 * @param object $tag Tag Object
207 function wxr_tag_description( $tag ) {
208 if ( empty( $tag->description ) )
211 echo '<wp:tag_description>' . wxr_cdata( $tag->description ) . '</wp:tag_description>';
215 * Output a term_name XML tag from a given term object
219 * @param object $term Term Object
221 function wxr_term_name( $term ) {
222 if ( empty( $term->name ) )
225 echo '<wp:term_name>' . wxr_cdata( $term->name ) . '</wp:term_name>';
229 * Output a term_description XML tag from a given term object
233 * @param object $term Term Object
235 function wxr_term_description( $term ) {
236 if ( empty( $term->description ) )
239 echo '<wp:term_description>' . wxr_cdata( $term->description ) . '</wp:term_description>';
243 * Output list of authors with posts
247 * @param array $post_ids Array of post IDs to filter the query by. Optional.
249 function wxr_authors_list( array $post_ids = null ) {
252 if ( !empty( $post_ids ) ) {
253 $post_ids = array_map( 'absint', $post_ids );
254 $and = 'AND ID IN ( ' . implode( ', ', $post_ids ) . ')';
260 $results = $wpdb->get_results( "SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_status != 'auto-draft' $and" );
261 foreach ( (array) $results as $result )
262 $authors[] = get_userdata( $result->post_author );
264 $authors = array_filter( $authors );
266 foreach ( $authors as $author ) {
267 echo "\t<wp:author>";
268 echo '<wp:author_id>' . $author->ID . '</wp:author_id>';
269 echo '<wp:author_login>' . $author->user_login . '</wp:author_login>';
270 echo '<wp:author_email>' . $author->user_email . '</wp:author_email>';
271 echo '<wp:author_display_name>' . wxr_cdata( $author->display_name ) . '</wp:author_display_name>';
272 echo '<wp:author_first_name>' . wxr_cdata( $author->user_firstname ) . '</wp:author_first_name>';
273 echo '<wp:author_last_name>' . wxr_cdata( $author->user_lastname ) . '</wp:author_last_name>';
274 echo "</wp:author>\n";
279 * Ouput all navigation menu terms
283 function wxr_nav_menu_terms() {
284 $nav_menus = wp_get_nav_menus();
285 if ( empty( $nav_menus ) || ! is_array( $nav_menus ) )
288 foreach ( $nav_menus as $menu ) {
289 echo "\t<wp:term><wp:term_id>{$menu->term_id}</wp:term_id><wp:term_taxonomy>nav_menu</wp:term_taxonomy><wp:term_slug>{$menu->slug}</wp:term_slug>";
290 wxr_term_name( $menu );
296 * Output list of taxonomy terms, in XML tag format, associated with a post
300 function wxr_post_taxonomy() {
303 $taxonomies = get_object_taxonomies( $post->post_type );
304 if ( empty( $taxonomies ) )
306 $terms = wp_get_object_terms( $post->ID, $taxonomies );
308 foreach ( (array) $terms as $term ) {
309 echo "\t\t<category domain=\"{$term->taxonomy}\" nicename=\"{$term->slug}\">" . wxr_cdata( $term->name ) . "</category>\n";
313 function wxr_filter_postmeta( $return_me, $meta_key ) {
314 if ( '_edit_lock' == $meta_key )
318 add_filter( 'wxr_export_skip_postmeta', 'wxr_filter_postmeta', 10, 2 );
320 echo '<?xml version="1.0" encoding="' . get_bloginfo('charset') . "\" ?>\n";
323 <!-- This is a WordPress eXtended RSS file generated by WordPress as an export of your site. -->
324 <!-- It contains information about your site's posts, pages, comments, categories, and other content. -->
325 <!-- You may use this file to transfer that content from one site to another. -->
326 <!-- This file is not intended to serve as a complete backup of your site. -->
328 <!-- To import this information into a WordPress site follow these steps: -->
329 <!-- 1. Log in to that site as an administrator. -->
330 <!-- 2. Go to Tools: Import in the WordPress admin panel. -->
331 <!-- 3. Install the "WordPress" importer from the list. -->
332 <!-- 4. Activate & Run Importer. -->
333 <!-- 5. Upload this file using the form provided on that page. -->
334 <!-- 6. You will first be asked to map the authors in this export file to users -->
335 <!-- on the site. For each author, you may choose to map to an -->
336 <!-- existing user on the site or to create a new user. -->
337 <!-- 7. WordPress will then import each of the posts, pages, comments, categories, etc. -->
338 <!-- contained in this file into your site. -->
340 <?php the_generator( 'export' ); ?>
342 xmlns:excerpt="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/excerpt/"
343 xmlns:content="http://purl.org/rss/1.0/modules/content/"
344 xmlns:wfw="http://wellformedweb.org/CommentAPI/"
345 xmlns:dc="http://purl.org/dc/elements/1.1/"
346 xmlns:wp="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/"
350 <title><?php bloginfo_rss( 'name' ); ?></title>
351 <link><?php bloginfo_rss( 'url' ); ?></link>
352 <description><?php bloginfo_rss( 'description' ); ?></description>
353 <pubDate><?php echo date( 'D, d M Y H:i:s +0000' ); ?></pubDate>
354 <language><?php bloginfo_rss( 'language' ); ?></language>
355 <wp:wxr_version><?php echo WXR_VERSION; ?></wp:wxr_version>
356 <wp:base_site_url><?php echo wxr_site_url(); ?></wp:base_site_url>
357 <wp:base_blog_url><?php bloginfo_rss( 'url' ); ?></wp:base_blog_url>
359 <?php wxr_authors_list( $post_ids ); ?>
361 <?php foreach ( $cats as $c ) : ?>
362 <wp:category><wp:term_id><?php echo $c->term_id ?></wp:term_id><wp:category_nicename><?php echo $c->slug; ?></wp:category_nicename><wp:category_parent><?php echo $c->parent ? $cats[$c->parent]->slug : ''; ?></wp:category_parent><?php wxr_cat_name( $c ); ?><?php wxr_category_description( $c ); ?></wp:category>
364 <?php foreach ( $tags as $t ) : ?>
365 <wp:tag><wp:term_id><?php echo $t->term_id ?></wp:term_id><wp:tag_slug><?php echo $t->slug; ?></wp:tag_slug><?php wxr_tag_name( $t ); ?><?php wxr_tag_description( $t ); ?></wp:tag>
367 <?php foreach ( $terms as $t ) : ?>
368 <wp:term><wp:term_id><?php echo $t->term_id ?></wp:term_id><wp:term_taxonomy><?php echo $t->taxonomy; ?></wp:term_taxonomy><wp:term_slug><?php echo $t->slug; ?></wp:term_slug><wp:term_parent><?php echo $t->parent ? $terms[$t->parent]->slug : ''; ?></wp:term_parent><?php wxr_term_name( $t ); ?><?php wxr_term_description( $t ); ?></wp:term>
370 <?php if ( 'all' == $args['content'] ) wxr_nav_menu_terms(); ?>
373 /** This action is documented in wp-includes/feed-rss2.php */
374 do_action( 'rss2_head' );
377 <?php if ( $post_ids ) {
380 // Fake being in the loop.
381 $wp_query->in_the_loop = true;
383 // Fetch 20 posts at a time rather than loading the entire table into memory.
384 while ( $next_posts = array_splice( $post_ids, 0, 20 ) ) {
385 $where = 'WHERE ID IN (' . join( ',', $next_posts ) . ')';
386 $posts = $wpdb->get_results( "SELECT * FROM {$wpdb->posts} $where" );
389 foreach ( $posts as $post ) {
390 setup_postdata( $post );
391 $is_sticky = is_sticky( $post->ID ) ? 1 : 0;
395 /** This filter is documented in wp-includes/feed.php */
396 echo apply_filters( 'the_title_rss', $post->post_title );
398 <link><?php the_permalink_rss() ?></link>
399 <pubDate><?php echo mysql2date( 'D, d M Y H:i:s +0000', get_post_time( 'Y-m-d H:i:s', true ), false ); ?></pubDate>
400 <dc:creator><?php echo wxr_cdata( get_the_author_meta( 'login' ) ); ?></dc:creator>
401 <guid isPermaLink="false"><?php the_guid(); ?></guid>
402 <description></description>
403 <content:encoded><?php
405 * Filter the post content used for WXR exports.
409 * @param string $post_content Content of the current post.
411 echo wxr_cdata( apply_filters( 'the_content_export', $post->post_content ) );
413 <excerpt:encoded><?php
415 * Filter the post excerpt used for WXR exports.
419 * @param string $post_excerpt Excerpt for the current post.
421 echo wxr_cdata( apply_filters( 'the_excerpt_export', $post->post_excerpt ) );
423 <wp:post_id><?php echo $post->ID; ?></wp:post_id>
424 <wp:post_date><?php echo $post->post_date; ?></wp:post_date>
425 <wp:post_date_gmt><?php echo $post->post_date_gmt; ?></wp:post_date_gmt>
426 <wp:comment_status><?php echo $post->comment_status; ?></wp:comment_status>
427 <wp:ping_status><?php echo $post->ping_status; ?></wp:ping_status>
428 <wp:post_name><?php echo $post->post_name; ?></wp:post_name>
429 <wp:status><?php echo $post->post_status; ?></wp:status>
430 <wp:post_parent><?php echo $post->post_parent; ?></wp:post_parent>
431 <wp:menu_order><?php echo $post->menu_order; ?></wp:menu_order>
432 <wp:post_type><?php echo $post->post_type; ?></wp:post_type>
433 <wp:post_password><?php echo $post->post_password; ?></wp:post_password>
434 <wp:is_sticky><?php echo $is_sticky; ?></wp:is_sticky>
435 <?php if ( $post->post_type == 'attachment' ) : ?>
436 <wp:attachment_url><?php echo wp_get_attachment_url( $post->ID ); ?></wp:attachment_url>
438 <?php wxr_post_taxonomy(); ?>
439 <?php $postmeta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d", $post->ID ) );
440 foreach ( $postmeta as $meta ) :
442 * Filter whether to selectively skip post meta used for WXR exports.
444 * Returning a truthy value to the filter will skip the current meta
445 * object from being exported.
449 * @param bool $skip Whether to skip the current post meta. Default false.
450 * @param string $meta_key Current meta key.
451 * @param object $meta Current meta object.
453 if ( apply_filters( 'wxr_export_skip_postmeta', false, $meta->meta_key, $meta ) )
457 <wp:meta_key><?php echo $meta->meta_key; ?></wp:meta_key>
458 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>
462 $comments = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved <> 'spam'", $post->ID ) );
463 foreach ( $comments as $c ) : ?>
465 <wp:comment_id><?php echo $c->comment_ID; ?></wp:comment_id>
466 <wp:comment_author><?php echo wxr_cdata( $c->comment_author ); ?></wp:comment_author>
467 <wp:comment_author_email><?php echo $c->comment_author_email; ?></wp:comment_author_email>
468 <wp:comment_author_url><?php echo esc_url_raw( $c->comment_author_url ); ?></wp:comment_author_url>
469 <wp:comment_author_IP><?php echo $c->comment_author_IP; ?></wp:comment_author_IP>
470 <wp:comment_date><?php echo $c->comment_date; ?></wp:comment_date>
471 <wp:comment_date_gmt><?php echo $c->comment_date_gmt; ?></wp:comment_date_gmt>
472 <wp:comment_content><?php echo wxr_cdata( $c->comment_content ) ?></wp:comment_content>
473 <wp:comment_approved><?php echo $c->comment_approved; ?></wp:comment_approved>
474 <wp:comment_type><?php echo $c->comment_type; ?></wp:comment_type>
475 <wp:comment_parent><?php echo $c->comment_parent; ?></wp:comment_parent>
476 <wp:comment_user_id><?php echo $c->user_id; ?></wp:comment_user_id>
477 <?php $c_meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id = %d", $c->comment_ID ) );
478 foreach ( $c_meta as $meta ) :
480 * Filter whether to selectively skip comment meta used for WXR exports.
482 * Returning a truthy value to the filter will skip the current meta
483 * object from being exported.
487 * @param bool $skip Whether to skip the current comment meta. Default false.
488 * @param string $meta_key Current meta key.
489 * @param object $meta Current meta object.
491 if ( apply_filters( 'wxr_export_skip_commentmeta', false, $meta->meta_key, $meta ) ) {
496 <wp:meta_key><?php echo $meta->meta_key; ?></wp:meta_key>
497 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>