Make WordPress Core

Ticket #51483: post.php

File post.php, 243.9 KB (added by vandestouwe, 4 years ago)

The corrected post.php

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