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