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