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