Wordpress 3.5
[autoinstalls/wordpress.git] / wp-includes / post.php
1 <?php
2 /**
3  * Post functions and post utility function.
4  *
5  * @package WordPress
6  * @subpackage Post
7  * @since 1.5.0
8  */
9
10 //
11 // Post Type Registration
12 //
13
14 /**
15  * Creates the initial post types when 'init' action is fired.
16  *
17  * @since 2.9.0
18  */
19 function create_initial_post_types() {
20         register_post_type( 'post', array(
21                 'labels' => array(
22                         'name_admin_bar' => _x( 'Post', 'add new on admin bar' ),
23                 ),
24                 'public'  => true,
25                 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
26                 '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
27                 'capability_type' => 'post',
28                 'map_meta_cap' => true,
29                 'hierarchical' => false,
30                 'rewrite' => false,
31                 'query_var' => false,
32                 'delete_with_user' => true,
33                 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ),
34         ) );
35
36         register_post_type( 'page', array(
37                 'labels' => array(
38                         'name_admin_bar' => _x( 'Page', 'add new on admin bar' ),
39                 ),
40                 'public' => true,
41                 'publicly_queryable' => false,
42                 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
43                 '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
44                 'capability_type' => 'page',
45                 'map_meta_cap' => true,
46                 'hierarchical' => true,
47                 'rewrite' => false,
48                 'query_var' => false,
49                 'delete_with_user' => true,
50                 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ),
51         ) );
52
53         register_post_type( 'attachment', array(
54                 'labels' => array(
55                         'name' => _x('Media', 'post type general name'),
56                         'name_admin_bar' => _x( 'Media', 'add new from admin bar' ),
57                         'add_new' => _x( 'Add New', 'add new media' ),
58                         'edit_item' => __( 'Edit Media' ),
59                         'view_item' => __( 'View Attachment Page' ),
60                 ),
61                 'public' => true,
62                 'show_ui' => true,
63                 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
64                 '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
65                 'capability_type' => 'post',
66                 'capabilities' => array(
67                         'create_posts' => 'upload_files',
68                 ),
69                 'map_meta_cap' => true,
70                 'hierarchical' => false,
71                 'rewrite' => false,
72                 'query_var' => false,
73                 'show_in_nav_menus' => false,
74                 'delete_with_user' => true,
75                 'supports' => array( 'title', 'author', 'comments' ),
76         ) );
77
78         register_post_type( 'revision', array(
79                 'labels' => array(
80                         'name' => __( 'Revisions' ),
81                         'singular_name' => __( 'Revision' ),
82                 ),
83                 'public' => false,
84                 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
85                 '_edit_link' => 'revision.php?revision=%d', /* internal use only. don't use this when registering your own post type. */
86                 'capability_type' => 'post',
87                 'map_meta_cap' => true,
88                 'hierarchical' => false,
89                 'rewrite' => false,
90                 'query_var' => false,
91                 'can_export' => false,
92                 'delete_with_user' => true,
93                 'supports' => array( 'author' ),
94         ) );
95
96         register_post_type( 'nav_menu_item', array(
97                 'labels' => array(
98                         'name' => __( 'Navigation Menu Items' ),
99                         'singular_name' => __( 'Navigation Menu Item' ),
100                 ),
101                 'public' => false,
102                 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
103                 'hierarchical' => false,
104                 'rewrite' => false,
105                 'delete_with_user' => false,
106                 'query_var' => false,
107         ) );
108
109         register_post_status( 'publish', array(
110                 'label'       => _x( 'Published', 'post' ),
111                 'public'      => true,
112                 '_builtin'    => true, /* internal use only. */
113                 'label_count' => _n_noop( 'Published <span class="count">(%s)</span>', 'Published <span class="count">(%s)</span>' ),
114         ) );
115
116         register_post_status( 'future', array(
117                 'label'       => _x( 'Scheduled', 'post' ),
118                 'protected'   => true,
119                 '_builtin'    => true, /* internal use only. */
120                 'label_count' => _n_noop('Scheduled <span class="count">(%s)</span>', 'Scheduled <span class="count">(%s)</span>' ),
121         ) );
122
123         register_post_status( 'draft', array(
124                 'label'       => _x( 'Draft', 'post' ),
125                 'protected'   => true,
126                 '_builtin'    => true, /* internal use only. */
127                 'label_count' => _n_noop( 'Draft <span class="count">(%s)</span>', 'Drafts <span class="count">(%s)</span>' ),
128         ) );
129
130         register_post_status( 'pending', array(
131                 'label'       => _x( 'Pending', 'post' ),
132                 'protected'   => true,
133                 '_builtin'    => true, /* internal use only. */
134                 'label_count' => _n_noop( 'Pending <span class="count">(%s)</span>', 'Pending <span class="count">(%s)</span>' ),
135         ) );
136
137         register_post_status( 'private', array(
138                 'label'       => _x( 'Private', 'post' ),
139                 'private'     => true,
140                 '_builtin'    => true, /* internal use only. */
141                 'label_count' => _n_noop( 'Private <span class="count">(%s)</span>', 'Private <span class="count">(%s)</span>' ),
142         ) );
143
144         register_post_status( 'trash', array(
145                 'label'       => _x( 'Trash', 'post' ),
146                 'internal'    => true,
147                 '_builtin'    => true, /* internal use only. */
148                 'label_count' => _n_noop( 'Trash <span class="count">(%s)</span>', 'Trash <span class="count">(%s)</span>' ),
149                 'show_in_admin_status_list' => true,
150         ) );
151
152         register_post_status( 'auto-draft', array(
153                 'label'    => 'auto-draft',
154                 'internal' => true,
155                 '_builtin' => true, /* internal use only. */
156         ) );
157
158         register_post_status( 'inherit', array(
159                 'label'    => 'inherit',
160                 'internal' => true,
161                 '_builtin' => true, /* internal use only. */
162                 'exclude_from_search' => false,
163         ) );
164 }
165 add_action( 'init', 'create_initial_post_types', 0 ); // highest priority
166
167 /**
168  * Retrieve attached file path based on attachment ID.
169  *
170  * You can optionally send it through the 'get_attached_file' filter, but by
171  * default it will just return the file path unfiltered.
172  *
173  * The function works by getting the single post meta name, named
174  * '_wp_attached_file' and returning it. This is a convenience function to
175  * prevent looking up the meta name and provide a mechanism for sending the
176  * attached filename through a filter.
177  *
178  * @since 2.0.0
179  * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID.
180  *
181  * @param int $attachment_id Attachment ID.
182  * @param bool $unfiltered Whether to apply filters.
183  * @return string|bool The file path to the attached file, or false if the attachment does not exist.
184  */
185 function get_attached_file( $attachment_id, $unfiltered = false ) {
186         $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
187         // If the file is relative, prepend upload dir
188         if ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) )
189                 $file = $uploads['basedir'] . "/$file";
190         if ( $unfiltered )
191                 return $file;
192         return apply_filters( 'get_attached_file', $file, $attachment_id );
193 }
194
195 /**
196  * Update attachment file path based on attachment ID.
197  *
198  * Used to update the file path of the attachment, which uses post meta name
199  * '_wp_attached_file' to store the path of the attachment.
200  *
201  * @since 2.1.0
202  * @uses apply_filters() Calls 'update_attached_file' on file path and attachment ID.
203  *
204  * @param int $attachment_id Attachment ID
205  * @param string $file File path for the attachment
206  * @return bool False on failure, true on success.
207  */
208 function update_attached_file( $attachment_id, $file ) {
209         if ( !get_post( $attachment_id ) )
210                 return false;
211
212         $file = apply_filters( 'update_attached_file', $file, $attachment_id );
213         if ( $file = _wp_relative_upload_path( $file ) )
214                 return update_post_meta( $attachment_id, '_wp_attached_file', $file );
215         else
216                 return delete_post_meta( $attachment_id, '_wp_attached_file' );
217 }
218
219 /**
220  * Return relative path to an uploaded file.
221  *
222  * The path is relative to the current upload dir.
223  *
224  * @since 2.9.0
225  * @uses apply_filters() Calls '_wp_relative_upload_path' on file path.
226  *
227  * @param string $path Full path to the file
228  * @return string relative path on success, unchanged path on failure.
229  */
230 function _wp_relative_upload_path( $path ) {
231         $new_path = $path;
232
233         $uploads = wp_upload_dir();
234         if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) {
235                         $new_path = str_replace( $uploads['basedir'], '', $new_path );
236                         $new_path = ltrim( $new_path, '/' );
237         }
238
239         return apply_filters( '_wp_relative_upload_path', $new_path, $path );
240 }
241
242 /**
243  * Retrieve all children of the post parent ID.
244  *
245  * Normally, without any enhancements, the children would apply to pages. In the
246  * context of the inner workings of WordPress, pages, posts, and attachments
247  * share the same table, so therefore the functionality could apply to any one
248  * of them. It is then noted that while this function does not work on posts, it
249  * does not mean that it won't work on posts. It is recommended that you know
250  * what context you wish to retrieve the children of.
251  *
252  * Attachments may also be made the child of a post, so if that is an accurate
253  * statement (which needs to be verified), it would then be possible to get
254  * all of the attachments for a post. Attachments have since changed since
255  * version 2.5, so this is most likely unaccurate, but serves generally as an
256  * example of what is possible.
257  *
258  * The arguments listed as defaults are for this function and also of the
259  * {@link get_posts()} function. The arguments are combined with the
260  * get_children defaults and are then passed to the {@link get_posts()}
261  * function, which accepts additional arguments. You can replace the defaults in
262  * this function, listed below and the additional arguments listed in the
263  * {@link get_posts()} function.
264  *
265  * The 'post_parent' is the most important argument and important attention
266  * needs to be paid to the $args parameter. If you pass either an object or an
267  * integer (number), then just the 'post_parent' is grabbed and everything else
268  * is lost. If you don't specify any arguments, then it is assumed that you are
269  * in The Loop and the post parent will be grabbed for from the current post.
270  *
271  * The 'post_parent' argument is the ID to get the children. The 'numberposts'
272  * is the amount of posts to retrieve that has a default of '-1', which is
273  * used to get all of the posts. Giving a number higher than 0 will only
274  * retrieve that amount of posts.
275  *
276  * The 'post_type' and 'post_status' arguments can be used to choose what
277  * criteria of posts to retrieve. The 'post_type' can be anything, but WordPress
278  * post types are 'post', 'pages', and 'attachments'. The 'post_status'
279  * argument will accept any post status within the write administration panels.
280  *
281  * @see get_posts() Has additional arguments that can be replaced.
282  * @internal Claims made in the long description might be inaccurate.
283  *
284  * @since 2.0.0
285  *
286  * @param mixed $args Optional. User defined arguments for replacing the defaults.
287  * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N.
288  * @return array|bool False on failure and the type will be determined by $output parameter.
289  */
290 function get_children($args = '', $output = OBJECT) {
291         $kids = array();
292         if ( empty( $args ) ) {
293                 if ( isset( $GLOBALS['post'] ) ) {
294                         $args = array('post_parent' => (int) $GLOBALS['post']->post_parent );
295                 } else {
296                         return $kids;
297                 }
298         } elseif ( is_object( $args ) ) {
299                 $args = array('post_parent' => (int) $args->post_parent );
300         } elseif ( is_numeric( $args ) ) {
301                 $args = array('post_parent' => (int) $args);
302         }
303
304         $defaults = array(
305                 'numberposts' => -1, 'post_type' => 'any',
306                 'post_status' => 'any', 'post_parent' => 0,
307         );
308
309         $r = wp_parse_args( $args, $defaults );
310
311         $children = get_posts( $r );
312
313         if ( !$children )
314                 return $kids;
315
316         update_post_cache($children);
317
318         foreach ( $children as $key => $child )
319                 $kids[$child->ID] = $children[$key];
320
321         if ( $output == OBJECT ) {
322                 return $kids;
323         } elseif ( $output == ARRAY_A ) {
324                 foreach ( (array) $kids as $kid )
325                         $weeuns[$kid->ID] = get_object_vars($kids[$kid->ID]);
326                 return $weeuns;
327         } elseif ( $output == ARRAY_N ) {
328                 foreach ( (array) $kids as $kid )
329                         $babes[$kid->ID] = array_values(get_object_vars($kids[$kid->ID]));
330                 return $babes;
331         } else {
332                 return $kids;
333         }
334 }
335
336 /**
337  * Get extended entry info (<!--more-->).
338  *
339  * There should not be any space after the second dash and before the word
340  * 'more'. There can be text or space(s) after the word 'more', but won't be
341  * referenced.
342  *
343  * The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before
344  * the <code><!--more--></code>. The 'extended' key has the content after the
345  * <code><!--more--></code> comment. The 'more_text' key has the custom "Read More" text.
346  *
347  * @since 1.0.0
348  *
349  * @param string $post Post content.
350  * @return array Post before ('main'), after ('extended'), and custom readmore ('more_text').
351  */
352 function get_extended($post) {
353         //Match the new style more links
354         if ( preg_match('/<!--more(.*?)?-->/', $post, $matches) ) {
355                 list($main, $extended) = explode($matches[0], $post, 2);
356                 $more_text = $matches[1];
357         } else {
358                 $main = $post;
359                 $extended = '';
360                 $more_text = '';
361         }
362
363         // Strip leading and trailing whitespace
364         $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main);
365         $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended);
366         $more_text = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $more_text);
367
368         return array( 'main' => $main, 'extended' => $extended, 'more_text' => $more_text );
369 }
370
371 /**
372  * Retrieves post data given a post ID or post object.
373  *
374  * See {@link sanitize_post()} for optional $filter values. Also, the parameter
375  * $post, must be given as a variable, since it is passed by reference.
376  *
377  * @since 1.5.1
378  * @uses $wpdb
379  * @link http://codex.wordpress.org/Function_Reference/get_post
380  *
381  * @param int|object $post Post ID or post object. Optional, default is the current post from the loop.
382  * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N.
383  * @param string $filter Optional, default is raw.
384  * @return WP_Post|null WP_Post on success or null on failure
385  */
386 function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
387         if ( empty( $post ) && isset( $GLOBALS['post'] ) )
388                 $post = $GLOBALS['post'];
389
390         if ( is_a( $post, 'WP_Post' ) ) {
391                 $_post = $post;
392         } elseif ( is_object( $post ) ) {
393                 if ( empty( $post->filter ) ) {
394                         $_post = sanitize_post( $post, 'raw' );
395                         $_post = new WP_Post( $_post );
396                 } elseif ( 'raw' == $post->filter ) {
397                         $_post = new WP_Post( $post );
398                 } else {
399                         $_post = WP_Post::get_instance( $post->ID );
400                 }
401         } else {
402                 $_post = WP_Post::get_instance( $post );
403         }
404
405         if ( ! $_post )
406                 return null;
407
408         $_post = $_post->filter( $filter );
409
410         if ( $output == ARRAY_A )
411                 return $_post->to_array();
412         elseif ( $output == ARRAY_N )
413                 return array_values( $_post->to_array() );
414
415         return $_post;
416 }
417
418 /**
419  * WordPress Post class.
420  *
421  * @since 3.5.0
422  *
423  */
424 final class WP_Post {
425
426         /**
427          *
428          * @var int
429          */
430         public $ID;
431
432         /**
433          *
434          * @var int
435          */
436         public $post_author = 0;
437
438         /**
439          *
440          * @var string
441          */
442         public $post_date = '0000-00-00 00:00:00';
443
444         /**
445          *
446          * @var string
447          */
448         public $post_date_gmt = '0000-00-00 00:00:00';
449
450         /**
451          *
452          * @var string
453          */
454         public $post_content = '';
455
456         /**
457          *
458          * @var string
459          */
460         public $post_title = '';
461
462         /**
463          *
464          * @var string
465          */
466         public $post_excerpt = '';
467
468         /**
469          *
470          * @var string
471          */
472         public $post_status = 'publish';
473
474         /**
475          *
476          * @var string
477          */
478         public $comment_status = 'open';
479
480         /**
481          *
482          * @var string
483          */
484         public $ping_status = 'open';
485
486         /**
487          *
488          * @var string
489          */
490         public $post_password = '';
491
492         /**
493          *
494          * @var string
495          */
496         public $post_name = '';
497
498         /**
499          *
500          * @var string
501          */
502         public $to_ping = '';
503
504         /**
505          *
506          * @var string
507          */
508         public $pinged = '';
509
510         /**
511          *
512          * @var string
513          */
514         public $post_modified = '0000-00-00 00:00:00';
515
516         /**
517          *
518          * @var string
519          */
520         public $post_modified_gmt = '0000-00-00 00:00:00';
521
522         /**
523          *
524          * @var string
525          */
526         public $post_content_filtered = '';
527
528         /**
529          *
530          * @var int
531          */
532         public $post_parent = 0;
533
534         /**
535          *
536          * @var string
537          */
538         public $guid = '';
539
540         /**
541          *
542          * @var int
543          */
544         public $menu_order = 0;
545
546         /**
547          *
548          * @var string
549          */
550         public $post_type = 'post';
551
552         /**
553          *
554          * @var string
555          */
556         public $post_mime_type = '';
557
558         /**
559          *
560          * @var int
561          */
562         public $comment_count = 0;
563
564         /**
565          *
566          * @var string
567          */
568         public $filter;
569
570         public static function get_instance( $post_id ) {
571                 global $wpdb;
572
573                 $post_id = (int) $post_id;
574                 if ( ! $post_id )
575                         return false;
576
577                 $_post = wp_cache_get( $post_id, 'posts' );
578
579                 if ( ! $_post ) {
580                         $_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id ) );
581
582                         if ( ! $_post )
583                                 return false;
584
585                         $_post = sanitize_post( $_post, 'raw' );
586                         wp_cache_add( $_post->ID, $_post, 'posts' );
587                 } elseif ( empty( $_post->filter ) ) {
588                         $_post = sanitize_post( $_post, 'raw' );
589                 }
590
591                 return new WP_Post( $_post );
592         }
593
594         public function __construct( $post ) {
595                 foreach ( get_object_vars( $post ) as $key => $value )
596                         $this->$key = $value;
597         }
598
599         public function __isset( $key ) {
600                 if ( 'ancestors' == $key )
601                         return true;
602
603                 if ( 'page_template' == $key )
604                         return ( 'page' == $this->post_type );
605
606                 if ( 'post_category' == $key )
607                    return true;
608
609                 if ( 'tags_input' == $key )
610                    return true;
611
612                 return metadata_exists( 'post', $this->ID, $key );
613         }
614
615         public function __get( $key ) {
616                 if ( 'page_template' == $key && $this->__isset( $key ) ) {
617                         return get_post_meta( $this->ID, '_wp_page_template', true );
618                 }
619
620                 if ( 'post_category' == $key ) {
621                         if ( is_object_in_taxonomy( $this->post_type, 'category' ) )
622                                 $terms = get_the_terms( $this, 'category' );
623
624                         if ( empty( $terms ) )
625                                 return array();
626
627                         return wp_list_pluck( $terms, 'term_id' );
628                 }
629
630                 if ( 'tags_input' == $key ) {
631                         if ( is_object_in_taxonomy( $this->post_type, 'post_tag' ) )
632                                 $terms = get_the_terms( $this, 'post_tag' );
633
634                         if ( empty( $terms ) )
635                                 return array();
636
637                         return wp_list_pluck( $terms, 'name' );
638                 }
639
640                 // Rest of the values need filtering
641
642                 if ( 'ancestors' == $key )
643                         $value = get_post_ancestors( $this );
644                 else
645                         $value = get_post_meta( $this->ID, $key, true );
646
647                 if ( $this->filter )
648                         $value = sanitize_post_field( $key, $value, $this->ID, $this->filter );
649
650                 return $value;
651         }
652
653         public function filter( $filter ) {
654                 if ( $this->filter == $filter )
655                         return $this;
656
657                 if ( $filter == 'raw' )
658                         return self::get_instance( $this->ID );
659
660                 return sanitize_post( $this, $filter );
661         }
662
663         public function to_array() {
664                 $post = get_object_vars( $this );
665
666                 foreach ( array( 'ancestors', 'page_template', 'post_category', 'tags_input' ) as $key ) {
667                         if ( $this->__isset( $key ) )
668                                 $post[ $key ] = $this->__get( $key );
669                 }
670
671                 return $post;
672         }
673 }
674
675 /**
676  * Retrieve ancestors of a post.
677  *
678  * @since 2.5.0
679  *
680  * @param int|object $post Post ID or post object
681  * @return array Ancestor IDs or empty array if none are found.
682  */
683 function get_post_ancestors( $post ) {
684         if ( ! $post )
685                 return false;
686
687         $post = get_post( $post );
688
689         if ( empty( $post->post_parent ) || $post->post_parent == $post->ID )
690                 return array();
691
692         $ancestors = array();
693
694         $id = $ancestors[] = $post->post_parent;
695
696         while ( $ancestor = get_post( $id ) ) {
697                 // Loop detection: If the ancestor has been seen before, break.
698                 if ( empty( $ancestor->post_parent ) || ( $ancestor->post_parent == $post->ID ) || in_array( $ancestor->post_parent, $ancestors ) )
699                         break;
700
701                 $id = $ancestors[] = $ancestor->post_parent;
702         }
703
704         return $ancestors;
705 }
706
707 /**
708  * Retrieve data from a post field based on Post ID.
709  *
710  * Examples of the post field will be, 'post_type', 'post_status', 'post_content',
711  * etc and based off of the post object property or key names.
712  *
713  * The context values are based off of the taxonomy filter functions and
714  * supported values are found within those functions.
715  *
716  * @since 2.3.0
717  * @uses sanitize_post_field() See for possible $context values.
718  *
719  * @param string $field Post field name
720  * @param id $post Post ID
721  * @param string $context Optional. How to filter the field. Default is display.
722  * @return bool|string False on failure or returns the value in post field
723  */
724 function get_post_field( $field, $post, $context = 'display' ) {
725         $post = get_post( $post );
726
727         if ( !$post )
728                 return '';
729
730         if ( !isset($post->$field) )
731                 return '';
732
733         return sanitize_post_field($field, $post->$field, $post->ID, $context);
734 }
735
736 /**
737  * Retrieve the mime type of an attachment based on the ID.
738  *
739  * This function can be used with any post type, but it makes more sense with
740  * attachments.
741  *
742  * @since 2.0.0
743  *
744  * @param int $ID Optional. Post ID.
745  * @return bool|string False on failure or returns the mime type
746  */
747 function get_post_mime_type($ID = '') {
748         $post = get_post($ID);
749
750         if ( is_object($post) )
751                 return $post->post_mime_type;
752
753         return false;
754 }
755
756 /**
757  * Retrieve the format slug for a post
758  *
759  * @since 3.1.0
760  *
761  * @param int|object $post A post
762  *
763  * @return mixed The format if successful. False if no format is set. WP_Error if errors.
764  */
765 function get_post_format( $post = null ) {
766         $post = get_post($post);
767
768         if ( ! post_type_supports( $post->post_type, 'post-formats' ) )
769                 return false;
770
771         $_format = get_the_terms( $post->ID, 'post_format' );
772
773         if ( empty( $_format ) )
774                 return false;
775
776         $format = array_shift( $_format );
777
778         return ( str_replace('post-format-', '', $format->slug ) );
779 }
780
781 /**
782  * Check if a post has a particular format
783  *
784  * @since 3.1.0
785  * @uses has_term()
786  *
787  * @param string $format The format to check for
788  * @param object|id $post The post to check. If not supplied, defaults to the current post if used in the loop.
789  * @return bool True if the post has the format, false otherwise.
790  */
791 function has_post_format( $format, $post = null ) {
792         return has_term('post-format-' . sanitize_key($format), 'post_format', $post);
793 }
794
795 /**
796  * Assign a format to a post
797  *
798  * @since 3.1.0
799  *
800  * @param int|object $post The post for which to assign a format
801  * @param string $format  A format to assign. Use an empty string or array to remove all formats from the post.
802  * @return mixed WP_Error on error. Array of affected term IDs on success.
803  */
804 function set_post_format( $post, $format ) {
805         $post = get_post($post);
806
807         if ( empty($post) )
808                 return new WP_Error('invalid_post', __('Invalid post'));
809
810         if ( !empty($format) ) {
811                 $format = sanitize_key($format);
812                 if ( 'standard' == $format || !in_array( $format, array_keys( get_post_format_slugs() ) ) )
813                         $format = '';
814                 else
815                         $format = 'post-format-' . $format;
816         }
817
818         return wp_set_post_terms($post->ID, $format, 'post_format');
819 }
820
821 /**
822  * Retrieve the post status based on the Post ID.
823  *
824  * If the post ID is of an attachment, then the parent post status will be given
825  * instead.
826  *
827  * @since 2.0.0
828  *
829  * @param int $ID Post ID
830  * @return string|bool Post status or false on failure.
831  */
832 function get_post_status($ID = '') {
833         $post = get_post($ID);
834
835         if ( !is_object($post) )
836                 return false;
837
838         if ( 'attachment' == $post->post_type ) {
839                 if ( 'private' == $post->post_status )
840                         return 'private';
841
842                 // Unattached attachments are assumed to be published
843                 if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) )
844                         return 'publish';
845
846                 // Inherit status from the parent
847                 if ( $post->post_parent && ( $post->ID != $post->post_parent ) )
848                         return get_post_status($post->post_parent);
849         }
850
851         return $post->post_status;
852 }
853
854 /**
855  * Retrieve all of the WordPress supported post statuses.
856  *
857  * Posts have a limited set of valid status values, this provides the
858  * post_status values and descriptions.
859  *
860  * @since 2.5.0
861  *
862  * @return array List of post statuses.
863  */
864 function get_post_statuses( ) {
865         $status = array(
866                 'draft'                 => __('Draft'),
867                 'pending'               => __('Pending Review'),
868                 'private'               => __('Private'),
869                 'publish'               => __('Published')
870         );
871
872         return $status;
873 }
874
875 /**
876  * Retrieve all of the WordPress support page statuses.
877  *
878  * Pages have a limited set of valid status values, this provides the
879  * post_status values and descriptions.
880  *
881  * @since 2.5.0
882  *
883  * @return array List of page statuses.
884  */
885 function get_page_statuses( ) {
886         $status = array(
887                 'draft'                 => __('Draft'),
888                 'private'               => __('Private'),
889                 'publish'               => __('Published')
890         );
891
892         return $status;
893 }
894
895 /**
896  * Register a post status. Do not use before init.
897  *
898  * A simple function for creating or modifying a post status based on the
899  * parameters given. The function will accept an array (second optional
900  * parameter), along with a string for the post status name.
901  *
902  *
903  * Optional $args contents:
904  *
905  * label - A descriptive name for the post status marked for translation. Defaults to $post_status.
906  * public - Whether posts of this status should be shown in the front end of the site. Defaults to true.
907  * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to false.
908  * show_in_admin_all_list - Whether to include posts in the edit listing for their post type
909  * show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit
910  *                             listings, e.g. All (12) | Published (9) | My Custom Status (2) ...
911  *
912  * Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
913  *
914  * @package WordPress
915  * @subpackage Post
916  * @since 3.0.0
917  * @uses $wp_post_statuses Inserts new post status object into the list
918  *
919  * @param string $post_status Name of the post status.
920  * @param array|string $args See above description.
921  */
922 function register_post_status($post_status, $args = array()) {
923         global $wp_post_statuses;
924
925         if (!is_array($wp_post_statuses))
926                 $wp_post_statuses = array();
927
928         // Args prefixed with an underscore are reserved for internal use.
929         $defaults = array(
930                 'label' => false,
931                 'label_count' => false,
932                 'exclude_from_search' => null,
933                 '_builtin' => false,
934                 'public' => null,
935                 'internal' => null,
936                 'protected' => null,
937                 'private' => null,
938                 'publicly_queryable' => null,
939                 'show_in_admin_status_list' => null,
940                 'show_in_admin_all_list' => null,
941         );
942         $args = wp_parse_args($args, $defaults);
943         $args = (object) $args;
944
945         $post_status = sanitize_key($post_status);
946         $args->name = $post_status;
947
948         if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private )
949                 $args->internal = true;
950
951         if ( null === $args->public  )
952                 $args->public = false;
953
954         if ( null === $args->private  )
955                 $args->private = false;
956
957         if ( null === $args->protected  )
958                 $args->protected = false;
959
960         if ( null === $args->internal  )
961                 $args->internal = false;
962
963         if ( null === $args->publicly_queryable )
964                 $args->publicly_queryable = $args->public;
965
966         if ( null === $args->exclude_from_search )
967                 $args->exclude_from_search = $args->internal;
968
969         if ( null === $args->show_in_admin_all_list )
970                 $args->show_in_admin_all_list = !$args->internal;
971
972         if ( null === $args->show_in_admin_status_list )
973                 $args->show_in_admin_status_list = !$args->internal;
974
975         if ( false === $args->label )
976                 $args->label = $post_status;
977
978         if ( false === $args->label_count )
979                 $args->label_count = array( $args->label, $args->label );
980
981         $wp_post_statuses[$post_status] = $args;
982
983         return $args;
984 }
985
986 /**
987  * Retrieve a post status object by name
988  *
989  * @package WordPress
990  * @subpackage Post
991  * @since 3.0.0
992  * @uses $wp_post_statuses
993  * @see register_post_status
994  * @see get_post_statuses
995  *
996  * @param string $post_status The name of a registered post status
997  * @return object A post status object
998  */
999 function get_post_status_object( $post_status ) {
1000         global $wp_post_statuses;
1001
1002         if ( empty($wp_post_statuses[$post_status]) )
1003                 return null;
1004
1005         return $wp_post_statuses[$post_status];
1006 }
1007
1008 /**
1009  * Get a list of all registered post status objects.
1010  *
1011  * @package WordPress
1012  * @subpackage Post
1013  * @since 3.0.0
1014  * @uses $wp_post_statuses
1015  * @see register_post_status
1016  * @see get_post_status_object
1017  *
1018  * @param array|string $args An array of key => value arguments to match against the post status objects.
1019  * @param string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default.
1020  * @param string $operator The logical operation to perform. 'or' means only one element
1021  *  from the array needs to match; 'and' means all elements must match. The default is 'and'.
1022  * @return array A list of post status names or objects
1023  */
1024 function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {
1025         global $wp_post_statuses;
1026
1027         $field = ('names' == $output) ? 'name' : false;
1028
1029         return wp_filter_object_list($wp_post_statuses, $args, $operator, $field);
1030 }
1031
1032 /**
1033  * Whether the post type is hierarchical.
1034  *
1035  * A false return value might also mean that the post type does not exist.
1036  *
1037  * @since 3.0.0
1038  * @see get_post_type_object
1039  *
1040  * @param string $post_type Post type name
1041  * @return bool Whether post type is hierarchical.
1042  */
1043 function is_post_type_hierarchical( $post_type ) {
1044         if ( ! post_type_exists( $post_type ) )
1045                 return false;
1046
1047         $post_type = get_post_type_object( $post_type );
1048         return $post_type->hierarchical;
1049 }
1050
1051 /**
1052  * Checks if a post type is registered.
1053  *
1054  * @since 3.0.0
1055  * @uses get_post_type_object()
1056  *
1057  * @param string $post_type Post type name
1058  * @return bool Whether post type is registered.
1059  */
1060 function post_type_exists( $post_type ) {
1061         return (bool) get_post_type_object( $post_type );
1062 }
1063
1064 /**
1065  * Retrieve the post type of the current post or of a given post.
1066  *
1067  * @since 2.1.0
1068  *
1069  * @uses $post The Loop current post global
1070  *
1071  * @param mixed $post Optional. Post object or post ID.
1072  * @return bool|string post type or false on failure.
1073  */
1074 function get_post_type( $post = null ) {
1075         if ( $post = get_post( $post ) )
1076                 return $post->post_type;
1077
1078         return false;
1079 }
1080
1081 /**
1082  * Retrieve a post type object by name
1083  *
1084  * @package WordPress
1085  * @subpackage Post
1086  * @since 3.0.0
1087  * @uses $wp_post_types
1088  * @see register_post_type
1089  * @see get_post_types
1090  *
1091  * @param string $post_type The name of a registered post type
1092  * @return object A post type object
1093  */
1094 function get_post_type_object( $post_type ) {
1095         global $wp_post_types;
1096
1097         if ( empty($wp_post_types[$post_type]) )
1098                 return null;
1099
1100         return $wp_post_types[$post_type];
1101 }
1102
1103 /**
1104  * Get a list of all registered post type objects.
1105  *
1106  * @package WordPress
1107  * @subpackage Post
1108  * @since 2.9.0
1109  * @uses $wp_post_types
1110  * @see register_post_type
1111  *
1112  * @param array|string $args An array of key => value arguments to match against the post type objects.
1113  * @param string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default.
1114  * @param string $operator The logical operation to perform. 'or' means only one element
1115  *  from the array needs to match; 'and' means all elements must match. The default is 'and'.
1116  * @return array A list of post type names or objects
1117  */
1118 function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) {
1119         global $wp_post_types;
1120
1121         $field = ('names' == $output) ? 'name' : false;
1122
1123         return wp_filter_object_list($wp_post_types, $args, $operator, $field);
1124 }
1125
1126 /**
1127  * Register a post type. Do not use before init.
1128  *
1129  * A function for creating or modifying a post type based on the
1130  * parameters given. The function will accept an array (second optional
1131  * parameter), along with a string for the post type name.
1132  *
1133  * Optional $args contents:
1134  *
1135  * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used.
1136  * - labels - An array of labels for this post type.
1137  *     * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones.
1138  *     * You can see accepted values in {@link get_post_type_labels()}.
1139  * - description - A short descriptive summary of what the post type is. Defaults to blank.
1140  * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users.
1141  *     * Defaults to false.
1142  *     * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are
1143  *       inherited from public, each does not rely on this relationship and controls a very specific intention.
1144  * - exclude_from_search - Whether to exclude posts with this post type from front end search results.
1145  *     * If not set, the the opposite of public's current value is used.
1146  * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request().
1147  *     * ?post_type={post_type_key}
1148  *     * ?{post_type_key}={single_post_slug}
1149  *     * ?{post_type_query_var}={single_post_slug}
1150  *     * If not set, the default is inherited from public.
1151  * - show_ui - Whether to generate a default UI for managing this post type in the admin.
1152  *     * If not set, the default is inherited from public.
1153  * - show_in_nav_menus - Makes this post type available for selection in navigation menus.
1154  *     * If not set, the default is inherited from public.
1155  * - show_in_menu - Where to show the post type in the admin menu.
1156  *     * If true, the post type is shown in its own top level menu.
1157  *     * If false, no menu is shown
1158  *     * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will
1159  *       be placed as a sub menu of that.
1160  *     * show_ui must be true.
1161  *     * If not set, the default is inherited from show_ui
1162  * - show_in_admin_bar - Makes this post type available via the admin bar.
1163  *     * If not set, the default is inherited from show_in_menu
1164  * - menu_position - The position in the menu order the post type should appear.
1165  *     * show_in_menu must be true
1166  *     * Defaults to null, which places it at the bottom of its area.
1167  * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon.
1168  * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'.
1169  *     * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the
1170  *       capabilities, e.g. array('story', 'stories').
1171  * - capabilities - Array of capabilities for this post type.
1172  *     * By default the capability_type is used as a base to construct capabilities.
1173  *     * You can see accepted values in {@link get_post_type_capabilities()}.
1174  * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false.
1175  * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false.
1176  * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor.
1177  *     * See {@link add_post_type_support()} for documentation.
1178  * - register_meta_box_cb - Provide a callback function that will be called when setting up the
1179  *     meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback.
1180  * - taxonomies - An array of taxonomy identifiers that will be registered for the post type.
1181  *     * Default is no taxonomies.
1182  *     * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type().
1183  * - has_archive - True to enable post type archives. Default is false.
1184  *     * Will generate the proper rewrite rules if rewrite is enabled.
1185  * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug.
1186  *     * To prevent rewrite, set to false.
1187  *     * To specify rewrite rules, an array can be passed with any of these keys
1188  *         * 'slug' => string Customize the permastruct slug. Defaults to $post_type key
1189  *         * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
1190  *         * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive.
1191  *         * 'pages' => bool Should the permastruct provide for pagination. Defaults to true.
1192  *         * 'ep_mask' => const Assign an endpoint mask.
1193  *             * If not specified and permalink_epmask is set, inherits from permalink_epmask.
1194  *             * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK
1195  * - query_var - Sets the query_var key for this post type. Defaults to $post_type key
1196  *     * If false, a post type cannot be loaded at ?{query_var}={post_slug}
1197  *     * If specified as a string, the query ?{query_var_string}={post_slug} will be valid.
1198  * - can_export - Allows this post type to be exported. Defaults to true.
1199  * - delete_with_user - Whether to delete posts of this type when deleting a user.
1200  *     * If true, posts of this type belonging to the user will be moved to trash when then user is deleted.
1201  *     * If false, posts of this type belonging to the user will *not* be trashed or deleted.
1202  *     * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted.
1203  * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY!
1204  * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY!
1205  *
1206  * @since 2.9.0
1207  * @uses $wp_post_types Inserts new post type object into the list
1208  *
1209  * @param string $post_type Post type key, must not exceed 20 characters
1210  * @param array|string $args See optional args description above.
1211  * @return object|WP_Error the registered post type object, or an error object
1212  */
1213 function register_post_type( $post_type, $args = array() ) {
1214         global $wp_post_types, $wp_rewrite, $wp;
1215
1216         if ( !is_array($wp_post_types) )
1217                 $wp_post_types = array();
1218
1219         // Args prefixed with an underscore are reserved for internal use.
1220         $defaults = array(
1221                 'labels' => array(), 'description' => '', 'publicly_queryable' => null, 'exclude_from_search' => null,
1222                 'capability_type' => 'post', 'capabilities' => array(), 'map_meta_cap' => null,
1223                 '_builtin' => false, '_edit_link' => 'post.php?post=%d', 'hierarchical' => false,
1224                 'public' => false, 'rewrite' => true, 'has_archive' => false, 'query_var' => true,
1225                 'supports' => array(), 'register_meta_box_cb' => null,
1226                 'taxonomies' => array(), 'show_ui' => null, 'menu_position' => null, 'menu_icon' => null,
1227                 'can_export' => true,
1228                 'show_in_nav_menus' => null, 'show_in_menu' => null, 'show_in_admin_bar' => null,
1229                 'delete_with_user' => null,
1230         );
1231         $args = wp_parse_args($args, $defaults);
1232         $args = (object) $args;
1233
1234         $post_type = sanitize_key($post_type);
1235         $args->name = $post_type;
1236
1237         if ( strlen( $post_type ) > 20 )
1238                         return new WP_Error( 'post_type_too_long', __( 'Post types cannot exceed 20 characters in length' ) );
1239
1240         // If not set, default to the setting for public.
1241         if ( null === $args->publicly_queryable )
1242                 $args->publicly_queryable = $args->public;
1243
1244         // If not set, default to the setting for public.
1245         if ( null === $args->show_ui )
1246                 $args->show_ui = $args->public;
1247
1248         // If not set, default to the setting for show_ui.
1249         if ( null === $args->show_in_menu || ! $args->show_ui )
1250                 $args->show_in_menu = $args->show_ui;
1251
1252         // If not set, default to the whether the full UI is shown.
1253         if ( null === $args->show_in_admin_bar )
1254                 $args->show_in_admin_bar = true === $args->show_in_menu;
1255
1256         // Whether to show this type in nav-menus.php. Defaults to the setting for public.
1257         if ( null === $args->show_in_nav_menus )
1258                 $args->show_in_nav_menus = $args->public;
1259
1260         // If not set, default to true if not public, false if public.
1261         if ( null === $args->exclude_from_search )
1262                 $args->exclude_from_search = !$args->public;
1263
1264         // Back compat with quirky handling in version 3.0. #14122
1265         if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
1266                 $args->map_meta_cap = true;
1267
1268         if ( null === $args->map_meta_cap )
1269                 $args->map_meta_cap = false;
1270
1271         $args->cap = get_post_type_capabilities( $args );
1272         unset($args->capabilities);
1273
1274         if ( is_array( $args->capability_type ) )
1275                 $args->capability_type = $args->capability_type[0];
1276
1277         if ( ! empty($args->supports) ) {
1278                 add_post_type_support($post_type, $args->supports);
1279                 unset($args->supports);
1280         } elseif ( false !== $args->supports ) {
1281                 // Add default features
1282                 add_post_type_support($post_type, array('title', 'editor'));
1283         }
1284
1285         if ( false !== $args->query_var && !empty($wp) ) {
1286                 if ( true === $args->query_var )
1287                         $args->query_var = $post_type;
1288                 else
1289                         $args->query_var = sanitize_title_with_dashes($args->query_var);
1290                 $wp->add_query_var($args->query_var);
1291         }
1292
1293         if ( false !== $args->rewrite && ( is_admin() || '' != get_option('permalink_structure') ) ) {
1294                 if ( ! is_array( $args->rewrite ) )
1295                         $args->rewrite = array();
1296                 if ( empty( $args->rewrite['slug'] ) )
1297                         $args->rewrite['slug'] = $post_type;
1298                 if ( ! isset( $args->rewrite['with_front'] ) )
1299                         $args->rewrite['with_front'] = true;
1300                 if ( ! isset( $args->rewrite['pages'] ) )
1301                         $args->rewrite['pages'] = true;
1302                 if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive )
1303                         $args->rewrite['feeds'] = (bool) $args->has_archive;
1304                 if ( ! isset( $args->rewrite['ep_mask'] ) ) {
1305                         if ( isset( $args->permalink_epmask ) )
1306                                 $args->rewrite['ep_mask'] = $args->permalink_epmask;
1307                         else
1308                                 $args->rewrite['ep_mask'] = EP_PERMALINK;
1309                 }
1310
1311                 if ( $args->hierarchical )
1312                         add_rewrite_tag("%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=");
1313                 else
1314                         add_rewrite_tag("%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=");
1315
1316                 if ( $args->has_archive ) {
1317                         $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive;
1318                         if ( $args->rewrite['with_front'] )
1319                                 $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug;
1320                         else
1321                                 $archive_slug = $wp_rewrite->root . $archive_slug;
1322
1323                         add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' );
1324                         if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) {
1325                                 $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';
1326                                 add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
1327                                 add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
1328                         }
1329                         if ( $args->rewrite['pages'] )
1330                                 add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' );
1331                 }
1332
1333                 add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $args->rewrite );
1334         }
1335
1336         if ( $args->register_meta_box_cb )
1337                 add_action('add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1);
1338
1339         $args->labels = get_post_type_labels( $args );
1340         $args->label = $args->labels->name;
1341
1342         $wp_post_types[$post_type] = $args;
1343
1344         add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 );
1345
1346         foreach ( $args->taxonomies as $taxonomy ) {
1347                 register_taxonomy_for_object_type( $taxonomy, $post_type );
1348         }
1349
1350         do_action( 'registered_post_type', $post_type, $args );
1351
1352         return $args;
1353 }
1354
1355 /**
1356  * Builds an object with all post type capabilities out of a post type object
1357  *
1358  * Post type capabilities use the 'capability_type' argument as a base, if the
1359  * capability is not set in the 'capabilities' argument array or if the
1360  * 'capabilities' argument is not supplied.
1361  *
1362  * The capability_type argument can optionally be registered as an array, with
1363  * the first value being singular and the second plural, e.g. array('story, 'stories')
1364  * Otherwise, an 's' will be added to the value for the plural form. After
1365  * registration, capability_type will always be a string of the singular value.
1366  *
1367  * By default, seven keys are accepted as part of the capabilities array:
1368  *
1369  * - edit_post, read_post, and delete_post are meta capabilities, which are then
1370  *   generally mapped to corresponding primitive capabilities depending on the
1371  *   context, which would be the post being edited/read/deleted and the user or
1372  *   role being checked. Thus these capabilities would generally not be granted
1373  *   directly to users or roles.
1374  *
1375  * - edit_posts - Controls whether objects of this post type can be edited.
1376  * - edit_others_posts - Controls whether objects of this type owned by other users
1377  *   can be edited. If the post type does not support an author, then this will
1378  *   behave like edit_posts.
1379  * - publish_posts - Controls publishing objects of this post type.
1380  * - read_private_posts - Controls whether private objects can be read.
1381  *
1382  * These four primitive capabilities are checked in core in various locations.
1383  * There are also seven other primitive capabilities which are not referenced
1384  * directly in core, except in map_meta_cap(), which takes the three aforementioned
1385  * meta capabilities and translates them into one or more primitive capabilities
1386  * that must then be checked against the user or role, depending on the context.
1387  *
1388  * - read - Controls whether objects of this post type can be read.
1389  * - delete_posts - Controls whether objects of this post type can be deleted.
1390  * - delete_private_posts - Controls whether private objects can be deleted.
1391  * - delete_published_posts - Controls whether published objects can be deleted.
1392  * - delete_others_posts - Controls whether objects owned by other users can be
1393  *   can be deleted. If the post type does not support an author, then this will
1394  *   behave like delete_posts.
1395  * - edit_private_posts - Controls whether private objects can be edited.
1396  * - edit_published_posts - Controls whether published objects can be edited.
1397  *
1398  * These additional capabilities are only used in map_meta_cap(). Thus, they are
1399  * only assigned by default if the post type is registered with the 'map_meta_cap'
1400  * argument set to true (default is false).
1401  *
1402  * @see map_meta_cap()
1403  * @since 3.0.0
1404  *
1405  * @param object $args Post type registration arguments
1406  * @return object object with all the capabilities as member variables
1407  */
1408 function get_post_type_capabilities( $args ) {
1409         if ( ! is_array( $args->capability_type ) )
1410                 $args->capability_type = array( $args->capability_type, $args->capability_type . 's' );
1411
1412         // Singular base for meta capabilities, plural base for primitive capabilities.
1413         list( $singular_base, $plural_base ) = $args->capability_type;
1414
1415         $default_capabilities = array(
1416                 // Meta capabilities
1417                 'edit_post'          => 'edit_'         . $singular_base,
1418                 'read_post'          => 'read_'         . $singular_base,
1419                 'delete_post'        => 'delete_'       . $singular_base,
1420                 // Primitive capabilities used outside of map_meta_cap():
1421                 'edit_posts'         => 'edit_'         . $plural_base,
1422                 'edit_others_posts'  => 'edit_others_'  . $plural_base,
1423                 'publish_posts'      => 'publish_'      . $plural_base,
1424                 'read_private_posts' => 'read_private_' . $plural_base,
1425         );
1426
1427         // Primitive capabilities used within map_meta_cap():
1428         if ( $args->map_meta_cap ) {
1429                 $default_capabilities_for_mapping = array(
1430                         'read'                   => 'read',
1431                         'delete_posts'           => 'delete_'           . $plural_base,
1432                         'delete_private_posts'   => 'delete_private_'   . $plural_base,
1433                         'delete_published_posts' => 'delete_published_' . $plural_base,
1434                         'delete_others_posts'    => 'delete_others_'    . $plural_base,
1435                         'edit_private_posts'     => 'edit_private_'     . $plural_base,
1436                         'edit_published_posts'   => 'edit_published_'   . $plural_base,
1437                 );
1438                 $default_capabilities = array_merge( $default_capabilities, $default_capabilities_for_mapping );
1439         }
1440
1441         $capabilities = array_merge( $default_capabilities, $args->capabilities );
1442
1443         // Post creation capability simply maps to edit_posts by default:
1444         if ( ! isset( $capabilities['create_posts'] ) )
1445                 $capabilities['create_posts'] = $capabilities['edit_posts'];
1446
1447         // Remember meta capabilities for future reference.
1448         if ( $args->map_meta_cap )
1449                 _post_type_meta_capabilities( $capabilities );
1450
1451         return (object) $capabilities;
1452 }
1453
1454 /**
1455  * Stores or returns a list of post type meta caps for map_meta_cap().
1456  *
1457  * @since 3.1.0
1458  * @access private
1459  */
1460 function _post_type_meta_capabilities( $capabilities = null ) {
1461         static $meta_caps = array();
1462         if ( null === $capabilities )
1463                 return $meta_caps;
1464         foreach ( $capabilities as $core => $custom ) {
1465                 if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) )
1466                         $meta_caps[ $custom ] = $core;
1467         }
1468 }
1469
1470 /**
1471  * Builds an object with all post type labels out of a post type object
1472  *
1473  * Accepted keys of the label array in the post type object:
1474  * - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages
1475  * - singular_name - name for one object of this post type. Default is Post/Page
1476  * - add_new - Default is Add New for both hierarchical and non-hierarchical types. When internationalizing this string, please use a {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} matching your post type. Example: <code>_x('Add New', 'product');</code>
1477  * - add_new_item - Default is Add New Post/Add New Page
1478  * - edit_item - Default is Edit Post/Edit Page
1479  * - new_item - Default is New Post/New Page
1480  * - view_item - Default is View Post/View Page
1481  * - search_items - Default is Search Posts/Search Pages
1482  * - not_found - Default is No posts found/No pages found
1483  * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash
1484  * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page:
1485  * - all_items - String for the submenu. Default is All Posts/All Pages
1486  * - menu_name - Default is the same as <code>name</code>
1487  *
1488  * Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages).
1489  *
1490  * @since 3.0.0
1491  * @param object $post_type_object
1492  * @return object object with all the labels as member variables
1493  */
1494 function get_post_type_labels( $post_type_object ) {
1495         $nohier_vs_hier_defaults = array(
1496                 'name' => array( _x('Posts', 'post type general name'), _x('Pages', 'post type general name') ),
1497                 'singular_name' => array( _x('Post', 'post type singular name'), _x('Page', 'post type singular name') ),
1498                 'add_new' => array( _x('Add New', 'post'), _x('Add New', 'page') ),
1499                 'add_new_item' => array( __('Add New Post'), __('Add New Page') ),
1500                 'edit_item' => array( __('Edit Post'), __('Edit Page') ),
1501                 'new_item' => array( __('New Post'), __('New Page') ),
1502                 'view_item' => array( __('View Post'), __('View Page') ),
1503                 'search_items' => array( __('Search Posts'), __('Search Pages') ),
1504                 'not_found' => array( __('No posts found.'), __('No pages found.') ),
1505                 'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ),
1506                 'parent_item_colon' => array( null, __('Parent Page:') ),
1507                 'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) )
1508         );
1509         $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
1510
1511         $labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults );
1512
1513         $post_type = $post_type_object->name;
1514         return apply_filters( "post_type_labels_{$post_type}", $labels );
1515 }
1516
1517 /**
1518  * Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object
1519  *
1520  * @access private
1521  * @since 3.0.0
1522  */
1523 function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
1524
1525         if ( isset( $object->label ) && empty( $object->labels['name'] ) )
1526                 $object->labels['name'] = $object->label;
1527
1528         if ( !isset( $object->labels['singular_name'] ) && isset( $object->labels['name'] ) )
1529                 $object->labels['singular_name'] = $object->labels['name'];
1530
1531         if ( ! isset( $object->labels['name_admin_bar'] ) )
1532                 $object->labels['name_admin_bar'] = isset( $object->labels['singular_name'] ) ? $object->labels['singular_name'] : $object->name;
1533
1534         if ( !isset( $object->labels['menu_name'] ) && isset( $object->labels['name'] ) )
1535                 $object->labels['menu_name'] = $object->labels['name'];
1536
1537         if ( !isset( $object->labels['all_items'] ) && isset( $object->labels['menu_name'] ) )
1538                 $object->labels['all_items'] = $object->labels['menu_name'];
1539
1540         foreach ( $nohier_vs_hier_defaults as $key => $value )
1541                         $defaults[$key] = $object->hierarchical ? $value[1] : $value[0];
1542
1543         $labels = array_merge( $defaults, $object->labels );
1544         return (object)$labels;
1545 }
1546
1547 /**
1548  * Adds submenus for post types.
1549  *
1550  * @access private
1551  * @since 3.1.0
1552  */
1553 function _add_post_type_submenus() {
1554         foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) {
1555                 $ptype_obj = get_post_type_object( $ptype );
1556                 // Submenus only.
1557                 if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true )
1558                         continue;
1559                 add_submenu_page( $ptype_obj->show_in_menu, $ptype_obj->labels->name, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, "edit.php?post_type=$ptype" );
1560         }
1561 }
1562 add_action( 'admin_menu', '_add_post_type_submenus' );
1563
1564 /**
1565  * Register support of certain features for a post type.
1566  *
1567  * All features are directly associated with a functional area of the edit screen, such as the
1568  * editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author',
1569  * 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'.
1570  *
1571  * Additionally, the 'revisions' feature dictates whether the post type will store revisions,
1572  * and the 'comments' feature dictates whether the comments count will show on the edit screen.
1573  *
1574  * @since 3.0.0
1575  * @param string $post_type The post type for which to add the feature
1576  * @param string|array $feature the feature being added, can be an array of feature strings or a single string
1577  */
1578 function add_post_type_support( $post_type, $feature ) {
1579         global $_wp_post_type_features;
1580
1581         $features = (array) $feature;
1582         foreach ($features as $feature) {
1583                 if ( func_num_args() == 2 )
1584                         $_wp_post_type_features[$post_type][$feature] = true;
1585                 else
1586                         $_wp_post_type_features[$post_type][$feature] = array_slice( func_get_args(), 2 );
1587         }
1588 }
1589
1590 /**
1591  * Remove support for a feature from a post type.
1592  *
1593  * @since 3.0.0
1594  * @param string $post_type The post type for which to remove the feature
1595  * @param string $feature The feature being removed
1596  */
1597 function remove_post_type_support( $post_type, $feature ) {
1598         global $_wp_post_type_features;
1599
1600         if ( !isset($_wp_post_type_features[$post_type]) )
1601                 return;
1602
1603         if ( isset($_wp_post_type_features[$post_type][$feature]) )
1604                 unset($_wp_post_type_features[$post_type][$feature]);
1605 }
1606
1607 /**
1608  * Get all the post type features
1609  *
1610  * @since 3.4.0
1611  * @param string $post_type The post type
1612  * @return array
1613  */
1614
1615 function get_all_post_type_supports( $post_type ) {
1616         global $_wp_post_type_features;
1617
1618         if ( isset( $_wp_post_type_features[$post_type] ) )
1619                 return $_wp_post_type_features[$post_type];
1620
1621         return array();
1622 }
1623
1624 /**
1625  * Checks a post type's support for a given feature
1626  *
1627  * @since 3.0.0
1628  * @param string $post_type The post type being checked
1629  * @param string $feature the feature being checked
1630  * @return boolean
1631  */
1632
1633 function post_type_supports( $post_type, $feature ) {
1634         global $_wp_post_type_features;
1635
1636         if ( !isset( $_wp_post_type_features[$post_type][$feature] ) )
1637                 return false;
1638
1639         // If no args passed then no extra checks need be performed
1640         if ( func_num_args() <= 2 )
1641                 return true;
1642
1643         // @todo Allow pluggable arg checking
1644         //$args = array_slice( func_get_args(), 2 );
1645
1646         return true;
1647 }
1648
1649 /**
1650  * Updates the post type for the post ID.
1651  *
1652  * The page or post cache will be cleaned for the post ID.
1653  *
1654  * @since 2.5.0
1655  *
1656  * @uses $wpdb
1657  *
1658  * @param int $post_id Post ID to change post type. Not actually optional.
1659  * @param string $post_type Optional, default is post. Supported values are 'post' or 'page' to
1660  *  name a few.
1661  * @return int Amount of rows changed. Should be 1 for success and 0 for failure.
1662  */
1663 function set_post_type( $post_id = 0, $post_type = 'post' ) {
1664         global $wpdb;
1665
1666         $post_type = sanitize_post_field('post_type', $post_type, $post_id, 'db');
1667         $return = $wpdb->update( $wpdb->posts, array('post_type' => $post_type), array('ID' => $post_id) );
1668
1669         clean_post_cache( $post_id );
1670
1671         return $return;
1672 }
1673
1674 /**
1675  * Retrieve list of latest posts or posts matching criteria.
1676  *
1677  * The defaults are as follows:
1678  *     'numberposts' - Default is 5. Total number of posts to retrieve.
1679  *     'offset' - Default is 0. See {@link WP_Query::query()} for more.
1680  *     'category' - What category to pull the posts from.
1681  *     'orderby' - Default is 'post_date'. How to order the posts.
1682  *     'order' - Default is 'DESC'. The order to retrieve the posts.
1683  *     'include' - See {@link WP_Query::query()} for more.
1684  *     'exclude' - See {@link WP_Query::query()} for more.
1685  *     'meta_key' - See {@link WP_Query::query()} for more.
1686  *     'meta_value' - See {@link WP_Query::query()} for more.
1687  *     'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few.
1688  *     'post_parent' - The parent of the post or post type.
1689  *     'post_status' - Default is 'publish'. Post status to retrieve.
1690  *
1691  * @since 1.2.0
1692  * @uses $wpdb
1693  * @uses WP_Query::query() See for more default arguments and information.
1694  * @link http://codex.wordpress.org/Template_Tags/get_posts
1695  *
1696  * @param array $args Optional. Overrides defaults.
1697  * @return array List of posts.
1698  */
1699 function get_posts($args = null) {
1700         $defaults = array(
1701                 'numberposts' => 5, 'offset' => 0,
1702                 'category' => 0, 'orderby' => 'post_date',
1703                 'order' => 'DESC', 'include' => array(),
1704                 'exclude' => array(), 'meta_key' => '',
1705                 'meta_value' =>'', 'post_type' => 'post',
1706                 'suppress_filters' => true
1707         );
1708
1709         $r = wp_parse_args( $args, $defaults );
1710         if ( empty( $r['post_status'] ) )
1711                 $r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish';
1712         if ( ! empty($r['numberposts']) && empty($r['posts_per_page']) )
1713                 $r['posts_per_page'] = $r['numberposts'];
1714         if ( ! empty($r['category']) )
1715                 $r['cat'] = $r['category'];
1716         if ( ! empty($r['include']) ) {
1717                 $incposts = wp_parse_id_list( $r['include'] );
1718                 $r['posts_per_page'] = count($incposts);  // only the number of posts included
1719                 $r['post__in'] = $incposts;
1720         } elseif ( ! empty($r['exclude']) )
1721                 $r['post__not_in'] = wp_parse_id_list( $r['exclude'] );
1722
1723         $r['ignore_sticky_posts'] = true;
1724         $r['no_found_rows'] = true;
1725
1726         $get_posts = new WP_Query;
1727         return $get_posts->query($r);
1728
1729 }
1730
1731 //
1732 // Post meta functions
1733 //
1734
1735 /**
1736  * Add meta data field to a post.
1737  *
1738  * Post meta data is called "Custom Fields" on the Administration Screen.
1739  *
1740  * @since 1.5.0
1741  * @uses $wpdb
1742  * @link http://codex.wordpress.org/Function_Reference/add_post_meta
1743  *
1744  * @param int $post_id Post ID.
1745  * @param string $meta_key Metadata name.
1746  * @param mixed $meta_value Metadata value.
1747  * @param bool $unique Optional, default is false. Whether the same key should not be added.
1748  * @return bool False for failure. True for success.
1749  */
1750 function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) {
1751         // make sure meta is added to the post, not a revision
1752         if ( $the_post = wp_is_post_revision($post_id) )
1753                 $post_id = $the_post;
1754
1755         return add_metadata('post', $post_id, $meta_key, $meta_value, $unique);
1756 }
1757
1758 /**
1759  * Remove metadata matching criteria from a post.
1760  *
1761  * You can match based on the key, or key and value. Removing based on key and
1762  * value, will keep from removing duplicate metadata with the same key. It also
1763  * allows removing all metadata matching key, if needed.
1764  *
1765  * @since 1.5.0
1766  * @uses $wpdb
1767  * @link http://codex.wordpress.org/Function_Reference/delete_post_meta
1768  *
1769  * @param int $post_id post ID
1770  * @param string $meta_key Metadata name.
1771  * @param mixed $meta_value Optional. Metadata value.
1772  * @return bool False for failure. True for success.
1773  */
1774 function delete_post_meta($post_id, $meta_key, $meta_value = '') {
1775         // make sure meta is added to the post, not a revision
1776         if ( $the_post = wp_is_post_revision($post_id) )
1777                 $post_id = $the_post;
1778
1779         return delete_metadata('post', $post_id, $meta_key, $meta_value);
1780 }
1781
1782 /**
1783  * Retrieve post meta field for a post.
1784  *
1785  * @since 1.5.0
1786  * @uses $wpdb
1787  * @link http://codex.wordpress.org/Function_Reference/get_post_meta
1788  *
1789  * @param int $post_id Post ID.
1790  * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
1791  * @param bool $single Whether to return a single value.
1792  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
1793  *  is true.
1794  */
1795 function get_post_meta($post_id, $key = '', $single = false) {
1796         return get_metadata('post', $post_id, $key, $single);
1797 }
1798
1799 /**
1800  * Update post meta field based on post ID.
1801  *
1802  * Use the $prev_value parameter to differentiate between meta fields with the
1803  * same key and post ID.
1804  *
1805  * If the meta field for the post does not exist, it will be added.
1806  *
1807  * @since 1.5.0
1808  * @uses $wpdb
1809  * @link http://codex.wordpress.org/Function_Reference/update_post_meta
1810  *
1811  * @param int $post_id Post ID.
1812  * @param string $meta_key Metadata key.
1813  * @param mixed $meta_value Metadata value.
1814  * @param mixed $prev_value Optional. Previous value to check before removing.
1815  * @return bool False on failure, true if success.
1816  */
1817 function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {
1818         // make sure meta is added to the post, not a revision
1819         if ( $the_post = wp_is_post_revision($post_id) )
1820                 $post_id = $the_post;
1821
1822         return update_metadata('post', $post_id, $meta_key, $meta_value, $prev_value);
1823 }
1824
1825 /**
1826  * Delete everything from post meta matching meta key.
1827  *
1828  * @since 2.3.0
1829  * @uses $wpdb
1830  *
1831  * @param string $post_meta_key Key to search for when deleting.
1832  * @return bool Whether the post meta key was deleted from the database
1833  */
1834 function delete_post_meta_by_key($post_meta_key) {
1835         return delete_metadata( 'post', null, $post_meta_key, '', true );
1836 }
1837
1838 /**
1839  * Retrieve post meta fields, based on post ID.
1840  *
1841  * The post meta fields are retrieved from the cache where possible,
1842  * so the function is optimized to be called more than once.
1843  *
1844  * @since 1.2.0
1845  * @link http://codex.wordpress.org/Function_Reference/get_post_custom
1846  *
1847  * @param int $post_id Post ID.
1848  * @return array
1849  */
1850 function get_post_custom( $post_id = 0 ) {
1851         $post_id = absint( $post_id );
1852         if ( ! $post_id )
1853                 $post_id = get_the_ID();
1854
1855         return get_post_meta( $post_id );
1856 }
1857
1858 /**
1859  * Retrieve meta field names for a post.
1860  *
1861  * If there are no meta fields, then nothing (null) will be returned.
1862  *
1863  * @since 1.2.0
1864  * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys
1865  *
1866  * @param int $post_id post ID
1867  * @return array|null Either array of the keys, or null if keys could not be retrieved.
1868  */
1869 function get_post_custom_keys( $post_id = 0 ) {
1870         $custom = get_post_custom( $post_id );
1871
1872         if ( !is_array($custom) )
1873                 return;
1874
1875         if ( $keys = array_keys($custom) )
1876                 return $keys;
1877 }
1878
1879 /**
1880  * Retrieve values for a custom post field.
1881  *
1882  * The parameters must not be considered optional. All of the post meta fields
1883  * will be retrieved and only the meta field key values returned.
1884  *
1885  * @since 1.2.0
1886  * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values
1887  *
1888  * @param string $key Meta field key.
1889  * @param int $post_id Post ID
1890  * @return array Meta field values.
1891  */
1892 function get_post_custom_values( $key = '', $post_id = 0 ) {
1893         if ( !$key )
1894                 return null;
1895
1896         $custom = get_post_custom($post_id);
1897
1898         return isset($custom[$key]) ? $custom[$key] : null;
1899 }
1900
1901 /**
1902  * Check if post is sticky.
1903  *
1904  * Sticky posts should remain at the top of The Loop. If the post ID is not
1905  * given, then The Loop ID for the current post will be used.
1906  *
1907  * @since 2.7.0
1908  *
1909  * @param int $post_id Optional. Post ID.
1910  * @return bool Whether post is sticky.
1911  */
1912 function is_sticky( $post_id = 0 ) {
1913         $post_id = absint( $post_id );
1914
1915         if ( ! $post_id )
1916                 $post_id = get_the_ID();
1917
1918         $stickies = get_option( 'sticky_posts' );
1919
1920         if ( ! is_array( $stickies ) )
1921                 return false;
1922
1923         if ( in_array( $post_id, $stickies ) )
1924                 return true;
1925
1926         return false;
1927 }
1928
1929 /**
1930  * Sanitize every post field.
1931  *
1932  * If the context is 'raw', then the post object or array will get minimal santization of the int fields.
1933  *
1934  * @since 2.3.0
1935  * @uses sanitize_post_field() Used to sanitize the fields.
1936  *
1937  * @param object|WP_Post|array $post The Post Object or Array
1938  * @param string $context Optional, default is 'display'. How to sanitize post fields.
1939  * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post)
1940  */
1941 function sanitize_post($post, $context = 'display') {
1942         if ( is_object($post) ) {
1943                 // Check if post already filtered for this context
1944                 if ( isset($post->filter) && $context == $post->filter )
1945                         return $post;
1946                 if ( !isset($post->ID) )
1947                         $post->ID = 0;
1948                 foreach ( array_keys(get_object_vars($post)) as $field )
1949                         $post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context);
1950                 $post->filter = $context;
1951         } else {
1952                 // Check if post already filtered for this context
1953                 if ( isset($post['filter']) && $context == $post['filter'] )
1954                         return $post;
1955                 if ( !isset($post['ID']) )
1956                         $post['ID'] = 0;
1957                 foreach ( array_keys($post) as $field )
1958                         $post[$field] = sanitize_post_field($field, $post[$field], $post['ID'], $context);
1959                 $post['filter'] = $context;
1960         }
1961         return $post;
1962 }
1963
1964 /**
1965  * Sanitize post field based on context.
1966  *
1967  * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1968  * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1969  * when calling filters.
1970  *
1971  * @since 2.3.0
1972  * @uses apply_filters() Calls 'edit_$field' and '{$field_no_prefix}_edit_pre' passing $value and
1973  *  $post_id if $context == 'edit' and field name prefix == 'post_'.
1974  *
1975  * @uses apply_filters() Calls 'edit_post_$field' passing $value and $post_id if $context == 'db'.
1976  * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db' and field name prefix == 'post_'.
1977  * @uses apply_filters() Calls '{$field}_pre' passing $value if $context == 'db' and field name prefix != 'post_'.
1978  *
1979  * @uses apply_filters() Calls '$field' passing $value, $post_id and $context if $context == anything
1980  *  other than 'raw', 'edit' and 'db' and field name prefix == 'post_'.
1981  * @uses apply_filters() Calls 'post_$field' passing $value if $context == anything other than 'raw',
1982  *  'edit' and 'db' and field name prefix != 'post_'.
1983  *
1984  * @param string $field The Post Object field name.
1985  * @param mixed $value The Post Object value.
1986  * @param int $post_id Post ID.
1987  * @param string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display',
1988  *               'attribute' and 'js'.
1989  * @return mixed Sanitized value.
1990  */
1991 function sanitize_post_field($field, $value, $post_id, $context) {
1992         $int_fields = array('ID', 'post_parent', 'menu_order');
1993         if ( in_array($field, $int_fields) )
1994                 $value = (int) $value;
1995
1996         // Fields which contain arrays of ints.
1997         $array_int_fields = array( 'ancestors' );
1998         if ( in_array($field, $array_int_fields) ) {
1999                 $value = array_map( 'absint', $value);
2000                 return $value;
2001         }
2002
2003         if ( 'raw' == $context )
2004                 return $value;
2005
2006         $prefixed = false;
2007         if ( false !== strpos($field, 'post_') ) {
2008                 $prefixed = true;
2009                 $field_no_prefix = str_replace('post_', '', $field);
2010         }
2011
2012         if ( 'edit' == $context ) {
2013                 $format_to_edit = array('post_content', 'post_excerpt', 'post_title', 'post_password');
2014
2015                 if ( $prefixed ) {
2016                         $value = apply_filters("edit_{$field}", $value, $post_id);
2017                         // Old school
2018                         $value = apply_filters("{$field_no_prefix}_edit_pre", $value, $post_id);
2019                 } else {
2020                         $value = apply_filters("edit_post_{$field}", $value, $post_id);
2021                 }
2022
2023                 if ( in_array($field, $format_to_edit) ) {
2024                         if ( 'post_content' == $field )
2025                                 $value = format_to_edit($value, user_can_richedit());
2026                         else
2027                                 $value = format_to_edit($value);
2028                 } else {
2029                         $value = esc_attr($value);
2030                 }
2031         } else if ( 'db' == $context ) {
2032                 if ( $prefixed ) {
2033                         $value = apply_filters("pre_{$field}", $value);
2034                         $value = apply_filters("{$field_no_prefix}_save_pre", $value);
2035                 } else {
2036                         $value = apply_filters("pre_post_{$field}", $value);
2037                         $value = apply_filters("{$field}_pre", $value);
2038                 }
2039         } else {
2040                 // Use display filters by default.
2041                 if ( $prefixed )
2042                         $value = apply_filters($field, $value, $post_id, $context);
2043                 else
2044                         $value = apply_filters("post_{$field}", $value, $post_id, $context);
2045         }
2046
2047         if ( 'attribute' == $context )
2048                 $value = esc_attr($value);
2049         else if ( 'js' == $context )
2050                 $value = esc_js($value);
2051
2052         return $value;
2053 }
2054
2055 /**
2056  * Make a post sticky.
2057  *
2058  * Sticky posts should be displayed at the top of the front page.
2059  *
2060  * @since 2.7.0
2061  *
2062  * @param int $post_id Post ID.
2063  */
2064 function stick_post($post_id) {
2065         $stickies = get_option('sticky_posts');
2066
2067         if ( !is_array($stickies) )
2068                 $stickies = array($post_id);
2069
2070         if ( ! in_array($post_id, $stickies) )
2071                 $stickies[] = $post_id;
2072
2073         update_option('sticky_posts', $stickies);
2074 }
2075
2076 /**
2077  * Unstick a post.
2078  *
2079  * Sticky posts should be displayed at the top of the front page.
2080  *
2081  * @since 2.7.0
2082  *
2083  * @param int $post_id Post ID.
2084  */
2085 function unstick_post($post_id) {
2086         $stickies = get_option('sticky_posts');
2087
2088         if ( !is_array($stickies) )
2089                 return;
2090
2091         if ( ! in_array($post_id, $stickies) )
2092                 return;
2093
2094         $offset = array_search($post_id, $stickies);
2095         if ( false === $offset )
2096                 return;
2097
2098         array_splice($stickies, $offset, 1);
2099
2100         update_option('sticky_posts', $stickies);
2101 }
2102
2103 /**
2104  * Count number of posts of a post type and is user has permissions to view.
2105  *
2106  * This function provides an efficient method of finding the amount of post's
2107  * type a blog has. Another method is to count the amount of items in
2108  * get_posts(), but that method has a lot of overhead with doing so. Therefore,
2109  * when developing for 2.5+, use this function instead.
2110  *
2111  * The $perm parameter checks for 'readable' value and if the user can read
2112  * private posts, it will display that for the user that is signed in.
2113  *
2114  * @since 2.5.0
2115  * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
2116  *
2117  * @param string $type Optional. Post type to retrieve count
2118  * @param string $perm Optional. 'readable' or empty.
2119  * @return object Number of posts for each status
2120  */
2121 function wp_count_posts( $type = 'post', $perm = '' ) {
2122         global $wpdb;
2123
2124         $user = wp_get_current_user();
2125
2126         $cache_key = $type;
2127
2128         $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s";
2129         if ( 'readable' == $perm && is_user_logged_in() ) {
2130                 $post_type_object = get_post_type_object($type);
2131                 if ( !current_user_can( $post_type_object->cap->read_private_posts ) ) {
2132                         $cache_key .= '_' . $perm . '_' . $user->ID;
2133                         $query .= " AND (post_status != 'private' OR ( post_author = '$user->ID' AND post_status = 'private' ))";
2134                 }
2135         }
2136         $query .= ' GROUP BY post_status';
2137
2138         $count = wp_cache_get($cache_key, 'counts');
2139         if ( false !== $count )
2140                 return $count;
2141
2142         $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A );
2143
2144         $stats = array();
2145         foreach ( get_post_stati() as $state )
2146                 $stats[$state] = 0;
2147
2148         foreach ( (array) $count as $row )
2149                 $stats[$row['post_status']] = $row['num_posts'];
2150
2151         $stats = (object) $stats;
2152         wp_cache_set($cache_key, $stats, 'counts');
2153
2154         return $stats;
2155 }
2156
2157 /**
2158  * Count number of attachments for the mime type(s).
2159  *
2160  * If you set the optional mime_type parameter, then an array will still be
2161  * returned, but will only have the item you are looking for. It does not give
2162  * you the number of attachments that are children of a post. You can get that
2163  * by counting the number of children that post has.
2164  *
2165  * @since 2.5.0
2166  *
2167  * @param string|array $mime_type Optional. Array or comma-separated list of MIME patterns.
2168  * @return array Number of posts for each mime type.
2169  */
2170 function wp_count_attachments( $mime_type = '' ) {
2171         global $wpdb;
2172
2173         $and = wp_post_mime_type_where( $mime_type );
2174         $count = $wpdb->get_results( "SELECT post_mime_type, COUNT( * ) AS num_posts FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status != 'trash' $and GROUP BY post_mime_type", ARRAY_A );
2175
2176         $stats = array( );
2177         foreach( (array) $count as $row ) {
2178                 $stats[$row['post_mime_type']] = $row['num_posts'];
2179         }
2180         $stats['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and");
2181
2182         return (object) $stats;
2183 }
2184
2185 /**
2186  * Get default post mime types
2187  *
2188  * @since 2.9.0
2189  *
2190  * @return array
2191  */
2192 function get_post_mime_types() {
2193         $post_mime_types = array(       //      array( adj, noun )
2194                 'image' => array(__('Images'), __('Manage Images'), _n_noop('Image <span class="count">(%s)</span>', 'Images <span class="count">(%s)</span>')),
2195                 'audio' => array(__('Audio'), __('Manage Audio'), _n_noop('Audio <span class="count">(%s)</span>', 'Audio <span class="count">(%s)</span>')),
2196                 'video' => array(__('Video'), __('Manage Video'), _n_noop('Video <span class="count">(%s)</span>', 'Video <span class="count">(%s)</span>')),
2197         );
2198
2199         return apply_filters('post_mime_types', $post_mime_types);
2200 }
2201
2202 /**
2203  * Check a MIME-Type against a list.
2204  *
2205  * If the wildcard_mime_types parameter is a string, it must be comma separated
2206  * list. If the real_mime_types is a string, it is also comma separated to
2207  * create the list.
2208  *
2209  * @since 2.5.0
2210  *
2211  * @param string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or
2212  *  flash (same as *flash*).
2213  * @param string|array $real_mime_types post_mime_type values
2214  * @return array array(wildcard=>array(real types))
2215  */
2216 function wp_match_mime_types($wildcard_mime_types, $real_mime_types) {
2217         $matches = array();
2218         if ( is_string($wildcard_mime_types) )
2219                 $wildcard_mime_types = array_map('trim', explode(',', $wildcard_mime_types));
2220         if ( is_string($real_mime_types) )
2221                 $real_mime_types = array_map('trim', explode(',', $real_mime_types));
2222         $wild = '[-._a-z0-9]*';
2223         foreach ( (array) $wildcard_mime_types as $type ) {
2224                 $type = str_replace('*', $wild, $type);
2225                 $patternses[1][$type] = "^$type$";
2226                 if ( false === strpos($type, '/') ) {
2227                         $patternses[2][$type] = "^$type/";
2228                         $patternses[3][$type] = $type;
2229                 }
2230         }
2231         asort($patternses);
2232         foreach ( $patternses as $patterns )
2233                 foreach ( $patterns as $type => $pattern )
2234                         foreach ( (array) $real_mime_types as $real )
2235                                 if ( preg_match("#$pattern#", $real) && ( empty($matches[$type]) || false === array_search($real, $matches[$type]) ) )
2236                                         $matches[$type][] = $real;
2237         return $matches;
2238 }
2239
2240 /**
2241  * Convert MIME types into SQL.
2242  *
2243  * @since 2.5.0
2244  *
2245  * @param string|array $post_mime_types List of mime types or comma separated string of mime types.
2246  * @param string $table_alias Optional. Specify a table alias, if needed.
2247  * @return string The SQL AND clause for mime searching.
2248  */
2249 function wp_post_mime_type_where($post_mime_types, $table_alias = '') {
2250         $where = '';
2251         $wildcards = array('', '%', '%/%');
2252         if ( is_string($post_mime_types) )
2253                 $post_mime_types = array_map('trim', explode(',', $post_mime_types));
2254         foreach ( (array) $post_mime_types as $mime_type ) {
2255                 $mime_type = preg_replace('/\s/', '', $mime_type);
2256                 $slashpos = strpos($mime_type, '/');
2257                 if ( false !== $slashpos ) {
2258                         $mime_group = preg_replace('/[^-*.a-zA-Z0-9]/', '', substr($mime_type, 0, $slashpos));
2259                         $mime_subgroup = preg_replace('/[^-*.+a-zA-Z0-9]/', '', substr($mime_type, $slashpos + 1));
2260                         if ( empty($mime_subgroup) )
2261                                 $mime_subgroup = '*';
2262                         else
2263                                 $mime_subgroup = str_replace('/', '', $mime_subgroup);
2264                         $mime_pattern = "$mime_group/$mime_subgroup";
2265                 } else {
2266                         $mime_pattern = preg_replace('/[^-*.a-zA-Z0-9]/', '', $mime_type);
2267                         if ( false === strpos($mime_pattern, '*') )
2268                                 $mime_pattern .= '/*';
2269                 }
2270
2271                 $mime_pattern = preg_replace('/\*+/', '%', $mime_pattern);
2272
2273                 if ( in_array( $mime_type, $wildcards ) )
2274                         return '';
2275
2276                 if ( false !== strpos($mime_pattern, '%') )
2277                         $wheres[] = empty($table_alias) ? "post_mime_type LIKE '$mime_pattern'" : "$table_alias.post_mime_type LIKE '$mime_pattern'";
2278                 else
2279                         $wheres[] = empty($table_alias) ? "post_mime_type = '$mime_pattern'" : "$table_alias.post_mime_type = '$mime_pattern'";
2280         }
2281         if ( !empty($wheres) )
2282                 $where = ' AND (' . join(' OR ', $wheres) . ') ';
2283         return $where;
2284 }
2285
2286 /**
2287  * Trashes or deletes a post or page.
2288  *
2289  * When the post and page is permanently deleted, everything that is tied to it is deleted also.
2290  * This includes comments, post meta fields, and terms associated with the post.
2291  *
2292  * The post or page is moved to trash instead of permanently deleted unless trash is
2293  * disabled, item is already in the trash, or $force_delete is true.
2294  *
2295  * @since 1.0.0
2296  * @uses do_action() on 'delete_post' before deletion unless post type is 'attachment'.
2297  * @uses do_action() on 'deleted_post' after deletion unless post type is 'attachment'.
2298  * @uses wp_delete_attachment() if post type is 'attachment'.
2299  * @uses wp_trash_post() if item should be trashed.
2300  *
2301  * @param int $postid Post ID.
2302  * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
2303  * @return mixed False on failure
2304  */
2305 function wp_delete_post( $postid = 0, $force_delete = false ) {
2306         global $wpdb;
2307
2308         if ( !$post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) )
2309                 return $post;
2310
2311         if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS )
2312                         return wp_trash_post($postid);
2313
2314         if ( $post->post_type == 'attachment' )
2315                 return wp_delete_attachment( $postid, $force_delete );
2316
2317         do_action('before_delete_post', $postid);
2318
2319         delete_post_meta($postid,'_wp_trash_meta_status');
2320         delete_post_meta($postid,'_wp_trash_meta_time');
2321
2322         wp_delete_object_term_relationships($postid, get_object_taxonomies($post->post_type));
2323
2324         $parent_data = array( 'post_parent' => $post->post_parent );
2325         $parent_where = array( 'post_parent' => $postid );
2326
2327         if ( is_post_type_hierarchical( $post->post_type ) ) {
2328                 // Point children of this page to its parent, also clean the cache of affected children
2329                 $children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type );
2330                 $children = $wpdb->get_results( $children_query );
2331
2332                 $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) );
2333         }
2334
2335         if ( 'page' == $post->post_type) {
2336                 // if the page is defined in option page_on_front or post_for_posts,
2337                 // adjust the corresponding options
2338                 if ( get_option('page_on_front') == $postid ) {
2339                         update_option('show_on_front', 'posts');
2340                         delete_option('page_on_front');
2341                 }
2342                 if ( get_option('page_for_posts') == $postid ) {
2343                         delete_option('page_for_posts');
2344                 }
2345         } else {
2346                 unstick_post($postid);
2347         }
2348
2349         // Do raw query. wp_get_post_revisions() is filtered
2350         $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
2351         // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
2352         foreach ( $revision_ids as $revision_id )
2353                 wp_delete_post_revision( $revision_id );
2354
2355         // Point all attachments to this post up one level
2356         $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
2357
2358         $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid ));
2359         foreach ( $comment_ids as $comment_id )
2360                 wp_delete_comment( $comment_id, true );
2361
2362         $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $postid ));
2363         foreach ( $post_meta_ids as $mid )
2364                 delete_metadata_by_mid( 'post', $mid );
2365
2366         do_action( 'delete_post', $postid );
2367         $wpdb->delete( $wpdb->posts, array( 'ID' => $postid ) );
2368         do_action( 'deleted_post', $postid );
2369
2370         clean_post_cache( $post );
2371
2372         if ( is_post_type_hierarchical( $post->post_type ) && $children ) {
2373                 foreach ( $children as $child )
2374                         clean_post_cache( $child );
2375         }
2376
2377         wp_clear_scheduled_hook('publish_future_post', array( $postid ) );
2378
2379         do_action('after_delete_post', $postid);
2380
2381         return $post;
2382 }
2383
2384 /**
2385  * Moves a post or page to the Trash
2386  *
2387  * If trash is disabled, the post or page is permanently deleted.
2388  *
2389  * @since 2.9.0
2390  * @uses do_action() on 'trash_post' before trashing
2391  * @uses do_action() on 'trashed_post' after trashing
2392  * @uses wp_delete_post() if trash is disabled
2393  *
2394  * @param int $post_id Post ID.
2395  * @return mixed False on failure
2396  */
2397 function wp_trash_post($post_id = 0) {
2398         if ( !EMPTY_TRASH_DAYS )
2399                 return wp_delete_post($post_id, true);
2400
2401         if ( !$post = get_post($post_id, ARRAY_A) )
2402                 return $post;
2403
2404         if ( $post['post_status'] == 'trash' )
2405                 return false;
2406
2407         do_action('wp_trash_post', $post_id);
2408
2409         add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']);
2410         add_post_meta($post_id,'_wp_trash_meta_time', time());
2411
2412         $post['post_status'] = 'trash';
2413         wp_insert_post($post);
2414
2415         wp_trash_post_comments($post_id);
2416
2417         do_action('trashed_post', $post_id);
2418
2419         return $post;
2420 }
2421
2422 /**
2423  * Restores a post or page from the Trash
2424  *
2425  * @since 2.9.0
2426  * @uses do_action() on 'untrash_post' before undeletion
2427  * @uses do_action() on 'untrashed_post' after undeletion
2428  *
2429  * @param int $post_id Post ID.
2430  * @return mixed False on failure
2431  */
2432 function wp_untrash_post($post_id = 0) {
2433         if ( !$post = get_post($post_id, ARRAY_A) )
2434                 return $post;
2435
2436         if ( $post['post_status'] != 'trash' )
2437                 return false;
2438
2439         do_action('untrash_post', $post_id);
2440
2441         $post_status = get_post_meta($post_id, '_wp_trash_meta_status', true);
2442
2443         $post['post_status'] = $post_status;
2444
2445         delete_post_meta($post_id, '_wp_trash_meta_status');
2446         delete_post_meta($post_id, '_wp_trash_meta_time');
2447
2448         wp_insert_post($post);
2449
2450         wp_untrash_post_comments($post_id);
2451
2452         do_action('untrashed_post', $post_id);
2453
2454         return $post;
2455 }
2456
2457 /**
2458  * Moves comments for a post to the trash
2459  *
2460  * @since 2.9.0
2461  * @uses do_action() on 'trash_post_comments' before trashing
2462  * @uses do_action() on 'trashed_post_comments' after trashing
2463  *
2464  * @param int $post Post ID or object.
2465  * @return mixed False on failure
2466  */
2467 function wp_trash_post_comments($post = null) {
2468         global $wpdb;
2469
2470         $post = get_post($post);
2471         if ( empty($post) )
2472                 return;
2473
2474         $post_id = $post->ID;
2475
2476         do_action('trash_post_comments', $post_id);
2477
2478         $comments = $wpdb->get_results( $wpdb->prepare("SELECT comment_ID, comment_approved FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id) );
2479         if ( empty($comments) )
2480                 return;
2481
2482         // Cache current status for each comment
2483         $statuses = array();
2484         foreach ( $comments as $comment )
2485                 $statuses[$comment->comment_ID] = $comment->comment_approved;
2486         add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses);
2487
2488         // Set status for all comments to post-trashed
2489         $result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id));
2490
2491         clean_comment_cache( array_keys($statuses) );
2492
2493         do_action('trashed_post_comments', $post_id, $statuses);
2494
2495         return $result;
2496 }
2497
2498 /**
2499  * Restore comments for a post from the trash
2500  *
2501  * @since 2.9.0
2502  * @uses do_action() on 'untrash_post_comments' before trashing
2503  * @uses do_action() on 'untrashed_post_comments' after trashing
2504  *
2505  * @param int $post Post ID or object.
2506  * @return mixed False on failure
2507  */
2508 function wp_untrash_post_comments($post = null) {
2509         global $wpdb;
2510
2511         $post = get_post($post);
2512         if ( empty($post) )
2513                 return;
2514
2515         $post_id = $post->ID;
2516
2517         $statuses = get_post_meta($post_id, '_wp_trash_meta_comments_status', true);
2518
2519         if ( empty($statuses) )
2520                 return true;
2521
2522         do_action('untrash_post_comments', $post_id);
2523
2524         // Restore each comment to its original status
2525         $group_by_status = array();
2526         foreach ( $statuses as $comment_id => $comment_status )
2527                 $group_by_status[$comment_status][] = $comment_id;
2528
2529         foreach ( $group_by_status as $status => $comments ) {
2530                 // Sanity check. This shouldn't happen.
2531                 if ( 'post-trashed' == $status )
2532                         $status = '0';
2533                 $comments_in = implode( "', '", $comments );
2534                 $wpdb->query( "UPDATE $wpdb->comments SET comment_approved = '$status' WHERE comment_ID IN ('" . $comments_in . "')" );
2535         }
2536
2537         clean_comment_cache( array_keys($statuses) );
2538
2539         delete_post_meta($post_id, '_wp_trash_meta_comments_status');
2540
2541         do_action('untrashed_post_comments', $post_id);
2542 }
2543
2544 /**
2545  * Retrieve the list of categories for a post.
2546  *
2547  * Compatibility layer for themes and plugins. Also an easy layer of abstraction
2548  * away from the complexity of the taxonomy layer.
2549  *
2550  * @since 2.1.0
2551  *
2552  * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here.
2553  *
2554  * @param int $post_id Optional. The Post ID.
2555  * @param array $args Optional. Overwrite the defaults.
2556  * @return array
2557  */
2558 function wp_get_post_categories( $post_id = 0, $args = array() ) {
2559         $post_id = (int) $post_id;
2560
2561         $defaults = array('fields' => 'ids');
2562         $args = wp_parse_args( $args, $defaults );
2563
2564         $cats = wp_get_object_terms($post_id, 'category', $args);
2565         return $cats;
2566 }
2567
2568 /**
2569  * Retrieve the tags for a post.
2570  *
2571  * There is only one default for this function, called 'fields' and by default
2572  * is set to 'all'. There are other defaults that can be overridden in
2573  * {@link wp_get_object_terms()}.
2574  *
2575  * @package WordPress
2576  * @subpackage Post
2577  * @since 2.3.0
2578  *
2579  * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
2580  *
2581  * @param int $post_id Optional. The Post ID
2582  * @param array $args Optional. Overwrite the defaults
2583  * @return array List of post tags.
2584  */
2585 function wp_get_post_tags( $post_id = 0, $args = array() ) {
2586         return wp_get_post_terms( $post_id, 'post_tag', $args);
2587 }
2588
2589 /**
2590  * Retrieve the terms for a post.
2591  *
2592  * There is only one default for this function, called 'fields' and by default
2593  * is set to 'all'. There are other defaults that can be overridden in
2594  * {@link wp_get_object_terms()}.
2595  *
2596  * @package WordPress
2597  * @subpackage Post
2598  * @since 2.8.0
2599  *
2600  * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
2601  *
2602  * @param int $post_id Optional. The Post ID
2603  * @param string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag.
2604  * @param array $args Optional. Overwrite the defaults
2605  * @return array List of post tags.
2606  */
2607 function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
2608         $post_id = (int) $post_id;
2609
2610         $defaults = array('fields' => 'all');
2611         $args = wp_parse_args( $args, $defaults );
2612
2613         $tags = wp_get_object_terms($post_id, $taxonomy, $args);
2614
2615         return $tags;
2616 }
2617
2618 /**
2619  * Retrieve number of recent posts.
2620  *
2621  * @since 1.0.0
2622  * @uses wp_parse_args()
2623  * @uses get_posts()
2624  *
2625  * @param string $deprecated Deprecated.
2626  * @param array $args Optional. Overrides defaults.
2627  * @param string $output Optional.
2628  * @return unknown.
2629  */
2630 function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
2631
2632         if ( is_numeric( $args ) ) {
2633                 _deprecated_argument( __FUNCTION__, '3.1', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) );
2634                 $args = array( 'numberposts' => absint( $args ) );
2635         }
2636
2637         // Set default arguments
2638         $defaults = array(
2639                 'numberposts' => 10, 'offset' => 0,
2640                 'category' => 0, 'orderby' => 'post_date',
2641                 'order' => 'DESC', 'include' => '',
2642                 'exclude' => '', 'meta_key' => '',
2643                 'meta_value' =>'', 'post_type' => 'post', 'post_status' => 'draft, publish, future, pending, private',
2644                 'suppress_filters' => true
2645         );
2646
2647         $r = wp_parse_args( $args, $defaults );
2648
2649         $results = get_posts( $r );
2650
2651         // Backward compatibility. Prior to 3.1 expected posts to be returned in array
2652         if ( ARRAY_A == $output ){
2653                 foreach( $results as $key => $result ) {
2654                         $results[$key] = get_object_vars( $result );
2655                 }
2656                 return $results ? $results : array();
2657         }
2658
2659         return $results ? $results : false;
2660
2661 }
2662
2663 /**
2664  * Insert a post.
2665  *
2666  * If the $postarr parameter has 'ID' set to a value, then post will be updated.
2667  *
2668  * You can set the post date manually, but setting the values for 'post_date'
2669  * and 'post_date_gmt' keys. You can close the comments or open the comments by
2670  * setting the value for 'comment_status' key.
2671  *
2672  * The defaults for the parameter $postarr are:
2673  *     'post_status'   - Default is 'draft'.
2674  *     'post_type'     - Default is 'post'.
2675  *     'post_author'   - Default is current user ID ($user_ID). The ID of the user who added the post.
2676  *     'ping_status'   - Default is the value in 'default_ping_status' option.
2677  *                       Whether the attachment can accept pings.
2678  *     'post_parent'   - Default is 0. Set this for the post it belongs to, if any.
2679  *     'menu_order'    - Default is 0. The order it is displayed.
2680  *     'to_ping'       - Whether to ping.
2681  *     'pinged'        - Default is empty string.
2682  *     'post_password' - Default is empty string. The password to access the attachment.
2683  *     'guid'          - Global Unique ID for referencing the attachment.
2684  *     'post_content_filtered' - Post content filtered.
2685  *     'post_excerpt'  - Post excerpt.
2686  *
2687  * @since 1.0.0
2688  * @uses $wpdb
2689  * @uses $user_ID
2690  * @uses do_action() Calls 'pre_post_update' on post ID if this is an update.
2691  * @uses do_action() Calls 'edit_post' action on post ID and post data if this is an update.
2692  * @uses do_action() Calls 'save_post' and 'wp_insert_post' on post id and post data just before returning.
2693  * @uses apply_filters() Calls 'wp_insert_post_data' passing $data, $postarr prior to database update or insert.
2694  * @uses wp_transition_post_status()
2695  *
2696  * @param array $postarr Elements that make up post to insert.
2697  * @param bool $wp_error Optional. Allow return of WP_Error on failure.
2698  * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
2699  */
2700 function wp_insert_post($postarr, $wp_error = false) {
2701         global $wpdb, $user_ID;
2702
2703         $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID,
2704                 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
2705                 'menu_order' => 0, 'to_ping' =>  '', 'pinged' => '', 'post_password' => '',
2706                 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0,
2707                 'post_content' => '', 'post_title' => '');
2708
2709         $postarr = wp_parse_args($postarr, $defaults);
2710
2711         unset( $postarr[ 'filter' ] );
2712
2713         $postarr = sanitize_post($postarr, 'db');
2714
2715         // export array as variables
2716         extract($postarr, EXTR_SKIP);
2717
2718         // Are we updating or creating?
2719         $update = false;
2720         if ( !empty($ID) ) {
2721                 $update = true;
2722                 $previous_status = get_post_field('post_status', $ID);
2723         } else {
2724                 $previous_status = 'new';
2725         }
2726
2727         $maybe_empty = ! $post_content && ! $post_title && ! $post_excerpt && post_type_supports( $post_type, 'editor' )
2728                 && post_type_supports( $post_type, 'title' ) && post_type_supports( $post_type, 'excerpt' );
2729         if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) {
2730                 if ( $wp_error )
2731                         return new WP_Error( 'empty_content', __( 'Content, title, and excerpt are empty.' ) );
2732                 else
2733                         return 0;
2734         }
2735
2736         if ( empty($post_type) )
2737                 $post_type = 'post';
2738
2739         if ( empty($post_status) )
2740                 $post_status = 'draft';
2741
2742         if ( !empty($post_category) )
2743                 $post_category = array_filter($post_category); // Filter out empty terms
2744
2745         // Make sure we set a valid category.
2746         if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
2747                 // 'post' requires at least one category.
2748                 if ( 'post' == $post_type && 'auto-draft' != $post_status )
2749                         $post_category = array( get_option('default_category') );
2750                 else
2751                         $post_category = array();
2752         }
2753
2754         if ( empty($post_author) )
2755                 $post_author = $user_ID;
2756
2757         $post_ID = 0;
2758
2759         // Get the post ID and GUID
2760         if ( $update ) {
2761                 $post_ID = (int) $ID;
2762                 $guid = get_post_field( 'guid', $post_ID );
2763                 $post_before = get_post($post_ID);
2764         }
2765
2766         // Don't allow contributors to set the post slug for pending review posts
2767         if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) )
2768                 $post_name = '';
2769
2770         // Create a valid post name. Drafts and pending posts are allowed to have an empty
2771         // post name.
2772         if ( empty($post_name) ) {
2773                 if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2774                         $post_name = sanitize_title($post_title);
2775                 else
2776                         $post_name = '';
2777         } else {
2778                 // On updates, we need to check to see if it's using the old, fixed sanitization context.
2779                 $check_name = sanitize_title( $post_name, '', 'old-save' );
2780                 if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $ID ) == $check_name )
2781                         $post_name = $check_name;
2782                 else // new post, or slug has changed.
2783                         $post_name = sanitize_title($post_name);
2784         }
2785
2786         // If the post date is empty (due to having been new or a draft) and status is not 'draft' or 'pending', set date to now
2787         if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date )
2788                 $post_date = current_time('mysql');
2789
2790                 // validate the date
2791                 $mm = substr( $post_date, 5, 2 );
2792                 $jj = substr( $post_date, 8, 2 );
2793                 $aa = substr( $post_date, 0, 4 );
2794                 $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date );
2795                 if ( !$valid_date ) {
2796                         if ( $wp_error )
2797                                 return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) );
2798                         else
2799                                 return 0;
2800                 }
2801
2802         if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) {
2803                 if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2804                         $post_date_gmt = get_gmt_from_date($post_date);
2805                 else
2806                         $post_date_gmt = '0000-00-00 00:00:00';
2807         }
2808
2809         if ( $update || '0000-00-00 00:00:00' == $post_date ) {
2810                 $post_modified     = current_time( 'mysql' );
2811                 $post_modified_gmt = current_time( 'mysql', 1 );
2812         } else {
2813                 $post_modified     = $post_date;
2814                 $post_modified_gmt = $post_date_gmt;
2815         }
2816
2817         if ( 'publish' == $post_status ) {
2818                 $now = gmdate('Y-m-d H:i:59');
2819                 if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) )
2820                         $post_status = 'future';
2821         } elseif( 'future' == $post_status ) {
2822                 $now = gmdate('Y-m-d H:i:59');
2823                 if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) )
2824                         $post_status = 'publish';
2825         }
2826
2827         if ( empty($comment_status) ) {
2828                 if ( $update )
2829                         $comment_status = 'closed';
2830                 else
2831                         $comment_status = get_option('default_comment_status');
2832         }
2833         if ( empty($ping_status) )
2834                 $ping_status = get_option('default_ping_status');
2835
2836         if ( isset($to_ping) )
2837                 $to_ping = sanitize_trackback_urls( $to_ping );
2838         else
2839                 $to_ping = '';
2840
2841         if ( ! isset($pinged) )
2842                 $pinged = '';
2843
2844         if ( isset($post_parent) )
2845                 $post_parent = (int) $post_parent;
2846         else
2847                 $post_parent = 0;
2848
2849         // Check the post_parent to see if it will cause a hierarchy loop
2850         $post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr );
2851
2852         if ( isset($menu_order) )
2853                 $menu_order = (int) $menu_order;
2854         else
2855                 $menu_order = 0;
2856
2857         if ( !isset($post_password) || 'private' == $post_status )
2858                 $post_password = '';
2859
2860         $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
2861
2862         // expected_slashed (everything!)
2863         $data = compact( array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'guid' ) );
2864         $data = apply_filters('wp_insert_post_data', $data, $postarr);
2865         $data = stripslashes_deep( $data );
2866         $where = array( 'ID' => $post_ID );
2867
2868         if ( $update ) {
2869                 do_action( 'pre_post_update', $post_ID );
2870                 if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) {
2871                         if ( $wp_error )
2872                                 return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error);
2873                         else
2874                                 return 0;
2875                 }
2876         } else {
2877                 if ( isset($post_mime_type) )
2878                         $data['post_mime_type'] = stripslashes( $post_mime_type ); // This isn't in the update
2879                 // If there is a suggested ID, use it if not already present
2880                 if ( !empty($import_id) ) {
2881                         $import_id = (int) $import_id;
2882                         if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
2883                                 $data['ID'] = $import_id;
2884                         }
2885                 }
2886                 if ( false === $wpdb->insert( $wpdb->posts, $data ) ) {
2887                         if ( $wp_error )
2888                                 return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error);
2889                         else
2890                                 return 0;
2891                 }
2892                 $post_ID = (int) $wpdb->insert_id;
2893
2894                 // use the newly generated $post_ID
2895                 $where = array( 'ID' => $post_ID );
2896         }
2897
2898         if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) {
2899                 $data['post_name'] = sanitize_title($data['post_title'], $post_ID);
2900                 $wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where );
2901         }
2902
2903         if ( is_object_in_taxonomy($post_type, 'category') )
2904                 wp_set_post_categories( $post_ID, $post_category );
2905
2906         if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') )
2907                 wp_set_post_tags( $post_ID, $tags_input );
2908
2909         // new-style support for all custom taxonomies
2910         if ( !empty($tax_input) ) {
2911                 foreach ( $tax_input as $taxonomy => $tags ) {
2912                         $taxonomy_obj = get_taxonomy($taxonomy);
2913                         if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical.
2914                                 $tags = array_filter($tags);
2915                         if ( current_user_can($taxonomy_obj->cap->assign_terms) )
2916                                 wp_set_post_terms( $post_ID, $tags, $taxonomy );
2917                 }
2918         }
2919
2920         $current_guid = get_post_field( 'guid', $post_ID );
2921
2922         // Set GUID
2923         if ( !$update && '' == $current_guid )
2924                 $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where );
2925
2926         clean_post_cache( $post_ID );
2927
2928         $post = get_post($post_ID);
2929
2930         if ( !empty($page_template) && 'page' == $data['post_type'] ) {
2931                 $post->page_template = $page_template;
2932                 $page_templates = wp_get_theme()->get_page_templates();
2933                 if ( 'default' != $page_template && ! isset( $page_templates[ $page_template ] ) ) {
2934                         if ( $wp_error )
2935                                 return new WP_Error('invalid_page_template', __('The page template is invalid.'));
2936                         else
2937                                 return 0;
2938                 }
2939                 update_post_meta($post_ID, '_wp_page_template',  $page_template);
2940         }
2941
2942         wp_transition_post_status($data['post_status'], $previous_status, $post);
2943
2944         if ( $update ) {
2945                 do_action('edit_post', $post_ID, $post);
2946                 $post_after = get_post($post_ID);
2947                 do_action( 'post_updated', $post_ID, $post_after, $post_before);
2948         }
2949
2950         do_action('save_post', $post_ID, $post);
2951         do_action('wp_insert_post', $post_ID, $post);
2952
2953         return $post_ID;
2954 }
2955
2956 /**
2957  * Update a post with new post data.
2958  *
2959  * The date does not have to be set for drafts. You can set the date and it will
2960  * not be overridden.
2961  *
2962  * @since 1.0.0
2963  *
2964  * @param array|object $postarr Post data. Arrays are expected to be escaped, objects are not.
2965  * @param bool $wp_error Optional. Allow return of WP_Error on failure.
2966  * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
2967  */
2968 function wp_update_post( $postarr = array(), $wp_error = false ) {
2969         if ( is_object($postarr) ) {
2970                 // non-escaped post was passed
2971                 $postarr = get_object_vars($postarr);
2972                 $postarr = add_magic_quotes($postarr);
2973         }
2974
2975         // First, get all of the original fields
2976         $post = get_post($postarr['ID'], ARRAY_A);
2977
2978         // Escape data pulled from DB.
2979         $post = add_magic_quotes($post);
2980
2981         // Passed post category list overwrites existing category list if not empty.
2982         if ( isset($postarr['post_category']) && is_array($postarr['post_category'])
2983                          && 0 != count($postarr['post_category']) )
2984                 $post_cats = $postarr['post_category'];
2985         else
2986                 $post_cats = $post['post_category'];
2987
2988         // Drafts shouldn't be assigned a date unless explicitly done so by the user
2989         if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) &&
2990                          ('0000-00-00 00:00:00' == $post['post_date_gmt']) )
2991                 $clear_date = true;
2992         else
2993                 $clear_date = false;
2994
2995         // Merge old and new fields with new fields overwriting old ones.
2996         $postarr = array_merge($post, $postarr);
2997         $postarr['post_category'] = $post_cats;
2998         if ( $clear_date ) {
2999                 $postarr['post_date'] = current_time('mysql');
3000                 $postarr['post_date_gmt'] = '';
3001         }
3002
3003         if ($postarr['post_type'] == 'attachment')
3004                 return wp_insert_attachment($postarr);
3005
3006         return wp_insert_post( $postarr, $wp_error );
3007 }
3008
3009 /**
3010  * Publish a post by transitioning the post status.
3011  *
3012  * @since 2.1.0
3013  * @uses wp_update_post()
3014  *
3015  * @param mixed $post Post ID or object.
3016  */
3017 function wp_publish_post( $post ) {
3018         if ( ! $post = get_post( $post ) )
3019                 return;
3020         if ( 'publish' == $post->post_status )
3021                 return;
3022
3023         $post->post_status = 'publish';
3024         wp_update_post( $post );
3025 }
3026
3027 /**
3028  * Publish future post and make sure post ID has future post status.
3029  *
3030  * Invoked by cron 'publish_future_post' event. This safeguard prevents cron
3031  * from publishing drafts, etc.
3032  *
3033  * @since 2.5.0
3034  *
3035  * @param int $post_id Post ID.
3036  * @return null Nothing is returned. Which can mean that no action is required or post was published.
3037  */
3038 function check_and_publish_future_post($post_id) {
3039
3040         $post = get_post($post_id);
3041
3042         if ( empty($post) )
3043                 return;
3044
3045         if ( 'future' != $post->post_status )
3046                 return;
3047
3048         $time = strtotime( $post->post_date_gmt . ' GMT' );
3049
3050         if ( $time > time() ) { // Uh oh, someone jumped the gun!
3051                 wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
3052                 wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
3053                 return;
3054         }
3055
3056         return wp_publish_post($post_id);
3057 }
3058
3059 /**
3060  * Computes a unique slug for the post, when given the desired slug and some post details.
3061  *
3062  * @since 2.8.0
3063  *
3064  * @global wpdb $wpdb
3065  * @global WP_Rewrite $wp_rewrite
3066  * @param string $slug the desired slug (post_name)
3067  * @param integer $post_ID
3068  * @param string $post_status no uniqueness checks are made if the post is still draft or pending
3069  * @param string $post_type
3070  * @param integer $post_parent
3071  * @return string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
3072  */
3073 function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) {
3074         if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
3075                 return $slug;
3076
3077         global $wpdb, $wp_rewrite;
3078
3079         $original_slug = $slug;
3080
3081         $feeds = $wp_rewrite->feeds;
3082         if ( ! is_array( $feeds ) )
3083                 $feeds = array();
3084
3085         $hierarchical_post_types = get_post_types( array('hierarchical' => true) );
3086         if ( 'attachment' == $post_type ) {
3087                 // Attachment slugs must be unique across all types.
3088                 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND ID != %d LIMIT 1";
3089                 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) );
3090
3091                 if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) {
3092                         $suffix = 2;
3093                         do {
3094                                 $alt_post_name = substr ($slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3095                                 $post_name_check = $wpdb->get_var( $wpdb->prepare($check_sql, $alt_post_name, $post_ID ) );
3096                                 $suffix++;
3097                         } while ( $post_name_check );
3098                         $slug = $alt_post_name;
3099                 }
3100         } elseif ( in_array( $post_type, $hierarchical_post_types ) ) {
3101                 if ( 'nav_menu_item' == $post_type )
3102                         return $slug;
3103                 // Page slugs must be unique within their own trees. Pages are in a separate
3104                 // namespace than posts so page slugs are allowed to overlap post slugs.
3105                 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type IN ( '" . implode( "', '", esc_sql( $hierarchical_post_types ) ) . "' ) AND ID != %d AND post_parent = %d LIMIT 1";
3106                 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID, $post_parent ) );
3107
3108                 if ( $post_name_check || in_array( $slug, $feeds ) || preg_match( "@^($wp_rewrite->pagination_base)?\d+$@", $slug )  || apply_filters( 'wp_unique_post_slug_is_bad_hierarchical_slug', false, $slug, $post_type, $post_parent ) ) {
3109                         $suffix = 2;
3110                         do {
3111                                 $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3112                                 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID, $post_parent ) );
3113                                 $suffix++;
3114                         } while ( $post_name_check );
3115                         $slug = $alt_post_name;
3116                 }
3117         } else {
3118                 // Post slugs must be unique across all posts.
3119                 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d LIMIT 1";
3120                 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID ) );
3121
3122                 if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) {
3123                         $suffix = 2;
3124                         do {
3125                                 $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3126                                 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID ) );
3127                                 $suffix++;
3128                         } while ( $post_name_check );
3129                         $slug = $alt_post_name;
3130                 }
3131         }
3132
3133         return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug );
3134 }
3135
3136 /**
3137  * Adds tags to a post.
3138  *
3139  * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true.
3140  *
3141  * @package WordPress
3142  * @subpackage Post
3143  * @since 2.3.0
3144  *
3145  * @param int $post_id Post ID
3146  * @param string $tags The tags to set for the post, separated by commas.
3147  * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise
3148  */
3149 function wp_add_post_tags($post_id = 0, $tags = '') {
3150         return wp_set_post_tags($post_id, $tags, true);
3151 }
3152
3153 /**
3154  * Set the tags for a post.
3155  *
3156  * @since 2.3.0
3157  * @uses wp_set_object_terms() Sets the tags for the post.
3158  *
3159  * @param int $post_id Post ID.
3160  * @param string $tags The tags to set for the post, separated by commas.
3161  * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
3162  * @return mixed Array of affected term IDs. WP_Error or false on failure.
3163  */
3164 function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
3165         return wp_set_post_terms( $post_id, $tags, 'post_tag', $append);
3166 }
3167
3168 /**
3169  * Set the terms for a post.
3170  *
3171  * @since 2.8.0
3172  * @uses wp_set_object_terms() Sets the tags for the post.
3173  *
3174  * @param int $post_id Post ID.
3175  * @param string $tags The tags to set for the post, separated by commas.
3176  * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'.
3177  * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
3178  * @return mixed Array of affected term IDs. WP_Error or false on failure.
3179  */
3180 function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
3181         $post_id = (int) $post_id;
3182
3183         if ( !$post_id )
3184                 return false;
3185
3186         if ( empty($tags) )
3187                 $tags = array();
3188
3189         if ( ! is_array( $tags ) ) {
3190                 $comma = _x( ',', 'tag delimiter' );
3191                 if ( ',' !== $comma )
3192                         $tags = str_replace( $comma, ',', $tags );
3193                 $tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) );
3194         }
3195
3196         // Hierarchical taxonomies must always pass IDs rather than names so that children with the same
3197         // names but different parents aren't confused.
3198         if ( is_taxonomy_hierarchical( $taxonomy ) ) {
3199                 $tags = array_unique( array_map( 'intval', $tags ) );
3200         }
3201
3202         return wp_set_object_terms( $post_id, $tags, $taxonomy, $append );
3203 }
3204
3205 /**
3206  * Set categories for a post.
3207  *
3208  * If the post categories parameter is not set, then the default category is
3209  * going used.
3210  *
3211  * @since 2.1.0
3212  *
3213  * @param int $post_ID Post ID.
3214  * @param array $post_categories Optional. List of categories.
3215  * @return bool|mixed
3216  */
3217 function wp_set_post_categories($post_ID = 0, $post_categories = array()) {
3218         $post_ID = (int) $post_ID;
3219         $post_type = get_post_type( $post_ID );
3220         $post_status = get_post_status( $post_ID );
3221         // If $post_categories isn't already an array, make it one:
3222         if ( !is_array($post_categories) || empty($post_categories) ) {
3223                 if ( 'post' == $post_type && 'auto-draft' != $post_status )
3224                         $post_categories = array( get_option('default_category') );
3225                 else
3226                         $post_categories = array();
3227         } else if ( 1 == count($post_categories) && '' == reset($post_categories) ) {
3228                 return true;
3229         }
3230
3231         return wp_set_post_terms($post_ID, $post_categories, 'category');
3232 }
3233
3234 /**
3235  * Transition the post status of a post.
3236  *
3237  * Calls hooks to transition post status.
3238  *
3239  * The first is 'transition_post_status' with new status, old status, and post data.
3240  *
3241  * The next action called is 'OLDSTATUS_to_NEWSTATUS' the 'NEWSTATUS' is the
3242  * $new_status parameter and the 'OLDSTATUS' is $old_status parameter; it has the
3243  * post data.
3244  *
3245  * The final action is named 'NEWSTATUS_POSTTYPE', 'NEWSTATUS' is from the $new_status
3246  * parameter and POSTTYPE is post_type post data.
3247  *
3248  * @since 2.3.0
3249  * @link http://codex.wordpress.org/Post_Status_Transitions
3250  *
3251  * @uses do_action() Calls 'transition_post_status' on $new_status, $old_status and
3252  *  $post if there is a status change.
3253  * @uses do_action() Calls '{$old_status}_to_{$new_status}' on $post if there is a status change.
3254  * @uses do_action() Calls '{$new_status}_{$post->post_type}' on post ID and $post.
3255  *
3256  * @param string $new_status Transition to this post status.
3257  * @param string $old_status Previous post status.
3258  * @param object $post Post data.
3259  */
3260 function wp_transition_post_status($new_status, $old_status, $post) {
3261         do_action('transition_post_status', $new_status, $old_status, $post);
3262         do_action("{$old_status}_to_{$new_status}", $post);
3263         do_action("{$new_status}_{$post->post_type}", $post->ID, $post);
3264 }
3265
3266 //
3267 // Trackback and ping functions
3268 //
3269
3270 /**
3271  * Add a URL to those already pung.
3272  *
3273  * @since 1.5.0
3274  * @uses $wpdb
3275  *
3276  * @param int $post_id Post ID.
3277  * @param string $uri Ping URI.
3278  * @return int How many rows were updated.
3279  */
3280 function add_ping($post_id, $uri) {
3281         global $wpdb;
3282         $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
3283         $pung = trim($pung);
3284         $pung = preg_split('/\s/', $pung);
3285         $pung[] = $uri;
3286         $new = implode("\n", $pung);
3287         $new = apply_filters('add_ping', $new);
3288         // expected_slashed ($new)
3289         $new = stripslashes($new);
3290         return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) );
3291 }
3292
3293 /**
3294  * Retrieve enclosures already enclosed for a post.
3295  *
3296  * @since 1.5.0
3297  * @uses $wpdb
3298  *
3299  * @param int $post_id Post ID.
3300  * @return array List of enclosures
3301  */
3302 function get_enclosed($post_id) {
3303         $custom_fields = get_post_custom( $post_id );
3304         $pung = array();
3305         if ( !is_array( $custom_fields ) )
3306                 return $pung;
3307
3308         foreach ( $custom_fields as $key => $val ) {
3309                 if ( 'enclosure' != $key || !is_array( $val ) )
3310                         continue;
3311                 foreach( $val as $enc ) {
3312                         $enclosure = explode( "\n", $enc );
3313                         $pung[] = trim( $enclosure[ 0 ] );
3314                 }
3315         }
3316         $pung = apply_filters('get_enclosed', $pung, $post_id);
3317         return $pung;
3318 }
3319
3320 /**
3321  * Retrieve URLs already pinged for a post.
3322  *
3323  * @since 1.5.0
3324  * @uses $wpdb
3325  *
3326  * @param int $post_id Post ID.
3327  * @return array
3328  */
3329 function get_pung($post_id) {
3330         global $wpdb;
3331         $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
3332         $pung = trim($pung);
3333         $pung = preg_split('/\s/', $pung);
3334         $pung = apply_filters('get_pung', $pung);
3335         return $pung;
3336 }
3337
3338 /**
3339  * Retrieve URLs that need to be pinged.
3340  *
3341  * @since 1.5.0
3342  * @uses $wpdb
3343  *
3344  * @param int $post_id Post ID
3345  * @return array
3346  */
3347 function get_to_ping($post_id) {
3348         global $wpdb;
3349         $to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id ));
3350         $to_ping = sanitize_trackback_urls( $to_ping );
3351         $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY);
3352         $to_ping = apply_filters('get_to_ping',  $to_ping);
3353         return $to_ping;
3354 }
3355
3356 /**
3357  * Do trackbacks for a list of URLs.
3358  *
3359  * @since 1.0.0
3360  *
3361  * @param string $tb_list Comma separated list of URLs
3362  * @param int $post_id Post ID
3363  */
3364 function trackback_url_list($tb_list, $post_id) {
3365         if ( ! empty( $tb_list ) ) {
3366                 // get post data
3367                 $postdata = get_post($post_id, ARRAY_A);
3368
3369                 // import postdata as variables
3370                 extract($postdata, EXTR_SKIP);
3371
3372                 // form an excerpt
3373                 $excerpt = strip_tags($post_excerpt ? $post_excerpt : $post_content);
3374
3375                 if (strlen($excerpt) > 255) {
3376                         $excerpt = substr($excerpt,0,252) . '...';
3377                 }
3378
3379                 $trackback_urls = explode(',', $tb_list);
3380                 foreach( (array) $trackback_urls as $tb_url) {
3381                         $tb_url = trim($tb_url);
3382                         trackback($tb_url, stripslashes($post_title), $excerpt, $post_id);
3383                 }
3384         }
3385 }
3386
3387 //
3388 // Page functions
3389 //
3390
3391 /**
3392  * Get a list of page IDs.
3393  *
3394  * @since 2.0.0
3395  * @uses $wpdb
3396  *
3397  * @return array List of page IDs.
3398  */
3399 function get_all_page_ids() {
3400         global $wpdb;
3401
3402         $page_ids = wp_cache_get('all_page_ids', 'posts');
3403         if ( ! is_array( $page_ids ) ) {
3404                 $page_ids = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE post_type = 'page'");
3405                 wp_cache_add('all_page_ids', $page_ids, 'posts');
3406         }
3407
3408         return $page_ids;
3409 }
3410
3411 /**
3412  * Retrieves page data given a page ID or page object.
3413  *
3414  * Use get_post() instead of get_page().
3415  *
3416  * @since 1.5.1
3417  * @deprecated 3.5.0
3418  *
3419  * @param mixed $page Page object or page ID. Passed by reference.
3420  * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N.
3421  * @param string $filter How the return value should be filtered.
3422  * @return WP_Post|null WP_Post on success or null on failure
3423  */
3424 function get_page( $page, $output = OBJECT, $filter = 'raw') {
3425         return get_post( $page, $output, $filter );
3426 }
3427
3428 /**
3429  * Retrieves a page given its path.
3430  *
3431  * @since 2.1.0
3432  * @uses $wpdb
3433  *
3434  * @param string $page_path Page path
3435  * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
3436  * @param string $post_type Optional. Post type. Default page.
3437  * @return WP_Post|null WP_Post on success or null on failure
3438  */
3439 function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') {
3440         global $wpdb;
3441
3442         $page_path = rawurlencode(urldecode($page_path));
3443         $page_path = str_replace('%2F', '/', $page_path);
3444         $page_path = str_replace('%20', ' ', $page_path);
3445         $parts = explode( '/', trim( $page_path, '/' ) );
3446         $parts = array_map( 'esc_sql', $parts );
3447         $parts = array_map( 'sanitize_title_for_query', $parts );
3448
3449         $in_string = "'". implode( "','", $parts ) . "'";
3450         $post_type_sql = $post_type;
3451         $wpdb->escape_by_ref( $post_type_sql );
3452         $pages = $wpdb->get_results( "SELECT ID, post_name, post_parent, post_type FROM $wpdb->posts WHERE post_name IN ($in_string) AND (post_type = '$post_type_sql' OR post_type = 'attachment')", OBJECT_K );
3453
3454         $revparts = array_reverse( $parts );
3455
3456         $foundid = 0;
3457         foreach ( (array) $pages as $page ) {
3458                 if ( $page->post_name == $revparts[0] ) {
3459                         $count = 0;
3460                         $p = $page;
3461                         while ( $p->post_parent != 0 && isset( $pages[ $p->post_parent ] ) ) {
3462                                 $count++;
3463                                 $parent = $pages[ $p->post_parent ];
3464                                 if ( ! isset( $revparts[ $count ] ) || $parent->post_name != $revparts[ $count ] )
3465                                         break;
3466                                 $p = $parent;
3467                         }
3468
3469                         if ( $p->post_parent == 0 && $count+1 == count( $revparts ) && $p->post_name == $revparts[ $count ] ) {
3470                                 $foundid = $page->ID;
3471                                 if ( $page->post_type == $post_type )
3472                                         break;
3473                         }
3474                 }
3475         }
3476
3477         if ( $foundid )
3478                 return get_post( $foundid, $output );
3479
3480         return null;
3481 }
3482
3483 /**
3484  * Retrieve a page given its title.
3485  *
3486  * @since 2.1.0
3487  * @uses $wpdb
3488  *
3489  * @param string $page_title Page title
3490  * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
3491  * @param string $post_type Optional. Post type. Default page.
3492  * @return WP_Post|null WP_Post on success or null on failure
3493  */
3494 function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) {
3495         global $wpdb;
3496         $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type= %s", $page_title, $post_type ) );
3497         if ( $page )
3498                 return get_post( $page, $output );
3499
3500         return null;
3501 }
3502
3503 /**
3504  * Retrieve child pages from list of pages matching page ID.
3505  *
3506  * Matches against the pages parameter against the page ID. Also matches all
3507  * children for the same to retrieve all children of a page. Does not make any
3508  * SQL queries to get the children.
3509  *
3510  * @since 1.5.1
3511  *
3512  * @param int $page_id Page ID.
3513  * @param array $pages List of pages' objects.
3514  * @return array
3515  */
3516 function get_page_children($page_id, $pages) {
3517         $page_list = array();
3518         foreach ( (array) $pages as $page ) {
3519                 if ( $page->post_parent == $page_id ) {
3520                         $page_list[] = $page;
3521                         if ( $children = get_page_children($page->ID, $pages) )
3522                                 $page_list = array_merge($page_list, $children);
3523                 }
3524         }
3525         return $page_list;
3526 }
3527
3528 /**
3529  * Order the pages with children under parents in a flat list.
3530  *
3531  * It uses auxiliary structure to hold parent-children relationships and
3532  * runs in O(N) complexity
3533  *
3534  * @since 2.0.0
3535  *
3536  * @param array $pages Posts array.
3537  * @param int $page_id Parent page ID.
3538  * @return array A list arranged by hierarchy. Children immediately follow their parents.
3539  */
3540 function get_page_hierarchy( &$pages, $page_id = 0 ) {
3541         if ( empty( $pages ) ) {
3542                 $result = array();
3543                 return $result;
3544         }
3545
3546         $children = array();
3547         foreach ( (array) $pages as $p ) {
3548                 $parent_id = intval( $p->post_parent );
3549                 $children[ $parent_id ][] = $p;
3550         }
3551
3552         $result = array();
3553         _page_traverse_name( $page_id, $children, $result );
3554
3555         return $result;
3556 }
3557
3558 /**
3559  * function to traverse and return all the nested children post names of a root page.
3560  * $children contains parent-children relations
3561  *
3562  * @since 2.9.0
3563  */
3564 function _page_traverse_name( $page_id, &$children, &$result ){
3565         if ( isset( $children[ $page_id ] ) ){
3566                 foreach( (array)$children[ $page_id ] as $child ) {
3567                         $result[ $child->ID ] = $child->post_name;
3568                         _page_traverse_name( $child->ID, $children, $result );
3569                 }
3570         }
3571 }
3572
3573 /**
3574  * Builds URI for a page.
3575  *
3576  * Sub pages will be in the "directory" under the parent page post name.
3577  *
3578  * @since 1.5.0
3579  *
3580  * @param mixed $page Page object or page ID.
3581  * @return string Page URI.
3582  */
3583 function get_page_uri($page) {
3584         if ( ! is_object($page) )
3585                 $page = get_post( $page );
3586         $uri = $page->post_name;
3587
3588         foreach ( $page->ancestors as $parent ) {
3589                 $uri = get_post( $parent )->post_name . "/" . $uri;
3590         }
3591
3592         return $uri;
3593 }
3594
3595 /**
3596  * Retrieve a list of pages.
3597  *
3598  * The defaults that can be overridden are the following: 'child_of',
3599  * 'sort_order', 'sort_column', 'post_title', 'hierarchical', 'exclude',
3600  * 'include', 'meta_key', 'meta_value','authors', 'number', and 'offset'.
3601  *
3602  * @since 1.5.0
3603  * @uses $wpdb
3604  *
3605  * @param mixed $args Optional. Array or string of options that overrides defaults.
3606  * @return array List of pages matching defaults or $args
3607  */
3608 function get_pages($args = '') {
3609         global $wpdb;
3610
3611         $pages = false;
3612
3613         $defaults = array(
3614                 'child_of' => 0, 'sort_order' => 'ASC',
3615                 'sort_column' => 'post_title', 'hierarchical' => 1,
3616                 'exclude' => array(), 'include' => array(),
3617                 'meta_key' => '', 'meta_value' => '',
3618                 'authors' => '', 'parent' => -1, 'exclude_tree' => '',
3619                 'number' => '', 'offset' => 0,
3620                 'post_type' => 'page', 'post_status' => 'publish',
3621         );
3622
3623         $r = wp_parse_args( $args, $defaults );
3624         extract( $r, EXTR_SKIP );
3625         $number = (int) $number;
3626         $offset = (int) $offset;
3627
3628         // Make sure the post type is hierarchical
3629         $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
3630         if ( !in_array( $post_type, $hierarchical_post_types ) )
3631                 return $pages;
3632
3633         // Make sure we have a valid post status
3634         if ( !is_array( $post_status ) )
3635                 $post_status = explode( ',', $post_status );
3636         if ( array_diff( $post_status, get_post_stati() ) )
3637                 return $pages;
3638
3639         $cache = array();
3640         $key = md5( serialize( compact(array_keys($defaults)) ) );
3641         if ( $cache = wp_cache_get( 'get_pages', 'posts' ) ) {
3642                 if ( is_array($cache) && isset( $cache[ $key ] ) && is_array( $cache[ $key ] ) ) {
3643                         // Convert to WP_Post instances
3644                         $pages = array_map( 'get_post', $cache[ $key ] );
3645                         $pages = apply_filters( 'get_pages', $pages, $r );
3646                         return $pages;
3647                 }
3648         }
3649
3650         if ( !is_array($cache) )
3651                 $cache = array();
3652
3653         $inclusions = '';
3654         if ( !empty($include) ) {
3655                 $child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
3656                 $parent = -1;
3657                 $exclude = '';
3658                 $meta_key = '';
3659                 $meta_value = '';
3660                 $hierarchical = false;
3661                 $incpages = wp_parse_id_list( $include );
3662                 if ( ! empty( $incpages ) ) {
3663                         foreach ( $incpages as $incpage ) {
3664                                 if (empty($inclusions))
3665                                         $inclusions = $wpdb->prepare(' AND ( ID = %d ', $incpage);
3666                                 else
3667                                         $inclusions .= $wpdb->prepare(' OR ID = %d ', $incpage);
3668                         }
3669                 }
3670         }
3671         if (!empty($inclusions))
3672                 $inclusions .= ')';
3673
3674         $exclusions = '';
3675         if ( !empty($exclude) ) {
3676                 $expages = wp_parse_id_list( $exclude );
3677                 if ( ! empty( $expages ) ) {
3678                         foreach ( $expages as $expage ) {
3679                                 if (empty($exclusions))
3680                                         $exclusions = $wpdb->prepare(' AND ( ID <> %d ', $expage);
3681                                 else
3682                                         $exclusions .= $wpdb->prepare(' AND ID <> %d ', $expage);
3683                         }
3684                 }
3685         }
3686         if (!empty($exclusions))
3687                 $exclusions .= ')';
3688
3689         $author_query = '';
3690         if (!empty($authors)) {
3691                 $post_authors = preg_split('/[\s,]+/',$authors);
3692
3693                 if ( ! empty( $post_authors ) ) {
3694                         foreach ( $post_authors as $post_author ) {
3695                                 //Do we have an author id or an author login?
3696                                 if ( 0 == intval($post_author) ) {
3697                                         $post_author = get_user_by('login', $post_author);
3698                                         if ( empty($post_author) )
3699                                                 continue;
3700                                         if ( empty($post_author->ID) )
3701                                                 continue;
3702                                         $post_author = $post_author->ID;
3703                                 }
3704
3705                                 if ( '' == $author_query )
3706                                         $author_query = $wpdb->prepare(' post_author = %d ', $post_author);
3707                                 else
3708                                         $author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author);
3709                         }
3710                         if ( '' != $author_query )
3711                                 $author_query = " AND ($author_query)";
3712                 }
3713         }
3714
3715         $join = '';
3716         $where = "$exclusions $inclusions ";
3717         if ( ! empty( $meta_key ) || ! empty( $meta_value ) ) {
3718                 $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )";
3719
3720                 // meta_key and meta_value might be slashed
3721                 $meta_key = stripslashes($meta_key);
3722                 $meta_value = stripslashes($meta_value);
3723                 if ( ! empty( $meta_key ) )
3724                         $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key);
3725                 if ( ! empty( $meta_value ) )
3726                         $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value);
3727
3728         }
3729
3730         if ( $parent >= 0 )
3731                 $where .= $wpdb->prepare(' AND post_parent = %d ', $parent);
3732
3733         if ( 1 == count( $post_status ) ) {
3734                 $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $post_type, array_shift( $post_status ) );
3735         } else {
3736                 $post_status = implode( "', '", $post_status );
3737                 $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $post_type );
3738         }
3739
3740         $orderby_array = array();
3741         $allowed_keys = array('author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified',
3742                                                   'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent',
3743                                                   'ID', 'rand', 'comment_count');
3744         foreach ( explode( ',', $sort_column ) as $orderby ) {
3745                 $orderby = trim( $orderby );
3746                 if ( !in_array( $orderby, $allowed_keys ) )
3747                         continue;
3748
3749                 switch ( $orderby ) {
3750                         case 'menu_order':
3751                                 break;
3752                         case 'ID':
3753                                 $orderby = "$wpdb->posts.ID";
3754                                 break;
3755                         case 'rand':
3756                                 $orderby = 'RAND()';
3757                                 break;
3758                         case 'comment_count':
3759                                 $orderby = "$wpdb->posts.comment_count";
3760                                 break;
3761                         default:
3762                                 if ( 0 === strpos( $orderby, 'post_' ) )
3763                                         $orderby = "$wpdb->posts." . $orderby;
3764                                 else
3765                                         $orderby = "$wpdb->posts.post_" . $orderby;
3766                 }
3767
3768                 $orderby_array[] = $orderby;
3769
3770         }
3771         $sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title";
3772
3773         $sort_order = strtoupper( $sort_order );
3774         if ( '' !== $sort_order && !in_array( $sort_order, array( 'ASC', 'DESC' ) ) )
3775                 $sort_order = 'ASC';
3776
3777         $query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where ";
3778         $query .= $author_query;
3779         $query .= " ORDER BY " . $sort_column . " " . $sort_order ;
3780
3781         if ( !empty($number) )
3782                 $query .= ' LIMIT ' . $offset . ',' . $number;
3783
3784         $pages = $wpdb->get_results($query);
3785
3786         if ( empty($pages) ) {
3787                 $pages = apply_filters('get_pages', array(), $r);
3788                 return $pages;
3789         }
3790
3791         // Sanitize before caching so it'll only get done once
3792         $num_pages = count($pages);
3793         for ($i = 0; $i < $num_pages; $i++) {
3794                 $pages[$i] = sanitize_post($pages[$i], 'raw');
3795         }
3796
3797         // Update cache.
3798         update_post_cache( $pages );
3799
3800         if ( $child_of || $hierarchical )
3801                 $pages = get_page_children($child_of, $pages);
3802
3803         if ( !empty($exclude_tree) ) {
3804                 $exclude = (int) $exclude_tree;
3805                 $children = get_page_children($exclude, $pages);
3806                 $excludes = array();
3807                 foreach ( $children as $child )
3808                         $excludes[] = $child->ID;
3809                 $excludes[] = $exclude;
3810                 $num_pages = count($pages);
3811                 for ( $i = 0; $i < $num_pages; $i++ ) {
3812                         if ( in_array($pages[$i]->ID, $excludes) )
3813                                 unset($pages[$i]);
3814                 }
3815         }
3816
3817         $cache[ $key ] = $pages;
3818         wp_cache_set( 'get_pages', $cache, 'posts' );
3819
3820         // Convert to WP_Post instances
3821         $pages = array_map( 'get_post', $pages );
3822
3823         $pages = apply_filters('get_pages', $pages, $r);
3824
3825         return $pages;
3826 }
3827
3828 //
3829 // Attachment functions
3830 //
3831
3832 /**
3833  * Check if the attachment URI is local one and is really an attachment.
3834  *
3835  * @since 2.0.0
3836  *
3837  * @param string $url URL to check
3838  * @return bool True on success, false on failure.
3839  */
3840 function is_local_attachment($url) {
3841         if (strpos($url, home_url()) === false)
3842                 return false;
3843         if (strpos($url, home_url('/?attachment_id=')) !== false)
3844                 return true;
3845         if ( $id = url_to_postid($url) ) {
3846                 $post = get_post($id);
3847                 if ( 'attachment' == $post->post_type )
3848                         return true;
3849         }
3850         return false;
3851 }
3852
3853 /**
3854  * Insert an attachment.
3855  *
3856  * If you set the 'ID' in the $object parameter, it will mean that you are
3857  * updating and attempt to update the attachment. You can also set the
3858  * attachment name or title by setting the key 'post_name' or 'post_title'.
3859  *
3860  * You can set the dates for the attachment manually by setting the 'post_date'