wp-admin/includes/export.php

   1 <?php
   2 /**
   3  * WordPress Export Administration API
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /**
  10  * Version number for the export format.
  11  *
  12  * Bump this when something changes that might affect compatibility.
  13  *
  14  * @since 2.5.0
  15  */
  16 define( 'WXR_VERSION', '1.2' );
  17
  18 /**
  19  * Generates the WXR export file for download
  20  *
  21  * @since 2.1.0
  22  *
  23  * @param array $args Filters defining what should be included in the export
  24  */
  25 function export_wp( $args = array() ) {
  26         global $wpdb, $post;
  27
  28         $defaults = array( 'content' => 'all', 'author' => false, 'category' => false,
  29                 'start_date' => false, 'end_date' => false, 'status' => false,
  30         );
  31         $args = wp_parse_args( $args, $defaults );
  32
  33         do_action( 'export_wp' );
  34
  35         $sitename = sanitize_key( get_bloginfo( 'name' ) );
  36         if ( ! empty($sitename) ) $sitename .= '.';
  37         $filename = $sitename . 'wordpress.' . date( 'Y-m-d' ) . '.xml';
  38
  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 );
  42
  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';
  47
  48                 $where = $wpdb->prepare( "{$wpdb->posts}.post_type = %s", $args['content'] );
  49         } else {
  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 );
  53         }
  54
  55         if ( $args['status'] && ( 'post' == $args['content'] || 'page' == $args['content'] ) )
  56                 $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_status = %s", $args['status'] );
  57         else
  58                 $where .= " AND {$wpdb->posts}.post_status != 'auto-draft'";
  59
  60         $join = '';
  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'] );
  65                 }
  66         }
  67
  68         if ( 'post' == $args['content'] || 'page' == $args['content'] ) {
  69                 if ( $args['author'] )
  70                         $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_author = %d", $args['author'] );
  71
  72                 if ( $args['start_date'] )
  73                         $where .= $wpdb->prepare( " AND {$wpdb->posts}.post_date >= %s", date( 'Y-m-d', strtotime($args['start_date']) ) );
  74
  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'])) ) );
  77         }
  78
  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" );
  81
  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 );
  87                 unset( $term, $cat );
  88         } else if ( 'all' == $args['content'] ) {
  89                 $categories = (array) get_categories( array( 'get' => 'all' ) );
  90                 $tags = (array) get_tags( array( 'get' => 'all' ) );
  91
  92                 $custom_taxonomies = get_taxonomies( array( '_builtin' => false ) );
  93                 $custom_terms = (array) get_terms( $custom_taxonomies, array( 'get' => 'all' ) );
  94
  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;
  99                         else
 100                                 $categories[] = $cat;
 101                 }
 102
 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;
 107                         else
 108                                 $custom_terms[] = $t;
 109                 }
 110
 111                 unset( $categories, $custom_taxonomies, $custom_terms );
 112         }
 113
 114         /**
 115          * Wrap given string in XML CDATA tag.
 116          *
 117          * @since 2.1.0
 118          *
 119          * @param string $str String to wrap in XML CDATA tag.
 120          * @return string
 121          */
 122         function wxr_cdata( $str ) {
 123                 if ( seems_utf8( $str ) == false )
 124                         $str = utf8_encode( $str );
 125
 126                 // $str = ent2ncr(esc_html($str));
 127                 $str = '<![CDATA[' . str_replace( ']]>', ']]]]><![CDATA[>', $str ) . ']]>';
 128
 129                 return $str;
 130         }
 131
 132         /**
 133          * Return the URL of the site
 134          *
 135          * @since 2.5.0
 136          *
 137          * @return string Site URL.
 138          */
 139         function wxr_site_url() {
 140                 // ms: the base url
 141                 if ( is_multisite() )
 142                         return network_home_url();
 143                 // wp: the blog url
 144                 else
 145                         return get_bloginfo_rss( 'url' );
 146         }
 147
 148         /**
 149          * Output a cat_name XML tag from a given category object
 150          *
 151          * @since 2.1.0
 152          *
 153          * @param object $category Category Object
 154          */
 155         function wxr_cat_name( $category ) {
 156                 if ( empty( $category->name ) )
 157                         return;
 158
 159                 echo '<wp:cat_name>' . wxr_cdata( $category->name ) . '</wp:cat_name>';
 160         }
 161
 162         /**
 163          * Output a category_description XML tag from a given category object
 164          *
 165          * @since 2.1.0
 166          *
 167          * @param object $category Category Object
 168          */
 169         function wxr_category_description( $category ) {
 170                 if ( empty( $category->description ) )
 171                         return;
 172
 173                 echo '<wp:category_description>' . wxr_cdata( $category->description ) . '</wp:category_description>';
 174         }
 175
 176         /**
 177          * Output a tag_name XML tag from a given tag object
 178          *
 179          * @since 2.3.0
 180          *
 181          * @param object $tag Tag Object
 182          */
 183         function wxr_tag_name( $tag ) {
 184                 if ( empty( $tag->name ) )
 185                         return;
 186
 187                 echo '<wp:tag_name>' . wxr_cdata( $tag->name ) . '</wp:tag_name>';
 188         }
 189
 190         /**
 191          * Output a tag_description XML tag from a given tag object
 192          *
 193          * @since 2.3.0
 194          *
 195          * @param object $tag Tag Object
 196          */
 197         function wxr_tag_description( $tag ) {
 198                 if ( empty( $tag->description ) )
 199                         return;
 200
 201                 echo '<wp:tag_description>' . wxr_cdata( $tag->description ) . '</wp:tag_description>';
 202         }
 203
 204         /**
 205          * Output a term_name XML tag from a given term object
 206          *
 207          * @since 2.9.0
 208          *
 209          * @param object $term Term Object
 210          */
 211         function wxr_term_name( $term ) {
 212                 if ( empty( $term->name ) )
 213                         return;
 214
 215                 echo '<wp:term_name>' . wxr_cdata( $term->name ) . '</wp:term_name>';
 216         }
 217
 218         /**
 219          * Output a term_description XML tag from a given term object
 220          *
 221          * @since 2.9.0
 222          *
 223          * @param object $term Term Object
 224          */
 225         function wxr_term_description( $term ) {
 226                 if ( empty( $term->description ) )
 227                         return;
 228
 229                 echo '<wp:term_description>' . wxr_cdata( $term->description ) . '</wp:term_description>';
 230         }
 231
 232         /**
 233          * Output list of authors with posts
 234          *
 235          * @since 3.1.0
 236          */
 237         function wxr_authors_list() {
 238                 global $wpdb;
 239
 240                 $authors = array();
 241                 $results = $wpdb->get_results( "SELECT DISTINCT post_author FROM $wpdb->posts WHERE post_status != 'auto-draft'" );
 242                 foreach ( (array) $results as $result )
 243                         $authors[] = get_userdata( $result->post_author );
 244
 245                 $authors = array_filter( $authors );
 246
 247                 foreach ( $authors as $author ) {
 248                         echo "\t<wp:author>";
 249                         echo '<wp:author_id>' . $author->ID . '</wp:author_id>';
 250                         echo '<wp:author_login>' . $author->user_login . '</wp:author_login>';
 251                         echo '<wp:author_email>' . $author->user_email . '</wp:author_email>';
 252                         echo '<wp:author_display_name>' . wxr_cdata( $author->display_name ) . '</wp:author_display_name>';
 253                         echo '<wp:author_first_name>' . wxr_cdata( $author->user_firstname ) . '</wp:author_first_name>';
 254                         echo '<wp:author_last_name>' . wxr_cdata( $author->user_lastname ) . '</wp:author_last_name>';
 255                         echo "</wp:author>\n";
 256                 }
 257         }
 258
 259         /**
 260          * Ouput all navigation menu terms
 261          *
 262          * @since 3.1.0
 263          */
 264         function wxr_nav_menu_terms() {
 265                 $nav_menus = wp_get_nav_menus();
 266                 if ( empty( $nav_menus ) || ! is_array( $nav_menus ) )
 267                         return;
 268
 269                 foreach ( $nav_menus as $menu ) {
 270                         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>";
 271                         wxr_term_name( $menu );
 272                         echo "</wp:term>\n";
 273                 }
 274         }
 275
 276         /**
 277          * Output list of taxonomy terms, in XML tag format, associated with a post
 278          *
 279          * @since 2.3.0
 280          */
 281         function wxr_post_taxonomy() {
 282                 $post = get_post();
 283
 284                 $taxonomies = get_object_taxonomies( $post->post_type );
 285                 if ( empty( $taxonomies ) )
 286                         return;
 287                 $terms = wp_get_object_terms( $post->ID, $taxonomies );
 288
 289                 foreach ( (array) $terms as $term ) {
 290                         echo "\t\t<category domain=\"{$term->taxonomy}\" nicename=\"{$term->slug}\">" . wxr_cdata( $term->name ) . "</category>\n";
 291                 }
 292         }
 293
 294         function wxr_filter_postmeta( $return_me, $meta_key ) {
 295                 if ( '_edit_lock' == $meta_key )
 296                         $return_me = true;
 297                 return $return_me;
 298         }
 299         add_filter( 'wxr_export_skip_postmeta', 'wxr_filter_postmeta', 10, 2 );
 300
 301         echo '<?xml version="1.0" encoding="' . get_bloginfo('charset') . "\" ?>\n";
 302
 303         ?>
 304 <!-- This is a WordPress eXtended RSS file generated by WordPress as an export of your site. -->
 305 <!-- It contains information about your site's posts, pages, comments, categories, and other content. -->
 306 <!-- You may use this file to transfer that content from one site to another. -->
 307 <!-- This file is not intended to serve as a complete backup of your site. -->
 308
 309 <!-- To import this information into a WordPress site follow these steps: -->
 310 <!-- 1. Log in to that site as an administrator. -->
 311 <!-- 2. Go to Tools: Import in the WordPress admin panel. -->
 312 <!-- 3. Install the "WordPress" importer from the list. -->
 313 <!-- 4. Activate & Run Importer. -->
 314 <!-- 5. Upload this file using the form provided on that page. -->
 315 <!-- 6. You will first be asked to map the authors in this export file to users -->
 316 <!--    on the site. For each author, you may choose to map to an -->
 317 <!--    existing user on the site or to create a new user. -->
 318 <!-- 7. WordPress will then import each of the posts, pages, comments, categories, etc. -->
 319 <!--    contained in this file into your site. -->
 320
 321 <?php the_generator( 'export' ); ?>
 322 <rss version="2.0"
 323         xmlns:excerpt="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/excerpt/"
 324         xmlns:content="http://purl.org/rss/1.0/modules/content/"
 325         xmlns:wfw="http://wellformedweb.org/CommentAPI/"
 326         xmlns:dc="http://purl.org/dc/elements/1.1/"
 327         xmlns:wp="http://wordpress.org/export/<?php echo WXR_VERSION; ?>/"
 328 >
 329
 330 <channel>
 331         <title><?php bloginfo_rss( 'name' ); ?></title>
 332         <link><?php bloginfo_rss( 'url' ); ?></link>
 333         <description><?php bloginfo_rss( 'description' ); ?></description>
 334         <pubDate><?php echo date( 'D, d M Y H:i:s +0000' ); ?></pubDate>
 335         <language><?php bloginfo_rss( 'language' ); ?></language>
 336         <wp:wxr_version><?php echo WXR_VERSION; ?></wp:wxr_version>
 337         <wp:base_site_url><?php echo wxr_site_url(); ?></wp:base_site_url>
 338         <wp:base_blog_url><?php bloginfo_rss( 'url' ); ?></wp:base_blog_url>
 339
 340 <?php wxr_authors_list(); ?>
 341
 342 <?php foreach ( $cats as $c ) : ?>
 343         <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>
 344 <?php endforeach; ?>
 345 <?php foreach ( $tags as $t ) : ?>
 346         <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>
 347 <?php endforeach; ?>
 348 <?php foreach ( $terms as $t ) : ?>
 349         <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>
 350 <?php endforeach; ?>
 351 <?php if ( 'all' == $args['content'] ) wxr_nav_menu_terms(); ?>
 352
 353         <?php do_action( 'rss2_head' ); ?>
 354
 355 <?php if ( $post_ids ) {
 356         global $wp_query;
 357         $wp_query->in_the_loop = true; // Fake being in the loop.
 358
 359         // fetch 20 posts at a time rather than loading the entire table into memory
 360         while ( $next_posts = array_splice( $post_ids, 0, 20 ) ) {
 361         $where = 'WHERE ID IN (' . join( ',', $next_posts ) . ')';
 362         $posts = $wpdb->get_results( "SELECT * FROM {$wpdb->posts} $where" );
 363
 364         // Begin Loop
 365         foreach ( $posts as $post ) {
 366                 setup_postdata( $post );
 367                 $is_sticky = is_sticky( $post->ID ) ? 1 : 0;
 368 ?>
 369         <item>
 370                 <title><?php echo apply_filters( 'the_title_rss', $post->post_title ); ?></title>
 371                 <link><?php the_permalink_rss() ?></link>
 372                 <pubDate><?php echo mysql2date( 'D, d M Y H:i:s +0000', get_post_time( 'Y-m-d H:i:s', true ), false ); ?></pubDate>
 373                 <dc:creator><?php echo get_the_author_meta( 'login' ); ?></dc:creator>
 374                 <guid isPermaLink="false"><?php esc_url( the_guid() ); ?></guid>
 375                 <description></description>
 376                 <content:encoded><?php echo wxr_cdata( apply_filters( 'the_content_export', $post->post_content ) ); ?></content:encoded>
 377                 <excerpt:encoded><?php echo wxr_cdata( apply_filters( 'the_excerpt_export', $post->post_excerpt ) ); ?></excerpt:encoded>
 378                 <wp:post_id><?php echo $post->ID; ?></wp:post_id>
 379                 <wp:post_date><?php echo $post->post_date; ?></wp:post_date>
 380                 <wp:post_date_gmt><?php echo $post->post_date_gmt; ?></wp:post_date_gmt>
 381                 <wp:comment_status><?php echo $post->comment_status; ?></wp:comment_status>
 382                 <wp:ping_status><?php echo $post->ping_status; ?></wp:ping_status>
 383                 <wp:post_name><?php echo $post->post_name; ?></wp:post_name>
 384                 <wp:status><?php echo $post->post_status; ?></wp:status>
 385                 <wp:post_parent><?php echo $post->post_parent; ?></wp:post_parent>
 386                 <wp:menu_order><?php echo $post->menu_order; ?></wp:menu_order>
 387                 <wp:post_type><?php echo $post->post_type; ?></wp:post_type>
 388                 <wp:post_password><?php echo $post->post_password; ?></wp:post_password>
 389                 <wp:is_sticky><?php echo $is_sticky; ?></wp:is_sticky>
 390 <?php   if ( $post->post_type == 'attachment' ) : ?>
 391                 <wp:attachment_url><?php echo wp_get_attachment_url( $post->ID ); ?></wp:attachment_url>
 392 <?php   endif; ?>
 393 <?php   wxr_post_taxonomy(); ?>
 394 <?php   $postmeta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->postmeta WHERE post_id = %d", $post->ID ) );
 395                 foreach ( $postmeta as $meta ) :
 396                         if ( apply_filters( 'wxr_export_skip_postmeta', false, $meta->meta_key, $meta ) )
 397                                 continue;
 398                 ?>
 399                 <wp:postmeta>
 400                         <wp:meta_key><?php echo $meta->meta_key; ?></wp:meta_key>
 401                         <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>
 402                 </wp:postmeta>
 403 <?php   endforeach; ?>
 404 <?php   $comments = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved <> 'spam'", $post->ID ) );
 405                 foreach ( $comments as $c ) : ?>
 406                 <wp:comment>
 407                         <wp:comment_id><?php echo $c->comment_ID; ?></wp:comment_id>
 408                         <wp:comment_author><?php echo wxr_cdata( $c->comment_author ); ?></wp:comment_author>
 409                         <wp:comment_author_email><?php echo $c->comment_author_email; ?></wp:comment_author_email>
 410                         <wp:comment_author_url><?php echo esc_url_raw( $c->comment_author_url ); ?></wp:comment_author_url>
 411                         <wp:comment_author_IP><?php echo $c->comment_author_IP; ?></wp:comment_author_IP>
 412                         <wp:comment_date><?php echo $c->comment_date; ?></wp:comment_date>
 413                         <wp:comment_date_gmt><?php echo $c->comment_date_gmt; ?></wp:comment_date_gmt>
 414                         <wp:comment_content><?php echo wxr_cdata( $c->comment_content ) ?></wp:comment_content>
 415                         <wp:comment_approved><?php echo $c->comment_approved; ?></wp:comment_approved>
 416                         <wp:comment_type><?php echo $c->comment_type; ?></wp:comment_type>
 417                         <wp:comment_parent><?php echo $c->comment_parent; ?></wp:comment_parent>
 418                         <wp:comment_user_id><?php echo $c->user_id; ?></wp:comment_user_id>
 419 <?php           $c_meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->commentmeta WHERE comment_id = %d", $c->comment_ID ) );
 420                         foreach ( $c_meta as $meta ) : ?>
 421                         <wp:commentmeta>
 422                                 <wp:meta_key><?php echo $meta->meta_key; ?></wp:meta_key>
 423                                 <wp:meta_value><?php echo wxr_cdata( $meta->meta_value ); ?></wp:meta_value>
 424                         </wp:commentmeta>
 425 <?php           endforeach; ?>
 426                 </wp:comment>
 427 <?php   endforeach; ?>
 428         </item>
 429 <?php
 430         }
 431         }
 432 } ?>
 433 </channel>
 434 </rss>
 435 <?php
 436 }