Make WordPress Core

source: trunk/src/wp-includes/post.php @ 32545

Last change on this file since 32545 was 32545, checked in by wonderboymusic, 7 years ago

When calling unset(), it is unnecessary to immediately precede it with a call to isset().

See #32444.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 189.2 KB
<
Line 
1<?php
2/**
3 * Post functions and post utility function.
4 *
5 * @package WordPress
6 * @subpackage Post
7 * @since 1.5.0
8 */
9
10//
11// Post Type Registration
12//
13
14/**
15 * Creates the initial post types when 'init' action is fired.
16 *
17 * @since 2.9.0
18 */
19function create_initial_post_types() {
20        register_post_type( 'post', array(
21                'labels' => array(
22                        'name_admin_bar' => _x( 'Post', 'add new on admin bar' ),
23                ),
24                'public'  => true,
25                '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
26                '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
27                'capability_type' => 'post',
28                'map_meta_cap' => true,
29                'hierarchical' => false,
30                'rewrite' => false,
31                'query_var' => false,
32                'delete_with_user' => true,
33                'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ),
34        ) );
35
36        register_post_type( 'page', array(
37                'labels' => array(
38                        'name_admin_bar' => _x( 'Page', 'add new on admin bar' ),
39                ),
40                'public' => true,
41                'publicly_queryable' => false,
42                '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
43                '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
44                'capability_type' => 'page',
45                'map_meta_cap' => true,
46                'hierarchical' => true,
47                'rewrite' => false,
48                'query_var' => false,
49                'delete_with_user' => true,
50                'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ),
51        ) );
52
53        register_post_type( 'attachment', array(
54                'labels' => array(
55                        'name' => _x('Media', 'post type general name'),
56                        'name_admin_bar' => _x( 'Media', 'add new from admin bar' ),
57                        'add_new' => _x( 'Add New', 'add new media' ),
58                        'edit_item' => __( 'Edit Media' ),
59                        'view_item' => __( 'View Attachment Page' ),
60                ),
61                'public' => true,
62                'show_ui' => true,
63                '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
64                '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
65                'capability_type' => 'post',
66                'capabilities' => array(
67                        'create_posts' => 'upload_files',
68                ),
69                'map_meta_cap' => true,
70                'hierarchical' => false,
71                'rewrite' => false,
72                'query_var' => false,
73                'show_in_nav_menus' => false,
74                'delete_with_user' => true,
75                'supports' => array( 'title', 'author', 'comments' ),
76        ) );
77        add_post_type_support( 'attachment:audio', 'thumbnail' );
78        add_post_type_support( 'attachment:video', 'thumbnail' );
79
80        register_post_type( 'revision', array(
81                'labels' => array(
82                        'name' => __( 'Revisions' ),
83                        'singular_name' => __( 'Revision' ),
84                ),
85                'public' => false,
86                '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
87                '_edit_link' => 'revision.php?revision=%d', /* internal use only. don't use this when registering your own post type. */
88                'capability_type' => 'post',
89                'map_meta_cap' => true,
90                'hierarchical' => false,
91                'rewrite' => false,
92                'query_var' => false,
93                'can_export' => false,
94                'delete_with_user' => true,
95                'supports' => array( 'author' ),
96        ) );
97
98        register_post_type( 'nav_menu_item', array(
99                'labels' => array(
100                        'name' => __( 'Navigation Menu Items' ),
101                        'singular_name' => __( 'Navigation Menu Item' ),
102                ),
103                'public' => false,
104                '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
105                'hierarchical' => false,
106                'rewrite' => false,
107                'delete_with_user' => false,
108                'query_var' => false,
109        ) );
110
111        register_post_status( 'publish', array(
112                'label'       => _x( 'Published', 'post' ),
113                'public'      => true,
114                '_builtin'    => true, /* internal use only. */
115                'label_count' => _n_noop( 'Published <span class="count">(%s)</span>', 'Published <span class="count">(%s)</span>' ),
116        ) );
117
118        register_post_status( 'future', array(
119                'label'       => _x( 'Scheduled', 'post' ),
120                'protected'   => true,
121                '_builtin'    => true, /* internal use only. */
122                'label_count' => _n_noop('Scheduled <span class="count">(%s)</span>', 'Scheduled <span class="count">(%s)</span>' ),
123        ) );
124
125        register_post_status( 'draft', array(
126                'label'       => _x( 'Draft', 'post' ),
127                'protected'   => true,
128                '_builtin'    => true, /* internal use only. */
129                'label_count' => _n_noop( 'Draft <span class="count">(%s)</span>', 'Drafts <span class="count">(%s)</span>' ),
130        ) );
131
132        register_post_status( 'pending', array(
133                'label'       => _x( 'Pending', 'post' ),
134                'protected'   => true,
135                '_builtin'    => true, /* internal use only. */
136                'label_count' => _n_noop( 'Pending <span class="count">(%s)</span>', 'Pending <span class="count">(%s)</span>' ),
137        ) );
138
139        register_post_status( 'private', array(
140                'label'       => _x( 'Private', 'post' ),
141                'private'     => true,
142                '_builtin'    => true, /* internal use only. */
143                'label_count' => _n_noop( 'Private <span class="count">(%s)</span>', 'Private <span class="count">(%s)</span>' ),
144        ) );
145
146        register_post_status( 'trash', array(
147                'label'       => _x( 'Trash', 'post' ),
148                'internal'    => true,
149                '_builtin'    => true, /* internal use only. */
150                'label_count' => _n_noop( 'Trash <span class="count">(%s)</span>', 'Trash <span class="count">(%s)</span>' ),
151                'show_in_admin_status_list' => true,
152        ) );
153
154        register_post_status( 'auto-draft', array(
155                'label'    => 'auto-draft',
156                'internal' => true,
157                '_builtin' => true, /* internal use only. */
158        ) );
159
160        register_post_status( 'inherit', array(
161                'label'    => 'inherit',
162                'internal' => true,
163                '_builtin' => true, /* internal use only. */
164                'exclude_from_search' => false,
165        ) );
166}
167
168/**
169 * Retrieve attached file path based on attachment ID.
170 *
171 * By default the path will go through the 'get_attached_file' filter, but
172 * passing a true to the $unfiltered argument of get_attached_file() will
173 * return the file path unfiltered.
174 *
175 * The function works by getting the single post meta name, named
176 * '_wp_attached_file' and returning it. This is a convenience function to
177 * prevent looking up the meta name and provide a mechanism for sending the
178 * attached filename through a filter.
179 *
180 * @since 2.0.0
181 *
182 * @param int  $attachment_id Attachment ID.
183 * @param bool $unfiltered    Optional. Whether to apply filters. Default false.
184 * @return string|bool The file path to where the attached file should be, false otherwise.
185 */
186function get_attached_file( $attachment_id, $unfiltered = false ) {
187        $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
188        // If the file is relative, prepend upload dir.
189        if ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) )
190                $file = $uploads['basedir'] . "/$file";
191        if ( $unfiltered )
192                return $file;
193
194        /**
195         * Filter the attached file based on the given ID.
196         *
197         * @since 2.1.0
198         *
199         * @param string $file          Path to attached file.
200         * @param int    $attachment_id Attachment ID.
201         */
202        return apply_filters( 'get_attached_file', $file, $attachment_id );
203}
204
205/**
206 * Update attachment file path based on attachment ID.
207 *
208 * Used to update the file path of the attachment, which uses post meta name
209 * '_wp_attached_file' to store the path of the attachment.
210 *
211 * @since 2.1.0
212 *
213 * @param int    $attachment_id Attachment ID.
214 * @param string $file          File path for the attachment.
215 * @return bool True on success, false on failure.
216 */
217function update_attached_file( $attachment_id, $file ) {
218        if ( !get_post( $attachment_id ) )
219                return false;
220
221        /**
222         * Filter the path to the attached file to update.
223         *
224         * @since 2.1.0
225         *
226         * @param string $file          Path to the attached file to update.
227         * @param int    $attachment_id Attachment ID.
228         */
229        $file = apply_filters( 'update_attached_file', $file, $attachment_id );
230
231        if ( $file = _wp_relative_upload_path( $file ) )
232                return update_post_meta( $attachment_id, '_wp_attached_file', $file );
233        else
234                return delete_post_meta( $attachment_id, '_wp_attached_file' );
235}
236
237/**
238 * Return relative path to an uploaded file.
239 *
240 * The path is relative to the current upload dir.
241 *
242 * @since 2.9.0
243 *
244 * @param string $path Full path to the file.
245 * @return string Relative path on success, unchanged path on failure.
246 */
247function _wp_relative_upload_path( $path ) {
248        $new_path = $path;
249
250        $uploads = wp_upload_dir();
251        if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) {
252                        $new_path = str_replace( $uploads['basedir'], '', $new_path );
253                        $new_path = ltrim( $new_path, '/' );
254        }
255
256        /**
257         * Filter the relative path to an uploaded file.
258         *
259         * @since 2.9.0
260         *
261         * @param string $new_path Relative path to the file.
262         * @param string $path     Full path to the file.
263         */
264        return apply_filters( '_wp_relative_upload_path', $new_path, $path );
265}
266
267/**
268 * Retrieve all children of the post parent ID.
269 *
270 * Normally, without any enhancements, the children would apply to pages. In the
271 * context of the inner workings of WordPress, pages, posts, and attachments
272 * share the same table, so therefore the functionality could apply to any one
273 * of them. It is then noted that while this function does not work on posts, it
274 * does not mean that it won't work on posts. It is recommended that you know
275 * what context you wish to retrieve the children of.
276 *
277 * Attachments may also be made the child of a post, so if that is an accurate
278 * statement (which needs to be verified), it would then be possible to get
279 * all of the attachments for a post. Attachments have since changed since
280 * version 2.5, so this is most likely unaccurate, but serves generally as an
281 * example of what is possible.
282 *
283 * The arguments listed as defaults are for this function and also of the
284 * {@link get_posts()} function. The arguments are combined with the
285 * get_children defaults and are then passed to the {@link get_posts()}
286 * function, which accepts additional arguments. You can replace the defaults in
287 * this function, listed below and the additional arguments listed in the
288 * {@link get_posts()} function.
289 *
290 * The 'post_parent' is the most important argument and important attention
291 * needs to be paid to the $args parameter. If you pass either an object or an
292 * integer (number), then just the 'post_parent' is grabbed and everything else
293 * is lost. If you don't specify any arguments, then it is assumed that you are
294 * in The Loop and the post parent will be grabbed for from the current post.
295 *
296 * The 'post_parent' argument is the ID to get the children. The 'numberposts'
297 * is the amount of posts to retrieve that has a default of '-1', which is
298 * used to get all of the posts. Giving a number higher than 0 will only
299 * retrieve that amount of posts.
300 *
301 * The 'post_type' and 'post_status' arguments can be used to choose what
302 * criteria of posts to retrieve. The 'post_type' can be anything, but WordPress
303 * post types are 'post', 'pages', and 'attachments'. The 'post_status'
304 * argument will accept any post status within the write administration panels.
305 *
306 * @since 2.0.0
307 *
308 * @see get_posts()
309 * @todo Check validity of description.
310 *
311 * @param mixed  $args   Optional. User defined arguments for replacing the defaults. Default empty.
312 * @param string $output Optional. Constant for return type. Accepts OBJECT, ARRAY_A, ARRAY_N.
313 *                       Default OBJECt.
314 * @return array Array of children, where the type of each element is determined by $output parameter.
315 *               Empty array on failure.
316 */
317function get_children( $args = '', $output = OBJECT ) {
318        $kids = array();
319        if ( empty( $args ) ) {
320                if ( isset( $GLOBALS['post'] ) ) {
321                        $args = array('post_parent' => (int) $GLOBALS['post']->post_parent );
322                } else {
323                        return $kids;
324                }
325        } elseif ( is_object( $args ) ) {
326                $args = array('post_parent' => (int) $args->post_parent );
327        } elseif ( is_numeric( $args ) ) {
328                $args = array('post_parent' => (int) $args);
329        }
330
331        $defaults = array(
332                'numberposts' => -1, 'post_type' => 'any',
333                'post_status' => 'any', 'post_parent' => 0,
334        );
335
336        $r = wp_parse_args( $args, $defaults );
337
338        $children = get_posts( $r );
339
340        if ( ! $children )
341                return $kids;
342
343        if ( ! empty( $r['fields'] ) )
344                return $children;
345
346        update_post_cache($children);
347
348        foreach ( $children as $key => $child )
349                $kids[$child->ID] = $children[$key];
350
351        if ( $output == OBJECT ) {
352                return $kids;
353        } elseif ( $output == ARRAY_A ) {
354                $weeuns = array();
355                foreach ( (array) $kids as $kid ) {
356                        $weeuns[$kid->ID] = get_object_vars($kids[$kid->ID]);
357                }
358                return $weeuns;
359        } elseif ( $output == ARRAY_N ) {
360                $babes = array();
361                foreach ( (array) $kids as $kid ) {
362                        $babes[$kid->ID] = array_values(get_object_vars($kids[$kid->ID]));
363                }
364                return $babes;
365        } else {
366                return $kids;
367        }
368}
369
370/**
371 * Get extended entry info (<!--more-->).
372 *
373 * There should not be any space after the second dash and before the word
374 * 'more'. There can be text or space(s) after the word 'more', but won't be
375 * referenced.
376 *
377 * The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before
378 * the `<!--more-->`. The 'extended' key has the content after the
379 * `<!--more-->` comment. The 'more_text' key has the custom "Read More" text.
380 *
381 * @since 1.0.0
382 *
383 * @param string $post Post content.
384 * @return array Post before ('main'), after ('extended'), and custom readmore ('more_text').
385 */
386function get_extended( $post ) {
387        //Match the new style more links.
388        if ( preg_match('/<!--more(.*?)?-->/', $post, $matches) ) {
389                list($main, $extended) = explode($matches[0], $post, 2);
390                $more_text = $matches[1];
391        } else {
392                $main = $post;
393                $extended = '';
394                $more_text = '';
395        }
396
397        //  leading and trailing whitespace.
398        $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main);
399        $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended);
400        $more_text = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $more_text);
401
402        return array( 'main' => $main, 'extended' => $extended, 'more_text' => $more_text );
403}
404
405/**
406 * Retrieves post data given a post ID or post object.
407 *
408 * See {@link sanitize_post()} for optional $filter values. Also, the parameter
409 * $post, must be given as a variable, since it is passed by reference.
410 *
411 * @since 1.5.1
412 *
413 * @param int|WP_Post $post   Optional. Post ID or post object. Defaults to global $post.
414 * @param string      $output Optional, default is Object. Accepts OBJECT, ARRAY_A, or ARRAY_N.
415 *                            Default OBJECT.
416 * @param string      $filter Optional. Type of filter to apply. Accepts 'raw', 'edit', 'db',
417 *                            or 'display'. Default 'raw'.
418 * @return WP_Post|array|null Type corresponding to $output on success or null on failure.
419 *                            When $output is OBJECT, a `WP_Post` instance is returned.
420 */
421function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
422        if ( empty( $post ) && isset( $GLOBALS['post'] ) )
423                $post = $GLOBALS['post'];
424
425        if ( $post instanceof WP_Post ) {
426                $_post = $post;
427        } elseif ( is_object( $post ) ) {
428                if ( empty( $post->filter ) ) {
429                        $_post = sanitize_post( $post, 'raw' );
430                        $_post = new WP_Post( $_post );
431                } elseif ( 'raw' == $post->filter ) {
432                        $_post = new WP_Post( $post );
433                } else {
434                        $_post = WP_Post::get_instance( $post->ID );
435                }
436        } else {
437                $_post = WP_Post::get_instance( $post );
438        }
439
440        if ( ! $_post )
441                return null;
442
443        $_post = $_post->filter( $filter );
444
445        if ( $output == ARRAY_A )
446                return $_post->to_array();
447        elseif ( $output == ARRAY_N )
448                return array_values( $_post->to_array() );
449
450        return $_post;
451}
452
453/**
454 * WordPress Post class.
455 *
456 * @since 3.5.0
457 *
458 * @property-read array  $ancestors
459 * @property-read string $page_template
460 * @property-read int    $post_category
461 * @property-read string $tag_input
462 *
463 */
464final class WP_Post {
465
466        /**
467         * Post ID.
468         *
469         * @var int
470         */
471        public $ID;
472
473        /**
474         * ID of post author.
475         *
476         * A numeric string, for compatibility reasons.
477         *
478         * @var string
479         */
480        public $post_author = 0;
481
482        /**
483         * The post's local publication time.
484         *
485         * @var string
486         */
487        public $post_date = '0000-00-00 00:00:00';
488
489        /**
490         * The post's GMT publication time.
491         *
492         * @var string
493         */
494        public $post_date_gmt = '0000-00-00 00:00:00';
495
496        /**
497         * The post's content.
498         *
499         * @var string
500         */
501        public $post_content = '';
502
503        /**
504         * The post's title.
505         *
506         * @var string
507         */
508        public $post_title = '';
509
510        /**
511         * The post's excerpt.
512         *
513         * @var string
514         */
515        public $post_excerpt = '';
516
517        /**
518         * The post's status.
519         *
520         * @var string
521         */
522        public $post_status = 'publish';
523
524        /**
525         * Whether comments are allowed.
526         *
527         * @var string
528         */
529        public $comment_status = 'open';
530
531        /**
532         * Whether pings are allowed.
533         *
534         * @var string
535         */
536        public $ping_status = 'open';
537
538        /**
539         * The post's password in plain text.
540         *
541         * @var string
542         */
543        public $post_password = '';
544
545        /**
546         * The post's slug.
547         *
548         * @var string
549         */
550        public $post_name = '';
551
552        /**
553         * URLs queued to be pinged.
554         *
555         * @var string
556         */
557        public $to_ping = '';
558
559        /**
560         * URLs that have been pinged.
561         *
562         * @var string
563         */
564        public $pinged = '';
565
566        /**
567         * The post's local modified time.
568         *
569         * @var string
570         */
571        public $post_modified = '0000-00-00 00:00:00';
572
573        /**
574         * The post's GMT modified time.
575         *
576         * @var string
577         */
578        public $post_modified_gmt = '0000-00-00 00:00:00';
579
580        /**
581         * A utility DB field for post content.
582         *
583         *
584         * @var string
585         */
586        public $post_content_filtered = '';
587
588        /**
589         * ID of a post's parent post.
590         *
591         * @var int
592         */
593        public $post_parent = 0;
594
595        /**
596         * The unique identifier for a post, not necessarily a URL, used as the feed GUID.
597         *
598         * @var string
599         */
600        public $guid = '';
601
602        /**
603         * A field used for ordering posts.
604         *
605         * @var int
606         */
607        public $menu_order = 0;
608
609        /**
610         * The post's type, like post or page.
611         *
612         * @var string
613         */
614        public $post_type = 'post';
615
616        /**
617         * An attachment's mime type.
618         *
619         * @var string
620         */
621        public $post_mime_type = '';
622
623        /**
624         * Cached comment count.
625         *
626         * A numeric string, for compatibility reasons.
627         *
628         * @var string
629         */
630        public $comment_count = 0;
631
632        /**
633         * Stores the post object's sanitization level.
634         *
635         * Does not correspond to a DB field.
636         *
637         * @var string
638         */
639        public $filter;
640
641        /**
642         * Retrieve WP_Post instance.
643         *
644         * @static
645         * @access public
646         *
647         * @param int $post_id Post ID.
648         * @return WP_Post|bool Post object, false otherwise.
649         */
650        public static function get_instance( $post_id ) {
651                global $wpdb;
652
653                $post_id = (int) $post_id;
654                if ( ! $post_id )
655                        return false;
656
657                $_post = wp_cache_get( $post_id, 'posts' );
658
659                if ( ! $_post ) {
660                        $_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id ) );
661
662                        if ( ! $_post )
663                                return false;
664
665                        $_post = sanitize_post( $_post, 'raw' );
666                        wp_cache_add( $_post->ID, $_post, 'posts' );
667                } elseif ( empty( $_post->filter ) ) {
668                        $_post = sanitize_post( $_post, 'raw' );
669                }
670
671                return new WP_Post( $_post );
672        }
673
674        /**
675         * Constructor.
676         *
677         * @param WP_Post $post Post object.
678         */
679        public function __construct( $post ) {
680                foreach ( get_object_vars( $post ) as $key => $value )
681                        $this->$key = $value;
682        }
683
684        /**
685         * Isset-er.
686         *
687         * @param string $key Property to check if set.
688         * @return bool
689         */
690        public function __isset( $key ) {
691                if ( 'ancestors' == $key )
692                        return true;
693
694                if ( 'page_template' == $key )
695                        return ( 'page' == $this->post_type );
696
697                if ( 'post_category' == $key )
698                   return true;
699
700                if ( 'tags_input' == $key )
701                   return true;
702
703                return metadata_exists( 'post', $this->ID, $key );
704        }
705
706        /**
707         * Getter.
708         *
709         * @param string $key Key to get.
710         * @return array|mixed
711         */
712        public function __get( $key ) {
713                if ( 'page_template' == $key && $this->__isset( $key ) ) {
714                        return get_post_meta( $this->ID, '_wp_page_template', true );
715                }
716
717                if ( 'post_category' == $key ) {
718                        if ( is_object_in_taxonomy( $this->post_type, 'category' ) )
719                                $terms = get_the_terms( $this, 'category' );
720
721                        if ( empty( $terms ) )
722                                return array();
723
724                        return wp_list_pluck( $terms, 'term_id' );
725                }
726
727                if ( 'tags_input' == $key ) {
728                        if ( is_object_in_taxonomy( $this->post_type, 'post_tag' ) )
729                                $terms = get_the_terms( $this, 'post_tag' );
730
731                        if ( empty( $terms ) )
732                                return array();
733
734                        return wp_list_pluck( $terms, 'name' );
735                }
736
737                // Rest of the values need filtering.
738                if ( 'ancestors' == $key )
739                        $value = get_post_ancestors( $this );
740                else
741                        $value = get_post_meta( $this->ID, $key, true );
742
743                if ( $this->filter )
744                        $value = sanitize_post_field( $key, $value, $this->ID, $this->filter );
745
746                return $value;
747        }
748
749        /**
750         * {@Missing Summary}
751         *
752         * @param string $filter Filter.
753         * @return $this|array|bool|object|WP_Post
754         */
755        public function filter( $filter ) {
756                if ( $this->filter == $filter )
757                        return $this;
758
759                if ( $filter == 'raw' )
760                        return self::get_instance( $this->ID );
761
762                return sanitize_post( $this, $filter );
763        }
764
765        /**
766         * Convert object to array.
767         *
768         * @return array Object as array.
769         */
770        public function to_array() {
771                $post = get_object_vars( $this );
772
773                foreach ( array( 'ancestors', 'page_template', 'post_category', 'tags_input' ) as $key ) {
774                        if ( $this->__isset( $key ) )
775                                $post[ $key ] = $this->__get( $key );
776                }
777
778                return $post;
779        }
780}
781
782/**
783 * Retrieve ancestors of a post.
784 *
785 * @since 2.5.0
786 *
787 * @param int|WP_Post $post Post ID or post object.
788 * @return array Ancestor IDs or empty array if none are found.
789 */
790function get_post_ancestors( $post ) {
791        $post = get_post( $post );
792
793        if ( ! $post || empty( $post->post_parent ) || $post->post_parent == $post->ID )
794                return array();
795
796        $ancestors = array();
797
798        $id = $ancestors[] = $post->post_parent;
799
800        while ( $ancestor = get_post( $id ) ) {
801                // Loop detection: If the ancestor has been seen before, break.
802                if ( empty( $ancestor->post_parent ) || ( $ancestor->post_parent == $post->ID ) || in_array( $ancestor->post_parent, $ancestors ) )
803                        break;
804
805                $id = $ancestors[] = $ancestor->post_parent;
806        }
807
808        return $ancestors;
809}
810
811/**
812 * Retrieve data from a post field based on Post ID.
813 *
814 * Examples of the post field will be, 'post_type', 'post_status', 'post_content',
815 * etc and based off of the post object property or key names.
816 *
817 * The context values are based off of the taxonomy filter functions and
818 * supported values are found within those functions.
819 *
820 * @since 2.3.0
821 *
822 * @see sanitize_post_field()
823 *
824 * @param string      $field   Post field name.
825 * @param int|WP_Post $post    Post ID or post object.
826 * @param string      $context Optional. How to filter the field. Accepts 'raw', 'edit', 'db',
827 *                             or 'display'. Default 'display'.
828 * @return string The value of the post field on success, empty string on failure.
829 */
830function get_post_field( $field, $post, $context = 'display' ) {
831        $post = get_post( $post );
832
833        if ( !$post )
834                return '';
835
836        if ( !isset($post->$field) )
837                return '';
838
839        return sanitize_post_field($field, $post->$field, $post->ID, $context);
840}
841
842/**
843 * Retrieve the mime type of an attachment based on the ID.
844 *
845 * This function can be used with any post type, but it makes more sense with
846 * attachments.
847 *
848 * @since 2.0.0
849 *
850 * @param int|WP_Post $ID Optional. Post ID or post object. Default empty.
851 * @return string|false The mime type on success, false on failure.
852 */
853function get_post_mime_type( $ID = '' ) {
854        $post = get_post($ID);
855
856        if ( is_object($post) )
857                return $post->post_mime_type;
858
859        return false;
860}
861
862/**
863 * Retrieve the post status based on the Post ID.
864 *
865 * If the post ID is of an attachment, then the parent post status will be given
866 * instead.
867 *
868 * @since 2.0.0
869 *
870 * @param int|WP_Post $ID Optional. Post ID or post object. Default empty.
871 * @return string|false Post status on success, false on failure.
872 */
873function get_post_status( $ID = '' ) {
874        $post = get_post($ID);
875
876        if ( !is_object($post) )
877                return false;
878
879        if ( 'attachment' == $post->post_type ) {
880                if ( 'private' == $post->post_status )
881                        return 'private';
882
883                // Unattached attachments are assumed to be published.
884                if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) )
885                        return 'publish';
886
887                // Inherit status from the parent.
888                if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) {
889                        $parent_post_status = get_post_status( $post->post_parent );
890                        if ( 'trash' == $parent_post_status ) {
891                                return get_post_meta( $post->post_parent, '_wp_trash_meta_status', true );
892                        } else {
893                                return $parent_post_status;
894                        }
895                }
896
897        }
898
899        return $post->post_status;
900}
901
902/**
903 * Retrieve all of the WordPress supported post statuses.
904 *
905 * Posts have a limited set of valid status values, this provides the
906 * post_status values and descriptions.
907 *
908 * @since 2.5.0
909 *
910 * @return array List of post statuses.
911 */
912function get_post_statuses() {
913        $status = array(
914                'draft'   => __( 'Draft' ),
915                'pending' => __( 'Pending Review' ),
916                'private' => __( 'Private' ),
917                'publish' => __( 'Published' )
918        );
919
920        return $status;
921}
922
923/**
924 * Retrieve all of the WordPress support page statuses.
925 *
926 * Pages have a limited set of valid status values, this provides the
927 * post_status values and descriptions.
928 *
929 * @since 2.5.0
930 *
931 * @return array List of page statuses.
932 */
933function get_page_statuses() {
934        $status = array(
935                'draft'   => __( 'Draft' ),
936                'private' => __( 'Private' ),
937                'publish' => __( 'Published' )
938        );
939
940        return $status;
941}
942
943/**
944 * Register a post status. Do not use before init.
945 *
946 * A simple function for creating or modifying a post status based on the
947 * parameters given. The function will accept an array (second optional
948 * parameter), along with a string for the post status name.
949 *
950 * Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
951 *
952 * @since 3.0.0
953 * @uses $wp_post_statuses Inserts new post status object into the list
954 *
955 * @param string $post_status Name of the post status.
956 * @param array|string $args {
957 *     Optional. Array or string of post status arguments.
958 *
959 *     @type bool|string $label                     A descriptive name for the post status marked
960 *                                                  for translation. Defaults to value of $post_status.
961 *     @type bool|array  $label_count               Descriptive text to use for nooped plurals.
962 *                                                  Default array of $label, twice
963 *     @type bool        $exclude_from_search       Whether to exclude posts with this post status
964 *                                                  from search results. Default is value of $internal.
965 *     @type bool        $_builtin                  Whether the status is built-in. Core-use only.
966 *                                                  Default false.
967 *     @type bool        $public                    Whether posts of this status should be shown
968 *                                                  in the front end of the site. Default true.
969 *     @type bool        $internal                  Whether the status is for internal use only.
970 *                                                  Default false.
971 *     @type bool        $protected                 Whether posts with this status should be protected.
972 *                                                  Default false.
973 *     @type bool        $private                   Whether posts with this status should be private.
974 *                                                  Default false.
975 *     @type bool        $publicly_queryable        Whether posts with this status should be publicly-
976 *                                                  queryable. Default is value of $public.
977 *     @type bool        $show_in_admin_all_list    Whether to include posts in the edit listing for
978 *                                                  their post type. Default is value of $internal.
979 *     @type bool        $show_in_admin_status_list Show in the list of statuses with post counts at
980 *                                                  the top of the edit listings,
981 *                                                  e.g. All (12) | Published (9) | My Custom Status (2)
982 *                                                  Default is value of $internal.
983 * }
984 */
985function register_post_status( $post_status, $args = array() ) {
986        global $wp_post_statuses;
987
988        if (!is_array($wp_post_statuses))
989                $wp_post_statuses = array();
990
991        // Args prefixed with an underscore are reserved for internal use.
992        $defaults = array(
993                'label' => false,
994                'label_count' => false,
995                'exclude_from_search' => null,
996                '_builtin' => false,
997                'public' => null,
998                'internal' => null,
999                'protected' => null,
1000                'private' => null,
1001                'publicly_queryable' => null,
1002                'show_in_admin_status_list' => null,
1003                'show_in_admin_all_list' => null,
1004        );
1005        $args = wp_parse_args($args, $defaults);
1006        $args = (object) $args;
1007
1008        $post_status = sanitize_key($post_status);
1009        $args->name = $post_status;
1010
1011        // Set various defaults.
1012        if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private )
1013                $args->internal = true;
1014
1015        if ( null === $args->public  )
1016                $args->public = false;
1017
1018        if ( null === $args->private  )
1019                $args->private = false;
1020
1021        if ( null === $args->protected  )
1022                $args->protected = false;
1023
1024        if ( null === $args->internal  )
1025                $args->internal = false;
1026
1027        if ( null === $args->publicly_queryable )
1028                $args->publicly_queryable = $args->public;
1029
1030        if ( null === $args->exclude_from_search )
1031                $args->exclude_from_search = $args->internal;
1032
1033        if ( null === $args->show_in_admin_all_list )
1034                $args->show_in_admin_all_list = !$args->internal;
1035
1036        if ( null === $args->show_in_admin_status_list )
1037                $args->show_in_admin_status_list = !$args->internal;
1038
1039        if ( false === $args->label )
1040                $args->label = $post_status;
1041
1042        if ( false === $args->label_count )
1043                $args->label_count = array( $args->label, $args->label );
1044
1045        $wp_post_statuses[$post_status] = $args;
1046
1047        return $args;
1048}
1049
1050/**
1051 * Retrieve a post status object by name.
1052 *
1053 * @since 3.0.0
1054 *
1055 * @global array $wp_post_statuses List of post statuses.
1056 *
1057 * @see register_post_status()
1058 *
1059 * @param string $post_status The name of a registered post status.
1060 * @return object A post status object.
1061 */
1062function get_post_status_object( $post_status ) {
1063        global $wp_post_statuses;
1064
1065        if ( empty($wp_post_statuses[$post_status]) )
1066                return null;
1067
1068        return $wp_post_statuses[$post_status];
1069}
1070
1071/**
1072 * Get a list of post statuses.
1073 *
1074 * @since 3.0.0
1075 *
1076 * @global array $wp_post_statuses List of post statuses.
1077 *
1078 * @see register_post_status()
1079 *
1080 * @param array|string $args     Optional. Array or string of post status arguments to compare against
1081 *                               properties of the global `$wp_post_statuses objects`. Default empty array.
1082 * @param string       $output   Optional. The type of output to return, either 'names' or 'objects'. Default 'names'.
1083 * @param string       $operator Optional. The logical operation to perform. 'or' means only one element
1084 *                               from the array needs to match; 'and' means all elements must match.
1085 *                               Default 'and'.
1086 * @return array A list of post status names or objects.
1087 */
1088function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {
1089        global $wp_post_statuses;
1090
1091        $field = ('names' == $output) ? 'name' : false;
1092
1093        return wp_filter_object_list($wp_post_statuses, $args, $operator, $field);
1094}
1095
1096/**
1097 * Whether the post type is hierarchical.
1098 *
1099 * A false return value might also mean that the post type does not exist.
1100 *
1101 * @since 3.0.0
1102 *
1103 * @see get_post_type_object()
1104 *
1105 * @param string $post_type Post type name
1106 * @return bool Whether post type is hierarchical.
1107 */
1108function is_post_type_hierarchical( $post_type ) {
1109        if ( ! post_type_exists( $post_type ) )
1110                return false;
1111
1112        $post_type = get_post_type_object( $post_type );
1113        return $post_type->hierarchical;
1114}
1115
1116/**
1117 * Check if a post type is registered.
1118 *
1119 * @since 3.0.0
1120 *
1121 * @see get_post_type_object()
1122 *
1123 * @param string $post_type Post type name.
1124 * @return bool Whether post type is registered.
1125 */
1126function post_type_exists( $post_type ) {
1127        return (bool) get_post_type_object( $post_type );
1128}
1129
1130/**
1131 * Retrieve the post type of the current post or of a given post.
1132 *
1133 * @since 2.1.0
1134 *
1135 * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
1136 * @return string|false Post type on success, false on failure.
1137 */
1138function get_post_type( $post = null ) {
1139        if ( $post = get_post( $post ) )
1140                return $post->post_type;
1141
1142        return false;
1143}
1144
1145/**
1146 * Retrieve a post type object by name.
1147 *
1148 * @since 3.0.0
1149 *
1150 * @global array $wp_post_types List of post types.
1151 *
1152 * @see register_post_type()
1153 *
1154 * @param string $post_type The name of a registered post type.
1155 * @return object A post type object.
1156 */
1157function get_post_type_object( $post_type ) {
1158        global $wp_post_types;
1159
1160        if ( empty($wp_post_types[$post_type]) )
1161                return null;
1162
1163        return $wp_post_types[$post_type];
1164}
1165
1166/**
1167 * Get a list of all registered post type objects.
1168 *
1169 * @since 2.9.0
1170 *
1171 * @global array $wp_post_types List of post types.
1172 *
1173 * @see register_post_type() for accepted arguments.
1174 *
1175 * @param array|string $args     Optional. An array of key => value arguments to match against
1176 *                               the post type objects. Default empty array.
1177 * @param string       $output   Optional. The type of output to return. Accepts post type 'names'
1178 *                               or 'objects'. Default 'names'.
1179 * @param string       $operator Optional. The logical operation to perform. 'or' means only one
1180 *                               element from the array needs to match; 'and' means all elements
1181 *                               must match. Accepts 'or' or 'and'. Default 'and'.
1182 * @return array A list of post type names or objects.
1183 */
1184function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) {
1185        global $wp_post_types;
1186
1187        $field = ('names' == $output) ? 'name' : false;
1188
1189        return wp_filter_object_list($wp_post_types, $args, $operator, $field);
1190}
1191
1192/**
1193 * Register a post type. Do not use before init.
1194 *
1195 * A function for creating or modifying a post type based on the
1196 * parameters given. The function will accept an array (second optional
1197 * parameter), along with a string for the post type name.
1198 *
1199 * @since 2.9.0
1200 *
1201 * @global array      $wp_post_types List of post types.
1202 * @global WP_Rewrite $wp_rewrite    Used for default feeds.
1203 * @global WP         $wp            Used to add query vars.
1204 *
1205 * @param string $post_type Post type key, must not exceed 20 characters.
1206 * @param array|string $args {
1207 *     Array or string of arguments for registering a post type.
1208 *
1209 *     @type string      $label                Name of the post type shown in the menu. Usually plural.
1210 *                                             Default is value of $labels['name'].
1211 *     @type array       $labels               An array of labels for this post type. If not set, post
1212 *                                             labels are inherited for non-hierarchical types and page
1213 *                                             labels for hierarchical ones. {@see get_post_type_labels()}.
1214 *     @type string      $description          A short descriptive summary of what the post type is.
1215 *                                             Default empty.
1216 *     @type bool        $public               Whether a post type is intended for use publicly either via
1217 *                                             the admin interface or by front-end users. While the default
1218 *                                             settings of $exclude_from_search, $publicly_queryable, $show_ui,
1219 *                                             and $show_in_nav_menus are inherited from public, each does not
1220 *                                             rely on this relationship and controls a very specific intention.
1221 *                                             Default false.
1222 *     @type bool        $hierarchical         Whether the post type is hierarchical (e.g. page). Default false.
1223 *     @type bool        $exclude_from_search  Whether to exclude posts with this post type from front end search
1224 *                                             results. Default is the opposite value of $public.
1225 *     @type bool        $publicly_queryable   Whether queries can be performed on the front end for the post type
1226 *                                             as part of {@see parse_request()}. Endpoints would include:
1227 *                                             * ?post_type={post_type_key}
1228 *                                             * ?{post_type_key}={single_post_slug}
1229 *                                             * ?{post_type_query_var}={single_post_slug}
1230 *                                             If not set, the default is inherited from $public.
1231 *     @type bool        $show_ui              Whether to generate a default UI for managing this post type in the
1232 *                                             admin. Default is value of $public.
1233 *     @type bool        $show_in_menu         Where to show the post type in the admin menu. To work, $show_ui
1234 *                                             must be true. If true, the post type is shown in its own top level
1235 *                                             menu. If false, no menu is shown. If a string of an existing top
1236 *                                             level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post
1237 *                                             type will be placed as a sub-menu of that.
1238 *                                             Default is value of $show_ui.
1239 *     @type bool        $show_in_nav_menus    Makes this post type available for selection in navigation menus.
1240 *                                             Default is value $public.
1241 *     @type bool        $show_in_admin_bar    Makes this post type available via the admin bar. Default is value
1242 *                                             of $show_in_menu.
1243 *     @type int         $menu_position        The position in the menu order the post type should appear. To work,
1244 *                                             $show_in_menu must be true. Default null (at the bottom).
1245 *     @type string      $menu_icon            The url to the icon to be used for this menu. Pass a base64-encoded
1246 *                                             SVG using a data URI, which will be colored to match the color scheme
1247 *                                             -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
1248 *                                             of a Dashicons helper class to use a font icon, e.g.
1249 *                                             'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
1250 *                                             so an icon can be added via CSS. Defaults to use the posts icon.
1251 *     @type string      $capability_type      The string to use to build the read, edit, and delete capabilities.
1252 *                                             May be passed as an array to allow for alternative plurals when using
1253 *                                             this argument as a base to construct the capabilities, e.g.
1254 *                                             array('story', 'stories'). Default 'post'.
1255 *     @type array       $capabilities         Array of capabilities for this post type. $capability_type is used
1256 *                                             as a base to construct capabilities by default.
1257 *                                             {@see get_post_type_capabilities()}.
1258 *     @type bool        $map_meta_cap         Whether to use the internal default meta capability handling.
1259 *                                             Default false.
1260 *     @type array       $supports             An alias for calling {@see add_post_type_support()} directly.
1261 *                                             Defaults to array containing 'title' & 'editor'.
1262 *     @type callback    $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
1263 *                                             edit form. Do remove_meta_box() and add_meta_box() calls in the
1264 *                                             callback. Default null.
1265 *     @type array       $taxonomies           An array of taxonomy identifiers that will be registered for the
1266 *                                             post type. Taxonomies can be registered later with
1267 *                                             {@see register_taxonomy()} or {@see register_taxonomy_for_object_type()}.
1268 *                                             Default empty array.
1269 *     @type bool|string $has_archive          Whether there should be post type archives, or if a string, the
1270 *                                             archive slug to use. Will generate the proper rewrite rules if
1271 *                                             $rewrite is enabled. Default false.
1272 *     @type bool|array  $rewrite              {
1273 *         Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
1274 *         Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be
1275 *         passed with any of these keys:
1276 *
1277 *         @type string $slug       Customize the permastruct slug. Defaults to $post_type key.
1278 *         @type bool   $with_front Whether the permastruct should be prepended with WP_Rewrite::$front.
1279 *                                  Default true.
1280 *         @type bool   $feeds      Whether the feed permastruct should be built for this post type.
1281 *                                  Default is value of $has_archive.
1282 *         @type bool   $pages      Whether the permastruct should provide for pagination. Default true.
1283 *         @type const  $ep_mask    Endpoint mask to assign. If not specified and permalink_epmask is set,
1284 *                                  inherits from $permalink_epmask. If not specified and permalink_epmask
1285 *                                  is not set, defaults to EP_PERMALINK.
1286 *     }
1287 *     @type string|bool $query_var            Sets the query_var key for this post type. Defaults to $post_type
1288 *                                             key. If false, a post type cannot be loaded at
1289 *                                             ?{query_var}={post_slug}. If specified as a string, the query
1290 *                                             ?{query_var_string}={post_slug} will be valid.
1291 *     @type bool        $can_export           Whether to allow this post type to be exported. Default true.
1292 *     @type bool        $delete_with_user     Whether to delete posts of this type when deleting a user. If true,
1293 *                                             posts of this type belonging to the user will be moved to trash
1294 *                                             when then user is deleted. If false, posts of this type belonging
1295 *                                             to the user will *not* be trashed or deleted. If not set (the default),
1296 *                                             posts are trashed if post_type_supports('author'). Otherwise posts
1297 *                                             are not trashed or deleted. Default null.
1298 *     @type bool        $_builtin             FOR INTERNAL USE ONLY! True if this post type is a native or
1299 *                                             "built-in" post_type. Default false.
1300 *     @type string      $_edit_link           FOR INTERNAL USE ONLY! URL segment to use for edit link of
1301 *                                             this post type. Default 'post.php?post=%d'.
1302 * }
1303 * @return object|WP_Error The registered post type object, or an error object.
1304 */
1305function register_post_type( $post_type, $args = array() ) {
1306        global $wp_post_types, $wp_rewrite, $wp;
1307
1308        if ( ! is_array( $wp_post_types ) )
1309                $wp_post_types = array();
1310
1311        // Args prefixed with an underscore are reserved for internal use.
1312        $defaults = array(
1313                'labels'               => array(),
1314                'description'          => '',
1315                'public'               => false,
1316                'hierarchical'         => false,
1317                'exclude_from_search'  => null,
1318                'publicly_queryable'   => null,
1319                'show_ui'              => null,
1320                'show_in_menu'         => null,
1321                'show_in_nav_menus'    => null,
1322                'show_in_admin_bar'    => null,
1323                'menu_position'        => null,
1324                'menu_icon'            => null,
1325                'capability_type'      => 'post',
1326                'capabilities'         => array(),
1327                'map_meta_cap'         => null,
1328                'supports'             => array(),
1329                'register_meta_box_cb' => null,
1330                'taxonomies'           => array(),
1331                'has_archive'          => false,
1332                'rewrite'              => true,
1333                'query_var'            => true,
1334                'can_export'           => true,
1335                'delete_with_user'     => null,
1336                '_builtin'             => false,
1337                '_edit_link'           => 'post.php?post=%d',
1338        );
1339        $args = wp_parse_args( $args, $defaults );
1340        $args = (object) $args;
1341
1342        $post_type = sanitize_key( $post_type );
1343        $args->name = $post_type;
1344
1345        if ( empty( $post_type ) || strlen( $post_type ) > 20 ) {
1346                _doing_it_wrong( __FUNCTION__, __( 'Post type names must be between 1 and 20 characters in length.' ), '4.2' );
1347                return new WP_Error( 'post_type_length_invalid', __( 'Post type names must be between 1 and 20 characters in length.' ) );
1348        }
1349
1350        // If not set, default to the setting for public.
1351        if ( null === $args->publicly_queryable )
1352                $args->publicly_queryable = $args->public;
1353
1354        // If not set, default to the setting for public.
1355        if ( null === $args->show_ui )
1356                $args->show_ui = $args->public;
1357
1358        // If not set, default to the setting for show_ui.
1359        if ( null === $args->show_in_menu || ! $args->show_ui )
1360                $args->show_in_menu = $args->show_ui;
1361
1362        // If not set, default to the whether the full UI is shown.
1363        if ( null === $args->show_in_admin_bar )
1364                $args->show_in_admin_bar = (bool) $args->show_in_menu;
1365
1366        // If not set, default to the setting for public.
1367        if ( null === $args->show_in_nav_menus )
1368                $args->show_in_nav_menus = $args->public;
1369
1370        // If not set, default to true if not public, false if public.
1371        if ( null === $args->exclude_from_search )
1372                $args->exclude_from_search = !$args->public;
1373
1374        // Back compat with quirky handling in version 3.0. #14122.
1375        if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
1376                $args->map_meta_cap = true;
1377
1378        // If not set, default to false.
1379        if ( null === $args->map_meta_cap )
1380                $args->map_meta_cap = false;
1381
1382        $args->cap = get_post_type_capabilities( $args );
1383        unset( $args->capabilities );
1384
1385        if ( is_array( $args->capability_type ) )
1386                $args->capability_type = $args->capability_type[0];
1387
1388        if ( ! empty( $args->supports ) ) {
1389                add_post_type_support( $post_type, $args->supports );
1390                unset( $args->supports );
1391        } elseif ( false !== $args->supports ) {
1392                // Add default features
1393                add_post_type_support( $post_type, array( 'title', 'editor' ) );
1394        }
1395
1396        if ( false !== $args->query_var && ! empty( $wp ) ) {
1397                if ( true === $args->query_var )
1398                        $args->query_var = $post_type;
1399                else
1400                        $args->query_var = sanitize_title_with_dashes( $args->query_var );
1401                $wp->add_query_var( $args->query_var );
1402        }
1403
1404        if ( false !== $args->rewrite && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
1405                if ( ! is_array( $args->rewrite ) )
1406                        $args->rewrite = array();
1407                if ( empty( $args->rewrite['slug'] ) )
1408                        $args->rewrite['slug'] = $post_type;
1409                if ( ! isset( $args->rewrite['with_front'] ) )
1410                        $args->rewrite['with_front'] = true;
1411                if ( ! isset( $args->rewrite['pages'] ) )
1412                        $args->rewrite['pages'] = true;
1413                if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive )
1414                        $args->rewrite['feeds'] = (bool) $args->has_archive;
1415                if ( ! isset( $args->rewrite['ep_mask'] ) ) {
1416                        if ( isset( $args->permalink_epmask ) )
1417                                $args->rewrite['ep_mask'] = $args->permalink_epmask;
1418                        else
1419                                $args->rewrite['ep_mask'] = EP_PERMALINK;
1420                }
1421
1422                if ( $args->hierarchical )
1423                        add_rewrite_tag( "%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&pagename=" );
1424                else
1425                        add_rewrite_tag( "%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=" );
1426
1427                if ( $args->has_archive ) {
1428                        $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive;
1429                        if ( $args->rewrite['with_front'] )
1430                                $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug;
1431                        else
1432                                $archive_slug = $wp_rewrite->root . $archive_slug;
1433
1434                        add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' );
1435                        if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) {
1436                                $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';
1437                                add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
1438                                add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
1439                        }
1440                        if ( $args->rewrite['pages'] )
1441                                add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' );
1442                }
1443
1444                $permastruct_args = $args->rewrite;
1445                $permastruct_args['feed'] = $permastruct_args['feeds'];
1446                add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $permastruct_args );
1447        }
1448
1449        // Register the post type meta box if a custom callback was specified.
1450        if ( $args->register_meta_box_cb )
1451                add_action( 'add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1 );
1452
1453        $args->labels = get_post_type_labels( $args );
1454        $args->label = $args->labels->name;
1455
1456        $wp_post_types[ $post_type ] = $args;
1457
1458        add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 );
1459
1460        foreach ( $args->taxonomies as $taxonomy ) {
1461                register_taxonomy_for_object_type( $taxonomy, $post_type );
1462        }
1463
1464        /**
1465         * Fires after a post type is registered.
1466         *
1467         * @since 3.3.0
1468         *
1469         * @param string $post_type Post type.
1470         * @param object $args      Arguments used to register the post type.
1471         */
1472        do_action( 'registered_post_type', $post_type, $args );
1473
1474        return $args;
1475}
1476
1477/**
1478 * Build an object with all post type capabilities out of a post type object
1479 *
1480 * Post type capabilities use the 'capability_type' argument as a base, if the
1481 * capability is not set in the 'capabilities' argument array or if the
1482 * 'capabilities' argument is not supplied.
1483 *
1484 * The capability_type argument can optionally be registered as an array, with
1485 * the first value being singular and the second plural, e.g. array('story, 'stories')
1486 * Otherwise, an 's' will be added to the value for the plural form. After
1487 * registration, capability_type will always be a string of the singular value.
1488 *
1489 * By default, seven keys are accepted as part of the capabilities array:
1490 *
1491 * - edit_post, read_post, and delete_post are meta capabilities, which are then
1492 *   generally mapped to corresponding primitive capabilities depending on the
1493 *   context, which would be the post being edited/read/deleted and the user or
1494 *   role being checked. Thus these capabilities would generally not be granted
1495 *   directly to users or roles.
1496 *
1497 * - edit_posts - Controls whether objects of this post type can be edited.
1498 * - edit_others_posts - Controls whether objects of this type owned by other users
1499 *   can be edited. If the post type does not support an author, then this will
1500 *   behave like edit_posts.
1501 * - publish_posts - Controls publishing objects of this post type.
1502 * - read_private_posts - Controls whether private objects can be read.
1503 *
1504 * These four primitive capabilities are checked in core in various locations.
1505 * There are also seven other primitive capabilities which are not referenced
1506 * directly in core, except in map_meta_cap(), which takes the three aforementioned
1507 * meta capabilities and translates them into one or more primitive capabilities
1508 * that must then be checked against the user or role, depending on the context.
1509 *
1510 * - read - Controls whether objects of this post type can be read.
1511 * - delete_posts - Controls whether objects of this post type can be deleted.
1512 * - delete_private_posts - Controls whether private objects can be deleted.
1513 * - delete_published_posts - Controls whether published objects can be deleted.
1514 * - delete_others_posts - Controls whether objects owned by other users can be
1515 *   can be deleted. If the post type does not support an author, then this will
1516 *   behave like delete_posts.
1517 * - edit_private_posts - Controls whether private objects can be edited.
1518 * - edit_published_posts - Controls whether published objects can be edited.
1519 *
1520 * These additional capabilities are only used in map_meta_cap(). Thus, they are
1521 * only assigned by default if the post type is registered with the 'map_meta_cap'
1522 * argument set to true (default is false).
1523 *
1524 * @since 3.0.0
1525 *
1526 * @see register_post_type()
1527 * @see map_meta_cap()
1528 *
1529 * @param object $args Post type registration arguments.
1530 * @return object object with all the capabilities as member variables.
1531 */
1532function get_post_type_capabilities( $args ) {
1533        if ( ! is_array( $args->capability_type ) )
1534                $args->capability_type = array( $args->capability_type, $args->capability_type . 's' );
1535
1536        // Singular base for meta capabilities, plural base for primitive capabilities.
1537        list( $singular_base, $plural_base ) = $args->capability_type;
1538
1539        $default_capabilities = array(
1540                // Meta capabilities
1541                'edit_post'          => 'edit_'         . $singular_base,
1542                'read_post'          => 'read_'         . $singular_base,
1543                'delete_post'        => 'delete_'       . $singular_base,
1544                // Primitive capabilities used outside of map_meta_cap():
1545                'edit_posts'         => 'edit_'         . $plural_base,
1546                'edit_others_posts'  => 'edit_others_'  . $plural_base,
1547                'publish_posts'      => 'publish_'      . $plural_base,
1548                'read_private_posts' => 'read_private_' . $plural_base,
1549        );
1550
1551        // Primitive capabilities used within map_meta_cap():
1552        if ( $args->map_meta_cap ) {
1553                $default_capabilities_for_mapping = array(
1554                        'read'                   => 'read',
1555                        'delete_posts'           => 'delete_'           . $plural_base,
1556                        'delete_private_posts'   => 'delete_private_'   . $plural_base,
1557                        'delete_published_posts' => 'delete_published_' . $plural_base,
1558                        'delete_others_posts'    => 'delete_others_'    . $plural_base,
1559                        'edit_private_posts'     => 'edit_private_'     . $plural_base,
1560                        'edit_published_posts'   => 'edit_published_'   . $plural_base,
1561                );
1562                $default_capabilities = array_merge( $default_capabilities, $default_capabilities_for_mapping );
1563        }
1564
1565        $capabilities = array_merge( $default_capabilities, $args->capabilities );
1566
1567        // Post creation capability simply maps to edit_posts by default:
1568        if ( ! isset( $capabilities['create_posts'] ) )
1569                $capabilities['create_posts'] = $capabilities['edit_posts'];
1570
1571        // Remember meta capabilities for future reference.
1572        if ( $args->map_meta_cap )
1573                _post_type_meta_capabilities( $capabilities );
1574
1575        return (object) $capabilities;
1576}
1577
1578/**
1579 * Store or return a list of post type meta caps for map_meta_cap().
1580 *
1581 * @since 3.1.0
1582 * @access private
1583 *
1584 * @param null|array $capabilities Post type meta capabilities.
1585 */
1586function _post_type_meta_capabilities( $capabilities = null ) {
1587        static $meta_caps = array();
1588        if ( null === $capabilities )
1589                return $meta_caps;
1590        foreach ( $capabilities as $core => $custom ) {
1591                if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) )
1592                        $meta_caps[ $custom ] = $core;
1593        }
1594}
1595
1596/**
1597 * Build an object with all post type labels out of a post type object
1598 *
1599 * Accepted keys of the label array in the post type object:
1600 *
1601 * - name - general name for the post type, usually plural. The same and overridden
1602 *          by $post_type_object->label. Default is Posts/Pages
1603 * - singular_name - name for one object of this post type. Default is Post/Page
1604 * - add_new - Default is Add New for both hierarchical and non-hierarchical types.
1605 *             When internationalizing this string, please use a gettext context
1606 *             {@link https://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context}
1607 *             matching your post type. Example: `_x( 'Add New', 'product' );`.
1608 * - add_new_item - Default is Add New Post/Add New Page.
1609 * - edit_item - Default is Edit Post/Edit Page.
1610 * - new_item - Default is New Post/New Page.
1611 * - view_item - Default is View Post/View Page.
1612 * - search_items - Default is Search Posts/Search Pages.
1613 * - not_found - Default is No posts found/No pages found.
1614 * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash.
1615 * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical
1616 *                       ones the default is 'Parent Page:'.
1617 * - all_items - String for the submenu. Default is All Posts/All Pages.
1618 * - menu_name - Default is the same as `name`.
1619 *
1620 * Above, the first default value is for non-hierarchical post types (like posts)
1621 * and the second one is for hierarchical post types (like pages).
1622 *
1623 * @since 3.0.0
1624 * @access private
1625 *
1626 * @param object $post_type_object Post type object.
1627 * @return object object with all the labels as member variables.
1628 */
1629function get_post_type_labels( $post_type_object ) {
1630        $nohier_vs_hier_defaults = array(
1631                'name' => array( _x('Posts', 'post type general name'), _x('Pages', 'post type general name') ),
1632                'singular_name' => array( _x('Post', 'post type singular name'), _x('Page', 'post type singular name') ),
1633                'add_new' => array( _x('Add New', 'post'), _x('Add New', 'page') ),
1634                'add_new_item' => array( __('Add New Post'), __('Add New Page') ),
1635                'edit_item' => array( __('Edit Post'), __('Edit Page') ),
1636                'new_item' => array( __('New Post'), __('New Page') ),
1637                'view_item' => array( __('View Post'), __('View Page') ),
1638                'search_items' => array( __('Search Posts'), __('Search Pages') ),
1639                'not_found' => array( __('No posts found.'), __('No pages found.') ),
1640                'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ),
1641                'parent_item_colon' => array( null, __('Parent Page:') ),
1642                'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) )
1643        );
1644        $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
1645
1646        $labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults );
1647
1648        $post_type = $post_type_object->name;
1649
1650        /**
1651         * Filter the labels of a specific post type.
1652         *
1653         * The dynamic portion of the hook name, `$post_type`, refers to
1654         * the post type slug.
1655         *
1656         * @since 3.5.0
1657         *
1658         * @see get_post_type_labels() for the full list of labels.
1659         *
1660         * @param array $labels Array of labels for the given post type.
1661         */
1662        return apply_filters( "post_type_labels_{$post_type}", $labels );
1663}
1664
1665/**
1666 * Build an object with custom-something object (post type, taxonomy) labels
1667 * out of a custom-something object
1668 *
1669 * @since 3.0.0
1670 * @access private
1671 *
1672 * @param object $object                  A custom-something object.
1673 * @param array  $nohier_vs_hier_defaults Hierarchical vs non-hierarchical default labels.
1674 */
1675function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
1676        $object->labels = (array) $object->labels;
1677
1678        if ( isset( $object->label ) && empty( $object->labels['name'] ) )
1679                $object->labels['name'] = $object->label;
1680
1681        if ( !isset( $object->labels['singular_name'] ) && isset( $object->labels['name'] ) )
1682                $object->labels['singular_name'] = $object->labels['name'];
1683
1684        if ( ! isset( $object->labels['name_admin_bar'] ) )
1685                $object->labels['name_admin_bar'] = isset( $object->labels['singular_name'] ) ? $object->labels['singular_name'] : $object->name;
1686
1687        if ( !isset( $object->labels['menu_name'] ) && isset( $object->labels['name'] ) )
1688                $object->labels['menu_name'] = $object->labels['name'];
1689
1690        if ( !isset( $object->labels['all_items'] ) && isset( $object->labels['menu_name'] ) )
1691                $object->labels['all_items'] = $object->labels['menu_name'];
1692
1693        $defaults = array();
1694        foreach ( $nohier_vs_hier_defaults as $key => $value ) {
1695                $defaults[$key] = $object->hierarchical ? $value[1] : $value[0];
1696        }
1697        $labels = array_merge( $defaults, $object->labels );
1698        return (object)$labels;
1699}
1700
1701/**
1702 * Add submenus for post types.
1703 *
1704 * @access private
1705 * @since 3.1.0
1706 */
1707function _add_post_type_submenus() {
1708        foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) {
1709                $ptype_obj = get_post_type_object( $ptype );
1710                // Sub-menus only.
1711                if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true )
1712                        continue;
1713                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" );
1714        }
1715}
1716
1717/**
1718 * Register support of certain features for a post type.
1719 *
1720 * All core features are directly associated with a functional area of the edit
1721 * screen, such as the editor or a meta box. Features include: 'title', 'editor',
1722 * 'comments', 'revisions', 'trackbacks', 'author', 'excerpt', 'page-attributes',
1723 * 'thumbnail', 'custom-fields', and 'post-formats'.
1724 *
1725 * Additionally, the 'revisions' feature dictates whether the post type will
1726 * store revisions, and the 'comments' feature dictates whether the comments
1727 * count will show on the edit screen.
1728 *
1729 * @since 3.0.0
1730 *
1731 * @param string       $post_type The post type for which to add the feature.
1732 * @param string|array $feature   The feature being added, accepts an array of
1733 *                                feature strings or a single string.
1734 */
1735function add_post_type_support( $post_type, $feature ) {
1736        global $_wp_post_type_features;
1737
1738        $features = (array) $feature;
1739        foreach ($features as $feature) {
1740                if ( func_num_args() == 2 )
1741                        $_wp_post_type_features[$post_type][$feature] = true;
1742                else
1743                        $_wp_post_type_features[$post_type][$feature] = array_slice( func_get_args(), 2 );
1744        }
1745}
1746
1747/**
1748 * Remove support for a feature from a post type.
1749 *
1750 * @since 3.0.0
1751 *
1752 * @param string $post_type The post type for which to remove the feature.
1753 * @param string $feature   The feature being removed.
1754 */
1755function remove_post_type_support( $post_type, $feature ) {
1756        global $_wp_post_type_features;
1757
1758        unset( $_wp_post_type_features[ $post_type ][ $feature ] );
1759}
1760
1761/**
1762 * Get all the post type features
1763 *
1764 * @since 3.4.0
1765 *
1766 * @param string $post_type The post type.
1767 * @return array Post type supports list.
1768 */
1769function get_all_post_type_supports( $post_type ) {
1770        global $_wp_post_type_features;
1771
1772        if ( isset( $_wp_post_type_features[$post_type] ) )
1773                return $_wp_post_type_features[$post_type];
1774
1775        return array();
1776}
1777
1778/**
1779 * Check a post type's support for a given feature.
1780 *
1781 * @since 3.0.0
1782 *
1783 * @param string $post_type The post type being checked.
1784 * @param string $feature the feature being checked.
1785 * @return bool Whether the post type supports the given feature.
1786 */
1787function post_type_supports( $post_type, $feature ) {
1788        global $_wp_post_type_features;
1789
1790        return ( isset( $_wp_post_type_features[$post_type][$feature] ) );
1791}
1792
1793/**
1794 * Update the post type for the post ID.
1795 *
1796 * The page or post cache will be cleaned for the post ID.
1797 *
1798 * @since 2.5.0
1799 *
1800 * @global wpdb $wpdb WordPress database abstraction object.
1801 *
1802 * @param int    $post_id   Optional. Post ID to change post type. Default 0.
1803 * @param string $post_type Optional. Post type. Accepts 'post' or 'page' to
1804 *                          name a few. Default 'post'.
1805 * @return int Amount of rows changed. Should be 1 for success and 0 for failure.
1806 */
1807function set_post_type( $post_id = 0, $post_type = 'post' ) {
1808        global $wpdb;
1809
1810        $post_type = sanitize_post_field('post_type', $post_type, $post_id, 'db');
1811        $return = $wpdb->update( $wpdb->posts, array('post_type' => $post_type), array('ID' => $post_id) );
1812
1813        clean_post_cache( $post_id );
1814
1815        return $return;
1816}
1817
1818/**
1819 * Retrieve list of latest posts or posts matching criteria.
1820 *
1821 * The defaults are as follows:
1822 *
1823 * @since 1.2.0
1824 *
1825 * @see WP_Query::parse_query()
1826 *
1827 * @param array $args {
1828 *     Optional. Arguments to retrieve posts. {@see WP_Query::parse_query()} for more
1829 *     available arguments.
1830 *
1831 *     @type int        $numberposts      Total number of posts to retrieve. Is an alias of $posts_per_page
1832 *                                        in WP_Query. Accepts 1+ and -1 for all. Default 5.
1833 *     @type int        $offset           The number of posts to offset before retrieval. Default 0.
1834 *     @type int|string $category         Category ID or comma-separated list of IDs (this or any children).
1835 *                                        Is an alias of $cat in WP_Query. Default 0.
1836 *     @type string     $orderby          Which field to order posts by. Accepts post fields. Default 'date'.
1837 *     @type array      $include          An array of post IDs to retrieve, sticky posts will be included.
1838 *                                        Is an alias of $post__in in WP_Query. Default empty array.
1839 *     @type array      $exclude          An array of post IDs not to retrieve. Default empty array.
1840 *     @type string     $meta_key         Custom field key. Default empty.
1841 *     @type mixed      $meta_value       Custom field value. Default empty string.
1842 *     @type string     $post_type        Post type. Default 'post'.
1843 *     @type bool       $suppress_filters Whether to suppress filters. Default true.
1844 * }
1845 * @return array List of posts.
1846 */
1847function get_posts( $args = null ) {
1848        $defaults = array(
1849                'numberposts' => 5, 'offset' => 0,
1850                'category' => 0, 'orderby' => 'date',
1851                'order' => 'DESC', 'include' => array(),
1852                'exclude' => array(), 'meta_key' => '',
1853                'meta_value' =>'', 'post_type' => 'post',
1854                'suppress_filters' => true
1855        );
1856
1857        $r = wp_parse_args( $args, $defaults );
1858        if ( empty( $r['post_status'] ) )
1859                $r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish';
1860        if ( ! empty($r['numberposts']) && empty($r['posts_per_page']) )
1861                $r['posts_per_page'] = $r['numberposts'];
1862        if ( ! empty($r['category']) )
1863                $r['cat'] = $r['category'];
1864        if ( ! empty($r['include']) ) {
1865                $incposts = wp_parse_id_list( $r['include'] );
1866                $r['posts_per_page'] = count($incposts);  // only the number of posts included
1867                $r['post__in'] = $incposts;
1868        } elseif ( ! empty($r['exclude']) )
1869                $r['post__not_in'] = wp_parse_id_list( $r['exclude'] );
1870
1871        $r['ignore_sticky_posts'] = true;
1872        $r['no_found_rows'] = true;
1873
1874        $get_posts = new WP_Query;
1875        return $get_posts->query($r);
1876
1877}
1878
1879//
1880// Post meta functions
1881//
1882
1883/**
1884 * Add meta data field to a post.
1885 *
1886 * Post meta data is called "Custom Fields" on the Administration Screen.
1887 *
1888 * @since 1.5.0
1889 *
1890 * @param int    $post_id    Post ID.
1891 * @param string $meta_key   Metadata name.
1892 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
1893 * @param bool   $unique     Optional. Whether the same key should not be added.
1894 *                           Default false.
1895 * @return int|bool Meta ID on success, false on failure.
1896 */
1897function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {
1898        // Make sure meta is added to the post, not a revision.
1899        if ( $the_post = wp_is_post_revision($post_id) )
1900                $post_id = $the_post;
1901
1902        return add_metadata('post', $post_id, $meta_key, $meta_value, $unique);
1903}
1904
1905/**
1906 * Remove metadata matching criteria from a post.
1907 *
1908 * You can match based on the key, or key and value. Removing based on key and
1909 * value, will keep from removing duplicate metadata with the same key. It also
1910 * allows removing all metadata matching key, if needed.
1911 *
1912 * @since 1.5.0
1913 *
1914 * @param int    $post_id    Post ID.
1915 * @param string $meta_key   Metadata name.
1916 * @param mixed  $meta_value Optional. Metadata value. Must be serializable if
1917 *                           non-scalar. Default empty.
1918 * @return bool True on success, false on failure.
1919 */
1920function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
1921        // Make sure meta is added to the post, not a revision.
1922        if ( $the_post = wp_is_post_revision($post_id) )
1923                $post_id = $the_post;
1924
1925        return delete_metadata('post', $post_id, $meta_key, $meta_value);
1926}
1927
1928/**
1929 * Retrieve post meta field for a post.
1930 *
1931 * @since 1.5.0
1932 *
1933 * @param int    $post_id Post ID.
1934 * @param string $key     Optional. The meta key to retrieve. By default, returns
1935 *                        data for all keys. Default empty.
1936 * @param bool   $single  Optional. Whether to return a single value. Default false.
1937 * @return mixed Will be an array if $single is false. Will be value of meta data
1938 *               field if $single is true.
1939 */
1940function get_post_meta( $post_id, $key = '', $single = false ) {
1941        return get_metadata('post', $post_id, $key, $single);
1942}
1943
1944/**
1945 * Update post meta field based on post ID.
1946 *
1947 * Use the $prev_value parameter to differentiate between meta fields with the
1948 * same key and post ID.
1949 *
1950 * If the meta field for the post does not exist, it will be added.
1951 *
1952 * @since 1.5.0
1953 *
1954 * @param int    $post_id    Post ID.
1955 * @param string $meta_key   Metadata key.
1956 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
1957 * @param mixed  $prev_value Optional. Previous value to check before removing.
1958 *                           Default empty.
1959 * @return int|bool Meta ID if the key didn't exist, true on successful update,
1960 *                  false on failure.
1961 */
1962function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
1963        // Make sure meta is added to the post, not a revision.
1964        if ( $the_post = wp_is_post_revision($post_id) )
1965                $post_id = $the_post;
1966
1967        return update_metadata('post', $post_id, $meta_key, $meta_value, $prev_value);
1968}
1969
1970/**
1971 * Delete everything from post meta matching meta key.
1972 *
1973 * @since 2.3.0
1974 *
1975 * @param string $post_meta_key Key to search for when deleting.
1976 * @return bool Whether the post meta key was deleted from the database.
1977 */
1978function delete_post_meta_by_key( $post_meta_key ) {
1979        return delete_metadata( 'post', null, $post_meta_key, '', true );
1980}
1981
1982/**
1983 * Retrieve post meta fields, based on post ID.
1984 *
1985 * The post meta fields are retrieved from the cache where possible,
1986 * so the function is optimized to be called more than once.
1987 *
1988 * @since 1.2.0
1989 *
1990 * @param int $post_id Optional. Post ID. Default is ID of the global $post.
1991 * @return array Post meta for the given post.
1992 */
1993function get_post_custom( $post_id = 0 ) {
1994        $post_id = absint( $post_id );
1995        if ( ! $post_id )
1996                $post_id = get_the_ID();
1997
1998        return get_post_meta( $post_id );
1999}
2000
2001/**
2002 * Retrieve meta field names for a post.
2003 *
2004 * If there are no meta fields, then nothing (null) will be returned.
2005 *
2006 * @since 1.2.0
2007 *
2008 * @param int $post_id Optional. Post ID. Default is ID of the global $post.
2009 * @return array|null Either array of the keys, or null if keys could not be
2010 *                    retrieved.
2011 */
2012function get_post_custom_keys( $post_id = 0 ) {
2013        $custom = get_post_custom( $post_id );
2014
2015        if ( !is_array($custom) )
2016                return;
2017
2018        if ( $keys = array_keys($custom) )
2019                return $keys;
2020}
2021
2022/**
2023 * Retrieve values for a custom post field.
2024 *
2025 * The parameters must not be considered optional. All of the post meta fields
2026 * will be retrieved and only the meta field key values returned.
2027 *
2028 * @since 1.2.0
2029 *
2030 * @param string $key     Optional. Meta field key. Default empty.
2031 * @param int    $post_id Optional. Post ID. Default is ID of the global $post.
2032 * @return array Meta field values.
2033 */
2034function get_post_custom_values( $key = '', $post_id = 0 ) {
2035        if ( !$key )
2036                return null;
2037
2038        $custom = get_post_custom($post_id);
2039
2040        return isset($custom[$key]) ? $custom[$key] : null;
2041}
2042
2043/**
2044 * Check if post is sticky.
2045 *
2046 * Sticky posts should remain at the top of The Loop. If the post ID is not
2047 * given, then The Loop ID for the current post will be used.
2048 *
2049 * @since 2.7.0
2050 *
2051 * @param int $post_id Optional. Post ID. Default is ID of the global $post.
2052 * @return bool Whether post is sticky.
2053 */
2054function is_sticky( $post_id = 0 ) {
2055        $post_id = absint( $post_id );
2056
2057        if ( ! $post_id )
2058                $post_id = get_the_ID();
2059
2060        $stickies = get_option( 'sticky_posts' );
2061
2062        if ( ! is_array( $stickies ) )
2063                return false;
2064
2065        if ( in_array( $post_id, $stickies ) )
2066                return true;
2067
2068        return false;
2069}
2070
2071/**
2072 * Sanitize every post field.
2073 *
2074 * If the context is 'raw', then the post object or array will get minimal
2075 * sanitization of the integer fields.
2076 *
2077 * @since 2.3.0
2078 *
2079 * @see sanitize_post_field()
2080 *
2081 * @param object|WP_Post|array $post    The Post Object or Array
2082 * @param string               $context Optional. How to sanitize post fields.
2083 *                                      Accepts 'raw', 'edit', 'db', or 'display'.
2084 *                                      Default 'display'.
2085 * @return object|WP_Post|array The now sanitized Post Object or Array (will be the
2086 *                              same type as $post).
2087 */
2088function sanitize_post( $post, $context = 'display' ) {
2089        if ( is_object($post) ) {
2090                // Check if post already filtered for this context.
2091                if ( isset($post->filter) && $context == $post->filter )
2092                        return $post;
2093                if ( !isset($post->ID) )
2094                        $post->ID = 0;
2095                foreach ( array_keys(get_object_vars($post)) as $field )
2096                        $post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context);
2097                $post->filter = $context;
2098        } else {
2099                // Check if post already filtered for this context.
2100                if ( isset($post['filter']) && $context == $post['filter'] )
2101                        return $post;
2102                if ( !isset($post['ID']) )
2103                        $post['ID'] = 0;
2104                foreach ( array_keys($post) as $field )
2105                        $post[$field] = sanitize_post_field($field, $post[$field], $post['ID'], $context);
2106                $post['filter'] = $context;
2107        }
2108        return $post;
2109}
2110
2111/**
2112 * Sanitize post field based on context.
2113 *
2114 * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and
2115 * 'js'. The 'display' context is used by default. 'attribute' and 'js' contexts
2116 * are treated like 'display' when calling filters.
2117 *
2118 * @since 2.3.0
2119 *
2120 * @param string $field   The Post Object field name.
2121 * @param mixed  $value   The Post Object value.
2122 * @param int    $post_id Post ID.
2123 * @param string $context How to sanitize post fields. Looks for 'raw', 'edit',
2124 *                        'db', 'display', 'attribute' and 'js'.
2125 * @return mixed Sanitized value.
2126 */
2127function sanitize_post_field($field, $value, $post_id, $context) {
2128        $int_fields = array('ID', 'post_parent', 'menu_order');
2129        if ( in_array($field, $int_fields) )
2130                $value = (int) $value;
2131
2132        // Fields which contain arrays of integers.
2133        $array_int_fields = array( 'ancestors' );
2134        if ( in_array($field, $array_int_fields) ) {
2135                $value = array_map( 'absint', $value);
2136                return $value;
2137        }
2138
2139        if ( 'raw' == $context )
2140                return $value;
2141
2142        $prefixed = false;
2143        if ( false !== strpos($field, 'post_') ) {
2144                $prefixed = true;
2145                $field_no_prefix = str_replace('post_', '', $field);
2146        }
2147
2148        if ( 'edit' == $context ) {
2149                $format_to_edit = array('post_content', 'post_excerpt', 'post_title', 'post_password');
2150
2151                if ( $prefixed ) {
2152
2153                        /**
2154                         * Filter the value of a specific post field to edit.
2155                         *
2156                         * The dynamic portion of the hook name, `$field`, refers to the post
2157                         * field name.
2158                         *
2159                         * @since 2.3.0
2160                         *
2161                         * @param mixed $value   Value of the post field.
2162                         * @param int   $post_id Post ID.
2163                         */
2164                        $value = apply_filters( "edit_{$field}", $value, $post_id );
2165
2166                        /**
2167                         * Filter the value of a specific post field to edit.
2168                         *
2169                         * The dynamic portion of the hook name, `$field_no_prefix`, refers to
2170                         * the post field name.
2171                         *
2172                         * @since 2.3.0
2173                         *
2174                         * @param mixed $value   Value of the post field.
2175                         * @param int   $post_id Post ID.
2176                         */
2177                        $value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id );
2178                } else {
2179                        $value = apply_filters( "edit_post_{$field}", $value, $post_id );
2180                }
2181
2182                if ( in_array($field, $format_to_edit) ) {
2183                        if ( 'post_content' == $field )
2184                                $value = format_to_edit($value, user_can_richedit());
2185                        else
2186                                $value = format_to_edit($value);
2187                } else {
2188                        $value = esc_attr($value);
2189                }
2190        } elseif ( 'db' == $context ) {
2191                if ( $prefixed ) {
2192
2193                        /**
2194                         * Filter the value of a specific post field before saving.
2195                         *
2196                         * The dynamic portion of the hook name, `$field`, refers to the post
2197                         * field name.
2198                         *
2199                         * @since 2.3.0
2200                         *
2201                         * @param mixed $value Value of the post field.
2202                         */
2203                        $value = apply_filters( "pre_{$field}", $value );
2204
2205                        /**
2206                         * Filter the value of a specific field before saving.
2207                         *
2208                         * The dynamic portion of the hook name, `$field_no_prefix`, refers
2209                         * to the post field name.
2210                         *
2211                         * @since 2.3.0
2212                         *
2213                         * @param mixed $value Value of the post field.
2214                         */
2215                        $value = apply_filters( "{$field_no_prefix}_save_pre", $value );
2216                } else {
2217                        $value = apply_filters( "pre_post_{$field}", $value );
2218
2219                        /**
2220                         * Filter the value of a specific post field before saving.
2221                         *
2222                         * The dynamic portion of the hook name, `$field`, refers to the post
2223                         * field name.
2224                         *
2225                         * @since 2.3.0
2226                         *
2227                         * @param mixed $value Value of the post field.
2228                         */
2229                        $value = apply_filters( "{$field}_pre", $value );
2230                }
2231        } else {
2232
2233                // Use display filters by default.
2234                if ( $prefixed ) {
2235
2236                        /**
2237                         * Filter the value of a specific post field for display.
2238                         *
2239                         * The dynamic portion of the hook name, `$field`, refers to the post
2240                         * field name.
2241                         *
2242                         * @since 2.3.0
2243                         *
2244                         * @param mixed  $value   Value of the prefixed post field.
2245                         * @param int    $post_id Post ID.
2246                         * @param string $context Context for how to sanitize the field. Possible
2247                         *                        values include 'raw', 'edit', 'db', 'display',
2248                         *                        'attribute' and 'js'.
2249                         */
2250                        $value = apply_filters( $field, $value, $post_id, $context );
2251                } else {
2252                        $value = apply_filters( "post_{$field}", $value, $post_id, $context );
2253                }
2254        }
2255
2256        if ( 'attribute' == $context )
2257                $value = esc_attr($value);
2258        elseif ( 'js' == $context )
2259                $value = esc_js($value);
2260
2261        return $value;
2262}
2263
2264/**
2265 * Make a post sticky.
2266 *
2267 * Sticky posts should be displayed at the top of the front page.
2268 *
2269 * @since 2.7.0
2270 *
2271 * @param int $post_id Post ID.
2272 */
2273function stick_post( $post_id ) {
2274        $stickies = get_option('sticky_posts');
2275
2276        if ( !is_array($stickies) )
2277                $stickies = array($post_id);
2278
2279        if ( ! in_array($post_id, $stickies) )
2280                $stickies[] = $post_id;
2281
2282        update_option('sticky_posts', $stickies);
2283}
2284
2285/**
2286 * Un-stick a post.
2287 *
2288 * Sticky posts should be displayed at the top of the front page.
2289 *
2290 * @since 2.7.0
2291 *
2292 * @param int $post_id Post ID.
2293 */
2294function unstick_post( $post_id ) {
2295        $stickies = get_option('sticky_posts');
2296
2297        if ( !is_array($stickies) )
2298                return;
2299
2300        if ( ! in_array($post_id, $stickies) )
2301                return;
2302
2303        $offset = array_search($post_id, $stickies);
2304        if ( false === $offset )
2305                return;
2306
2307        array_splice($stickies, $offset, 1);
2308
2309        update_option('sticky_posts', $stickies);
2310}
2311
2312/**
2313 * Return the cache key for wp_count_posts() based on the passed arguments.
2314 *
2315 * @since 3.9.0
2316 *
2317 * @param string $type Optional. Post type to retrieve count Default 'post'.
2318 * @param string $perm Optional. 'readable' or empty. Default empty.
2319 * @return string The cache key.
2320 */
2321function _count_posts_cache_key( $type = 'post', $perm = '' ) {
2322        $cache_key = 'posts-' . $type;
2323        if ( 'readable' == $perm && is_user_logged_in() ) {
2324                $post_type_object = get_post_type_object( $type );
2325                if ( $post_type_object && ! current_user_can( $post_type_object->cap->read_private_posts ) ) {
2326                        $cache_key .= '_' . $perm . '_' . get_current_user_id();
2327                }
2328        }
2329        return $cache_key;
2330}
2331
2332/**
2333 * Count number of posts of a post type and if user has permissions to view.
2334 *
2335 * This function provides an efficient method of finding the amount of post's
2336 * type a blog has. Another method is to count the amount of items in
2337 * get_posts(), but that method has a lot of overhead with doing so. Therefore,
2338 * when developing for 2.5+, use this function instead.
2339 *
2340 * The $perm parameter checks for 'readable' value and if the user can read
2341 * private posts, it will display that for the user that is signed in.
2342 *
2343 * @since 2.5.0
2344 *
2345 * @param string $type Optional. Post type to retrieve count. Default 'post'.
2346 * @param string $perm Optional. 'readable' or empty. Default empty.
2347 * @return object Number of posts for each status.
2348 */
2349function wp_count_posts( $type = 'post', $perm = '' ) {
2350        global $wpdb;
2351
2352        if ( ! post_type_exists( $type ) )
2353                return new stdClass;
2354
2355        $cache_key = _count_posts_cache_key( $type, $perm );
2356
2357        $counts = wp_cache_get( $cache_key, 'counts' );
2358        if ( false !== $counts ) {
2359                /** This filter is documented in wp-includes/post.php */
2360                return apply_filters( 'wp_count_posts', $counts, $type, $perm );
2361        }
2362
2363        $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s";
2364        if ( 'readable' == $perm && is_user_logged_in() ) {
2365                $post_type_object = get_post_type_object($type);
2366                if ( ! current_user_can( $post_type_object->cap->read_private_posts ) ) {
2367                        $query .= $wpdb->prepare( " AND (post_status != 'private' OR ( post_author = %d AND post_status = 'private' ))",
2368                                get_current_user_id()
2369                        );
2370                }
2371        }
2372        $query .= ' GROUP BY post_status';
2373
2374        $results = (array) $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A );
2375        $counts = array_fill_keys( get_post_stati(), 0 );
2376
2377        foreach ( $results as $row ) {
2378                $counts[ $row['post_status'] ] = $row['num_posts'];
2379        }
2380
2381        $counts = (object) $counts;
2382        wp_cache_set( $cache_key, $counts, 'counts' );
2383
2384        /**
2385         * Modify returned post counts by status for the current post type.
2386         *
2387         * @since 3.7.0
2388         *
2389         * @param object $counts An object containing the current post_type's post
2390         *                       counts by status.
2391         * @param string $type   Post type.
2392         * @param string $perm   The permission to determine if the posts are 'readable'
2393         *                       by the current user.
2394         */
2395        return apply_filters( 'wp_count_posts', $counts, $type, $perm );
2396}
2397
2398/**
2399 * Count number of attachments for the mime type(s).
2400 *
2401 * If you set the optional mime_type parameter, then an array will still be
2402 * returned, but will only have the item you are looking for. It does not give
2403 * you the number of attachments that are children of a post. You can get that
2404 * by counting the number of children that post has.
2405 *
2406 * @since 2.5.0
2407 *
2408 * @param string|array $mime_type Optional. Array or comma-separated list of
2409 *                                MIME patterns. Default empty.
2410 * @return object An object containing the attachment counts by mime type.
2411 */
2412function wp_count_attachments( $mime_type = '' ) {
2413        global $wpdb;
2414
2415        $and = wp_post_mime_type_where( $mime_type );
2416        $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 );
2417
2418        $counts = array();
2419        foreach( (array) $count as $row ) {
2420                $counts[ $row['post_mime_type'] ] = $row['num_posts'];
2421        }
2422        $counts['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and");
2423
2424        /**
2425         * Modify returned attachment counts by mime type.
2426         *
2427         * @since 3.7.0
2428         *
2429         * @param object $counts    An object containing the attachment counts by
2430         *                          mime type.
2431         * @param string $mime_type The mime type pattern used to filter the attachments
2432         *                          counted.
2433         */
2434        return apply_filters( 'wp_count_attachments', (object) $counts, $mime_type );
2435}
2436
2437/**
2438 * Get default post mime types.
2439 *
2440 * @since 2.9.0
2441 *
2442 * @return array List of post mime types.
2443 */
2444function get_post_mime_types() {
2445        $post_mime_types = array(       //      array( adj, noun )
2446                'image' => array(__('Images'), __('Manage Images'), _n_noop('Image <span class="count">(%s)</span>', 'Images <span class="count">(%s)</span>')),
2447                'audio' => array(__('Audio'), __('Manage Audio'), _n_noop('Audio <span class="count">(%s)</span>', 'Audio <span class="count">(%s)</span>')),
2448                'video' => array(__('Video'), __('Manage Video'), _n_noop('Video <span class="count">(%s)</span>', 'Video <span class="count">(%s)</span>')),
2449        );
2450
2451        /**
2452         * Filter the default list of post mime types.
2453         *
2454         * @since 2.5.0
2455         *
2456         * @param array $post_mime_types Default list of post mime types.
2457         */
2458        return apply_filters( 'post_mime_types', $post_mime_types );
2459}
2460
2461/**
2462 * Check a MIME-Type against a list.
2463 *
2464 * If the wildcard_mime_types parameter is a string, it must be comma separated
2465 * list. If the real_mime_types is a string, it is also comma separated to
2466 * create the list.
2467 *
2468 * @since 2.5.0
2469 *
2470 * @param string|array $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*)
2471 *                                          or flash (same as *flash*).
2472 * @param string|array $real_mime_types     Real post mime type values.
2473 * @return array array(wildcard=>array(real types)).
2474 */
2475function wp_match_mime_types( $wildcard_mime_types, $real_mime_types ) {
2476        $matches = array();
2477        if ( is_string( $wildcard_mime_types ) ) {
2478                $wildcard_mime_types = array_map( 'trim', explode( ',', $wildcard_mime_types ) );
2479        }
2480        if ( is_string( $real_mime_types ) ) {
2481                $real_mime_types = array_map( 'trim', explode( ',', $real_mime_types ) );
2482        }
2483
2484        $patternses = array();
2485        $wild = '[-._a-z0-9]*';
2486
2487        foreach ( (array) $wildcard_mime_types as $type ) {
2488                $mimes = array_map( 'trim', explode( ',', $type ) );
2489                foreach ( $mimes as $mime ) {
2490                        $regex = str_replace( '__wildcard__', $wild, preg_quote( str_replace( '*', '__wildcard__', $mime ) ) );
2491                        $patternses[][$type] = "^$regex$";
2492                        if ( false === strpos( $mime, '/' ) ) {
2493                                $patternses[][$type] = "^$regex/";
2494                                $patternses[][$type] = $regex;
2495                        }
2496                }
2497        }
2498        asort( $patternses );
2499
2500        foreach ( $patternses as $patterns ) {
2501                foreach ( $patterns as $type => $pattern ) {
2502                        foreach ( (array) $real_mime_types as $real ) {
2503                                if ( preg_match( "#$pattern#", $real ) && ( empty( $matches[$type] ) || false === array_search( $real, $matches[$type] ) ) ) {
2504                                        $matches[$type][] = $real;
2505                                }
2506                        }
2507                }
2508        }
2509        return $matches;
2510}
2511
2512/**
2513 * Convert MIME types into SQL.
2514 *
2515 * @since 2.5.0
2516 *
2517 * @param string|array $post_mime_types List of mime types or comma separated string
2518 *                                      of mime types.
2519 * @param string       $table_alias     Optional. Specify a table alias, if needed.
2520 *                                      Default empty.
2521 * @return string The SQL AND clause for mime searching.
2522 */
2523function wp_post_mime_type_where( $post_mime_types, $table_alias = '' ) {
2524        $where = '';
2525        $wildcards = array('', '%', '%/%');
2526        if ( is_string($post_mime_types) )
2527                $post_mime_types = array_map('trim', explode(',', $post_mime_types));
2528
2529        $wheres = array();
2530
2531        foreach ( (array) $post_mime_types as $mime_type ) {
2532                $mime_type = preg_replace('/\s/', '', $mime_type);
2533                $slashpos = strpos($mime_type, '/');
2534                if ( false !== $slashpos ) {
2535                        $mime_group = preg_replace('/[^-*.a-zA-Z0-9]/', '', substr($mime_type, 0, $slashpos));
2536                        $mime_subgroup = preg_replace('/[^-*.+a-zA-Z0-9]/', '', substr($mime_type, $slashpos + 1));
2537                        if ( empty($mime_subgroup) )
2538                                $mime_subgroup = '*';
2539                        else
2540                                $mime_subgroup = str_replace('/', '', $mime_subgroup);
2541                        $mime_pattern = "$mime_group/$mime_subgroup";
2542                } else {
2543                        $mime_pattern = preg_replace('/[^-*.a-zA-Z0-9]/', '', $mime_type);
2544                        if ( false === strpos($mime_pattern, '*') )
2545                                $mime_pattern .= '/*';
2546                }
2547
2548                $mime_pattern = preg_replace('/\*+/', '%', $mime_pattern);
2549
2550                if ( in_array( $mime_type, $wildcards ) )
2551                        return '';
2552
2553                if ( false !== strpos($mime_pattern, '%') )
2554                        $wheres[] = empty($table_alias) ? "post_mime_type LIKE '$mime_pattern'" : "$table_alias.post_mime_type LIKE '$mime_pattern'";
2555                else
2556                        $wheres[] = empty($table_alias) ? "post_mime_type = '$mime_pattern'" : "$table_alias.post_mime_type = '$mime_pattern'";
2557        }
2558        if ( !empty($wheres) )
2559                $where = ' AND (' . join(' OR ', $wheres) . ') ';
2560        return $where;
2561}
2562
2563/**
2564 * Trash or delete a post or page.
2565 *
2566 * When the post and page is permanently deleted, everything that is tied to
2567 * it is deleted also. This includes comments, post meta fields, and terms
2568 * associated with the post.
2569 *
2570 * The post or page is moved to trash instead of permanently deleted unless
2571 * trash is disabled, item is already in the trash, or $force_delete is true.
2572 *
2573 * @since 1.0.0
2574 *
2575 * @global wpdb $wpdb WordPress database abstraction object.
2576 * @see wp_delete_attachment()
2577 * @see wp_trash_post()
2578 *
2579 * @param int  $postid       Optional. Post ID. Default 0.
2580 * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
2581 *                           Default false.
2582 * @return array|bool|WP_Post False on failure.
2583 */
2584function wp_delete_post( $postid = 0, $force_delete = false ) {
2585        global $wpdb;
2586
2587        if ( !$post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) )
2588                return $post;
2589
2590        if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS )
2591                        return wp_trash_post($postid);
2592
2593        if ( $post->post_type == 'attachment' )
2594                return wp_delete_attachment( $postid, $force_delete );
2595
2596        /**
2597         * Fires before a post is deleted, at the start of wp_delete_post().
2598         *
2599         * @since 3.2.0
2600         *
2601         * @see wp_delete_post()
2602         *
2603         * @param int $postid Post ID.
2604         */
2605        do_action( 'before_delete_post', $postid );
2606
2607        delete_post_meta($postid,'_wp_trash_meta_status');
2608        delete_post_meta($postid,'_wp_trash_meta_time');
2609
2610        wp_delete_object_term_relationships($postid, get_object_taxonomies($post->post_type));
2611
2612        $parent_data = array( 'post_parent' => $post->post_parent );
2613        $parent_where = array( 'post_parent' => $postid );
2614
2615        if ( is_post_type_hierarchical( $post->post_type ) ) {
2616                // Point children of this page to its parent, also clean the cache of affected children.
2617                $children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type );
2618                $children = $wpdb->get_results( $children_query );
2619
2620                $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) );
2621        }
2622
2623        // Do raw query. wp_get_post_revisions() is filtered.
2624        $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
2625        // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
2626        foreach ( $revision_ids as $revision_id )
2627                wp_delete_post_revision( $revision_id );
2628
2629        // Point all attachments to this post up one level.
2630        $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
2631
2632        $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid ));
2633        foreach ( $comment_ids as $comment_id )
2634                wp_delete_comment( $comment_id, true );
2635
2636        $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $postid ));
2637        foreach ( $post_meta_ids as $mid )
2638                delete_metadata_by_mid( 'post', $mid );
2639
2640        /**
2641         * Fires immediately before a post is deleted from the database.
2642         *
2643         * @since 1.2.0
2644         *
2645         * @param int $postid Post ID.
2646         */
2647        do_action( 'delete_post', $postid );
2648        $result = $wpdb->delete( $wpdb->posts, array( 'ID' => $postid ) );
2649        if ( ! $result ) {
2650                return false;
2651        }
2652
2653        /**
2654         * Fires immediately after a post is deleted from the database.
2655         *
2656         * @since 2.2.0
2657         *
2658         * @param int $postid Post ID.
2659         */
2660        do_action( 'deleted_post', $postid );
2661
2662        clean_post_cache( $post );
2663
2664        if ( is_post_type_hierarchical( $post->post_type ) && $children ) {
2665                foreach ( $children as $child )
2666                        clean_post_cache( $child );
2667        }
2668
2669        wp_clear_scheduled_hook('publish_future_post', array( $postid ) );
2670
2671        /**
2672         * Fires after a post is deleted, at the conclusion of wp_delete_post().
2673         *
2674         * @since 3.2.0
2675         *
2676         * @see wp_delete_post()
2677         *
2678         * @param int $postid Post ID.
2679         */
2680        do_action( 'after_delete_post', $postid );
2681
2682        return $post;
2683}
2684
2685/**
2686 * Reset the page_on_front, show_on_front, and page_for_post settings when
2687 * a linked page is deleted or trashed.
2688 *
2689 * Also ensures the post is no longer sticky.
2690 *
2691 * @since 3.7.0
2692 * @access private
2693 *
2694 * @param int $post_id Post ID.
2695 */
2696function _reset_front_page_settings_for_post( $post_id ) {
2697        $post = get_post( $post_id );
2698        if ( 'page' == $post->post_type ) {
2699                /*
2700                 * If the page is defined in option page_on_front or post_for_posts,
2701                 * adjust the corresponding options.
2702                 */
2703                if ( get_option( 'page_on_front' ) == $post->ID ) {
2704                        update_option( 'show_on_front', 'posts' );
2705                        update_option( 'page_on_front', 0 );
2706                }
2707                if ( get_option( 'page_for_posts' ) == $post->ID ) {
2708                        delete_option( 'page_for_posts', 0 );
2709                }
2710        }
2711        unstick_post( $post->ID );
2712}
2713
2714/**
2715 * Move a post or page to the Trash
2716 *
2717 * If trash is disabled, the post or page is permanently deleted.
2718 *
2719 * @since 2.9.0
2720 *
2721 * @see wp_delete_post()
2722 *
2723 * @param int $post_id Optional. Post ID. Default is ID of the global $post
2724 *                     if EMPTY_TRASH_DAYS equals true.
2725 * @return bool|array Post data array, otherwise false.
2726 */
2727function wp_trash_post( $post_id = 0 ) {
2728        if ( !EMPTY_TRASH_DAYS )
2729                return wp_delete_post($post_id, true);
2730
2731        if ( !$post = get_post($post_id, ARRAY_A) )
2732                return $post;
2733
2734        if ( $post['post_status'] == 'trash' )
2735                return false;
2736
2737        /**
2738         * Fires before a post is sent to the trash.
2739         *
2740         * @since 3.3.0
2741         *
2742         * @param int $post_id Post ID.
2743         */
2744        do_action( 'wp_trash_post', $post_id );
2745
2746        add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']);
2747        add_post_meta($post_id,'_wp_trash_meta_time', time());
2748
2749        $post['post_status'] = 'trash';
2750        wp_insert_post($post);
2751
2752        wp_trash_post_comments($post_id);
2753
2754        /**
2755         * Fires after a post is sent to the trash.
2756         *
2757         * @since 2.9.0
2758         *
2759         * @param int $post_id Post ID.
2760         */
2761        do_action( 'trashed_post', $post_id );
2762
2763        return $post;
2764}
2765
2766/**
2767 * Restore a post or page from the Trash.
2768 *
2769 * @since 2.9.0
2770 *
2771 * @param int $post_id Optional. Post ID. Default is ID of the global $post.
2772 * @return WP_Post|bool WP_Post object. False on failure.
2773 */
2774function wp_untrash_post( $post_id = 0 ) {
2775        if ( !$post = get_post($post_id, ARRAY_A) )
2776                return $post;
2777
2778        if ( $post['post_status'] != 'trash' )
2779                return false;
2780
2781        /**
2782         * Fires before a post is restored from the trash.
2783         *
2784         * @since 2.9.0
2785         *
2786         * @param int $post_id Post ID.
2787         */
2788        do_action( 'untrash_post', $post_id );
2789
2790        $post_status = get_post_meta($post_id, '_wp_trash_meta_status', true);
2791
2792        $post['post_status'] = $post_status;
2793
2794        delete_post_meta($post_id, '_wp_trash_meta_status');
2795        delete_post_meta($post_id, '_wp_trash_meta_time');
2796
2797        wp_insert_post($post);
2798
2799        wp_untrash_post_comments($post_id);
2800
2801        /**
2802         * Fires after a post is restored from the trash.
2803         *
2804         * @since 2.9.0
2805         *
2806         * @param int $post_id Post ID.
2807         */
2808        do_action( 'untrashed_post', $post_id );
2809
2810        return $post;
2811}
2812
2813/**
2814 * Moves comments for a post to the trash.
2815 *
2816 * @since 2.9.0
2817 *
2818 * @global wpdb $wpdb WordPress database abstraction object.
2819 *
2820 * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
2821 * @return mixed False on failure.
2822 */
2823function wp_trash_post_comments( $post = null ) {
2824        global $wpdb;
2825
2826        $post = get_post($post);
2827        if ( empty($post) )
2828                return;
2829
2830        $post_id = $post->ID;
2831
2832        /**
2833         * Fires before comments are sent to the trash.
2834         *
2835         * @since 2.9.0
2836         *
2837         * @param int $post_id Post ID.
2838         */
2839        do_action( 'trash_post_comments', $post_id );
2840
2841        $comments = $wpdb->get_results( $wpdb->prepare("SELECT comment_ID, comment_approved FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id) );
2842        if ( empty($comments) )
2843                return;
2844
2845        // Cache current status for each comment.
2846        $statuses = array();
2847        foreach ( $comments as $comment )
2848                $statuses[$comment->comment_ID] = $comment->comment_approved;
2849        add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses);
2850
2851        // Set status for all comments to post-trashed.
2852        $result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id));
2853
2854        clean_comment_cache( array_keys($statuses) );
2855
2856        /**
2857         * Fires after comments are sent to the trash.
2858         *
2859         * @since 2.9.0
2860         *
2861         * @param int   $post_id  Post ID.
2862         * @param array $statuses Array of comment statuses.
2863         */
2864        do_action( 'trashed_post_comments', $post_id, $statuses );
2865
2866        return $result;
2867}
2868
2869/**
2870 * Restore comments for a post from the trash.
2871 *
2872 * @since 2.9.0
2873 *
2874 * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
2875 * @return null|bool Null on failure.
2876 */
2877function wp_untrash_post_comments( $post = null ) {
2878        global $wpdb;
2879
2880        $post = get_post($post);
2881        if ( empty($post) )
2882                return;
2883
2884        $post_id = $post->ID;
2885
2886        $statuses = get_post_meta($post_id, '_wp_trash_meta_comments_status', true);
2887
2888        if ( empty($statuses) )
2889                return true;
2890
2891        /**
2892         * Fires before comments are restored for a post from the trash.
2893         *
2894         * @since 2.9.0
2895         *
2896         * @param int $post_id Post ID.
2897         */
2898        do_action( 'untrash_post_comments', $post_id );
2899
2900        // Restore each comment to its original status.
2901        $group_by_status = array();
2902        foreach ( $statuses as $comment_id => $comment_status )
2903                $group_by_status[$comment_status][] = $comment_id;
2904
2905        foreach ( $group_by_status as $status => $comments ) {
2906                // Sanity check. This shouldn't happen.
2907                if ( 'post-trashed' == $status )
2908                        $status = '0';
2909                $comments_in = implode( "', '", $comments );
2910                $wpdb->query( "UPDATE $wpdb->comments SET comment_approved = '$status' WHERE comment_ID IN ('" . $comments_in . "')" );
2911        }
2912
2913        clean_comment_cache( array_keys($statuses) );
2914
2915        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
2916
2917        /**
2918         * Fires after comments are restored for a post from the trash.
2919         *
2920         * @since 2.9.0
2921         *
2922         * @param int $post_id Post ID.
2923         */
2924        do_action( 'untrashed_post_comments', $post_id );
2925}
2926
2927/**
2928 * Retrieve the list of categories for a post.
2929 *
2930 * Compatibility layer for themes and plugins. Also an easy layer of abstraction
2931 * away from the complexity of the taxonomy layer.
2932 *
2933 * @since 2.1.0
2934 *
2935 * @see wp_get_object_terms()
2936 *
2937 * @param int   $post_id Optional. The Post ID. Does not default to the ID of the
2938 *                       global $post. Default 0.
2939 * @param array $args    Optional. Category arguments. Default empty.
2940 * @return array List of categories.
2941 */
2942function wp_get_post_categories( $post_id = 0, $args = array() ) {
2943        $post_id = (int) $post_id;
2944
2945        $defaults = array('fields' => 'ids');
2946        $args = wp_parse_args( $args, $defaults );
2947
2948        $cats = wp_get_object_terms($post_id, 'category', $args);
2949        return $cats;
2950}
2951
2952/**
2953 * Retrieve the tags for a post.
2954 *
2955 * There is only one default for this function, called 'fields' and by default
2956 * is set to 'all'. There are other defaults that can be overridden in
2957 * {@link wp_get_object_terms()}.
2958 *
2959 * @since 2.3.0
2960 *
2961 * @param int   $post_id Optional. The Post ID. Does not default to the ID of the
2962 *                       global $post. Defualt 0.
2963 * @param array $args Optional. Overwrite the defaults
2964 * @return array List of post tags.
2965 */
2966function wp_get_post_tags( $post_id = 0, $args = array() ) {
2967        return wp_get_post_terms( $post_id, 'post_tag', $args);
2968}
2969
2970/**
2971 * Retrieve the terms for a post.
2972 *
2973 * There is only one default for this function, called 'fields' and by default
2974 * is set to 'all'. There are other defaults that can be overridden in
2975 * {@link wp_get_object_terms()}.
2976 *
2977 * @since 2.8.0
2978 *
2979 * @param int    $post_id  Optional. The Post ID. Does not default to the ID of the
2980 *                         global $post. Default 0.
2981 * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
2982 * @param array  $args     Optional. {@link wp_get_object_terms()} arguments. Default empty array.
2983 * @return array List of post tags.
2984 */
2985function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
2986        $post_id = (int) $post_id;
2987
2988        $defaults = array('fields' => 'all');
2989        $args = wp_parse_args( $args, $defaults );
2990
2991        $tags = wp_get_object_terms($post_id, $taxonomy, $args);
2992
2993        return $tags;
2994}
2995
2996/**
2997 * Retrieve a number of recent posts.
2998 *
2999 * @since 1.0.0
3000 *
3001 * @see get_posts()
3002 *
3003 * @param array  $args       Optional. Arguments to retrieve posts. Default empty array.
3004 * @param string $output     Optional. Type of output. Accepts ARRAY_A or ''. Default ARRAY_A.
3005 * @return array|bool Associative array if $output equals ARRAY_A, array or false if no results.
3006 */
3007function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
3008
3009        if ( is_numeric( $args ) ) {
3010                _deprecated_argument( __FUNCTION__, '3.1', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) );
3011                $args = array( 'numberposts' => absint( $args ) );
3012        }
3013
3014        // Set default arguments.
3015        $defaults = array(
3016                'numberposts' => 10, 'offset' => 0,
3017                'category' => 0, 'orderby' => 'post_date',
3018                'order' => 'DESC', 'include' => '',
3019                'exclude' => '', 'meta_key' => '',
3020                'meta_value' =>'', 'post_type' => 'post', 'post_status' => 'draft, publish, future, pending, private',
3021                'suppress_filters' => true
3022        );
3023
3024        $r = wp_parse_args( $args, $defaults );
3025
3026        $results = get_posts( $r );
3027
3028        // Backward compatibility. Prior to 3.1 expected posts to be returned in array.
3029        if ( ARRAY_A == $output ){
3030                foreach( $results as $key => $result ) {
3031                        $results[$key] = get_object_vars( $result );
3032                }
3033                return $results ? $results : array();
3034        }
3035
3036        return $results ? $results : false;
3037
3038}
3039
3040/**
3041 * Insert or update a post.
3042 *
3043 * If the $postarr parameter has 'ID' set to a value, then post will be updated.
3044 *
3045 * You can set the post date manually, by setting the values for 'post_date'
3046 * and 'post_date_gmt' keys. You can close the comments or open the comments by
3047 * setting the value for 'comment_status' key.
3048 *
3049 * @since 1.0.0
3050 * @since 4.2.0 Support was added for encoding emoji in the post title, content, and excerpt.
3051 *
3052 * @see sanitize_post()
3053 * @global wpdb $wpdb WordPress database abstraction object.
3054 *
3055 * @param array $postarr {
3056 *     An array of elements that make up a post to update or insert.
3057 *
3058 *     @type int    $ID                    The post ID. If equal to something other than 0,
3059 *                                         the post with that ID will be updated. Default 0.
3060 *     @type int    $post_author           The ID of the user who added the post. Default is
3061 *                                         the current user ID.
3062 *     @type string $post_date             The date of the post. Default is the current time.
3063 *     @type string $post_date_gmt         The date of the post in the GMT timezone. Default is
3064 *                                         the value of `$post_date`.
3065 *     @type mixed  $post_content          The post content. Default empty.
3066 *     @type string $post_content_filtered The filtered post content. Default empty.
3067 *     @type string $post_title            The post title. Default empty.
3068 *     @type string $post_excerpt          The post excerpt. Default empty.
3069 *     @type string $post_status           The post status. Default 'draft'.
3070 *     @type string $post_type             The post type. Default 'post'.
3071 *     @type string $comment_status        Whether the post can accept comments. Accepts 'open' or 'closed'.
3072 *                                         Default is the value of 'default_comment_status' option.
3073 *     @type string $ping_status           Whether the post can accept pings. Accepts 'open' or 'closed'.
3074 *                                         Default is the value of 'default_ping_status' option.
3075 *     @type string $post_password         The password to access the post. Default empty.
3076 *     @type string $post_name             The post name. Default is the sanitized post title.
3077 *     @type string $to_ping               Space or carriage return-separated list of URLs to ping.
3078 *                                         Default empty.
3079 *     @type string $pinged                Space or carriage return-separated list of URLs that have
3080 *                                         been pinged. Default empty.
3081 *     @type string $post_modified         The date when the post was last modified. Default is
3082 *                                         the current time.
3083 *     @type string $post_modified_gmt     The date when the post was last modified in the GMT
3084 *                                         timezone. Default is the current time.
3085 *     @type int    $post_parent           Set this for the post it belongs to, if any. Default 0.
3086 *     @type int    $menu_order            The order the post should be displayed in. Default 0.
3087 *     @type string $post_mime_type        The mime type of the post. Default empty.
3088 *     @type string $guid                  Global Unique ID for referencing the post. Default empty.
3089 * }
3090 * @param bool  $wp_error Optional. Whether to allow return of WP_Error on failure. Default false.
3091 * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
3092 */
3093function wp_insert_post( $postarr, $wp_error = false ) {
3094        global $wpdb;
3095
3096        $user_id = get_current_user_id();
3097
3098        $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_id,
3099                'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
3100                'menu_order' => 0, 'to_ping' =>  '', 'pinged' => '', 'post_password' => '',
3101                'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0,
3102                'post_content' => '', 'post_title' => '', 'context' => '');
3103
3104        $postarr = wp_parse_args($postarr, $defaults);
3105
3106        unset( $postarr[ 'filter' ] );
3107
3108        $postarr = sanitize_post($postarr, 'db');
3109
3110        // Are we updating or creating?
3111        $post_ID = 0;
3112        $update = false;
3113        $guid = $postarr['guid'];
3114
3115        if ( ! empty( $postarr['ID'] ) ) {
3116                $update = true;
3117
3118                // Get the post ID and GUID.
3119                $post_ID = $postarr['ID'];
3120                $post_before = get_post( $post_ID );
3121                if ( is_null( $post_before ) ) {
3122                        if ( $wp_error ) {
3123                                return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );
3124                        }
3125                        return 0;
3126                }
3127
3128                $guid = get_post_field( 'guid', $post_ID );
3129                $previous_status = get_post_field('post_status', $post_ID );
3130        } else {
3131                $previous_status = 'new';
3132        }
3133
3134        $post_type = empty( $postarr['post_type'] ) ? 'post' : $postarr['post_type'];
3135
3136        $post_title = $postarr['post_title'];
3137        $post_content = $postarr['post_content'];
3138        $post_excerpt = $postarr['post_excerpt'];
3139        if ( isset( $postarr['post_name'] ) ) {
3140                $post_name = $postarr['post_name'];
3141        }
3142
3143        $maybe_empty = 'attachment' !== $post_type
3144                && ! $post_content && ! $post_title && ! $post_excerpt
3145                && post_type_supports( $post_type, 'editor' )
3146                && post_type_supports( $post_type, 'title' )
3147                && post_type_supports( $post_type, 'excerpt' );
3148
3149        /**
3150         * Filter whether the post should be considered "empty".
3151         *
3152         * The post is considered "empty" if both:
3153         * 1. The post type supports the title, editor, and excerpt fields
3154         * 2. The title, editor, and excerpt fields are all empty
3155         *
3156         * Returning a truthy value to the filter will effectively short-circuit
3157         * the new post being inserted, returning 0. If $wp_error is true, a WP_Error
3158         * will be returned instead.
3159         *
3160         * @since 3.3.0
3161         *
3162         * @param bool  $maybe_empty Whether the post should be considered "empty".
3163         * @param array $postarr     Array of post data.
3164         */
3165        if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) {
3166                if ( $wp_error ) {
3167                        return new WP_Error( 'empty_content', __( 'Content, title, and excerpt are empty.' ) );
3168                } else {
3169                        return 0;
3170                }
3171        }
3172
3173        $post_status = empty( $postarr['post_status'] ) ? 'draft' : $postarr['post_status'];
3174        if ( 'attachment' === $post_type && ! in_array( $post_status, array( 'inherit', 'private', 'trash' ) ) ) {
3175                $post_status = 'inherit';
3176        }
3177
3178        if ( ! empty( $postarr['post_category'] ) ) {
3179                // Filter out empty terms.
3180                $post_category = array_filter( $postarr['post_category'] );
3181        }
3182
3183        // Make sure we set a valid category.
3184        if ( empty( $post_category ) || 0 == count( $post_category ) || ! is_array( $post_category ) ) {
3185                // 'post' requires at least one category.
3186                if ( 'post' == $post_type && 'auto-draft' != $post_status ) {
3187                        $post_category = array( get_option('default_category') );
3188                } else {
3189                        $post_category = array();
3190                }
3191        }
3192
3193        // Don't allow contributors to set the post slug for pending review posts.
3194        if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) ) {
3195                $post_name = '';
3196        }
3197
3198        /*
3199         * Create a valid post name. Drafts and pending posts are allowed to have
3200         * an empty post name.
3201         */
3202        if ( empty($post_name) ) {
3203                if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) {
3204                        $post_name = sanitize_title($post_title);
3205                } else {
3206                        $post_name = '';
3207                }
3208        } else {
3209                // On updates, we need to check to see if it's using the old, fixed sanitization context.
3210                $check_name = sanitize_title( $post_name, '', 'old-save' );
3211                if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $post_ID ) == $check_name ) {
3212                        $post_name = $check_name;
3213                } else { // new post, or slug has changed.
3214                        $post_name = sanitize_title($post_name);
3215                }
3216        }
3217
3218        /*
3219         * If the post date is empty (due to having been new or a draft) and status
3220         * is not 'draft' or 'pending', set date to now.
3221         */
3222        if ( empty( $postarr['post_date'] ) || '0000-00-00 00:00:00' == $postarr['post_date'] ) {
3223                $post_date = current_time( 'mysql' );
3224        } else {
3225                $post_date = $postarr['post_date'];
3226        }
3227
3228        // Validate the date.
3229        $mm = substr( $post_date, 5, 2 );
3230        $jj = substr( $post_date, 8, 2 );
3231        $aa = substr( $post_date, 0, 4 );
3232        $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date );
3233        if ( ! $valid_date ) {
3234                if ( $wp_error ) {
3235                        return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) );
3236                } else {
3237                        return 0;
3238                }
3239        }
3240
3241        if ( empty( $postarr['post_date_gmt'] ) || '0000-00-00 00:00:00' == $postarr['post_date_gmt'] ) {
3242                if ( ! in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) {
3243                        $post_date_gmt = get_gmt_from_date( $post_date );
3244                } else {
3245                        $post_date_gmt = '0000-00-00 00:00:00';
3246                }
3247        } else {
3248                $post_date_gmt = $postarr['post_date_gmt'];
3249        }
3250
3251        if ( $update || '0000-00-00 00:00:00' == $post_date ) {
3252                $post_modified     = current_time( 'mysql' );
3253                $post_modified_gmt = current_time( 'mysql', 1 );
3254        } else {
3255                $post_modified     = $post_date;
3256                $post_modified_gmt = $post_date_gmt;
3257        }
3258
3259        if ( 'attachment' !== $post_type ) {
3260                if ( 'publish' == $post_status ) {
3261                        $now = gmdate('Y-m-d H:i:59');
3262                        if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) ) {
3263                                $post_status = 'future';
3264                        }
3265                } elseif( 'future' == $post_status ) {
3266                        $now = gmdate('Y-m-d H:i:59');
3267                        if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) ) {
3268                                $post_status = 'publish';
3269                        }
3270                }
3271        }
3272
3273        if ( empty( $postarr['comment_status'] ) ) {
3274                if ( $update ) {
3275                        $comment_status = 'closed';
3276                } else {
3277                        $comment_status = get_option('default_comment_status');
3278                }
3279        } else {
3280                $comment_status = $postarr['comment_status'];
3281        }
3282
3283        // These variables are needed by compact() later.
3284        $post_content_filtered = $postarr['post_content_filtered'];
3285        $post_author = empty( $postarr['post_author'] ) ? $user_id : $postarr['post_author'];
3286        $ping_status = empty( $postarr['ping_status'] ) ? get_option( 'default_ping_status' ) : $postarr['ping_status'];
3287        $to_ping = isset( $postarr['to_ping'] ) ? sanitize_trackback_urls( $postarr['to_ping'] ) : '';
3288        $pinged = isset( $postarr['pinged'] ) ? $postarr['pinged'] : '';
3289        $import_id = isset( $postarr['import_id'] ) ? $postarr['import_id'] : 0;
3290
3291        /*
3292         * The 'wp_insert_post_parent' filter expects all variables to be present.
3293         * Previously, these variables would have already been extracted
3294         */
3295        if ( isset( $postarr['menu_order'] ) ) {
3296                $menu_order = (int) $postarr['menu_order'];
3297        } else {
3298                $menu_order = 0;
3299        }
3300
3301        $post_password = isset( $postarr['post_password'] ) ? $postarr['post_password'] : '';
3302        if ( 'private' == $post_status ) {
3303                $post_password = '';
3304        }
3305
3306        if ( isset( $postarr['post_parent'] ) ) {
3307                $post_parent = (int) $postarr['post_parent'];
3308        } else {
3309                $post_parent = 0;
3310        }
3311
3312        /**
3313         * Filter the post parent -- used to check for and prevent hierarchy loops.
3314         *
3315         * @since 3.1.0
3316         *
3317         * @param int   $post_parent Post parent ID.
3318         * @param int   $post_ID     Post ID.
3319         * @param array $new_postarr Array of parsed post data.
3320         * @param array $postarr     Array of sanitized, but otherwise unmodified post data.
3321         */
3322        $post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr );
3323
3324        $post_name = wp_unique_post_slug( $post_name, $post_ID, $post_status, $post_type, $post_parent );
3325
3326        // Don't unslash.
3327        $post_mime_type = isset( $postarr['post_mime_type'] ) ? $postarr['post_mime_type'] : '';
3328
3329        // Expected_slashed (everything!).
3330        $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' );
3331
3332        $emoji_fields = array( 'post_title', 'post_content', 'post_excerpt' );
3333
3334        foreach( $emoji_fields as $emoji_field ) {
3335                if ( isset( $data[ $emoji_field ] ) ) {
3336                        $charset = $wpdb->get_col_charset( $wpdb->posts, $emoji_field );
3337                        if ( 'utf8' === $charset ) {
3338                                $data[ $emoji_field ] = wp_encode_emoji( $data[ $emoji_field ] );
3339                        }
3340                }
3341        }
3342
3343        if ( 'attachment' === $post_type ) {
3344                /**
3345                 * Filter attachment post data before it is updated in or added to the database.
3346                 *
3347                 * @since 3.9.0
3348                 *
3349                 * @param array $data    An array of sanitized attachment post data.
3350                 * @param array $postarr An array of unsanitized attachment post data.
3351                 */
3352                $data = apply_filters( 'wp_insert_attachment_data', $data, $postarr );
3353        } else {
3354                /**
3355                 * Filter slashed post data just before it is inserted into the database.
3356                 *
3357                 * @since 2.7.0
3358                 *
3359                 * @param array $data    An array of slashed post data.
3360                 * @param array $postarr An array of sanitized, but otherwise unmodified post data.
3361                 */
3362                $data = apply_filters( 'wp_insert_post_data', $data, $postarr );
3363        }
3364        $data = wp_unslash( $data );
3365        $where = array( 'ID' => $post_ID );
3366
3367        if ( $update ) {
3368                /**
3369                 * Fires immediately before an existing post is updated in the database.
3370                 *
3371                 * @since 2.5.0
3372                 *
3373                 * @param int   $post_ID Post ID.
3374                 * @param array $data    Array of unslashed post data.
3375                 */
3376                do_action( 'pre_post_update', $post_ID, $data );
3377                if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) {
3378                        if ( $wp_error ) {
3379                                return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error);
3380                        } else {
3381                                return 0;
3382                        }
3383                }
3384        } else {
3385                // If there is a suggested ID, use it if not already present.
3386                if ( ! empty( $import_id ) ) {
3387                        $import_id = (int) $import_id;
3388                        if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
3389                                $data['ID'] = $import_id;
3390                        }
3391                }
3392                if ( false === $wpdb->insert( $wpdb->posts, $data ) ) {
3393                        if ( $wp_error ) {
3394                                return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error);
3395                        } else {
3396                                return 0;
3397                        }
3398                }
3399                $post_ID = (int) $wpdb->insert_id;
3400
3401                // Use the newly generated $post_ID.
3402                $where = array( 'ID' => $post_ID );
3403        }
3404
3405        if ( empty( $data['post_name'] ) && ! in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) {
3406                $data['post_name'] = sanitize_title( $data['post_title'], $post_ID );
3407                $wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where );
3408        }
3409
3410        if ( is_object_in_taxonomy( $post_type, 'category' ) ) {
3411                wp_set_post_categories( $post_ID, $post_category );
3412        }
3413
3414        if ( isset( $postarr['tags_input'] ) && is_object_in_taxonomy( $post_type, 'post_tag' ) ) {
3415                wp_set_post_tags( $post_ID, $postarr['tags_input'] );
3416        }
3417
3418        // New-style support for all custom taxonomies.
3419        if ( ! empty( $postarr['tax_input'] ) ) {
3420                foreach ( $postarr['tax_input'] as $taxonomy => $tags ) {
3421                        $taxonomy_obj = get_taxonomy($taxonomy);
3422                        // array = hierarchical, string = non-hierarchical.
3423                        if ( is_array( $tags ) ) {
3424                                $tags = array_filter($tags);
3425                        }
3426                        if ( current_user_can( $taxonomy_obj->cap->assign_terms ) ) {
3427                                wp_set_post_terms( $post_ID, $tags, $taxonomy );
3428                        }
3429                }
3430        }
3431
3432        $current_guid = get_post_field( 'guid', $post_ID );
3433
3434        // Set GUID.
3435        if ( ! $update && '' == $current_guid ) {
3436                $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where );
3437        }
3438
3439        if ( 'attachment' === $postarr['post_type'] ) {
3440                if ( ! empty( $postarr['file'] ) ) {
3441                        update_attached_file( $post_ID, $postarr['file'] );
3442                }
3443
3444                if ( ! empty( $postarr['context'] ) ) {
3445                        add_post_meta( $post_ID, '_wp_attachment_context', $postarr['context'], true );
3446                }
3447        }
3448
3449        clean_post_cache( $post_ID );
3450
3451        $post = get_post( $post_ID );
3452
3453        if ( ! empty( $postarr['page_template'] ) && 'page' == $data['post_type'] ) {
3454                $post->page_template = $postarr['page_template'];
3455                $page_templates = wp_get_theme()->get_page_templates( $post );
3456                if ( 'default' != $postarr['page_template'] && ! isset( $page_templates[ $postarr['page_template'] ] ) ) {
3457                        if ( $wp_error ) {
3458                                return new WP_Error('invalid_page_template', __('The page template is invalid.'));
3459                        }
3460                        update_post_meta( $post_ID, '_wp_page_template', 'default' );
3461                } else {
3462                        update_post_meta( $post_ID, '_wp_page_template', $postarr['page_template'] );
3463                }
3464        }
3465
3466        if ( 'attachment' !== $postarr['post_type'] ) {
3467                wp_transition_post_status( $data['post_status'], $previous_status, $post );
3468        } else {
3469                if ( $update ) {
3470                        /**
3471                         * Fires once an existing attachment has been updated.
3472                         *
3473                         * @since 2.0.0
3474                         *
3475                         * @param int $post_ID Attachment ID.
3476                         */
3477                        do_action( 'edit_attachment', $post_ID );
3478                } else {
3479
3480                        /**
3481                         * Fires once an attachment has been added.
3482                         *
3483                         * @since 2.0.0
3484                         *
3485                         * @param int $post_ID Attachment ID.
3486                         */
3487                        do_action( 'add_attachment', $post_ID );
3488                }
3489
3490                return $post_ID;
3491        }
3492
3493        if ( $update ) {
3494                /**
3495                 * Fires once an existing post has been updated.
3496                 *
3497                 * @since 1.2.0
3498                 *
3499                 * @param int     $post_ID Post ID.
3500                 * @param WP_Post $post    Post object.
3501                 */
3502                do_action( 'edit_post', $post_ID, $post );
3503                $post_after = get_post($post_ID);
3504
3505                /**
3506                 * Fires once an existing post has been updated.
3507                 *
3508                 * @since 3.0.0
3509                 *
3510                 * @param int     $post_ID      Post ID.
3511                 * @param WP_Post $post_after   Post object following the update.
3512                 * @param WP_Post $post_before  Post object before the update.
3513                 */
3514                do_action( 'post_updated', $post_ID, $post_after, $post_before);
3515        }
3516
3517        /**
3518         * Fires once a post has been saved.
3519         *
3520         * The dynamic portion of the hook name, `$post->post_type`, refers to
3521         * the post type slug.
3522         *
3523         * @since 3.7.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->post_type}", $post_ID, $post, $update );
3530
3531        /**
3532         * Fires once a post has been saved.
3533         *
3534         * @since 1.5.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( 'save_post', $post_ID, $post, $update );
3541
3542        /**
3543         * Fires once a post has been saved.
3544         *
3545         * @since 2.0.0
3546         *
3547         * @param int     $post_ID Post ID.
3548         * @param WP_Post $post    Post object.
3549         * @param bool    $update  Whether this is an existing post being updated or not.
3550         */
3551        do_action( 'wp_insert_post', $post_ID, $post, $update );
3552
3553        return $post_ID;
3554}
3555
3556/**
3557 * Update a post with new post data.
3558 *
3559 * The date does not have to be set for drafts. You can set the date and it will
3560 * not be overridden.
3561 *
3562 * @since 1.0.0
3563 *
3564 * @param array|object $postarr  Optional. Post data. Arrays are expected to be escaped,
3565 *                               objects are not. Default array.
3566 * @param bool         $wp_error Optional. Allow return of WP_Error on failure. Default false.
3567 * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
3568 */
3569function wp_update_post( $postarr = array(), $wp_error = false ) {
3570        if ( is_object($postarr) ) {
3571                // Non-escaped post was passed.
3572                $postarr = get_object_vars($postarr);
3573                $postarr = wp_slash($postarr);
3574        }
3575
3576        // First, get all of the original fields.
3577        $post = get_post($postarr['ID'], ARRAY_A);
3578
3579        if ( is_null( $post ) ) {
3580                if ( $wp_error )
3581                        return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );
3582                return 0;
3583        }
3584
3585        // Escape data pulled from DB.
3586        $post = wp_slash($post);
3587
3588        // Passed post category list overwrites existing category list if not empty.
3589        if ( isset($postarr['post_category']) && is_array($postarr['post_category'])
3590                         && 0 != count($postarr['post_category']) )
3591                $post_cats = $postarr['post_category'];
3592        else
3593                $post_cats = $post['post_category'];
3594
3595        // Drafts shouldn't be assigned a date unless explicitly done so by the user.
3596        if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) &&
3597                         ('0000-00-00 00:00:00' == $post['post_date_gmt']) )
3598                $clear_date = true;
3599        else
3600                $clear_date = false;
3601
3602        // Merge old and new fields with new fields overwriting old ones.
3603        $postarr = array_merge($post, $postarr);
3604        $postarr['post_category'] = $post_cats;
3605        if ( $clear_date ) {
3606                $postarr['post_date'] = current_time('mysql');
3607                $postarr['post_date_gmt'] = '';
3608        }
3609
3610        if ($postarr['post_type'] == 'attachment')
3611                return wp_insert_attachment($postarr);
3612
3613        return wp_insert_post( $postarr, $wp_error );
3614}
3615
3616/**
3617 * Publish a post by transitioning the post status.
3618 *
3619 * @since 2.1.0
3620 *
3621 * @global wpdb $wpdb WordPress database abstraction object.
3622 *
3623 * @param int|WP_Post $post Post ID or post object.
3624 */
3625function wp_publish_post( $post ) {
3626        global $wpdb;
3627
3628        if ( ! $post = get_post( $post ) )
3629                return;
3630
3631        if ( 'publish' == $post->post_status )
3632                return;
3633
3634        $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $post->ID ) );
3635
3636        clean_post_cache( $post->ID );
3637
3638        $old_status = $post->post_status;
3639        $post->post_status = 'publish';
3640        wp_transition_post_status( 'publish', $old_status, $post );
3641
3642        /** This action is documented in wp-includes/post.php */
3643        do_action( 'edit_post', $post->ID, $post );
3644
3645        /** This action is documented in wp-includes/post.php */
3646        do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
3647
3648        /** This action is documented in wp-includes/post.php */
3649        do_action( 'save_post', $post->ID, $post, true );
3650
3651        /** This action is documented in wp-includes/post.php */
3652        do_action( 'wp_insert_post', $post->ID, $post, true );
3653}
3654
3655/**
3656 * Publish future post and make sure post ID has future post status.
3657 *
3658 * Invoked by cron 'publish_future_post' event. This safeguard prevents cron
3659 * from publishing drafts, etc.
3660 *
3661 * @since 2.5.0
3662 *
3663 * @param int|WP_Post $post_id Post ID or post object.
3664 * @return null Nothing is returned. Which can mean that no action is required
3665 *              or post was published.
3666 */
3667function check_and_publish_future_post( $post_id ) {
3668
3669        $post = get_post($post_id);
3670
3671        if ( empty($post) )
3672                return;
3673
3674        if ( 'future' != $post->post_status )
3675                return;
3676
3677        $time = strtotime( $post->post_date_gmt . ' GMT' );
3678
3679        // Uh oh, someone jumped the gun!
3680        if ( $time > time() ) {
3681                wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
3682                wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
3683                return;
3684        }
3685
3686        return wp_publish_post($post_id);
3687}
3688
3689/**
3690 * Computes a unique slug for the post, when given the desired slug and some post details.
3691 *
3692 * @since 2.8.0
3693 *
3694 * @global wpdb $wpdb WordPress database abstraction object.
3695 * @global WP_Rewrite $wp_rewrite
3696 *
3697 * @param string $slug        The desired slug (post_name).
3698 * @param int    $post_ID     Post ID.
3699 * @param string $post_status No uniqueness checks are made if the post is still draft or pending.
3700 * @param string $post_type   Post type.
3701 * @param int    $post_parent Post parent ID.
3702 * @return string Unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
3703 */
3704function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) {
3705        if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) || ( 'inherit' == $post_status && 'revision' == $post_type ) )
3706                return $slug;
3707
3708        global $wpdb, $wp_rewrite;
3709
3710        $original_slug = $slug;
3711
3712        $feeds = $wp_rewrite->feeds;
3713        if ( ! is_array( $feeds ) )
3714                $feeds = array();
3715
3716        if ( 'attachment' == $post_type ) {
3717                // Attachment slugs must be unique across all types.
3718                $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND ID != %d LIMIT 1";
3719                $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) );
3720
3721                /**
3722                 * Filter whether the post slug would make a bad attachment slug.
3723                 *
3724                 * @since 3.1.0
3725                 *
3726                 * @param bool   $bad_slug Whether the slug would be bad as an attachment slug.
3727                 * @param string $slug     The post slug.
3728                 */
3729                if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) {
3730                        $suffix = 2;
3731                        do {
3732                                $alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3733                                $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID ) );
3734                                $suffix++;
3735                        } while ( $post_name_check );
3736                        $slug = $alt_post_name;
3737                }
3738        } elseif ( is_post_type_hierarchical( $post_type ) ) {
3739                if ( 'nav_menu_item' == $post_type )
3740                        return $slug;
3741
3742                /*
3743                 * Page slugs must be unique within their own trees. Pages are in a separate
3744                 * namespace than posts so page slugs are allowed to overlap post slugs.
3745                 */
3746                $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type IN ( %s, 'attachment' ) AND ID != %d AND post_parent = %d LIMIT 1";
3747                $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID, $post_parent ) );
3748
3749                /**
3750                 * Filter whether the post slug would make a bad hierarchical post slug.
3751                 *
3752                 * @since 3.1.0
3753                 *
3754                 * @param bool   $bad_slug    Whether the post slug would be bad in a hierarchical post context.
3755                 * @param string $slug        The post slug.
3756                 * @param string $post_type   Post type.
3757                 * @param int    $post_parent Post parent ID.
3758                 */
3759                if ( $post_name_check || in_array( $slug, $feeds ) || preg_match( "@^($wp_rewrite->pagination_base)?\d+$@", $slug )  || apply_filters( 'wp_unique_post_slug_is_bad_hierarchical_slug', false, $slug, $post_type, $post_parent ) ) {
3760                        $suffix = 2;
3761                        do {
3762                                $alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3763                                $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID, $post_parent ) );
3764                                $suffix++;
3765                        } while ( $post_name_check );
3766                        $slug = $alt_post_name;
3767                }
3768        } else {
3769                // Post slugs must be unique across all posts.
3770                $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d LIMIT 1";
3771                $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID ) );
3772
3773                /**
3774                 * Filter whether the post slug would be bad as a flat slug.
3775                 *
3776                 * @since 3.1.0
3777                 *
3778                 * @param bool   $bad_slug  Whether the post slug would be bad as a flat slug.
3779                 * @param string $slug      The post slug.
3780                 * @param string $post_type Post type.
3781                 */
3782                if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) {
3783                        $suffix = 2;
3784                        do {
3785                                $alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3786                                $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID ) );
3787                                $suffix++;
3788                        } while ( $post_name_check );
3789                        $slug = $alt_post_name;
3790                }
3791        }
3792
3793        /**
3794         * Filter the unique post slug.
3795         *
3796         * @since 3.3.0
3797         *
3798         * @param string $slug          The post slug.
3799         * @param int    $post_ID       Post ID.
3800         * @param string $post_status   The post status.
3801         * @param string $post_type     Post type.
3802         * @param int    $post_parent   Post parent ID
3803         * @param string $original_slug The original post slug.
3804         */
3805        return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug );
3806}
3807
3808/**
3809 * Truncate a post slug.
3810 *
3811 * @since 3.6.0
3812 * @access private
3813 *
3814 * @see utf8_uri_encode()
3815 *
3816 * @param string $slug   The slug to truncate.
3817 * @param int    $length Optional. Max length of the slug. Default 200 (characters).
3818 * @return string The truncated slug.
3819 */
3820function _truncate_post_slug( $slug, $length = 200 ) {
3821        if ( strlen( $slug ) > $length ) {
3822                $decoded_slug = urldecode( $slug );
3823                if ( $decoded_slug === $slug )
3824                        $slug = substr( $slug, 0, $length );
3825                else
3826                        $slug = utf8_uri_encode( $decoded_slug, $length );
3827        }
3828
3829        return rtrim( $slug, '-' );
3830}
3831
3832/**
3833 * Add tags to a post.
3834 *
3835 * @see wp_set_post_tags()
3836 *
3837 * @since 2.3.0
3838 *
3839 * @param int    $post_id Optional. The Post ID. Does not default to the ID of the global $post.
3840 *                        Default 0.
3841 * @param string $tags    Optional. The tags to set for the post, separated by commas. Default empty.
3842 * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise.
3843 */
3844function wp_add_post_tags( $post_id = 0, $tags = '' ) {
3845        return wp_set_post_tags($post_id, $tags, true);
3846}
3847
3848/**
3849 * Set the tags for a post.
3850 *
3851 * @since 2.3.0
3852 *
3853 * @see wp_set_object_terms()
3854 *
3855 * @param int    $post_id Optional. The Post ID. Does not default to the ID of the global $post.
3856 * @param string $tags    Optional. The tags to set for the post, separated by commas.
3857 *                        Default empty.
3858 * @param bool   $append  Optional. If true, don't delete existing tags, just add on. If false,
3859 *                        replace the tags with the new tags. Default false.
3860 * @return mixed Array of affected term IDs. WP_Error or false on failure.
3861 */
3862function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
3863        return wp_set_post_terms( $post_id, $tags, 'post_tag', $append);
3864}
3865
3866/**
3867 * Set the terms for a post.
3868 *
3869 * @since 2.8.0
3870 *
3871 * @see wp_set_object_terms()
3872 *
3873 * @param int    $post_id  Optional. The Post ID. Does not default to the ID of the global $post.
3874 * @param string $tags     Optional. The tags to set for the post, separated by commas. Default empty.
3875 * @param string $taxonomy Optional. Taxonomy name. Default 'post_tag'.
3876 * @param bool   $append   Optional. If true, don't delete existing tags, just add on. If false,
3877 *                         replace the tags with the new tags. Default false.
3878 * @return mixed Array of affected term IDs. WP_Error or false on failure.
3879 */
3880function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
3881        $post_id = (int) $post_id;
3882
3883        if ( !$post_id )
3884                return false;
3885
3886        if ( empty($tags) )
3887                $tags = array();
3888
3889        if ( ! is_array( $tags ) ) {
3890                $comma = _x( ',', 'tag delimiter' );
3891                if ( ',' !== $comma )
3892                        $tags = str_replace( $comma, ',', $tags );
3893                $tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) );
3894        }
3895
3896        /*
3897         * Hierarchical taxonomies must always pass IDs rather than names so that
3898         * children with the same names but different parents aren't confused.
3899         */
3900        if ( is_taxonomy_hierarchical( $taxonomy ) ) {
3901                $tags = array_unique( array_map( 'intval', $tags ) );
3902        }
3903
3904        return wp_set_object_terms( $post_id, $tags, $taxonomy, $append );
3905}
3906
3907/**
3908 * Set categories for a post.
3909 *
3910 * If the post categories parameter is not set, then the default category is
3911 * going used.
3912 *
3913 * @since 2.1.0
3914 *
3915 * @param int       $post_ID         Optional. The Post ID. Does not default to the ID
3916 *                                   of the global $post. Default 0.
3917 * @param array|int $post_categories Optional. List of categories or ID of category.
3918 *                                   Default empty array.
3919 * @param bool      $append         If true, don't delete existing categories, just add on.
3920 *                                  If false, replace the categories with the new categories.
3921 * @return bool|mixed
3922 */
3923function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $append = false ) {
3924        $post_ID = (int) $post_ID;
3925        $post_type = get_post_type( $post_ID );
3926        $post_status = get_post_status( $post_ID );
3927        // If $post_categories isn't already an array, make it one:
3928        $post_categories = (array) $post_categories;
3929        if ( empty( $post_categories ) ) {
3930                if ( 'post' == $post_type && 'auto-draft' != $post_status ) {
3931                        $post_categories = array( get_option('default_category') );
3932                        $append = false;
3933                } else {
3934                        $post_categories = array();
3935                }
3936        } elseif ( 1 == count( $post_categories ) && '' == reset( $post_categories ) ) {
3937                return true;
3938        }
3939
3940        return wp_set_post_terms( $post_ID, $post_categories, 'category', $append );
3941}
3942
3943/**
3944 * Transition the post status of a post.
3945 *
3946 * When a post is saved, the post status is "transitioned" from one status to another,
3947 * though this does not always mean the status has actually changed before and after
3948 * the save.
3949 *
3950 * For instance: When publishing a post for the first time, the post status may transition
3951 * from 'draft' – or some other status – to 'publish'. However, if a post is already
3952 * published and is simply being updated, the "old" and "new" statuses may both be 'publish'
3953 * before and after the transition.
3954 *
3955 * @since 2.3.0
3956 *
3957 * @param string  $new_status Transition to this post status.
3958 * @param string  $old_status Previous post status.
3959 * @param WP_Post $post Post data.
3960 */
3961function wp_transition_post_status( $new_status, $old_status, $post ) {
3962        /**
3963         * Fires when a post is transitioned from one status to another.
3964         *
3965         * @since 2.3.0
3966         *
3967         * @param string  $new_status New post status.
3968         * @param string  $old_status Old post status.
3969         * @param WP_Post $post       Post object.
3970         */
3971        do_action( 'transition_post_status', $new_status, $old_status, $post );
3972
3973        /**
3974         * Fires when a post is transitioned from one status to another.
3975         *
3976         * The dynamic portions of the hook name, `$new_status` and `$old status`,
3977         * refer to the old and new post statuses, respectively.
3978         *
3979         * @since 2.3.0
3980         *
3981         * @param WP_Post $post Post object.
3982         */
3983        do_action( "{$old_status}_to_{$new_status}", $post );
3984
3985        /**
3986         * Fires when a post is transitioned from one status to another.
3987         *
3988         * The dynamic portions of the hook name, `$new_status` and `$post->post_type`,
3989         * refer to the new post status and post type, respectively.
3990         *
3991         * Please note: When this action is hooked using a particular post status (like
3992         * 'publish', as `publish_{$post->post_type}`), it will fire both when a post is
3993         * first transitioned to that status from something else, as well as upon
3994         * subsequent post updates (old and new status are both the same).
3995         *
3996         * Therefore, if you are looking to only fire a callback when a post is first
3997         * transitioned to a status, use the {@see 'transition_post_status'} hook instead.
3998         *
3999         * @since 2.3.0
4000         *
4001         * @param int     $post_id Post ID.
4002         * @param WP_Post $post    Post object.
4003         */
4004        do_action( "{$new_status}_{$post->post_type}", $post->ID, $post );
4005}
4006
4007//
4008// Trackback and ping functions
4009//
4010
4011/**
4012 * Add a URL to those already pinged.
4013 *
4014 * @since 1.5.0
4015 *
4016 * @global wpdb $wpdb WordPress database abstraction object.
4017 *
4018 * @param int    $post_id Post ID.
4019 * @param string $uri     Ping URI.
4020 * @return int How many rows were updated.
4021 */
4022function add_ping( $post_id, $uri ) {
4023        global $wpdb;
4024        $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
4025        $pung = trim($pung);
4026        $pung = preg_split('/\s/', $pung);
4027        $pung[] = $uri;
4028        $new = implode("\n", $pung);
4029
4030        /**
4031         * Filter the new ping URL to add for the given post.
4032         *
4033         * @since 2.0.0
4034         *
4035         * @param string $new New ping URL to add.
4036         */
4037        $new = apply_filters( 'add_ping', $new );
4038
4039        // expected_slashed ($new).
4040        $new = wp_unslash($new);
4041        return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) );
4042}
4043
4044/**
4045 * Retrieve enclosures already enclosed for a post.
4046 *
4047 * @since 1.5.0
4048 *
4049 * @param int $post_id Post ID.
4050 * @return array List of enclosures.
4051 */
4052function get_enclosed( $post_id ) {
4053        $custom_fields = get_post_custom( $post_id );
4054        $pung = array();
4055        if ( !is_array( $custom_fields ) )
4056                return $pung;
4057
4058        foreach ( $custom_fields as $key => $val ) {
4059                if ( 'enclosure' != $key || !is_array( $val ) )
4060                        continue;
4061                foreach( $val as $enc ) {
4062                        $enclosure = explode( "\n", $enc );
4063                        $pung[] = trim( $enclosure[ 0 ] );
4064                }
4065        }
4066
4067        /**
4068         * Filter the list of enclosures already enclosed for the given post.
4069         *
4070         * @since 2.0.0
4071         *
4072         * @param array $pung    Array of enclosures for the given post.
4073         * @param int   $post_id Post ID.
4074         */
4075        $pung = apply_filters( 'get_enclosed', $pung, $post_id );
4076        return $pung;
4077}
4078
4079/**
4080 * Retrieve URLs already pinged for a post.
4081 *
4082 * @since 1.5.0
4083 *
4084 * @global wpdb $wpdb WordPress database abstraction object.
4085 *
4086 * @param int $post_id Post ID.
4087 * @return array
4088 */
4089function get_pung( $post_id ) {
4090        global $wpdb;
4091        $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
4092        $pung = trim($pung);
4093        $pung = preg_split('/\s/', $pung);
4094
4095        /**
4096         * Filter the list of already-pinged URLs for the given post.
4097         *
4098         * @since 2.0.0
4099         *
4100         * @param array $pung Array of URLs already pinged for the given post.
4101         */
4102        $pung = apply_filters( 'get_pung', $pung );
4103        return $pung;
4104}
4105
4106/**
4107 * Retrieve URLs that need to be pinged.
4108 *
4109 * @since 1.5.0
4110 *
4111 * @global wpdb $wpdb WordPress database abstraction object.
4112 *
4113 * @param int $post_id Post ID
4114 * @return array
4115 */
4116function get_to_ping( $post_id ) {
4117        global $wpdb;
4118        $to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id ));
4119        $to_ping = sanitize_trackback_urls( $to_ping );
4120        $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY);
4121
4122        /**
4123         * Filter the list of URLs yet to ping for the given post.
4124         *
4125         * @since 2.0.0
4126         *
4127         * @param array $to_ping List of URLs yet to ping.
4128         */
4129        $to_ping = apply_filters( 'get_to_ping', $to_ping );
4130        return $to_ping;
4131}
4132
4133/**
4134 * Do trackbacks for a list of URLs.
4135 *
4136 * @since 1.0.0
4137 *
4138 * @param string $tb_list Comma separated list of URLs.
4139 * @param int    $post_id Post ID.
4140 */
4141function trackback_url_list( $tb_list, $post_id ) {
4142        if ( ! empty( $tb_list ) ) {
4143                // Get post data.
4144                $postdata = get_post( $post_id, ARRAY_A );
4145
4146                // Form an excerpt.
4147                $excerpt = strip_tags( $postdata['post_excerpt'] ? $postdata['post_excerpt'] : $postdata['post_content'] );
4148
4149                if ( strlen( $excerpt ) > 255 ) {
4150                        $excerpt = substr( $excerpt, 0, 252 ) . '&hellip;';
4151                }
4152
4153                $trackback_urls = explode( ',', $tb_list );
4154                foreach( (array) $trackback_urls as $tb_url ) {
4155                        $tb_url = trim( $tb_url );
4156                        trackback( $tb_url, wp_unslash( $postdata['post_title'] ), $excerpt, $post_id );
4157                }
4158        }
4159}
4160
4161//
4162// Page functions
4163//
4164
4165/**
4166 * Get a list of page IDs.
4167 *
4168 * @since 2.0.0
4169 *
4170 * @global wpdb $wpdb WordPress database abstraction object.
4171 *
4172 * @return array List of page IDs.
4173 */
4174function get_all_page_ids() {
4175        global $wpdb;
4176
4177        $page_ids = wp_cache_get('all_page_ids', 'posts');
4178        if ( ! is_array( $page_ids ) ) {
4179                $page_ids = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE post_type = 'page'");
4180                wp_cache_add('all_page_ids', $page_ids, 'posts');
4181        }
4182
4183        return $page_ids;
4184}
4185
4186/**
4187 * Retrieves page data given a page ID or page object.
4188 *
4189 * Use get_post() instead of get_page().
4190 *
4191 * @since 1.5.1
4192 * @deprecated 3.5.0 Use get_post()
4193 *
4194 * @param mixed  $page   Page object or page ID. Passed by reference.
4195 * @param string $output Optional. What to output. Accepts OBJECT, ARRAY_A, or ARRAY_N.
4196 *                       Default OBJECT.
4197 * @param string $filter Optional. How the return value should be filtered. Accepts 'raw',
4198 *                       'edit', 'db', 'display'. Default 'raw'.
4199 * @return WP_Post|null WP_Post on success or null on failure.
4200 */
4201function get_page( $page, $output = OBJECT, $filter = 'raw') {
4202        return get_post( $page, $output, $filter );
4203}
4204
4205/**
4206 * Retrieves a page given its path.
4207 *
4208 * @since 2.1.0
4209 *
4210 * @global wpdb $wpdb WordPress database abstraction object.
4211 *
4212 * @param string       $page_path Page path.
4213 * @param string       $output    Optional. Output type. Accepts OBJECT, ARRAY_N, or ARRAY_A.
4214 *                                Default OBJECT.
4215 * @param string|array $post_type Optional. Post type or array of post types. Default 'page'.
4216 * @return WP_Post|null WP_Post on success or null on failure.
4217 */
4218function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
4219        global $wpdb;
4220
4221        $page_path = rawurlencode(urldecode($page_path));
4222        $page_path = str_replace('%2F', '/', $page_path);
4223        $page_path = str_replace('%20', ' ', $page_path);
4224        $parts = explode( '/', trim( $page_path, '/' ) );
4225        $parts = esc_sql( $parts );
4226        $parts = array_map( 'sanitize_title_for_query', $parts );
4227
4228        $in_string = "'" . implode( "','", $parts ) . "'";
4229
4230        if ( is_array( $post_type ) ) {
4231                $post_types = $post_type;
4232        } else {
4233                $post_types = array( $post_type, 'attachment' );
4234        }
4235
4236        $post_types = esc_sql( $post_types );
4237        $post_type_in_string = "'" . implode( "','", $post_types ) . "'";
4238        $sql = "
4239                SELECT ID, post_name, post_parent, post_type
4240                FROM $wpdb->posts
4241                WHERE post_name IN ($in_string)
4242                AND post_type IN ($post_type_in_string)
4243        ";
4244
4245        $pages = $wpdb->get_results( $sql, OBJECT_K );
4246
4247        $revparts = array_reverse( $parts );
4248
4249        $foundid = 0;
4250        foreach ( (array) $pages as $page ) {
4251                if ( $page->post_name == $revparts[0] ) {
4252                        $count = 0;
4253                        $p = $page;
4254                        while ( $p->post_parent != 0 && isset( $pages[ $p->post_parent ] ) ) {
4255                                $count++;
4256                                $parent = $pages[ $p->post_parent ];
4257                                if ( ! isset( $revparts[ $count ] ) || $parent->post_name != $revparts[ $count ] )
4258                                        break;
4259                                $p = $parent;
4260                        }
4261
4262                        if ( $p->post_parent == 0 && $count+1 == count( $revparts ) && $p->post_name == $revparts[ $count ] ) {
4263                                $foundid = $page->ID;
4264                                if ( $page->post_type == $post_type )
4265                                        break;
4266                        }
4267                }
4268        }
4269
4270        if ( $foundid )
4271                return get_post( $foundid, $output );
4272
4273        return null;
4274}
4275
4276/**
4277 * Retrieve a page given its title.
4278 *
4279 * @since 2.1.0
4280 *
4281 * @global wpdb $wpdb WordPress database abstraction object.
4282 *
4283 * @param string       $page_title Page title
4284 * @param string       $output     Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A.
4285 *                                 Default OBJECT.
4286 * @param string|array $post_type  Optional. Post type or array of post types. Default 'page'.
4287 * @return WP_Post|null WP_Post on success or null on failure
4288 */
4289function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) {
4290        global $wpdb;
4291
4292        if ( is_array( $post_type ) ) {
4293                $post_type = esc_sql( $post_type );
4294                $post_type_in_string = "'" . implode( "','", $post_type ) . "'";
4295                $sql = $wpdb->prepare( "
4296                        SELECT ID
4297                        FROM $wpdb->posts
4298                        WHERE post_title = %s
4299                        AND post_type IN ($post_type_in_string)
4300                ", $page_title );
4301        } else {
4302                $sql = $wpdb->prepare( "
4303                        SELECT ID
4304                        FROM $wpdb->posts
4305                        WHERE post_title = %s
4306                        AND post_type = %s
4307                ", $page_title, $post_type );
4308        }
4309
4310        $page = $wpdb->get_var( $sql );
4311
4312        if ( $page )
4313                return get_post( $page, $output );
4314
4315        return null;
4316}
4317
4318/**
4319 * Identify descendants of a given page ID in a list of page objects.
4320 *
4321 * Descendants are identified from the `$pages` array passed to the function. No database queries are performed.
4322 *
4323 * @since 1.5.1
4324 *
4325 * @param int   $page_id Page ID.
4326 * @param array $pages   List of page objects from which descendants should be identified.
4327 * @return array List of page children.
4328 */
4329function get_page_children( $page_id, $pages ) {
4330        // Build a hash of ID -> children.
4331        $children = array();
4332        foreach ( (array) $pages as $page ) {
4333                $children[ intval( $page->post_parent ) ][] = $page;
4334        }
4335
4336        $page_list = array();
4337
4338        // Start the search by looking at immediate children.
4339        if ( isset( $children[ $page_id ] ) ) {
4340                // Always start at the end of the stack in order to preserve original `$pages` order.
4341                $to_look = array_reverse( $children[ $page_id ] );
4342
4343                while ( $to_look ) {
4344                        $p = array_pop( $to_look );
4345                        $page_list[] = $p;
4346                        if ( isset( $children[ $p->ID ] ) ) {
4347                                foreach ( array_reverse( $children[ $p->ID ] ) as $child ) {
4348                                        // Append to the `$to_look` stack to descend the tree.
4349                                        $to_look[] = $child;
4350                                }
4351                        }
4352                }
4353        }
4354
4355        return $page_list;
4356}
4357
4358/**
4359 * Order the pages with children under parents in a flat list.
4360 *
4361 * It uses auxiliary structure to hold parent-children relationships and
4362 * runs in O(N) complexity
4363 *
4364 * @since 2.0.0
4365 *
4366 * @param array $pages   Posts array, passed by reference.
4367 * @param int   $page_id Optional. Parent page ID. Default 0.
4368 * @return array A list arranged by hierarchy. Children immediately follow their parents.
4369 */
4370function get_page_hierarchy( &$pages, $page_id = 0 ) {
4371        if ( empty( $pages ) ) {
4372                $result = array();
4373                return $result;
4374        }
4375
4376        $children = array();
4377        foreach ( (array) $pages as $p ) {
4378                $parent_id = intval( $p->post_parent );
4379                $children[ $parent_id ][] = $p;
4380        }
4381
4382        $result = array();
4383        _page_traverse_name( $page_id, $children, $result );
4384
4385        return $result;
4386}
4387
4388/**
4389 * Traverse and return all the nested children post names of a root page.
4390 *
4391 * $children contains parent-children relations
4392 *
4393 * @since 2.9.0
4394 *
4395 * @see _page_traverse_name()
4396 *
4397 * @param int   $page_id   Page ID.
4398 * @param array &$children Parent-children relations, passed by reference.
4399 * @param array &$result   Result, passed by reference.
4400 */
4401function _page_traverse_name( $page_id, &$children, &$result ){
4402        if ( isset( $children[ $page_id ] ) ){
4403                foreach( (array)$children[ $page_id ] as $child ) {
4404                        $result[ $child->ID ] = $child->post_name;
4405                        _page_traverse_name( $child->ID, $children, $result );
4406                }
4407        }
4408}
4409
4410/**
4411 * Build URI for a page.
4412 *
4413 * Sub pages will be in the "directory" under the parent page post name.
4414 *
4415 * @since 1.5.0
4416 *
4417 * @param WP_Post|object|int $page Page object or page ID.
4418 * @return string|false Page URI, false on error.
4419 */
4420function get_page_uri( $page ) {
4421        $page = get_post( $page );
4422
4423        if ( ! $page )
4424                return false;
4425
4426        $uri = $page->post_name;
4427
4428        foreach ( $page->ancestors as $parent ) {
4429                $uri = get_post( $parent )->post_name . '/' . $uri;
4430        }
4431
4432        return $uri;
4433}
4434
4435/**
4436 * Retrieve a list of pages.
4437 *
4438 * @global wpdb $wpdb WordPress database abstraction object.
4439 *
4440 * @since 1.5.0
4441 *
4442 * @param array|string $args {
4443 *     Optional. Array or string of arguments to retrieve pages.
4444 *
4445 *     @type int          $child_of     Page ID to return child and grandchild pages of.
4446 *                                      Default 0, or no restriction.
4447 *     @type string       $sort_order   How to sort retrieved pages. Accepts 'ASC', 'DESC'. Default 'ASC'.
4448 *     @type string       $sort_column  What columns to sort pages by, comma-separated. Accepts 'post_author',
4449 *                                      'post_date', 'post_title', 'post_name', 'post_modified', 'menu_order',
4450 *                                      'post_modified_gmt', 'post_parent', 'ID', 'rand', 'comment_count'.
4451 *                                      'post_' can be omitted for any values that start with it.
4452 *                                      Default 'post_title'.
4453 *     @type bool         $hierarchical Whether to return pages hierarchically. Default true.
4454 *     @type array        $exclude      Array of page IDs to exclude. Default empty array.
4455 *     @type array        $include      Array of page IDs to include. Cannot be used with `$child_of`,
4456 *                                      `$parent`, `$exclude`, `$meta_key`, `$meta_value`, or `$hierarchical`.
4457 *                                      Default empty array.
4458 *     @type string       $meta_key     Only include pages with this meta key. Default empty.
4459 *     @type string       $meta_value   Only include pages with this meta value. Requires `$meta_key`.
4460 *                                      Default empty.
4461 *     @type string       $authors      A comma-separated list of author IDs. Default empty.
4462 *     @type int          $parent       Page ID to return direct children of. `$hierarchical` must be false.
4463 *                                      Default -1, or no restriction.
4464 *     @type string|array $exclude_tree Comma-separated string or array of page IDs to exclude.
4465 *                                      Default empty array.
4466 *     @type int          $number       The number of pages to return. Default 0, or all pages.
4467 *     @type int          $offset       The number of pages to skip before returning. Requires `$number`.
4468 *                                      Default 0.
4469 *     @type string       $post_type    The post type to query. Default 'page'.
4470 *     @type string       $post_status  A comma-separated list of post status types to include.
4471 *                                      Default 'publish'.
4472 * }
4473 * @return array List of pages matching defaults or `$args`.
4474 */
4475function get_pages( $args = array() ) {
4476        global $wpdb;
4477
4478        $defaults = array(
4479                'child_of' => 0, 'sort_order' => 'ASC',
4480                'sort_column' => 'post_title', 'hierarchical' => 1,
4481                'exclude' => array(), 'include' => array(),
4482                'meta_key' => '', 'meta_value' => '',
4483                'authors' => '', 'parent' => -1, 'exclude_tree' => array(),
4484                'number' => '', 'offset' => 0,
4485                'post_type' => 'page', 'post_status' => 'publish',
4486        );
4487
4488        $r = wp_parse_args( $args, $defaults );
4489
4490        $number = (int) $r['number'];
4491        $offset = (int) $r['offset'];
4492        $child_of = (int) $r['child_of'];
4493        $hierarchical = $r['hierarchical'];
4494        $exclude = $r['exclude'];
4495        $meta_key = $r['meta_key'];
4496        $meta_value = $r['meta_value'];
4497        $parent = $r['parent'];
4498        $post_status = $r['post_status'];
4499
4500        // Make sure the post type is hierarchical.
4501        $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
4502        if ( ! in_array( $r['post_type'], $hierarchical_post_types ) ) {
4503                return false;
4504        }
4505
4506        if ( $parent > 0 && ! $child_of ) {
4507                $hierarchical = false;
4508        }
4509
4510        // Make sure we have a valid post status.
4511        if ( ! is_array( $post_status ) ) {
4512                $post_status = explode( ',', $post_status );
4513        }
4514        if ( array_diff( $post_status, get_post_stati() ) ) {
4515                return false;
4516        }
4517
4518        // $args can be whatever, only use the args defined in defaults to compute the key.
4519        $key = md5( serialize( wp_array_slice_assoc( $r, array_keys( $defaults ) ) ) );
4520        $last_changed = wp_cache_get( 'last_changed', 'posts' );
4521        if ( ! $last_changed ) {
4522                $last_changed = microtime();
4523                wp_cache_set( 'last_changed', $last_changed, 'posts' );
4524        }
4525
4526        $cache_key = "get_pages:$key:$last_changed";
4527        if ( $cache = wp_cache_get( $cache_key, 'posts' ) ) {
4528                // Convert to WP_Post instances.
4529                $pages = array_map( 'get_post', $cache );
4530                /** This filter is documented in wp-includes/post.php */
4531                $pages = apply_filters( 'get_pages', $pages, $r );
4532                return $pages;
4533        }
4534
4535        $inclusions = '';
4536        if ( ! empty( $r['include'] ) ) {
4537                $child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
4538                $parent = -1;
4539                $exclude = '';
4540                $meta_key = '';
4541                $meta_value = '';
4542                $hierarchical = false;
4543                $incpages = wp_parse_id_list( $r['include'] );
4544                if ( ! empty( $incpages ) ) {
4545                        $inclusions = ' AND ID IN (' . implode( ',', $incpages ) .  ')';
4546                }
4547        }
4548
4549        $exclusions = '';
4550        if ( ! empty( $exclude ) ) {
4551                $expages = wp_parse_id_list( $exclude );
4552                if ( ! empty( $expages ) ) {
4553                        $exclusions = ' AND ID NOT IN (' . implode( ',', $expages ) .  ')';
4554                }
4555        }
4556
4557        $author_query = '';
4558        if ( ! empty( $r['authors'] ) ) {
4559                $post_authors = preg_split( '/[\s,]+/', $r['authors'] );
4560
4561                if ( ! empty( $post_authors ) ) {
4562                        foreach ( $post_authors as $post_author ) {
4563                                //Do we have an author id or an author login?
4564                                if ( 0 == intval($post_author) ) {
4565                                        $post_author = get_user_by('login', $post_author);
4566                                        if ( empty( $post_author ) ) {
4567                                                continue;
4568                                        }
4569                                        if ( empty( $post_author->ID ) ) {
4570                                                continue;
4571                                        }
4572                                        $post_author = $post_author->ID;
4573                                }
4574
4575                                if ( '' == $author_query ) {
4576                                        $author_query = $wpdb->prepare(' post_author = %d ', $post_author);
4577                                } else {
4578                                        $author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author);
4579                                }
4580                        }
4581                        if ( '' != $author_query ) {
4582                                $author_query = " AND ($author_query)";
4583                        }
4584                }
4585        }
4586
4587        $join = '';
4588        $where = "$exclusions $inclusions ";
4589        if ( '' !== $meta_key || '' !== $meta_value ) {
4590                $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )";
4591
4592                // meta_key and meta_value might be slashed
4593                $meta_key = wp_unslash($meta_key);
4594                $meta_value = wp_unslash($meta_value);
4595                if ( '' !== $meta_key ) {
4596                        $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key);
4597                }
4598                if ( '' !== $meta_value ) {
4599                        $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value);
4600                }
4601
4602        }
4603
4604        if ( is_array( $parent ) ) {
4605                $post_parent__in = implode( ',', array_map( 'absint', (array) $parent ) );
4606                if ( ! empty( $post_parent__in ) ) {
4607                        $where .= " AND post_parent IN ($post_parent__in)";
4608                }
4609        } elseif ( $parent >= 0 ) {
4610                $where .= $wpdb->prepare(' AND post_parent = %d ', $parent);
4611        }
4612
4613        if ( 1 == count( $post_status ) ) {
4614                $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $r['post_type'], reset( $post_status ) );
4615        } else {
4616                $post_status = implode( "', '", $post_status );
4617                $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $r['post_type'] );
4618        }
4619
4620        $orderby_array = array();
4621        $allowed_keys = array( 'author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified',
4622                'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent',
4623                'ID', 'rand', 'comment_count' );
4624
4625        foreach ( explode( ',', $r['sort_column'] ) as $orderby ) {
4626                $orderby = trim( $orderby );
4627                if ( ! in_array( $orderby, $allowed_keys ) ) {
4628                        continue;
4629                }
4630
4631                switch ( $orderby ) {
4632                        case 'menu_order':
4633                                break;
4634                        case 'ID':
4635                                $orderby = "$wpdb->posts.ID";
4636                                break;
4637                        case 'rand':
4638                                $orderby = 'RAND()';
4639                                break;
4640                        case 'comment_count':
4641                                $orderby = "$wpdb->posts.comment_count";
4642                                break;
4643                        default:
4644                                if ( 0 === strpos( $orderby, 'post_' ) ) {
4645                                        $orderby = "$wpdb->posts." . $orderby;
4646                                } else {
4647                                        $orderby = "$wpdb->posts.post_" . $orderby;
4648                                }
4649                }
4650
4651                $orderby_array[] = $orderby;
4652
4653        }
4654        $sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title";
4655
4656        $sort_order = strtoupper( $r['sort_order'] );
4657        if ( '' !== $sort_order && ! in_array( $sort_order, array( 'ASC', 'DESC' ) ) ) {
4658                $sort_order = 'ASC';
4659        }
4660
4661        $query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where ";
4662        $query .= $author_query;
4663        $query .= " ORDER BY " . $sort_column . " " . $sort_order ;
4664
4665        if ( ! empty( $number ) ) {
4666                $query .= ' LIMIT ' . $offset . ',' . $number;
4667        }
4668
4669        $pages = $wpdb->get_results($query);
4670
4671        if ( empty($pages) ) {
4672                /** This filter is documented in wp-includes/post.php */
4673                $pages = apply_filters( 'get_pages', array(), $r );
4674                return $pages;
4675        }
4676
4677        // Sanitize before caching so it'll only get done once.
4678        $num_pages = count($pages);
4679        for ($i = 0; $i < $num_pages; $i++) {
4680                $pages[$i] = sanitize_post($pages[$i], 'raw');
4681        }
4682
4683        // Update cache.
4684        update_post_cache( $pages );
4685
4686        if ( $child_of || $hierarchical ) {
4687                $pages = get_page_children($child_of, $pages);
4688        }
4689
4690        if ( ! empty( $r['exclude_tree'] ) ) {
4691                $exclude = wp_parse_id_list( $r['exclude_tree'] );
4692                foreach( $exclude as $id ) {
4693                        $children = get_page_children( $id, $pages );
4694                        foreach ( $children as $child ) {
4695                                $exclude[] = $child->ID;
4696                        }
4697                }
4698
4699                $num_pages = count( $pages );
4700                for ( $i = 0; $i < $num_pages; $i++ ) {
4701                        if ( in_array( $pages[$i]->ID, $exclude ) ) {
4702                                unset( $pages[$i] );
4703                        }
4704                }
4705        }
4706
4707        $page_structure = array();
4708        foreach ( $pages as $page ) {
4709                $page_structure[] = $page->ID;
4710        }
4711
4712        wp_cache_set( $cache_key, $page_structure, 'posts' );
4713
4714        // Convert to WP_Post instances
4715        $pages = array_map( 'get_post', $pages );
4716
4717        /**
4718         * Filter the retrieved list of pages.
4719         *
4720         * @since 2.1.0
4721         *
4722         * @param array $pages List of pages to retrieve.
4723         * @param array $r     Array of get_pages() arguments.
4724         */
4725        $pages = apply_filters( 'get_pages', $pages, $r );
4726
4727        return $pages;
4728}
4729
4730//
4731// Attachment functions
4732//
4733
4734/**
4735 * Check if the attachment URI is local one and is really an attachment.
4736 *
4737 * @since 2.0.0
4738 *
4739 * @param string $url URL to check
4740 * @return bool True on success, false on failure.
4741 */
4742function is_local_attachment($url) {
4743        if (strpos($url, home_url()) === false)
4744                return false;
4745        if (strpos($url, home_url('/?attachment_id=')) !== false)
4746                return true;
4747        if ( $id = url_to_postid($url) ) {
4748                $post = get_post($id);
4749                if ( 'attachment' == $post->post_type )
4750                        return true;
4751        }
4752        return false;
4753}
4754
4755/**
4756 * Insert an attachment.
4757 *
4758 * If you set the 'ID' in the $args parameter, it will mean that you are
4759 * updating and attempt to update the attachment. You can also set the
4760 * attachment name or title by setting the key 'post_name' or 'post_title'.
4761 *
4762 * You can set the dates for the attachment manually by setting the 'post_date'
4763 * and 'post_date_gmt' keys' values.
4764 *
4765 * By default, the comments will use the default settings for whether the
4766 * comments are allowed. You can close them manually or keep them open by
4767 * setting the value for the 'comment_status' key.
4768 *
4769 * @since 2.0.0
4770 *
4771 * @see wp_insert_post()
4772 *
4773 * @param string|array $args   Arguments for inserting an attachment.
4774 * @param string       $file   Optional. Filename.
4775 * @param int          $parent Optional. Parent post ID.
4776 * @return int Attachment ID.
4777 */
4778function wp_insert_attachment( $args, $file = false, $parent = 0 ) {
4779        $defaults = array(
4780                'file'        => $file,
4781                'post_parent' => 0
4782        );
4783
4784        $data = wp_parse_args( $args, $defaults );
4785
4786        if ( ! empty( $parent ) ) {
4787                $data['post_parent'] = $parent;
4788        }
4789
4790        $data['post_type'] = 'attachment';
4791
4792        return wp_insert_post( $data );
4793}
4794
4795/**
4796 * Trash or delete an attachment.
4797 *
4798 * When an attachment is permanently deleted, the file will also be removed.
4799 * Deletion removes all post meta fields, taxonomy, comments, etc. associated
4800 * with the attachment (except the main post).
4801 *
4802 * The attachment is moved to the trash instead of permanently deleted unless trash
4803 * for media is disabled, item is already in the trash, or $force_delete is true.
4804 *
4805 * @since 2.0.0
4806 *
4807 * @global wpdb $wpdb WordPress database abstraction object.
4808 *
4809 * @param int  $post_id      Attachment ID.
4810 * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
4811 *                           Default false.
4812 * @return mixed False on failure. Post data on success.
4813 */
4814function wp_delete_attachment( $post_id, $force_delete = false ) {
4815        global $wpdb;
4816
4817        if ( !$post = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $post_id) ) )
4818                return $post;
4819
4820        if ( 'attachment' != $post->post_type )
4821                return false;
4822
4823        if ( !$force_delete && EMPTY_TRASH_DAYS && MEDIA_TRASH && 'trash' != $post->post_status )
4824                return wp_trash_post( $post_id );
4825
4826        delete_post_meta($post_id, '_wp_trash_meta_status');
4827        delete_post_meta($post_id, '_wp_trash_meta_time');
4828
4829        $meta = wp_get_attachment_metadata( $post_id );
4830        $backup_sizes = get_post_meta( $post->ID, '_wp_attachment_backup_sizes', true );
4831        $file = get_attached_file( $post_id );
4832
4833        if ( is_multisite() )
4834                delete_transient( 'dirsize_cache' );
4835
4836        /**
4837         * Fires before an attachment is deleted, at the start of wp_delete_attachment().
4838         *
4839         * @since 2.0.0
4840         *
4841         * @param int $post_id Attachment ID.
4842         */
4843        do_action( 'delete_attachment', $post_id );
4844
4845        wp_delete_object_term_relationships($post_id, array('category', 'post_tag'));
4846        wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type));
4847
4848        // Delete all for any posts.
4849        delete_metadata( 'post', null, '_thumbnail_id', $post_id, true );
4850
4851        $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id ));
4852        foreach ( $comment_ids as $comment_id )
4853                wp_delete_comment( $comment_id, true );
4854
4855        $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $post_id ));
4856        foreach ( $post_meta_ids as $mid )
4857                delete_metadata_by_mid( 'post', $mid );
4858
4859        /** This action is documented in wp-includes/post.php */
4860        do_action( 'delete_post', $post_id );
4861        $result = $wpdb->delete( $wpdb->posts, array( 'ID' => $post_id ) );
4862        if ( ! $result ) {
4863                return false;
4864        }
4865        /** This action is documented in wp-includes/post.php */
4866        do_action( 'deleted_post', $post_id );
4867
4868        $uploadpath = wp_upload_dir();
4869
4870        if ( ! empty($meta['thumb']) ) {
4871                // Don't delete the thumb if another attachment uses it.
4872                if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $wpdb->esc_like( $meta['thumb'] ) . '%', $post_id)) ) {
4873                        $thumbfile = str_replace(basename($file), $meta['thumb'], $file);
4874                        /** This filter is documented in wp-includes/functions.php */
4875                        $thumbfile = apply_filters( 'wp_delete_file', $thumbfile );
4876                        @ unlink( path_join($uploadpath['basedir'], $thumbfile) );
4877                }
4878        }
4879
4880        // Remove intermediate and backup images if there are any.
4881        if ( isset( $meta['sizes'] ) && is_array( $meta['sizes'] ) ) {
4882                foreach ( $meta['sizes'] as $size => $sizeinfo ) {
4883                        $intermediate_file = str_replace( basename( $file ), $sizeinfo['file'], $file );
4884                        /** This filter is documented in wp-includes/functions.php */
4885                        $intermediate_file = apply_filters( 'wp_delete_file', $intermediate_file );
4886                        @ unlink( path_join( $uploadpath['basedir'], $intermediate_file ) );
4887                }
4888        }
4889
4890        if ( is_array($backup_sizes) ) {
4891                foreach ( $backup_sizes as $size ) {
4892                        $del_file = path_join( dirname($meta['file']), $size['file'] );
4893                        /** This filter is documented in wp-includes/functions.php */
4894                        $del_file = apply_filters( 'wp_delete_file', $del_file );
4895                        @ unlink( path_join($uploadpath['basedir'], $del_file) );
4896                }
4897        }
4898
4899        wp_delete_file( $file );
4900
4901        clean_post_cache( $post );
4902
4903        return $post;
4904}
4905
4906/**
4907 * Retrieve attachment meta field for attachment ID.
4908 *
4909 * @since 2.1.0
4910 *
4911 * @param int  $post_id    Attachment ID. Default 0.
4912 * @param bool $unfiltered Optional. If true, filters are not run. Default false.
4913 * @return string|bool Attachment meta field. False on failure.
4914 */
4915function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
4916        $post_id = (int) $post_id;
4917        if ( !$post = get_post( $post_id ) )
4918                return false;
4919
4920        $data = get_post_meta( $post->ID, '_wp_attachment_metadata', true );
4921
4922        if ( $unfiltered )
4923                return $data;
4924
4925        /**
4926         * Filter the attachment meta data.
4927         *
4928         * @since 2.1.0
4929         *
4930         * @param array|bool $data    Array of meta data for the given attachment, or false
4931         *                            if the object does not exist.
4932         * @param int        $post_id Attachment ID.
4933         */
4934        return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID );
4935}
4936
4937/**
4938 * Update metadata for an attachment.
4939 *
4940 * @since 2.1.0
4941 *
4942 * @param int   $post_id Attachment ID.
4943 * @param array $data    Attachment data.
4944 * @return int|bool False if $post is invalid.
4945 */
4946function wp_update_attachment_metadata( $post_id, $data ) {
4947        $post_id = (int) $post_id;
4948        if ( !$post = get_post( $post_id ) )
4949                return false;
4950
4951        /**
4952         * Filter the updated attachment meta data.
4953         *
4954         * @since 2.1.0
4955         *
4956         * @param array $data    Array of updated attachment meta data.
4957         * @param int   $post_id Attachment ID.
4958         */
4959        if ( $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ) )
4960                return update_post_meta( $post->ID, '_wp_attachment_metadata', $data );
4961        else
4962                return delete_post_meta( $post->ID, '_wp_attachment_metadata' );
4963}
4964
4965/**
4966 * Retrieve the URL for an attachment.
4967 *
4968 * @since 2.1.0
4969 *
4970 * @param int $post_id Optional. Attachment ID. Default 0.
4971 * @return string|bool Attachment URL, otherwise false.
4972 */
4973function wp_get_attachment_url( $post_id = 0 ) {
4974        $post_id = (int) $post_id;
4975        if ( !$post = get_post( $post_id ) )
4976                return false;
4977
4978        if ( 'attachment' != $post->post_type )
4979                return false;
4980
4981        $url = '';
4982        // Get attached file.
4983        if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) {
4984                // Get upload directory.
4985                if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) {
4986                        // Check that the upload base exists in the file location.
4987                        if ( 0 === strpos( $file, $uploads['basedir'] ) ) {
4988                                // Replace file location with url location.
4989                                $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file);
4990                        } elseif ( false !== strpos($file, 'wp-content/uploads') ) {
4991                                $url = $uploads['baseurl'] . substr( $file, strpos($file, 'wp-content/uploads') + 18 );
4992                        } else {
4993                                // It's a newly-uploaded file, therefore $file is relative to the basedir.
4994                                $url = $uploads['baseurl'] . "/$file";
4995                        }
4996                }
4997        }
4998
4999        /*
5000         * If any of the above options failed, Fallback on the GUID as used pre-2.7,
5001         * not recommended to rely upon this.
5002         */
5003        if ( empty($url) ) {
5004                $url = get_the_guid( $post->ID );
5005        }
5006
5007        // On SSL front-end, URLs should be HTTPS.
5008        if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] ) {
5009                $url = set_url_scheme( $url );
5010        }
5011
5012        /**
5013         * Filter the attachment URL.
5014         *
5015         * @since 2.1.0
5016         *
5017         * @param string $url     URL for the given attachment.
5018         * @param int    $post_id Attachment ID.
5019         */
5020        $url = apply_filters( 'wp_get_attachment_url', $url, $post->ID );
5021
5022        if ( empty( $url ) )