[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> post.php (source)

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