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