wp-includes/post.php

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