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.1' );
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 );
33 do_action( 'export_wp' );
35 $sitename = sanitize_key( get_bloginfo( 'name' ) );
36 if ( ! empty($sitename) ) $sitename .= '.';
37 $filename = $sitename . 'wordpress.' . date( 'Y-m-d' ) . '.xml';
39 header( 'Content-Description: File Transfer' );
40 header( 'Content-Disposition: attachment; filename=' . $filename );
41 header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ), true );
43 if ( 'all' != $args['content'] && post_type_exists( $args['content'] ) ) {
44 $ptype = get_post_type_object( $args['content'] );
45 if ( ! $ptype->can_export )
46 $args['content'] = 'post';
48 $where = $wpdb->prepare( "{$wpdb->posts}.post_type = %s", $args['content'] );
50 $post_types = get_post_types( array( 'can_export' => true ) );
51 $esses = array_fill( 0, count($post_types), '%s' );
52 $where = $wpdb->prepare( "{$wpdb->posts}.post_type IN (" . implode( ',', $esses ) . ')', $post_types );
55 if ( $args['status'] && ( 'post' == $args['content'] || 'page' == $args['content'] ) )
56 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_status = %s", $args['status'] );
58 $where .= " AND {$wpdb->posts}.post_status != 'auto-draft'";
61 if ( $args['category'] && 'post' == $args['content'] ) {
62 if ( $term = term_exists( $args['category'], 'category' ) ) {
63 $join = "INNER JOIN {$wpdb->term_relationships} ON ({$wpdb->posts}.ID = {$wpdb->term_relationships}.object_id)";
64 $where .= $wpdb->prepare( " AND {$wpdb->term_relationships}.term_taxonomy_id = %d", $term['term_taxonomy_id'] );
68 if ( 'post' == $args['content'] || 'page' == $args['content'] ) {
69 if ( $args['author'] )
70 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_author = %d", $args['author'] );
72 if ( $args['start_date'] )
73 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date >= %s", date( 'Y-m-d', strtotime($args['start_date']) ) );
75 if ( $args['end_date'] )
76 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date < %s", date( 'Y-m-d', strtotime('+1 month', strtotime($args['end_date'])) ) );
79 // grab a snapshot of post IDs, just in case it changes during the export
80 $post_ids = $wpdb->get_col( "SELECT ID FROM {$wpdb->posts} $join WHERE $where" );
82 // get the requested terms ready, empty unless posts filtered by category or all content
83 $cats = $tags = $terms = array();
84 if ( isset( $term ) && $term ) {
85 $cat = get_term( $term['term_id'], 'category' );
86 $cats = array( $cat->term_id => $cat );
88 } else if ( 'all' == $args['content'] ) {
89 $categories = (array) get_categories( array( 'get' => 'all' ) );
90 $tags = (array) get_tags( array( 'get' => 'all' ) );
92 $custom_taxonomies = get_taxonomies( array( '_builtin' => false ) );
93 $custom_terms = (array) get_terms( $custom_taxonomies, array( 'get' => 'all' ) );
95 // put categories in order with no child going before its parent
96 while ( $cat = array_shift( $categories ) ) {
97 if ( $cat->parent == 0 || isset( $cats[$cat->parent] ) )
98 $cats[$cat->term_id] = $cat;
100 $categories[] = $cat;
103 // put terms in order with no child going before its parent
104 while ( $t = array_shift( $custom_terms ) ) {
105 if ( $t->parent == 0 || isset( $terms[$t->parent] ) )
106 $terms[$t->term_id] = $t;
108 $custom_terms[] = $t;
111 unset( $categories, $custom_taxonomies, $custom_terms );
115 * Wrap given string in XML CDATA tag.
119 * @param string $str String to wrap in XML CDATA tag.
121 function wxr_cdata( $str ) {
122 if ( seems_utf8( $str ) == false )
123 $str = utf8_encode( $str );
125 // $str = ent2ncr(esc_html($str));
126 $str = "<![CDATA[$str" . ( ( substr( $str, -1 ) == ']' ) ? ' ' : '' ) . ']]>';
132 * Return the URL of the site
136 * @return string Site URL.
138 function wxr_site_url() {
140 if ( is_multisite() )
141 return network_home_url();
144 return get_bloginfo_rss( 'url' );
148 * Output a cat_name XML tag from a given category object
152 * @param object $category Category Object
154 function wxr_cat_name( $category ) {
155 if ( empty( $category->name ) )
158 echo '<wp:cat_name>' . wxr_cdata( $category->name ) . '</wp:cat_name>';
162 * Output a category_description XML tag from a given category object
166 * @param object $category Category Object
168 function wxr_category_description( $category ) {
169 if ( empty( $category->description ) )
172 echo '<wp:category_description>' . wxr_cdata( $category->description ) . '</wp:category_description>';
176 * Output a tag_name XML tag from a given tag object
180 * @param object $tag Tag Object
182 function wxr_tag_name( $tag ) {
183 if ( empty( $tag->name ) )
186 echo '<wp:tag_name>' . wxr_cdata( $tag->name ) . '</wp:tag_name>';
190 * Output a tag_description XML tag from a given tag object
194 * @param object $tag Tag Object
196 function wxr_tag_description( $tag ) {
197 if ( empty( $tag->description ) )
200 echo '<wp:tag_description>' . wxr_cdata( $tag->description ) . '</wp:tag_description>';
204 * Output a term_name XML tag from a given term object
208 * @param object $term Term Object
210 function wxr_term_name( $term ) {
211 if ( empty( $term->name ) )
214 echo '<wp:term_name>' . wxr_cdata( $term->name ) . '</wp:term_name>';
218 * Output a term_description XML tag from a given term object
222 * @param object $term Term Object
224 function wxr_term_description( $term ) {
225 if ( empty( $term->description ) )
228 echo '<wp:term_description>' . wxr_cdata( $term->description ) . '</wp:term_description>';
232 * Output list of authors with posts
236 function wxr_authors_list() {
240 $results = $wpdb->get_results( "SELECT DISTINCT post_author FROM $wpdb->posts" );
241 foreach ( (array) $results as $result )
242 $authors[] = get_userdata( $result->post_author );
244 $authors = array_filter( $authors );
246 foreach( $authors as $author ) {
247 echo "\t<wp:author>";
248 echo '<wp:author_id>' . $author->ID . '</wp:author_id>';
249 echo '<wp:author_login>' . $author->user_login . '</wp:author_login>';
250 echo '<wp:author_email>' . $author->user_email . '</wp:author_email>';
251 echo '<wp:author_display_name>' . wxr_cdata( $author->display_name ) . '</wp:author_display_name>';
252 echo '<wp:author_first_name>' . wxr_cdata( $author->user_firstname ) . '</wp:author_first_name>';
253 echo '<wp:author_last_name>' . wxr_cdata( $author->user_lastname ) . '</wp:author_last_name>';
254 echo "</wp:author>\n";
259 * Ouput all navigation menu terms
263 function wxr_nav_menu_terms() {
264 $nav_menus = wp_get_nav_menus();
265 if ( empty( $nav_menus ) || ! is_array( $nav_menus ) )
268 foreach ( $nav_menus as $menu ) {
269 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>";
270 wxr_term_name( $menu );
276 * Output list of taxonomy terms, in XML tag format, associated with a post
280 function wxr_post_taxonomy() {
283 $taxonomies = get_object_taxonomies( $post->post_type );
284 if ( empty( $taxonomies ) )
286 $terms = wp_get_object_terms( $post->ID, $taxonomies );
288 foreach ( (array) $terms as $term ) {
289 echo "\t\t<category domain=\"{$term->taxonomy}\" nicename=\"{$term->slug}\">" . wxr_cdata( $term->name ) . "</category>\n";
293 echo '<?xml version="1.0" encoding="' . get_bloginfo('charset') . "\" ?>\n";
296 <!-- This is a WordPress eXtended RSS file generated by WordPress as an export of your site. -->
297 <!-- It contains information about your site's posts, pages, comments, categories, and other content. -->
298 <!-- You may use this file to transfer that content from one site to another. -->
299 <!-- This file is not intended to serve as a complete backup of your site. -->
301 <!-- To import this information into a WordPress site follow these steps: -->
302 <!-- 1. Log in to that site as an administrator. -->
303 <!-- 2. Go to Tools: Import in the WordPress admin panel. -->
304 <!-- 3. Install the "WordPress" importer from the list. -->
305 <!-- 4. Activate & Run Importer. -->
306 <!-- 5. Upload this file using the form provided on that page. -->
307 <!-- 6. You will first be asked to map the authors in this export file to users -->
308 <!-- on the site. For each author, you may choose to map to an -->
309 <!-- existing user on the site or to create a new user. -->
310 <!-- 7. WordPress will then import each of the posts, pages, comments, categories, etc. -->
311 <!-- contained in this file into your site. -->
313 <?php the_generator( 'export' ); ?>
315 xmlns:excerpt="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/excerpt/"
316 xmlns:content="http://purl.org/rss/1.0/modules/content/"
317 xmlns:wfw="http://wellformedweb.org/CommentAPI/"
318 xmlns:dc="http://purl.org/dc/elements/1.1/"
319 xmlns:wp="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/"
323 <title><?php bloginfo_rss( 'name' ); ?></title>
324 <link><?php bloginfo_rss( 'url' ); ?></link>
325 <description><?php bloginfo_rss( 'description' ); ?></description>
326 <pubDate><?php echo date( 'D, d M Y H:i:s +0000' ); ?></pubDate>
327 <language><?php echo get_option( 'rss_language' ); ?></language>
328 <wp:wxr_version><?php echo WXR_VERSION; ?></wp:wxr_version>
329 <wp:base_site_url><?php echo wxr_site_url(); ?></wp:base_site_url>
330 <wp:base_blog_url><?php bloginfo_rss( 'url' ); ?></wp:base_blog_url>
332 <?php wxr_authors_list(); ?>
334 <?php foreach ( $cats as $c ) : ?>
335 <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>
337 <?php foreach ( $tags as $t ) : ?>
338 <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>
340 <?php foreach ( $terms as $t ) : ?>
341 <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>
343 <?php if ( 'all' == $args['content'] ) wxr_nav_menu_terms(); ?>
345 <?php do_action( 'rss2_head' ); ?>
347 <?php if ( $post_ids ) {
349 $wp_query->in_the_loop = true; // Fake being in the loop.
351 // fetch 20 posts at a time rather than loading the entire table into memory
352 while ( $next_posts = array_splice( $post_ids, 0, 20 ) ) {
353 $where = 'WHERE ID IN (' . join( ',', $next_posts ) . ')';
354 $posts = $wpdb->get_results( "SELECT * FROM {$wpdb->posts} $where" );
357 foreach ( $posts as $post ) {
358 setup_postdata( $post );
359 $is_sticky = is_sticky( $post->ID ) ? 1 : 0;
362 <title><?php echo apply_filters( 'the_title_rss', $post->post_title ); ?></title>
363 <link><?php the_permalink_rss() ?></link>
364 <pubDate><?php echo mysql2date( 'D, d M Y H:i:s +0000', get_post_time( 'Y-m-d H:i:s', true ), false ); ?></pubDate>
365 <dc:creator><?php echo get_the_author_meta( 'login' ); ?></dc:creator>
366 <guid isPermaLink="false"><?php esc_url( the_guid() ); ?></guid>
367 <description></description>
368 <content:encoded><?php echo wxr_cdata( apply_filters( 'the_content_export', $post->post_content ) ); ?></content:encoded>
369 <excerpt:encoded><?php echo wxr_cdata( apply_filters( 'the_excerpt_export', $post->post_excerpt ) ); ?></excerpt:encoded>
370 <wp:post_id><?php echo $post->ID; ?></wp:post_id>
371 <wp:post_date><?php echo $post->post_date; ?></wp:post_date>
372 <wp:post_date_gmt><?php echo $post->post_date_gmt; ?></wp:post_date_gmt>
373 <wp:comment_status><?php echo $post->comment_status; ?></wp:comment_status>
374 <wp:ping_status><?php echo $post->ping_status; ?></wp:ping_status>
375 <wp:post_name><?php echo $post->post_name; ?></wp:post_name>
376 <wp:status><?php echo $post->post_status; ?></wp:status>
377 <wp:post_parent><?php echo $post->post_parent; ?></wp:post_parent>
378 <wp:menu_order><?php echo $post->menu_order; ?></wp:menu_order>
379 <wp:post_type><?php echo $post->post_type; ?></wp:post_type>
380 <wp:post_password><?php echo $post->post_password; ?></wp:post_password>
381 <wp:is_sticky><?php echo $is_sticky; ?></wp:is_sticky>
382 <?php if ( $post->post_type == 'attachment' ) : ?>
383 <wp:attachment_url><?php echo wp_get_attachment_url( $post->ID ); ?></wp:attachment_url>
385 <?php wxr_post_taxonomy(); ?>
386 <?php $postmeta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d", $post->ID ) );
387 foreach( $postmeta as $meta ) : if ( $meta->meta_key != '_edit_lock' ) : ?>
389 <wp:meta_key><?php echo $meta->meta_key; ?></wp:meta_key>
390 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>
392 <?php endif; endforeach; ?>
393 <?php $comments = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved <> 'spam'", $post->ID ) );
394 foreach ( $comments as $c ) : ?>
396 <wp:comment_id><?php echo $c->comment_ID; ?></wp:comment_id>
397 <wp:comment_author><?php echo wxr_cdata( $c->comment_author ); ?></wp:comment_author>
398 <wp:comment_author_email><?php echo $c->comment_author_email; ?></wp:comment_author_email>
399 <wp:comment_author_url><?php echo esc_url_raw( $c->comment_author_url ); ?></wp:comment_author_url>
400 <wp:comment_author_IP><?php echo $c->comment_author_IP; ?></wp:comment_author_IP>
401 <wp:comment_date><?php echo $c->comment_date; ?></wp:comment_date>
402 <wp:comment_date_gmt><?php echo $c->comment_date_gmt; ?></wp:comment_date_gmt>
403 <wp:comment_content><?php echo wxr_cdata( $c->comment_content ) ?></wp:comment_content>
404 <wp:comment_approved><?php echo $c->comment_approved; ?></wp:comment_approved>
405 <wp:comment_type><?php echo $c->comment_type; ?></wp:comment_type>
406 <wp:comment_parent><?php echo $c->comment_parent; ?></wp:comment_parent>
407 <wp:comment_user_id><?php echo $c->user_id; ?></wp:comment_user_id>
408 <?php $c_meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id = %d", $c->comment_ID ) );
409 foreach ( $c_meta as $meta ) : ?>
411 <wp:meta_key><?php echo $meta->meta_key; ?></wp:meta_key>
412 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>