3 * Post functions and post utility function.
11 // Post Type Registration
15 * Creates the initial post types when 'init' action is fired.
19 function create_initial_post_types() {
20 register_post_type( 'post', array(
22 'name_admin_bar' => _x( 'Post', 'add new on admin bar' ),
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,
32 'delete_with_user' => true,
33 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ),
36 register_post_type( 'page', array(
38 'name_admin_bar' => _x( 'Page', 'add new on admin bar' ),
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,
49 'delete_with_user' => true,
50 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ),
53 register_post_type( 'attachment', 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' ),
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',
69 'map_meta_cap' => true,
70 'hierarchical' => false,
73 'show_in_nav_menus' => false,
74 'delete_with_user' => true,
75 'supports' => array( 'title', 'author', 'comments' ),
78 register_post_type( 'revision', array(
80 'name' => __( 'Revisions' ),
81 'singular_name' => __( 'Revision' ),
84 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
85 '_edit_link' => 'revision.php?revision=%d', /* internal use only. don't use this when registering your own post type. */
86 'capability_type' => 'post',
87 'map_meta_cap' => true,
88 'hierarchical' => false,
91 'can_export' => false,
92 'delete_with_user' => true,
93 'supports' => array( 'author' ),
96 register_post_type( 'nav_menu_item', array(
98 'name' => __( 'Navigation Menu Items' ),
99 'singular_name' => __( 'Navigation Menu Item' ),
102 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
103 'hierarchical' => false,
105 'delete_with_user' => false,
106 'query_var' => false,
109 register_post_status( 'publish', array(
110 'label' => _x( 'Published', 'post' ),
112 '_builtin' => true, /* internal use only. */
113 'label_count' => _n_noop( 'Published <span class="count">(%s)</span>', 'Published <span class="count">(%s)</span>' ),
116 register_post_status( 'future', array(
117 'label' => _x( 'Scheduled', 'post' ),
119 '_builtin' => true, /* internal use only. */
120 'label_count' => _n_noop('Scheduled <span class="count">(%s)</span>', 'Scheduled <span class="count">(%s)</span>' ),
123 register_post_status( 'draft', array(
124 'label' => _x( 'Draft', 'post' ),
126 '_builtin' => true, /* internal use only. */
127 'label_count' => _n_noop( 'Draft <span class="count">(%s)</span>', 'Drafts <span class="count">(%s)</span>' ),
130 register_post_status( 'pending', array(
131 'label' => _x( 'Pending', 'post' ),
133 '_builtin' => true, /* internal use only. */
134 'label_count' => _n_noop( 'Pending <span class="count">(%s)</span>', 'Pending <span class="count">(%s)</span>' ),
137 register_post_status( 'private', array(
138 'label' => _x( 'Private', 'post' ),
140 '_builtin' => true, /* internal use only. */
141 'label_count' => _n_noop( 'Private <span class="count">(%s)</span>', 'Private <span class="count">(%s)</span>' ),
144 register_post_status( 'trash', array(
145 'label' => _x( 'Trash', 'post' ),
147 '_builtin' => true, /* internal use only. */
148 'label_count' => _n_noop( 'Trash <span class="count">(%s)</span>', 'Trash <span class="count">(%s)</span>' ),
149 'show_in_admin_status_list' => true,
152 register_post_status( 'auto-draft', array(
153 'label' => 'auto-draft',
155 '_builtin' => true, /* internal use only. */
158 register_post_status( 'inherit', array(
159 'label' => 'inherit',
161 '_builtin' => true, /* internal use only. */
162 'exclude_from_search' => false,
165 add_action( 'init', 'create_initial_post_types', 0 ); // highest priority
168 * Retrieve attached file path based on attachment ID.
170 * You can optionally send it through the 'get_attached_file' filter, but by
171 * default it will just return the file path unfiltered.
173 * The function works by getting the single post meta name, named
174 * '_wp_attached_file' and returning it. This is a convenience function to
175 * prevent looking up the meta name and provide a mechanism for sending the
176 * attached filename through a filter.
179 * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID.
181 * @param int $attachment_id Attachment ID.
182 * @param bool $unfiltered Whether to apply filters.
183 * @return string|bool The file path to the attached file, or false if the attachment does not exist.
185 function get_attached_file( $attachment_id, $unfiltered = false ) {
186 $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
187 // If the file is relative, prepend upload dir
188 if ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) )
189 $file = $uploads['basedir'] . "/$file";
192 return apply_filters( 'get_attached_file', $file, $attachment_id );
196 * Update attachment file path based on attachment ID.
198 * Used to update the file path of the attachment, which uses post meta name
199 * '_wp_attached_file' to store the path of the attachment.
202 * @uses apply_filters() Calls 'update_attached_file' on file path and attachment ID.
204 * @param int $attachment_id Attachment ID
205 * @param string $file File path for the attachment
206 * @return bool False on failure, true on success.
208 function update_attached_file( $attachment_id, $file ) {
209 if ( !get_post( $attachment_id ) )
212 $file = apply_filters( 'update_attached_file', $file, $attachment_id );
213 if ( $file = _wp_relative_upload_path( $file ) )
214 return update_post_meta( $attachment_id, '_wp_attached_file', $file );
216 return delete_post_meta( $attachment_id, '_wp_attached_file' );
220 * Return relative path to an uploaded file.
222 * The path is relative to the current upload dir.
225 * @uses apply_filters() Calls '_wp_relative_upload_path' on file path.
227 * @param string $path Full path to the file
228 * @return string relative path on success, unchanged path on failure.
230 function _wp_relative_upload_path( $path ) {
233 $uploads = wp_upload_dir();
234 if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) {
235 $new_path = str_replace( $uploads['basedir'], '', $new_path );
236 $new_path = ltrim( $new_path, '/' );
239 return apply_filters( '_wp_relative_upload_path', $new_path, $path );
243 * Retrieve all children of the post parent ID.
245 * Normally, without any enhancements, the children would apply to pages. In the
246 * context of the inner workings of WordPress, pages, posts, and attachments
247 * share the same table, so therefore the functionality could apply to any one
248 * of them. It is then noted that while this function does not work on posts, it
249 * does not mean that it won't work on posts. It is recommended that you know
250 * what context you wish to retrieve the children of.
252 * Attachments may also be made the child of a post, so if that is an accurate
253 * statement (which needs to be verified), it would then be possible to get
254 * all of the attachments for a post. Attachments have since changed since
255 * version 2.5, so this is most likely unaccurate, but serves generally as an
256 * example of what is possible.
258 * The arguments listed as defaults are for this function and also of the
259 * {@link get_posts()} function. The arguments are combined with the
260 * get_children defaults and are then passed to the {@link get_posts()}
261 * function, which accepts additional arguments. You can replace the defaults in
262 * this function, listed below and the additional arguments listed in the
263 * {@link get_posts()} function.
265 * The 'post_parent' is the most important argument and important attention
266 * needs to be paid to the $args parameter. If you pass either an object or an
267 * integer (number), then just the 'post_parent' is grabbed and everything else
268 * is lost. If you don't specify any arguments, then it is assumed that you are
269 * in The Loop and the post parent will be grabbed for from the current post.
271 * The 'post_parent' argument is the ID to get the children. The 'numberposts'
272 * is the amount of posts to retrieve that has a default of '-1', which is
273 * used to get all of the posts. Giving a number higher than 0 will only
274 * retrieve that amount of posts.
276 * The 'post_type' and 'post_status' arguments can be used to choose what
277 * criteria of posts to retrieve. The 'post_type' can be anything, but WordPress
278 * post types are 'post', 'pages', and 'attachments'. The 'post_status'
279 * argument will accept any post status within the write administration panels.
281 * @see get_posts() Has additional arguments that can be replaced.
282 * @internal Claims made in the long description might be inaccurate.
286 * @param mixed $args Optional. User defined arguments for replacing the defaults.
287 * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N.
288 * @return array|bool False on failure and the type will be determined by $output parameter.
290 function get_children($args = '', $output = OBJECT) {
292 if ( empty( $args ) ) {
293 if ( isset( $GLOBALS['post'] ) ) {
294 $args = array('post_parent' => (int) $GLOBALS['post']->post_parent );
298 } elseif ( is_object( $args ) ) {
299 $args = array('post_parent' => (int) $args->post_parent );
300 } elseif ( is_numeric( $args ) ) {
301 $args = array('post_parent' => (int) $args);
305 'numberposts' => -1, 'post_type' => 'any',
306 'post_status' => 'any', 'post_parent' => 0,
309 $r = wp_parse_args( $args, $defaults );
311 $children = get_posts( $r );
316 update_post_cache($children);
318 foreach ( $children as $key => $child )
319 $kids[$child->ID] = $children[$key];
321 if ( $output == OBJECT ) {
323 } elseif ( $output == ARRAY_A ) {
324 foreach ( (array) $kids as $kid )
325 $weeuns[$kid->ID] = get_object_vars($kids[$kid->ID]);
327 } elseif ( $output == ARRAY_N ) {
328 foreach ( (array) $kids as $kid )
329 $babes[$kid->ID] = array_values(get_object_vars($kids[$kid->ID]));
337 * Get extended entry info (<!--more-->).
339 * There should not be any space after the second dash and before the word
340 * 'more'. There can be text or space(s) after the word 'more', but won't be
343 * The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before
344 * the <code><!--more--></code>. The 'extended' key has the content after the
345 * <code><!--more--></code> comment. The 'more_text' key has the custom "Read More" text.
349 * @param string $post Post content.
350 * @return array Post before ('main'), after ('extended'), and custom readmore ('more_text').
352 function get_extended($post) {
353 //Match the new style more links
354 if ( preg_match('/<!--more(.*?)?-->/', $post, $matches) ) {
355 list($main, $extended) = explode($matches[0], $post, 2);
356 $more_text = $matches[1];
363 // Strip leading and trailing whitespace
364 $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main);
365 $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended);
366 $more_text = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $more_text);
368 return array( 'main' => $main, 'extended' => $extended, 'more_text' => $more_text );
372 * Retrieves post data given a post ID or post object.
374 * See {@link sanitize_post()} for optional $filter values. Also, the parameter
375 * $post, must be given as a variable, since it is passed by reference.
379 * @link http://codex.wordpress.org/Function_Reference/get_post
381 * @param int|object $post Post ID or post object. Optional, default is the current post from the loop.
382 * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N.
383 * @param string $filter Optional, default is raw.
384 * @return WP_Post|null WP_Post on success or null on failure
386 function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
387 if ( empty( $post ) && isset( $GLOBALS['post'] ) )
388 $post = $GLOBALS['post'];
390 if ( is_a( $post, 'WP_Post' ) ) {
392 } elseif ( is_object( $post ) ) {
393 if ( empty( $post->filter ) ) {
394 $_post = sanitize_post( $post, 'raw' );
395 $_post = new WP_Post( $_post );
396 } elseif ( 'raw' == $post->filter ) {
397 $_post = new WP_Post( $post );
399 $_post = WP_Post::get_instance( $post->ID );
402 $_post = WP_Post::get_instance( $post );
408 $_post = $_post->filter( $filter );
410 if ( $output == ARRAY_A )
411 return $_post->to_array();
412 elseif ( $output == ARRAY_N )
413 return array_values( $_post->to_array() );
419 * WordPress Post class.
424 final class WP_Post {
436 public $post_author = 0;
442 public $post_date = '0000-00-00 00:00:00';
448 public $post_date_gmt = '0000-00-00 00:00:00';
454 public $post_content = '';
460 public $post_title = '';
466 public $post_excerpt = '';
472 public $post_status = 'publish';
478 public $comment_status = 'open';
484 public $ping_status = 'open';
490 public $post_password = '';
496 public $post_name = '';
502 public $to_ping = '';
514 public $post_modified = '0000-00-00 00:00:00';
520 public $post_modified_gmt = '0000-00-00 00:00:00';
526 public $post_content_filtered = '';
532 public $post_parent = 0;
544 public $menu_order = 0;
550 public $post_type = 'post';
556 public $post_mime_type = '';
562 public $comment_count = 0;
570 public static function get_instance( $post_id ) {
573 $post_id = (int) $post_id;
577 $_post = wp_cache_get( $post_id, 'posts' );
580 $_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id ) );
585 $_post = sanitize_post( $_post, 'raw' );
586 wp_cache_add( $_post->ID, $_post, 'posts' );
587 } elseif ( empty( $_post->filter ) ) {
588 $_post = sanitize_post( $_post, 'raw' );
591 return new WP_Post( $_post );
594 public function __construct( $post ) {
595 foreach ( get_object_vars( $post ) as $key => $value )
596 $this->$key = $value;
599 public function __isset( $key ) {
600 if ( 'ancestors' == $key )
603 if ( 'page_template' == $key )
604 return ( 'page' == $this->post_type );
606 if ( 'post_category' == $key )
609 if ( 'tags_input' == $key )
612 return metadata_exists( 'post', $this->ID, $key );
615 public function __get( $key ) {
616 if ( 'page_template' == $key && $this->__isset( $key ) ) {
617 return get_post_meta( $this->ID, '_wp_page_template', true );
620 if ( 'post_category' == $key ) {
621 if ( is_object_in_taxonomy( $this->post_type, 'category' ) )
622 $terms = get_the_terms( $this, 'category' );
624 if ( empty( $terms ) )
627 return wp_list_pluck( $terms, 'term_id' );
630 if ( 'tags_input' == $key ) {
631 if ( is_object_in_taxonomy( $this->post_type, 'post_tag' ) )
632 $terms = get_the_terms( $this, 'post_tag' );
634 if ( empty( $terms ) )
637 return wp_list_pluck( $terms, 'name' );
640 // Rest of the values need filtering
642 if ( 'ancestors' == $key )
643 $value = get_post_ancestors( $this );
645 $value = get_post_meta( $this->ID, $key, true );
648 $value = sanitize_post_field( $key, $value, $this->ID, $this->filter );
653 public function filter( $filter ) {
654 if ( $this->filter == $filter )
657 if ( $filter == 'raw' )
658 return self::get_instance( $this->ID );
660 return sanitize_post( $this, $filter );
663 public function to_array() {
664 $post = get_object_vars( $this );
666 foreach ( array( 'ancestors', 'page_template', 'post_category', 'tags_input' ) as $key ) {
667 if ( $this->__isset( $key ) )
668 $post[ $key ] = $this->__get( $key );
676 * Retrieve ancestors of a post.
680 * @param int|object $post Post ID or post object
681 * @return array Ancestor IDs or empty array if none are found.
683 function get_post_ancestors( $post ) {
684 $post = get_post( $post );
686 if ( ! $post || empty( $post->post_parent ) || $post->post_parent == $post->ID )
689 $ancestors = array();
691 $id = $ancestors[] = $post->post_parent;
693 while ( $ancestor = get_post( $id ) ) {
694 // Loop detection: If the ancestor has been seen before, break.
695 if ( empty( $ancestor->post_parent ) || ( $ancestor->post_parent == $post->ID ) || in_array( $ancestor->post_parent, $ancestors ) )
698 $id = $ancestors[] = $ancestor->post_parent;
705 * Retrieve data from a post field based on Post ID.
707 * Examples of the post field will be, 'post_type', 'post_status', 'post_content',
708 * etc and based off of the post object property or key names.
710 * The context values are based off of the taxonomy filter functions and
711 * supported values are found within those functions.
714 * @uses sanitize_post_field() See for possible $context values.
716 * @param string $field Post field name
717 * @param id $post Post ID
718 * @param string $context Optional. How to filter the field. Default is display.
719 * @return bool|string False on failure or returns the value in post field
721 function get_post_field( $field, $post, $context = 'display' ) {
722 $post = get_post( $post );
727 if ( !isset($post->$field) )
730 return sanitize_post_field($field, $post->$field, $post->ID, $context);
734 * Retrieve the mime type of an attachment based on the ID.
736 * This function can be used with any post type, but it makes more sense with
741 * @param int $ID Optional. Post ID.
742 * @return bool|string False on failure or returns the mime type
744 function get_post_mime_type($ID = '') {
745 $post = get_post($ID);
747 if ( is_object($post) )
748 return $post->post_mime_type;
754 * Retrieve the format slug for a post
758 * @param int|object $post A post
760 * @return mixed The format if successful. False if no format is set. WP_Error if errors.
762 function get_post_format( $post = null ) {
763 $post = get_post($post);
765 if ( ! post_type_supports( $post->post_type, 'post-formats' ) )
768 $_format = get_the_terms( $post->ID, 'post_format' );
770 if ( empty( $_format ) )
773 $format = array_shift( $_format );
775 return ( str_replace('post-format-', '', $format->slug ) );
779 * Check if a post has a particular format
784 * @param string $format The format to check for
785 * @param object|id $post The post to check. If not supplied, defaults to the current post if used in the loop.
786 * @return bool True if the post has the format, false otherwise.
788 function has_post_format( $format, $post = null ) {
789 return has_term('post-format-' . sanitize_key($format), 'post_format', $post);
793 * Assign a format to a post
797 * @param int|object $post The post for which to assign a format
798 * @param string $format A format to assign. Use an empty string or array to remove all formats from the post.
799 * @return mixed WP_Error on error. Array of affected term IDs on success.
801 function set_post_format( $post, $format ) {
802 $post = get_post($post);
805 return new WP_Error('invalid_post', __('Invalid post'));
807 if ( !empty($format) ) {
808 $format = sanitize_key($format);
809 if ( 'standard' == $format || !in_array( $format, array_keys( get_post_format_slugs() ) ) )
812 $format = 'post-format-' . $format;
815 return wp_set_post_terms($post->ID, $format, 'post_format');
819 * Retrieve the post status based on the Post ID.
821 * If the post ID is of an attachment, then the parent post status will be given
826 * @param int $ID Post ID
827 * @return string|bool Post status or false on failure.
829 function get_post_status($ID = '') {
830 $post = get_post($ID);
832 if ( !is_object($post) )
835 if ( 'attachment' == $post->post_type ) {
836 if ( 'private' == $post->post_status )
839 // Unattached attachments are assumed to be published
840 if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) )
843 // Inherit status from the parent
844 if ( $post->post_parent && ( $post->ID != $post->post_parent ) )
845 return get_post_status($post->post_parent);
848 return $post->post_status;
852 * Retrieve all of the WordPress supported post statuses.
854 * Posts have a limited set of valid status values, this provides the
855 * post_status values and descriptions.
859 * @return array List of post statuses.
861 function get_post_statuses( ) {
863 'draft' => __('Draft'),
864 'pending' => __('Pending Review'),
865 'private' => __('Private'),
866 'publish' => __('Published')
873 * Retrieve all of the WordPress support page statuses.
875 * Pages have a limited set of valid status values, this provides the
876 * post_status values and descriptions.
880 * @return array List of page statuses.
882 function get_page_statuses( ) {
884 'draft' => __('Draft'),
885 'private' => __('Private'),
886 'publish' => __('Published')
893 * Register a post status. Do not use before init.
895 * A simple function for creating or modifying a post status based on the
896 * parameters given. The function will accept an array (second optional
897 * parameter), along with a string for the post status name.
900 * Optional $args contents:
902 * label - A descriptive name for the post status marked for translation. Defaults to $post_status.
903 * public - Whether posts of this status should be shown in the front end of the site. Defaults to true.
904 * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to false.
905 * show_in_admin_all_list - Whether to include posts in the edit listing for their post type
906 * show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit
907 * listings, e.g. All (12) | Published (9) | My Custom Status (2) ...
909 * Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
914 * @uses $wp_post_statuses Inserts new post status object into the list
916 * @param string $post_status Name of the post status.
917 * @param array|string $args See above description.
919 function register_post_status($post_status, $args = array()) {
920 global $wp_post_statuses;
922 if (!is_array($wp_post_statuses))
923 $wp_post_statuses = array();
925 // Args prefixed with an underscore are reserved for internal use.
928 'label_count' => false,
929 'exclude_from_search' => null,
935 'publicly_queryable' => null,
936 'show_in_admin_status_list' => null,
937 'show_in_admin_all_list' => null,
939 $args = wp_parse_args($args, $defaults);
940 $args = (object) $args;
942 $post_status = sanitize_key($post_status);
943 $args->name = $post_status;
945 if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private )
946 $args->internal = true;
948 if ( null === $args->public )
949 $args->public = false;
951 if ( null === $args->private )
952 $args->private = false;
954 if ( null === $args->protected )
955 $args->protected = false;
957 if ( null === $args->internal )
958 $args->internal = false;
960 if ( null === $args->publicly_queryable )
961 $args->publicly_queryable = $args->public;
963 if ( null === $args->exclude_from_search )
964 $args->exclude_from_search = $args->internal;
966 if ( null === $args->show_in_admin_all_list )
967 $args->show_in_admin_all_list = !$args->internal;
969 if ( null === $args->show_in_admin_status_list )
970 $args->show_in_admin_status_list = !$args->internal;
972 if ( false === $args->label )
973 $args->label = $post_status;
975 if ( false === $args->label_count )
976 $args->label_count = array( $args->label, $args->label );
978 $wp_post_statuses[$post_status] = $args;
984 * Retrieve a post status object by name
989 * @uses $wp_post_statuses
990 * @see register_post_status
991 * @see get_post_statuses
993 * @param string $post_status The name of a registered post status
994 * @return object A post status object
996 function get_post_status_object( $post_status ) {
997 global $wp_post_statuses;
999 if ( empty($wp_post_statuses[$post_status]) )
1002 return $wp_post_statuses[$post_status];
1006 * Get a list of all registered post status objects.
1008 * @package WordPress
1011 * @uses $wp_post_statuses
1012 * @see register_post_status
1013 * @see get_post_status_object
1015 * @param array|string $args An array of key => value arguments to match against the post status objects.
1016 * @param string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default.
1017 * @param string $operator The logical operation to perform. 'or' means only one element
1018 * from the array needs to match; 'and' means all elements must match. The default is 'and'.
1019 * @return array A list of post status names or objects
1021 function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {
1022 global $wp_post_statuses;
1024 $field = ('names' == $output) ? 'name' : false;
1026 return wp_filter_object_list($wp_post_statuses, $args, $operator, $field);
1030 * Whether the post type is hierarchical.
1032 * A false return value might also mean that the post type does not exist.
1035 * @see get_post_type_object
1037 * @param string $post_type Post type name
1038 * @return bool Whether post type is hierarchical.
1040 function is_post_type_hierarchical( $post_type ) {
1041 if ( ! post_type_exists( $post_type ) )
1044 $post_type = get_post_type_object( $post_type );
1045 return $post_type->hierarchical;
1049 * Checks if a post type is registered.
1052 * @uses get_post_type_object()
1054 * @param string $post_type Post type name
1055 * @return bool Whether post type is registered.
1057 function post_type_exists( $post_type ) {
1058 return (bool) get_post_type_object( $post_type );
1062 * Retrieve the post type of the current post or of a given post.
1066 * @uses $post The Loop current post global
1068 * @param mixed $post Optional. Post object or post ID.
1069 * @return bool|string post type or false on failure.
1071 function get_post_type( $post = null ) {
1072 if ( $post = get_post( $post ) )
1073 return $post->post_type;
1079 * Retrieve a post type object by name
1081 * @package WordPress
1084 * @uses $wp_post_types
1085 * @see register_post_type
1086 * @see get_post_types
1088 * @param string $post_type The name of a registered post type
1089 * @return object A post type object
1091 function get_post_type_object( $post_type ) {
1092 global $wp_post_types;
1094 if ( empty($wp_post_types[$post_type]) )
1097 return $wp_post_types[$post_type];
1101 * Get a list of all registered post type objects.
1103 * @package WordPress
1106 * @uses $wp_post_types
1107 * @see register_post_type
1109 * @param array|string $args An array of key => value arguments to match against the post type objects.
1110 * @param string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default.
1111 * @param string $operator The logical operation to perform. 'or' means only one element
1112 * from the array needs to match; 'and' means all elements must match. The default is 'and'.
1113 * @return array A list of post type names or objects
1115 function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) {
1116 global $wp_post_types;
1118 $field = ('names' == $output) ? 'name' : false;
1120 return wp_filter_object_list($wp_post_types, $args, $operator, $field);
1124 * Register a post type. Do not use before init.
1126 * A function for creating or modifying a post type based on the
1127 * parameters given. The function will accept an array (second optional
1128 * parameter), along with a string for the post type name.
1130 * Optional $args contents:
1132 * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used.
1133 * - labels - An array of labels for this post type.
1134 * * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones.
1135 * * You can see accepted values in {@link get_post_type_labels()}.
1136 * - description - A short descriptive summary of what the post type is. Defaults to blank.
1137 * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users.
1138 * * Defaults to false.
1139 * * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are
1140 * inherited from public, each does not rely on this relationship and controls a very specific intention.
1141 * - exclude_from_search - Whether to exclude posts with this post type from front end search results.
1142 * * If not set, the the opposite of public's current value is used.
1143 * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request().
1144 * * ?post_type={post_type_key}
1145 * * ?{post_type_key}={single_post_slug}
1146 * * ?{post_type_query_var}={single_post_slug}
1147 * * If not set, the default is inherited from public.
1148 * - show_ui - Whether to generate a default UI for managing this post type in the admin.
1149 * * If not set, the default is inherited from public.
1150 * - show_in_nav_menus - Makes this post type available for selection in navigation menus.
1151 * * If not set, the default is inherited from public.
1152 * - show_in_menu - Where to show the post type in the admin menu.
1153 * * If true, the post type is shown in its own top level menu.
1154 * * If false, no menu is shown
1155 * * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will
1156 * be placed as a sub menu of that.
1157 * * show_ui must be true.
1158 * * If not set, the default is inherited from show_ui
1159 * - show_in_admin_bar - Makes this post type available via the admin bar.
1160 * * If not set, the default is inherited from show_in_menu
1161 * - menu_position - The position in the menu order the post type should appear.
1162 * * show_in_menu must be true
1163 * * Defaults to null, which places it at the bottom of its area.
1164 * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon.
1165 * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'.
1166 * * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the
1167 * capabilities, e.g. array('story', 'stories').
1168 * - capabilities - Array of capabilities for this post type.
1169 * * By default the capability_type is used as a base to construct capabilities.
1170 * * You can see accepted values in {@link get_post_type_capabilities()}.
1171 * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false.
1172 * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false.
1173 * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor.
1174 * * See {@link add_post_type_support()} for documentation.
1175 * - register_meta_box_cb - Provide a callback function that will be called when setting up the
1176 * meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback.
1177 * - taxonomies - An array of taxonomy identifiers that will be registered for the post type.
1178 * * Default is no taxonomies.
1179 * * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type().
1180 * - has_archive - True to enable post type archives. Default is false.
1181 * * Will generate the proper rewrite rules if rewrite is enabled.
1182 * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug.
1183 * * To prevent rewrite, set to false.
1184 * * To specify rewrite rules, an array can be passed with any of these keys
1185 * * 'slug' => string Customize the permastruct slug. Defaults to $post_type key
1186 * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
1187 * * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive.
1188 * * 'pages' => bool Should the permastruct provide for pagination. Defaults to true.
1189 * * 'ep_mask' => const Assign an endpoint mask.
1190 * * If not specified and permalink_epmask is set, inherits from permalink_epmask.
1191 * * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK
1192 * - query_var - Sets the query_var key for this post type. Defaults to $post_type key
1193 * * If false, a post type cannot be loaded at ?{query_var}={post_slug}
1194 * * If specified as a string, the query ?{query_var_string}={post_slug} will be valid.
1195 * - can_export - Allows this post type to be exported. Defaults to true.
1196 * - delete_with_user - Whether to delete posts of this type when deleting a user.
1197 * * If true, posts of this type belonging to the user will be moved to trash when then user is deleted.
1198 * * If false, posts of this type belonging to the user will *not* be trashed or deleted.
1199 * * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted.
1200 * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY!
1201 * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY!
1204 * @uses $wp_post_types Inserts new post type object into the list
1206 * @param string $post_type Post type key, must not exceed 20 characters
1207 * @param array|string $args See optional args description above.
1208 * @return object|WP_Error the registered post type object, or an error object
1210 function register_post_type( $post_type, $args = array() ) {
1211 global $wp_post_types, $wp_rewrite, $wp;
1213 if ( !is_array($wp_post_types) )
1214 $wp_post_types = array();
1216 // Args prefixed with an underscore are reserved for internal use.
1218 'labels' => array(), 'description' => '', 'publicly_queryable' => null, 'exclude_from_search' => null,
1219 'capability_type' => 'post', 'capabilities' => array(), 'map_meta_cap' => null,
1220 '_builtin' => false, '_edit_link' => 'post.php?post=%d', 'hierarchical' => false,
1221 'public' => false, 'rewrite' => true, 'has_archive' => false, 'query_var' => true,
1222 'supports' => array(), 'register_meta_box_cb' => null,
1223 'taxonomies' => array(), 'show_ui' => null, 'menu_position' => null, 'menu_icon' => null,
1224 'can_export' => true,
1225 'show_in_nav_menus' => null, 'show_in_menu' => null, 'show_in_admin_bar' => null,
1226 'delete_with_user' => null,
1228 $args = wp_parse_args($args, $defaults);
1229 $args = (object) $args;
1231 $post_type = sanitize_key($post_type);
1232 $args->name = $post_type;
1234 if ( strlen( $post_type ) > 20 )
1235 return new WP_Error( 'post_type_too_long', __( 'Post types cannot exceed 20 characters in length' ) );
1237 // If not set, default to the setting for public.
1238 if ( null === $args->publicly_queryable )
1239 $args->publicly_queryable = $args->public;
1241 // If not set, default to the setting for public.
1242 if ( null === $args->show_ui )
1243 $args->show_ui = $args->public;
1245 // If not set, default to the setting for show_ui.
1246 if ( null === $args->show_in_menu || ! $args->show_ui )
1247 $args->show_in_menu = $args->show_ui;
1249 // If not set, default to the whether the full UI is shown.
1250 if ( null === $args->show_in_admin_bar )
1251 $args->show_in_admin_bar = true === $args->show_in_menu;
1253 // Whether to show this type in nav-menus.php. Defaults to the setting for public.
1254 if ( null === $args->show_in_nav_menus )
1255 $args->show_in_nav_menus = $args->public;
1257 // If not set, default to true if not public, false if public.
1258 if ( null === $args->exclude_from_search )
1259 $args->exclude_from_search = !$args->public;
1261 // Back compat with quirky handling in version 3.0. #14122
1262 if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
1263 $args->map_meta_cap = true;
1265 if ( null === $args->map_meta_cap )
1266 $args->map_meta_cap = false;
1268 $args->cap = get_post_type_capabilities( $args );
1269 unset($args->capabilities);
1271 if ( is_array( $args->capability_type ) )
1272 $args->capability_type = $args->capability_type[0];
1274 if ( ! empty($args->supports) ) {
1275 add_post_type_support($post_type, $args->supports);
1276 unset($args->supports);
1277 } elseif ( false !== $args->supports ) {
1278 // Add default features
1279 add_post_type_support($post_type, array('title', 'editor'));
1282 if ( false !== $args->query_var && !empty($wp) ) {
1283 if ( true === $args->query_var )
1284 $args->query_var = $post_type;
1286 $args->query_var = sanitize_title_with_dashes($args->query_var);
1287 $wp->add_query_var($args->query_var);
1290 if ( false !== $args->rewrite && ( is_admin() || '' != get_option('permalink_structure') ) ) {
1291 if ( ! is_array( $args->rewrite ) )
1292 $args->rewrite = array();
1293 if ( empty( $args->rewrite['slug'] ) )
1294 $args->rewrite['slug'] = $post_type;
1295 if ( ! isset( $args->rewrite['with_front'] ) )
1296 $args->rewrite['with_front'] = true;
1297 if ( ! isset( $args->rewrite['pages'] ) )
1298 $args->rewrite['pages'] = true;
1299 if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive )
1300 $args->rewrite['feeds'] = (bool) $args->has_archive;
1301 if ( ! isset( $args->rewrite['ep_mask'] ) ) {
1302 if ( isset( $args->permalink_epmask ) )
1303 $args->rewrite['ep_mask'] = $args->permalink_epmask;
1305 $args->rewrite['ep_mask'] = EP_PERMALINK;
1308 if ( $args->hierarchical )
1309 add_rewrite_tag("%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=");
1311 add_rewrite_tag("%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=");
1313 if ( $args->has_archive ) {
1314 $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive;
1315 if ( $args->rewrite['with_front'] )
1316 $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug;
1318 $archive_slug = $wp_rewrite->root . $archive_slug;
1320 add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' );
1321 if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) {
1322 $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';
1323 add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
1324 add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
1326 if ( $args->rewrite['pages'] )
1327 add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' );
1330 add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $args->rewrite );
1333 if ( $args->register_meta_box_cb )
1334 add_action('add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1);
1336 $args->labels = get_post_type_labels( $args );
1337 $args->label = $args->labels->name;
1339 $wp_post_types[$post_type] = $args;
1341 add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 );
1343 foreach ( $args->taxonomies as $taxonomy ) {
1344 register_taxonomy_for_object_type( $taxonomy, $post_type );
1347 do_action( 'registered_post_type', $post_type, $args );
1353 * Builds an object with all post type capabilities out of a post type object
1355 * Post type capabilities use the 'capability_type' argument as a base, if the
1356 * capability is not set in the 'capabilities' argument array or if the
1357 * 'capabilities' argument is not supplied.
1359 * The capability_type argument can optionally be registered as an array, with
1360 * the first value being singular and the second plural, e.g. array('story, 'stories')
1361 * Otherwise, an 's' will be added to the value for the plural form. After
1362 * registration, capability_type will always be a string of the singular value.
1364 * By default, seven keys are accepted as part of the capabilities array:
1366 * - edit_post, read_post, and delete_post are meta capabilities, which are then
1367 * generally mapped to corresponding primitive capabilities depending on the
1368 * context, which would be the post being edited/read/deleted and the user or
1369 * role being checked. Thus these capabilities would generally not be granted
1370 * directly to users or roles.
1372 * - edit_posts - Controls whether objects of this post type can be edited.
1373 * - edit_others_posts - Controls whether objects of this type owned by other users
1374 * can be edited. If the post type does not support an author, then this will
1375 * behave like edit_posts.
1376 * - publish_posts - Controls publishing objects of this post type.
1377 * - read_private_posts - Controls whether private objects can be read.
1379 * These four primitive capabilities are checked in core in various locations.
1380 * There are also seven other primitive capabilities which are not referenced
1381 * directly in core, except in map_meta_cap(), which takes the three aforementioned
1382 * meta capabilities and translates them into one or more primitive capabilities
1383 * that must then be checked against the user or role, depending on the context.
1385 * - read - Controls whether objects of this post type can be read.
1386 * - delete_posts - Controls whether objects of this post type can be deleted.
1387 * - delete_private_posts - Controls whether private objects can be deleted.
1388 * - delete_published_posts - Controls whether published objects can be deleted.
1389 * - delete_others_posts - Controls whether objects owned by other users can be
1390 * can be deleted. If the post type does not support an author, then this will
1391 * behave like delete_posts.
1392 * - edit_private_posts - Controls whether private objects can be edited.
1393 * - edit_published_posts - Controls whether published objects can be edited.
1395 * These additional capabilities are only used in map_meta_cap(). Thus, they are
1396 * only assigned by default if the post type is registered with the 'map_meta_cap'
1397 * argument set to true (default is false).
1399 * @see map_meta_cap()
1402 * @param object $args Post type registration arguments
1403 * @return object object with all the capabilities as member variables
1405 function get_post_type_capabilities( $args ) {
1406 if ( ! is_array( $args->capability_type ) )
1407 $args->capability_type = array( $args->capability_type, $args->capability_type . 's' );
1409 // Singular base for meta capabilities, plural base for primitive capabilities.
1410 list( $singular_base, $plural_base ) = $args->capability_type;
1412 $default_capabilities = array(
1413 // Meta capabilities
1414 'edit_post' => 'edit_' . $singular_base,
1415 'read_post' => 'read_' . $singular_base,
1416 'delete_post' => 'delete_' . $singular_base,
1417 // Primitive capabilities used outside of map_meta_cap():
1418 'edit_posts' => 'edit_' . $plural_base,
1419 'edit_others_posts' => 'edit_others_' . $plural_base,
1420 'publish_posts' => 'publish_' . $plural_base,
1421 'read_private_posts' => 'read_private_' . $plural_base,
1424 // Primitive capabilities used within map_meta_cap():
1425 if ( $args->map_meta_cap ) {
1426 $default_capabilities_for_mapping = array(
1428 'delete_posts' => 'delete_' . $plural_base,
1429 'delete_private_posts' => 'delete_private_' . $plural_base,
1430 'delete_published_posts' => 'delete_published_' . $plural_base,
1431 'delete_others_posts' => 'delete_others_' . $plural_base,
1432 'edit_private_posts' => 'edit_private_' . $plural_base,
1433 'edit_published_posts' => 'edit_published_' . $plural_base,
1435 $default_capabilities = array_merge( $default_capabilities, $default_capabilities_for_mapping );
1438 $capabilities = array_merge( $default_capabilities, $args->capabilities );
1440 // Post creation capability simply maps to edit_posts by default:
1441 if ( ! isset( $capabilities['create_posts'] ) )
1442 $capabilities['create_posts'] = $capabilities['edit_posts'];
1444 // Remember meta capabilities for future reference.
1445 if ( $args->map_meta_cap )
1446 _post_type_meta_capabilities( $capabilities );
1448 return (object) $capabilities;
1452 * Stores or returns a list of post type meta caps for map_meta_cap().
1457 function _post_type_meta_capabilities( $capabilities = null ) {
1458 static $meta_caps = array();
1459 if ( null === $capabilities )
1461 foreach ( $capabilities as $core => $custom ) {
1462 if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) )
1463 $meta_caps[ $custom ] = $core;
1468 * Builds an object with all post type labels out of a post type object
1470 * Accepted keys of the label array in the post type object:
1471 * - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages
1472 * - singular_name - name for one object of this post type. Default is Post/Page
1473 * - add_new - Default is Add New for both hierarchical and non-hierarchical types. When internationalizing this string, please use a {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} matching your post type. Example: <code>_x('Add New', 'product');</code>
1474 * - add_new_item - Default is Add New Post/Add New Page
1475 * - edit_item - Default is Edit Post/Edit Page
1476 * - new_item - Default is New Post/New Page
1477 * - view_item - Default is View Post/View Page
1478 * - search_items - Default is Search Posts/Search Pages
1479 * - not_found - Default is No posts found/No pages found
1480 * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash
1481 * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page:
1482 * - all_items - String for the submenu. Default is All Posts/All Pages
1483 * - menu_name - Default is the same as <code>name</code>
1485 * Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages).
1488 * @param object $post_type_object
1489 * @return object object with all the labels as member variables
1491 function get_post_type_labels( $post_type_object ) {
1492 $nohier_vs_hier_defaults = array(
1493 'name' => array( _x('Posts', 'post type general name'), _x('Pages', 'post type general name') ),
1494 'singular_name' => array( _x('Post', 'post type singular name'), _x('Page', 'post type singular name') ),
1495 'add_new' => array( _x('Add New', 'post'), _x('Add New', 'page') ),
1496 'add_new_item' => array( __('Add New Post'), __('Add New Page') ),
1497 'edit_item' => array( __('Edit Post'), __('Edit Page') ),
1498 'new_item' => array( __('New Post'), __('New Page') ),
1499 'view_item' => array( __('View Post'), __('View Page') ),
1500 'search_items' => array( __('Search Posts'), __('Search Pages') ),
1501 'not_found' => array( __('No posts found.'), __('No pages found.') ),
1502 'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ),
1503 'parent_item_colon' => array( null, __('Parent Page:') ),
1504 'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) )
1506 $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
1508 $labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults );
1510 $post_type = $post_type_object->name;
1511 return apply_filters( "post_type_labels_{$post_type}", $labels );
1515 * Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object
1520 function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
1522 if ( isset( $object->label ) && empty( $object->labels['name'] ) )
1523 $object->labels['name'] = $object->label;
1525 if ( !isset( $object->labels['singular_name'] ) && isset( $object->labels['name'] ) )
1526 $object->labels['singular_name'] = $object->labels['name'];
1528 if ( ! isset( $object->labels['name_admin_bar'] ) )
1529 $object->labels['name_admin_bar'] = isset( $object->labels['singular_name'] ) ? $object->labels['singular_name'] : $object->name;
1531 if ( !isset( $object->labels['menu_name'] ) && isset( $object->labels['name'] ) )
1532 $object->labels['menu_name'] = $object->labels['name'];
1534 if ( !isset( $object->labels['all_items'] ) && isset( $object->labels['menu_name'] ) )
1535 $object->labels['all_items'] = $object->labels['menu_name'];
1537 foreach ( $nohier_vs_hier_defaults as $key => $value )
1538 $defaults[$key] = $object->hierarchical ? $value[1] : $value[0];
1540 $labels = array_merge( $defaults, $object->labels );
1541 return (object)$labels;
1545 * Adds submenus for post types.
1550 function _add_post_type_submenus() {
1551 foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) {
1552 $ptype_obj = get_post_type_object( $ptype );
1554 if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true )
1556 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" );
1559 add_action( 'admin_menu', '_add_post_type_submenus' );
1562 * Register support of certain features for a post type.
1564 * All features are directly associated with a functional area of the edit screen, such as the
1565 * editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author',
1566 * 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'.
1568 * Additionally, the 'revisions' feature dictates whether the post type will store revisions,
1569 * and the 'comments' feature dictates whether the comments count will show on the edit screen.
1572 * @param string $post_type The post type for which to add the feature
1573 * @param string|array $feature the feature being added, can be an array of feature strings or a single string
1575 function add_post_type_support( $post_type, $feature ) {
1576 global $_wp_post_type_features;
1578 $features = (array) $feature;
1579 foreach ($features as $feature) {
1580 if ( func_num_args() == 2 )
1581 $_wp_post_type_features[$post_type][$feature] = true;
1583 $_wp_post_type_features[$post_type][$feature] = array_slice( func_get_args(), 2 );
1588 * Remove support for a feature from a post type.
1591 * @param string $post_type The post type for which to remove the feature
1592 * @param string $feature The feature being removed
1594 function remove_post_type_support( $post_type, $feature ) {
1595 global $_wp_post_type_features;
1597 if ( !isset($_wp_post_type_features[$post_type]) )
1600 if ( isset($_wp_post_type_features[$post_type][$feature]) )
1601 unset($_wp_post_type_features[$post_type][$feature]);
1605 * Get all the post type features
1608 * @param string $post_type The post type
1612 function get_all_post_type_supports( $post_type ) {
1613 global $_wp_post_type_features;
1615 if ( isset( $_wp_post_type_features[$post_type] ) )
1616 return $_wp_post_type_features[$post_type];
1622 * Checks a post type's support for a given feature
1625 * @param string $post_type The post type being checked
1626 * @param string $feature the feature being checked
1630 function post_type_supports( $post_type, $feature ) {
1631 global $_wp_post_type_features;
1633 if ( !isset( $_wp_post_type_features[$post_type][$feature] ) )
1636 // If no args passed then no extra checks need be performed
1637 if ( func_num_args() <= 2 )
1640 // @todo Allow pluggable arg checking
1641 //$args = array_slice( func_get_args(), 2 );
1647 * Updates the post type for the post ID.
1649 * The page or post cache will be cleaned for the post ID.
1655 * @param int $post_id Post ID to change post type. Not actually optional.
1656 * @param string $post_type Optional, default is post. Supported values are 'post' or 'page' to
1658 * @return int Amount of rows changed. Should be 1 for success and 0 for failure.
1660 function set_post_type( $post_id = 0, $post_type = 'post' ) {
1663 $post_type = sanitize_post_field('post_type', $post_type, $post_id, 'db');
1664 $return = $wpdb->update( $wpdb->posts, array('post_type' => $post_type), array('ID' => $post_id) );
1666 clean_post_cache( $post_id );
1672 * Retrieve list of latest posts or posts matching criteria.
1674 * The defaults are as follows:
1675 * 'numberposts' - Default is 5. Total number of posts to retrieve.
1676 * 'offset' - Default is 0. See {@link WP_Query::query()} for more.
1677 * 'category' - What category to pull the posts from.
1678 * 'orderby' - Default is 'post_date'. How to order the posts.
1679 * 'order' - Default is 'DESC'. The order to retrieve the posts.
1680 * 'include' - See {@link WP_Query::query()} for more.
1681 * 'exclude' - See {@link WP_Query::query()} for more.
1682 * 'meta_key' - See {@link WP_Query::query()} for more.
1683 * 'meta_value' - See {@link WP_Query::query()} for more.
1684 * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few.
1685 * 'post_parent' - The parent of the post or post type.
1686 * 'post_status' - Default is 'publish'. Post status to retrieve.
1690 * @uses WP_Query::query() See for more default arguments and information.
1691 * @link http://codex.wordpress.org/Template_Tags/get_posts
1693 * @param array $args Optional. Overrides defaults.
1694 * @return array List of posts.
1696 function get_posts($args = null) {
1698 'numberposts' => 5, 'offset' => 0,
1699 'category' => 0, 'orderby' => 'post_date',
1700 'order' => 'DESC', 'include' => array(),
1701 'exclude' => array(), 'meta_key' => '',
1702 'meta_value' =>'', 'post_type' => 'post',
1703 'suppress_filters' => true
1706 $r = wp_parse_args( $args, $defaults );
1707 if ( empty( $r['post_status'] ) )
1708 $r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish';
1709 if ( ! empty($r['numberposts']) && empty($r['posts_per_page']) )
1710 $r['posts_per_page'] = $r['numberposts'];
1711 if ( ! empty($r['category']) )
1712 $r['cat'] = $r['category'];
1713 if ( ! empty($r['include']) ) {
1714 $incposts = wp_parse_id_list( $r['include'] );
1715 $r['posts_per_page'] = count($incposts); // only the number of posts included
1716 $r['post__in'] = $incposts;
1717 } elseif ( ! empty($r['exclude']) )
1718 $r['post__not_in'] = wp_parse_id_list( $r['exclude'] );
1720 $r['ignore_sticky_posts'] = true;
1721 $r['no_found_rows'] = true;
1723 $get_posts = new WP_Query;
1724 return $get_posts->query($r);
1729 // Post meta functions
1733 * Add meta data field to a post.
1735 * Post meta data is called "Custom Fields" on the Administration Screen.
1739 * @link http://codex.wordpress.org/Function_Reference/add_post_meta
1741 * @param int $post_id Post ID.
1742 * @param string $meta_key Metadata name.
1743 * @param mixed $meta_value Metadata value.
1744 * @param bool $unique Optional, default is false. Whether the same key should not be added.
1745 * @return bool False for failure. True for success.
1747 function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) {
1748 // make sure meta is added to the post, not a revision
1749 if ( $the_post = wp_is_post_revision($post_id) )
1750 $post_id = $the_post;
1752 return add_metadata('post', $post_id, $meta_key, $meta_value, $unique);
1756 * Remove metadata matching criteria from a post.
1758 * You can match based on the key, or key and value. Removing based on key and
1759 * value, will keep from removing duplicate metadata with the same key. It also
1760 * allows removing all metadata matching key, if needed.
1764 * @link http://codex.wordpress.org/Function_Reference/delete_post_meta
1766 * @param int $post_id post ID
1767 * @param string $meta_key Metadata name.
1768 * @param mixed $meta_value Optional. Metadata value.
1769 * @return bool False for failure. True for success.
1771 function delete_post_meta($post_id, $meta_key, $meta_value = '') {
1772 // make sure meta is added to the post, not a revision
1773 if ( $the_post = wp_is_post_revision($post_id) )
1774 $post_id = $the_post;
1776 return delete_metadata('post', $post_id, $meta_key, $meta_value);
1780 * Retrieve post meta field for a post.
1784 * @link http://codex.wordpress.org/Function_Reference/get_post_meta
1786 * @param int $post_id Post ID.
1787 * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
1788 * @param bool $single Whether to return a single value.
1789 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
1792 function get_post_meta($post_id, $key = '', $single = false) {
1793 return get_metadata('post', $post_id, $key, $single);
1797 * Update post meta field based on post ID.
1799 * Use the $prev_value parameter to differentiate between meta fields with the
1800 * same key and post ID.
1802 * If the meta field for the post does not exist, it will be added.
1806 * @link http://codex.wordpress.org/Function_Reference/update_post_meta
1808 * @param int $post_id Post ID.
1809 * @param string $meta_key Metadata key.
1810 * @param mixed $meta_value Metadata value.
1811 * @param mixed $prev_value Optional. Previous value to check before removing.
1812 * @return bool False on failure, true if success.
1814 function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {
1815 // make sure meta is added to the post, not a revision
1816 if ( $the_post = wp_is_post_revision($post_id) )
1817 $post_id = $the_post;
1819 return update_metadata('post', $post_id, $meta_key, $meta_value, $prev_value);
1823 * Delete everything from post meta matching meta key.
1828 * @param string $post_meta_key Key to search for when deleting.
1829 * @return bool Whether the post meta key was deleted from the database
1831 function delete_post_meta_by_key($post_meta_key) {
1832 return delete_metadata( 'post', null, $post_meta_key, '', true );
1836 * Retrieve post meta fields, based on post ID.
1838 * The post meta fields are retrieved from the cache where possible,
1839 * so the function is optimized to be called more than once.
1842 * @link http://codex.wordpress.org/Function_Reference/get_post_custom
1844 * @param int $post_id Post ID.
1847 function get_post_custom( $post_id = 0 ) {
1848 $post_id = absint( $post_id );
1850 $post_id = get_the_ID();
1852 return get_post_meta( $post_id );
1856 * Retrieve meta field names for a post.
1858 * If there are no meta fields, then nothing (null) will be returned.
1861 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys
1863 * @param int $post_id post ID
1864 * @return array|null Either array of the keys, or null if keys could not be retrieved.
1866 function get_post_custom_keys( $post_id = 0 ) {
1867 $custom = get_post_custom( $post_id );
1869 if ( !is_array($custom) )
1872 if ( $keys = array_keys($custom) )
1877 * Retrieve values for a custom post field.
1879 * The parameters must not be considered optional. All of the post meta fields
1880 * will be retrieved and only the meta field key values returned.
1883 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values
1885 * @param string $key Meta field key.
1886 * @param int $post_id Post ID
1887 * @return array Meta field values.
1889 function get_post_custom_values( $key = '', $post_id = 0 ) {
1893 $custom = get_post_custom($post_id);
1895 return isset($custom[$key]) ? $custom[$key] : null;
1899 * Check if post is sticky.
1901 * Sticky posts should remain at the top of The Loop. If the post ID is not
1902 * given, then The Loop ID for the current post will be used.
1906 * @param int $post_id Optional. Post ID.
1907 * @return bool Whether post is sticky.
1909 function is_sticky( $post_id = 0 ) {
1910 $post_id = absint( $post_id );
1913 $post_id = get_the_ID();
1915 $stickies = get_option( 'sticky_posts' );
1917 if ( ! is_array( $stickies ) )
1920 if ( in_array( $post_id, $stickies ) )
1927 * Sanitize every post field.
1929 * If the context is 'raw', then the post object or array will get minimal santization of the int fields.
1932 * @uses sanitize_post_field() Used to sanitize the fields.
1934 * @param object|WP_Post|array $post The Post Object or Array
1935 * @param string $context Optional, default is 'display'. How to sanitize post fields.
1936 * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post)
1938 function sanitize_post($post, $context = 'display') {
1939 if ( is_object($post) ) {
1940 // Check if post already filtered for this context
1941 if ( isset($post->filter) && $context == $post->filter )
1943 if ( !isset($post->ID) )
1945 foreach ( array_keys(get_object_vars($post)) as $field )
1946 $post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context);
1947 $post->filter = $context;
1949 // Check if post already filtered for this context
1950 if ( isset($post['filter']) && $context == $post['filter'] )
1952 if ( !isset($post['ID']) )
1954 foreach ( array_keys($post) as $field )
1955 $post[$field] = sanitize_post_field($field, $post[$field], $post['ID'], $context);
1956 $post['filter'] = $context;
1962 * Sanitize post field based on context.
1964 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1965 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1966 * when calling filters.
1969 * @uses apply_filters() Calls 'edit_$field' and '{$field_no_prefix}_edit_pre' passing $value and
1970 * $post_id if $context == 'edit' and field name prefix == 'post_'.
1972 * @uses apply_filters() Calls 'edit_post_$field' passing $value and $post_id if $context == 'db'.
1973 * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db' and field name prefix == 'post_'.
1974 * @uses apply_filters() Calls '{$field}_pre' passing $value if $context == 'db' and field name prefix != 'post_'.
1976 * @uses apply_filters() Calls '$field' passing $value, $post_id and $context if $context == anything
1977 * other than 'raw', 'edit' and 'db' and field name prefix == 'post_'.
1978 * @uses apply_filters() Calls 'post_$field' passing $value if $context == anything other than 'raw',
1979 * 'edit' and 'db' and field name prefix != 'post_'.
1981 * @param string $field The Post Object field name.
1982 * @param mixed $value The Post Object value.
1983 * @param int $post_id Post ID.
1984 * @param string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display',
1985 * 'attribute' and 'js'.
1986 * @return mixed Sanitized value.
1988 function sanitize_post_field($field, $value, $post_id, $context) {
1989 $int_fields = array('ID', 'post_parent', 'menu_order');
1990 if ( in_array($field, $int_fields) )
1991 $value = (int) $value;
1993 // Fields which contain arrays of ints.
1994 $array_int_fields = array( 'ancestors' );
1995 if ( in_array($field, $array_int_fields) ) {
1996 $value = array_map( 'absint', $value);
2000 if ( 'raw' == $context )
2004 if ( false !== strpos($field, 'post_') ) {
2006 $field_no_prefix = str_replace('post_', '', $field);
2009 if ( 'edit' == $context ) {
2010 $format_to_edit = array('post_content', 'post_excerpt', 'post_title', 'post_password');
2013 $value = apply_filters("edit_{$field}", $value, $post_id);
2015 $value = apply_filters("{$field_no_prefix}_edit_pre", $value, $post_id);
2017 $value = apply_filters("edit_post_{$field}", $value, $post_id);
2020 if ( in_array($field, $format_to_edit) ) {
2021 if ( 'post_content' == $field )
2022 $value = format_to_edit($value, user_can_richedit());
2024 $value = format_to_edit($value);
2026 $value = esc_attr($value);
2028 } else if ( 'db' == $context ) {
2030 $value = apply_filters("pre_{$field}", $value);
2031 $value = apply_filters("{$field_no_prefix}_save_pre", $value);
2033 $value = apply_filters("pre_post_{$field}", $value);
2034 $value = apply_filters("{$field}_pre", $value);
2037 // Use display filters by default.
2039 $value = apply_filters($field, $value, $post_id, $context);
2041 $value = apply_filters("post_{$field}", $value, $post_id, $context);
2044 if ( 'attribute' == $context )
2045 $value = esc_attr($value);
2046 else if ( 'js' == $context )
2047 $value = esc_js($value);
2053 * Make a post sticky.
2055 * Sticky posts should be displayed at the top of the front page.
2059 * @param int $post_id Post ID.
2061 function stick_post($post_id) {
2062 $stickies = get_option('sticky_posts');
2064 if ( !is_array($stickies) )
2065 $stickies = array($post_id);
2067 if ( ! in_array($post_id, $stickies) )
2068 $stickies[] = $post_id;
2070 update_option('sticky_posts', $stickies);
2076 * Sticky posts should be displayed at the top of the front page.
2080 * @param int $post_id Post ID.
2082 function unstick_post($post_id) {
2083 $stickies = get_option('sticky_posts');
2085 if ( !is_array($stickies) )
2088 if ( ! in_array($post_id, $stickies) )
2091 $offset = array_search($post_id, $stickies);
2092 if ( false === $offset )
2095 array_splice($stickies, $offset, 1);
2097 update_option('sticky_posts', $stickies);
2101 * Count number of posts of a post type and is user has permissions to view.
2103 * This function provides an efficient method of finding the amount of post's
2104 * type a blog has. Another method is to count the amount of items in
2105 * get_posts(), but that method has a lot of overhead with doing so. Therefore,
2106 * when developing for 2.5+, use this function instead.
2108 * The $perm parameter checks for 'readable' value and if the user can read
2109 * private posts, it will display that for the user that is signed in.
2112 * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
2114 * @param string $type Optional. Post type to retrieve count
2115 * @param string $perm Optional. 'readable' or empty.
2116 * @return object Number of posts for each status
2118 function wp_count_posts( $type = 'post', $perm = '' ) {
2121 $user = wp_get_current_user();
2125 $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s";
2126 if ( 'readable' == $perm && is_user_logged_in() ) {
2127 $post_type_object = get_post_type_object($type);
2128 if ( !current_user_can( $post_type_object->cap->read_private_posts ) ) {
2129 $cache_key .= '_' . $perm . '_' . $user->ID;
2130 $query .= " AND (post_status != 'private' OR ( post_author = '$user->ID' AND post_status = 'private' ))";
2133 $query .= ' GROUP BY post_status';
2135 $count = wp_cache_get($cache_key, 'counts');
2136 if ( false !== $count )
2139 $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A );
2142 foreach ( get_post_stati() as $state )
2145 foreach ( (array) $count as $row )
2146 $stats[$row['post_status']] = $row['num_posts'];
2148 $stats = (object) $stats;
2149 wp_cache_set($cache_key, $stats, 'counts');
2155 * Count number of attachments for the mime type(s).
2157 * If you set the optional mime_type parameter, then an array will still be
2158 * returned, but will only have the item you are looking for. It does not give
2159 * you the number of attachments that are children of a post. You can get that
2160 * by counting the number of children that post has.
2164 * @param string|array $mime_type Optional. Array or comma-separated list of MIME patterns.
2165 * @return array Number of posts for each mime type.
2167 function wp_count_attachments( $mime_type = '' ) {
2170 $and = wp_post_mime_type_where( $mime_type );
2171 $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 );
2174 foreach( (array) $count as $row ) {
2175 $stats[$row['post_mime_type']] = $row['num_posts'];
2177 $stats['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and");
2179 return (object) $stats;
2183 * Get default post mime types
2189 function get_post_mime_types() {
2190 $post_mime_types = array( // array( adj, noun )
2191 'image' => array(__('Images'), __('Manage Images'), _n_noop('Image <span class="count">(%s)</span>', 'Images <span class="count">(%s)</span>')),
2192 'audio' => array(__('Audio'), __('Manage Audio'), _n_noop('Audio <span class="count">(%s)</span>', 'Audio <span class="count">(%s)</span>')),
2193 'video' => array(__('Video'), __('Manage Video'), _n_noop('Video <span class="count">(%s)</span>', 'Video <span class="count">(%s)</span>')),
2196 return apply_filters('post_mime_types', $post_mime_types);
2200 * Check a MIME-Type against a list.
2202 * If the wildcard_mime_types parameter is a string, it must be comma separated
2203 * list. If the real_mime_types is a string, it is also comma separated to
2208 * @param string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or
2209 * flash (same as *flash*).
2210 * @param string|array $real_mime_types post_mime_type values
2211 * @return array array(wildcard=>array(real types))
2213 function wp_match_mime_types($wildcard_mime_types, $real_mime_types) {
2215 if ( is_string($wildcard_mime_types) )
2216 $wildcard_mime_types = array_map('trim', explode(',', $wildcard_mime_types));
2217 if ( is_string($real_mime_types) )
2218 $real_mime_types = array_map('trim', explode(',', $real_mime_types));
2219 $wild = '[-._a-z0-9]*';
2220 foreach ( (array) $wildcard_mime_types as $type ) {
2221 $type = str_replace('*', $wild, $type);
2222 $patternses[1][$type] = "^$type$";
2223 if ( false === strpos($type, '/') ) {
2224 $patternses[2][$type] = "^$type/";
2225 $patternses[3][$type] = $type;
2229 foreach ( $patternses as $patterns )
2230 foreach ( $patterns as $type => $pattern )
2231 foreach ( (array) $real_mime_types as $real )
2232 if ( preg_match("#$pattern#", $real) && ( empty($matches[$type]) || false === array_search($real, $matches[$type]) ) )
2233 $matches[$type][] = $real;
2238 * Convert MIME types into SQL.
2242 * @param string|array $post_mime_types List of mime types or comma separated string of mime types.
2243 * @param string $table_alias Optional. Specify a table alias, if needed.
2244 * @return string The SQL AND clause for mime searching.
2246 function wp_post_mime_type_where($post_mime_types, $table_alias = '') {
2248 $wildcards = array('', '%', '%/%');
2249 if ( is_string($post_mime_types) )
2250 $post_mime_types = array_map('trim', explode(',', $post_mime_types));
2251 foreach ( (array) $post_mime_types as $mime_type ) {
2252 $mime_type = preg_replace('/\s/', '', $mime_type);
2253 $slashpos = strpos($mime_type, '/');
2254 if ( false !== $slashpos ) {
2255 $mime_group = preg_replace('/[^-*.a-zA-Z0-9]/', '', substr($mime_type, 0, $slashpos));
2256 $mime_subgroup = preg_replace('/[^-*.+a-zA-Z0-9]/', '', substr($mime_type, $slashpos + 1));
2257 if ( empty($mime_subgroup) )
2258 $mime_subgroup = '*';
2260 $mime_subgroup = str_replace('/', '', $mime_subgroup);
2261 $mime_pattern = "$mime_group/$mime_subgroup";
2263 $mime_pattern = preg_replace('/[^-*.a-zA-Z0-9]/', '', $mime_type);
2264 if ( false === strpos($mime_pattern, '*') )
2265 $mime_pattern .= '/*';
2268 $mime_pattern = preg_replace('/\*+/', '%', $mime_pattern);
2270 if ( in_array( $mime_type, $wildcards ) )
2273 if ( false !== strpos($mime_pattern, '%') )
2274 $wheres[] = empty($table_alias) ? "post_mime_type LIKE '$mime_pattern'" : "$table_alias.post_mime_type LIKE '$mime_pattern'";
2276 $wheres[] = empty($table_alias) ? "post_mime_type = '$mime_pattern'" : "$table_alias.post_mime_type = '$mime_pattern'";
2278 if ( !empty($wheres) )
2279 $where = ' AND (' . join(' OR ', $wheres) . ') ';
2284 * Trashes or deletes a post or page.
2286 * When the post and page is permanently deleted, everything that is tied to it is deleted also.
2287 * This includes comments, post meta fields, and terms associated with the post.
2289 * The post or page is moved to trash instead of permanently deleted unless trash is
2290 * disabled, item is already in the trash, or $force_delete is true.
2293 * @uses do_action() on 'delete_post' before deletion unless post type is 'attachment'.
2294 * @uses do_action() on 'deleted_post' after deletion unless post type is 'attachment'.
2295 * @uses wp_delete_attachment() if post type is 'attachment'.
2296 * @uses wp_trash_post() if item should be trashed.
2298 * @param int $postid Post ID.
2299 * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
2300 * @return mixed False on failure
2302 function wp_delete_post( $postid = 0, $force_delete = false ) {
2305 if ( !$post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) )
2308 if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS )
2309 return wp_trash_post($postid);
2311 if ( $post->post_type == 'attachment' )
2312 return wp_delete_attachment( $postid, $force_delete );
2314 do_action('before_delete_post', $postid);
2316 delete_post_meta($postid,'_wp_trash_meta_status');
2317 delete_post_meta($postid,'_wp_trash_meta_time');
2319 wp_delete_object_term_relationships($postid, get_object_taxonomies($post->post_type));
2321 $parent_data = array( 'post_parent' => $post->post_parent );
2322 $parent_where = array( 'post_parent' => $postid );
2324 if ( is_post_type_hierarchical( $post->post_type ) ) {
2325 // Point children of this page to its parent, also clean the cache of affected children
2326 $children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type );
2327 $children = $wpdb->get_results( $children_query );
2329 $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) );
2332 if ( 'page' == $post->post_type) {
2333 // if the page is defined in option page_on_front or post_for_posts,
2334 // adjust the corresponding options
2335 if ( get_option('page_on_front') == $postid ) {
2336 update_option('show_on_front', 'posts');
2337 delete_option('page_on_front');
2339 if ( get_option('page_for_posts') == $postid ) {
2340 delete_option('page_for_posts');
2343 unstick_post($postid);
2346 // Do raw query. wp_get_post_revisions() is filtered
2347 $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
2348 // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
2349 foreach ( $revision_ids as $revision_id )
2350 wp_delete_post_revision( $revision_id );
2352 // Point all attachments to this post up one level
2353 $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
2355 $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid ));
2356 foreach ( $comment_ids as $comment_id )
2357 wp_delete_comment( $comment_id, true );
2359 $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $postid ));
2360 foreach ( $post_meta_ids as $mid )
2361 delete_metadata_by_mid( 'post', $mid );
2363 do_action( 'delete_post', $postid );
2364 $wpdb->delete( $wpdb->posts, array( 'ID' => $postid ) );
2365 do_action( 'deleted_post', $postid );
2367 clean_post_cache( $post );
2369 if ( is_post_type_hierarchical( $post->post_type ) && $children ) {
2370 foreach ( $children as $child )
2371 clean_post_cache( $child );
2374 wp_clear_scheduled_hook('publish_future_post', array( $postid ) );
2376 do_action('after_delete_post', $postid);
2382 * Moves a post or page to the Trash
2384 * If trash is disabled, the post or page is permanently deleted.
2387 * @uses do_action() on 'trash_post' before trashing
2388 * @uses do_action() on 'trashed_post' after trashing
2389 * @uses wp_delete_post() if trash is disabled
2391 * @param int $post_id Post ID.
2392 * @return mixed False on failure
2394 function wp_trash_post($post_id = 0) {
2395 if ( !EMPTY_TRASH_DAYS )
2396 return wp_delete_post($post_id, true);
2398 if ( !$post = get_post($post_id, ARRAY_A) )
2401 if ( $post['post_status'] == 'trash' )
2404 do_action('wp_trash_post', $post_id);
2406 add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']);
2407 add_post_meta($post_id,'_wp_trash_meta_time', time());
2409 $post['post_status'] = 'trash';
2410 wp_insert_post($post);
2412 wp_trash_post_comments($post_id);
2414 do_action('trashed_post', $post_id);
2420 * Restores a post or page from the Trash
2423 * @uses do_action() on 'untrash_post' before undeletion
2424 * @uses do_action() on 'untrashed_post' after undeletion
2426 * @param int $post_id Post ID.
2427 * @return mixed False on failure
2429 function wp_untrash_post($post_id = 0) {
2430 if ( !$post = get_post($post_id, ARRAY_A) )
2433 if ( $post['post_status'] != 'trash' )
2436 do_action('untrash_post', $post_id);
2438 $post_status = get_post_meta($post_id, '_wp_trash_meta_status', true);
2440 $post['post_status'] = $post_status;
2442 delete_post_meta($post_id, '_wp_trash_meta_status');
2443 delete_post_meta($post_id, '_wp_trash_meta_time');
2445 wp_insert_post($post);
2447 wp_untrash_post_comments($post_id);
2449 do_action('untrashed_post', $post_id);
2455 * Moves comments for a post to the trash
2458 * @uses do_action() on 'trash_post_comments' before trashing
2459 * @uses do_action() on 'trashed_post_comments' after trashing
2461 * @param int $post Post ID or object.
2462 * @return mixed False on failure
2464 function wp_trash_post_comments($post = null) {
2467 $post = get_post($post);
2471 $post_id = $post->ID;
2473 do_action('trash_post_comments', $post_id);
2475 $comments = $wpdb->get_results( $wpdb->prepare("SELECT comment_ID, comment_approved FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id) );
2476 if ( empty($comments) )
2479 // Cache current status for each comment
2480 $statuses = array();
2481 foreach ( $comments as $comment )
2482 $statuses[$comment->comment_ID] = $comment->comment_approved;
2483 add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses);
2485 // Set status for all comments to post-trashed
2486 $result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id));
2488 clean_comment_cache( array_keys($statuses) );
2490 do_action('trashed_post_comments', $post_id, $statuses);
2496 * Restore comments for a post from the trash
2499 * @uses do_action() on 'untrash_post_comments' before trashing
2500 * @uses do_action() on 'untrashed_post_comments' after trashing
2502 * @param int $post Post ID or object.
2503 * @return mixed False on failure
2505 function wp_untrash_post_comments($post = null) {
2508 $post = get_post($post);
2512 $post_id = $post->ID;
2514 $statuses = get_post_meta($post_id, '_wp_trash_meta_comments_status', true);
2516 if ( empty($statuses) )
2519 do_action('untrash_post_comments', $post_id);
2521 // Restore each comment to its original status
2522 $group_by_status = array();
2523 foreach ( $statuses as $comment_id => $comment_status )
2524 $group_by_status[$comment_status][] = $comment_id;
2526 foreach ( $group_by_status as $status => $comments ) {
2527 // Sanity check. This shouldn't happen.
2528 if ( 'post-trashed' == $status )
2530 $comments_in = implode( "', '", $comments );
2531 $wpdb->query( "UPDATE $wpdb->comments SET comment_approved = '$status' WHERE comment_ID IN ('" . $comments_in . "')" );
2534 clean_comment_cache( array_keys($statuses) );
2536 delete_post_meta($post_id, '_wp_trash_meta_comments_status');
2538 do_action('untrashed_post_comments', $post_id);
2542 * Retrieve the list of categories for a post.
2544 * Compatibility layer for themes and plugins. Also an easy layer of abstraction
2545 * away from the complexity of the taxonomy layer.
2549 * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here.
2551 * @param int $post_id Optional. The Post ID.
2552 * @param array $args Optional. Overwrite the defaults.
2555 function wp_get_post_categories( $post_id = 0, $args = array() ) {
2556 $post_id = (int) $post_id;
2558 $defaults = array('fields' => 'ids');
2559 $args = wp_parse_args( $args, $defaults );
2561 $cats = wp_get_object_terms($post_id, 'category', $args);
2566 * Retrieve the tags for a post.
2568 * There is only one default for this function, called 'fields' and by default
2569 * is set to 'all'. There are other defaults that can be overridden in
2570 * {@link wp_get_object_terms()}.
2572 * @package WordPress
2576 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
2578 * @param int $post_id Optional. The Post ID
2579 * @param array $args Optional. Overwrite the defaults
2580 * @return array List of post tags.
2582 function wp_get_post_tags( $post_id = 0, $args = array() ) {
2583 return wp_get_post_terms( $post_id, 'post_tag', $args);
2587 * Retrieve the terms for a post.
2589 * There is only one default for this function, called 'fields' and by default
2590 * is set to 'all'. There are other defaults that can be overridden in
2591 * {@link wp_get_object_terms()}.
2593 * @package WordPress
2597 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
2599 * @param int $post_id Optional. The Post ID
2600 * @param string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag.
2601 * @param array $args Optional. Overwrite the defaults
2602 * @return array List of post tags.
2604 function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
2605 $post_id = (int) $post_id;
2607 $defaults = array('fields' => 'all');
2608 $args = wp_parse_args( $args, $defaults );
2610 $tags = wp_get_object_terms($post_id, $taxonomy, $args);
2616 * Retrieve number of recent posts.
2619 * @uses wp_parse_args()
2622 * @param string $deprecated Deprecated.
2623 * @param array $args Optional. Overrides defaults.
2624 * @param string $output Optional.
2627 function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
2629 if ( is_numeric( $args ) ) {
2630 _deprecated_argument( __FUNCTION__, '3.1', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) );
2631 $args = array( 'numberposts' => absint( $args ) );
2634 // Set default arguments
2636 'numberposts' => 10, 'offset' => 0,
2637 'category' => 0, 'orderby' => 'post_date',
2638 'order' => 'DESC', 'include' => '',
2639 'exclude' => '', 'meta_key' => '',
2640 'meta_value' =>'', 'post_type' => 'post', 'post_status' => 'draft, publish, future, pending, private',
2641 'suppress_filters' => true
2644 $r = wp_parse_args( $args, $defaults );
2646 $results = get_posts( $r );
2648 // Backward compatibility. Prior to 3.1 expected posts to be returned in array
2649 if ( ARRAY_A == $output ){
2650 foreach( $results as $key => $result ) {
2651 $results[$key] = get_object_vars( $result );
2653 return $results ? $results : array();
2656 return $results ? $results : false;
2663 * If the $postarr parameter has 'ID' set to a value, then post will be updated.
2665 * You can set the post date manually, but setting the values for 'post_date'
2666 * and 'post_date_gmt' keys. You can close the comments or open the comments by
2667 * setting the value for 'comment_status' key.
2669 * The defaults for the parameter $postarr are:
2670 * 'post_status' - Default is 'draft'.
2671 * 'post_type' - Default is 'post'.
2672 * 'post_author' - Default is current user ID ($user_ID). The ID of the user who added the post.
2673 * 'ping_status' - Default is the value in 'default_ping_status' option.
2674 * Whether the attachment can accept pings.
2675 * 'post_parent' - Default is 0. Set this for the post it belongs to, if any.
2676 * 'menu_order' - Default is 0. The order it is displayed.
2677 * 'to_ping' - Whether to ping.
2678 * 'pinged' - Default is empty string.
2679 * 'post_password' - Default is empty string. The password to access the attachment.
2680 * 'guid' - Global Unique ID for referencing the attachment.
2681 * 'post_content_filtered' - Post content filtered.
2682 * 'post_excerpt' - Post excerpt.
2687 * @uses do_action() Calls 'pre_post_update' on post ID if this is an update.
2688 * @uses do_action() Calls 'edit_post' action on post ID and post data if this is an update.
2689 * @uses do_action() Calls 'save_post' and 'wp_insert_post' on post id and post data just before returning.
2690 * @uses apply_filters() Calls 'wp_insert_post_data' passing $data, $postarr prior to database update or insert.
2691 * @uses wp_transition_post_status()
2693 * @param array $postarr Elements that make up post to insert.
2694 * @param bool $wp_error Optional. Allow return of WP_Error on failure.
2695 * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
2697 function wp_insert_post($postarr, $wp_error = false) {
2698 global $wpdb, $user_ID;
2700 $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID,
2701 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
2702 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '',
2703 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0,
2704 'post_content' => '', 'post_title' => '');
2706 $postarr = wp_parse_args($postarr, $defaults);
2708 unset( $postarr[ 'filter' ] );
2710 $postarr = sanitize_post($postarr, 'db');
2712 // export array as variables
2713 extract($postarr, EXTR_SKIP);
2715 // Are we updating or creating?
2717 if ( !empty($ID) ) {
2719 $previous_status = get_post_field('post_status', $ID);
2721 $previous_status = 'new';
2724 $maybe_empty = ! $post_content && ! $post_title && ! $post_excerpt && post_type_supports( $post_type, 'editor' )
2725 && post_type_supports( $post_type, 'title' ) && post_type_supports( $post_type, 'excerpt' );
2726 if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) {
2728 return new WP_Error( 'empty_content', __( 'Content, title, and excerpt are empty.' ) );
2733 if ( empty($post_type) )
2734 $post_type = 'post';
2736 if ( empty($post_status) )
2737 $post_status = 'draft';
2739 if ( !empty($post_category) )
2740 $post_category = array_filter($post_category); // Filter out empty terms
2742 // Make sure we set a valid category.
2743 if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
2744 // 'post' requires at least one category.
2745 if ( 'post' == $post_type && 'auto-draft' != $post_status )
2746 $post_category = array( get_option('default_category') );
2748 $post_category = array();
2751 if ( empty($post_author) )
2752 $post_author = $user_ID;
2756 // Get the post ID and GUID
2758 $post_ID = (int) $ID;
2759 $guid = get_post_field( 'guid', $post_ID );
2760 $post_before = get_post($post_ID);
2763 // Don't allow contributors to set the post slug for pending review posts
2764 if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) )
2767 // Create a valid post name. Drafts and pending posts are allowed to have an empty
2769 if ( empty($post_name) ) {
2770 if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2771 $post_name = sanitize_title($post_title);
2775 // On updates, we need to check to see if it's using the old, fixed sanitization context.
2776 $check_name = sanitize_title( $post_name, '', 'old-save' );
2777 if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $ID ) == $check_name )
2778 $post_name = $check_name;
2779 else // new post, or slug has changed.
2780 $post_name = sanitize_title($post_name);
2783 // If the post date is empty (due to having been new or a draft) and status is not 'draft' or 'pending', set date to now
2784 if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date )
2785 $post_date = current_time('mysql');
2787 // validate the date
2788 $mm = substr( $post_date, 5, 2 );
2789 $jj = substr( $post_date, 8, 2 );
2790 $aa = substr( $post_date, 0, 4 );
2791 $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date );
2792 if ( !$valid_date ) {
2794 return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) );
2799 if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) {
2800 if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2801 $post_date_gmt = get_gmt_from_date($post_date);
2803 $post_date_gmt = '0000-00-00 00:00:00';
2806 if ( $update || '0000-00-00 00:00:00' == $post_date ) {
2807 $post_modified = current_time( 'mysql' );
2808 $post_modified_gmt = current_time( 'mysql', 1 );
2810 $post_modified = $post_date;
2811 $post_modified_gmt = $post_date_gmt;
2814 if ( 'publish' == $post_status ) {
2815 $now = gmdate('Y-m-d H:i:59');
2816 if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) )
2817 $post_status = 'future';
2818 } elseif( 'future' == $post_status ) {
2819 $now = gmdate('Y-m-d H:i:59');
2820 if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) )
2821 $post_status = 'publish';
2824 if ( empty($comment_status) ) {
2826 $comment_status = 'closed';
2828 $comment_status = get_option('default_comment_status');
2830 if ( empty($ping_status) )
2831 $ping_status = get_option('default_ping_status');
2833 if ( isset($to_ping) )
2834 $to_ping = sanitize_trackback_urls( $to_ping );
2838 if ( ! isset($pinged) )
2841 if ( isset($post_parent) )
2842 $post_parent = (int) $post_parent;
2846 // Check the post_parent to see if it will cause a hierarchy loop
2847 $post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr );
2849 if ( isset($menu_order) )
2850 $menu_order = (int) $menu_order;
2854 if ( !isset($post_password) || 'private' == $post_status )
2855 $post_password = '';
2857 $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
2859 // expected_slashed (everything!)
2860 $data = compact( array( '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', 'guid' ) );
2861 $data = apply_filters('wp_insert_post_data', $data, $postarr);
2862 $data = stripslashes_deep( $data );
2863 $where = array( 'ID' => $post_ID );
2866 do_action( 'pre_post_update', $post_ID );
2867 if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) {
2869 return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error);
2874 if ( isset($post_mime_type) )
2875 $data['post_mime_type'] = stripslashes( $post_mime_type ); // This isn't in the update
2876 // If there is a suggested ID, use it if not already present
2877 if ( !empty($import_id) ) {
2878 $import_id = (int) $import_id;
2879 if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
2880 $data['ID'] = $import_id;
2883 if ( false === $wpdb->insert( $wpdb->posts, $data ) ) {
2885 return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error);
2889 $post_ID = (int) $wpdb->insert_id;
2891 // use the newly generated $post_ID
2892 $where = array( 'ID' => $post_ID );
2895 if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) {
2896 $data['post_name'] = sanitize_title($data['post_title'], $post_ID);
2897 $wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where );
2900 if ( is_object_in_taxonomy($post_type, 'category') )
2901 wp_set_post_categories( $post_ID, $post_category );
2903 if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') )
2904 wp_set_post_tags( $post_ID, $tags_input );
2906 // new-style support for all custom taxonomies
2907 if ( !empty($tax_input) ) {
2908 foreach ( $tax_input as $taxonomy => $tags ) {
2909 $taxonomy_obj = get_taxonomy($taxonomy);
2910 if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical.
2911 $tags = array_filter($tags);
2912 if ( current_user_can($taxonomy_obj->cap->assign_terms) )
2913 wp_set_post_terms( $post_ID, $tags, $taxonomy );
2917 $current_guid = get_post_field( 'guid', $post_ID );
2920 if ( !$update && '' == $current_guid )
2921 $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where );
2923 clean_post_cache( $post_ID );
2925 $post = get_post($post_ID);
2927 if ( !empty($page_template) && 'page' == $data['post_type'] ) {
2928 $post->page_template = $page_template;
2929 $page_templates = wp_get_theme()->get_page_templates();
2930 if ( 'default' != $page_template && ! isset( $page_templates[ $page_template ] ) ) {
2932 return new WP_Error('invalid_page_template', __('The page template is invalid.'));
2936 update_post_meta($post_ID, '_wp_page_template', $page_template);
2939 wp_transition_post_status($data['post_status'], $previous_status, $post);
2942 do_action('edit_post', $post_ID, $post);
2943 $post_after = get_post($post_ID);
2944 do_action( 'post_updated', $post_ID, $post_after, $post_before);
2947 do_action('save_post', $post_ID, $post);
2948 do_action('wp_insert_post', $post_ID, $post);
2954 * Update a post with new post data.
2956 * The date does not have to be set for drafts. You can set the date and it will
2957 * not be overridden.
2961 * @param array|object $postarr Post data. Arrays are expected to be escaped, objects are not.
2962 * @param bool $wp_error Optional. Allow return of WP_Error on failure.
2963 * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
2965 function wp_update_post( $postarr = array(), $wp_error = false ) {
2966 if ( is_object($postarr) ) {
2967 // non-escaped post was passed
2968 $postarr = get_object_vars($postarr);
2969 $postarr = add_magic_quotes($postarr);
2972 // First, get all of the original fields
2973 $post = get_post($postarr['ID'], ARRAY_A);
2975 // Escape data pulled from DB.
2976 $post = add_magic_quotes($post);
2978 // Passed post category list overwrites existing category list if not empty.
2979 if ( isset($postarr['post_category']) && is_array($postarr['post_category'])
2980 && 0 != count($postarr['post_category']) )
2981 $post_cats = $postarr['post_category'];
2983 $post_cats = $post['post_category'];
2985 // Drafts shouldn't be assigned a date unless explicitly done so by the user
2986 if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) &&
2987 ('0000-00-00 00:00:00' == $post['post_date_gmt']) )
2990 $clear_date = false;
2992 // Merge old and new fields with new fields overwriting old ones.
2993 $postarr = array_merge($post, $postarr);
2994 $postarr['post_category'] = $post_cats;
2995 if ( $clear_date ) {
2996 $postarr['post_date'] = current_time('mysql');
2997 $postarr['post_date_gmt'] = '';
3000 if ($postarr['post_type'] == 'attachment')
3001 return wp_insert_attachment($postarr);
3003 return wp_insert_post( $postarr, $wp_error );
3007 * Publish a post by transitioning the post status.
3011 * @uses do_action() Calls 'edit_post', 'save_post', and 'wp_insert_post' on post_id and post data.
3013 * @param mixed $post Post ID or object.
3015 function wp_publish_post( $post ) {
3018 if ( ! $post = get_post( $post ) )
3021 if ( 'publish' == $post->post_status )
3024 $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $post->ID ) );
3026 clean_post_cache( $post->ID );
3028 $old_status = $post->post_status;
3029 $post->post_status = 'publish';
3030 wp_transition_post_status( 'publish', $old_status, $post );
3032 do_action( 'edit_post', $post->ID, $post );
3033 do_action( 'save_post', $post->ID, $post );
3034 do_action( 'wp_insert_post', $post->ID, $post );
3038 * Publish future post and make sure post ID has future post status.
3040 * Invoked by cron 'publish_future_post' event. This safeguard prevents cron
3041 * from publishing drafts, etc.
3045 * @param int $post_id Post ID.
3046 * @return null Nothing is returned. Which can mean that no action is required or post was published.
3048 function check_and_publish_future_post($post_id) {
3050 $post = get_post($post_id);
3055 if ( 'future' != $post->post_status )
3058 $time = strtotime( $post->post_date_gmt . ' GMT' );
3060 if ( $time > time() ) { // Uh oh, someone jumped the gun!
3061 wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
3062 wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
3066 return wp_publish_post($post_id);
3070 * Computes a unique slug for the post, when given the desired slug and some post details.
3074 * @global wpdb $wpdb
3075 * @global WP_Rewrite $wp_rewrite
3076 * @param string $slug the desired slug (post_name)
3077 * @param integer $post_ID
3078 * @param string $post_status no uniqueness checks are made if the post is still draft or pending
3079 * @param string $post_type
3080 * @param integer $post_parent
3081 * @return string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
3083 function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) {
3084 if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
3087 global $wpdb, $wp_rewrite;
3089 $original_slug = $slug;
3091 $feeds = $wp_rewrite->feeds;
3092 if ( ! is_array( $feeds ) )
3095 $hierarchical_post_types = get_post_types( array('hierarchical' => true) );
3096 if ( 'attachment' == $post_type ) {
3097 // Attachment slugs must be unique across all types.
3098 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND ID != %d LIMIT 1";
3099 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) );
3101 if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) {
3104 $alt_post_name = substr ($slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3105 $post_name_check = $wpdb->get_var( $wpdb->prepare($check_sql, $alt_post_name, $post_ID ) );
3107 } while ( $post_name_check );
3108 $slug = $alt_post_name;
3110 } elseif ( in_array( $post_type, $hierarchical_post_types ) ) {
3111 if ( 'nav_menu_item' == $post_type )
3113 // Page slugs must be unique within their own trees. Pages are in a separate
3114 // namespace than posts so page slugs are allowed to overlap post slugs.
3115 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type IN ( '" . implode( "', '", esc_sql( $hierarchical_post_types ) ) . "' ) AND ID != %d AND post_parent = %d LIMIT 1";
3116 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID, $post_parent ) );
3118 if ( $post_name_check || in_array( $slug, $feeds ) || preg_match( "@^($wp_rewrite->pagination_base)?\d+$@", $slug ) || apply_filters( 'wp_unique_post_slug_is_bad_hierarchical_slug', false, $slug, $post_type, $post_parent ) ) {
3121 $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3122 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID, $post_parent ) );
3124 } while ( $post_name_check );
3125 $slug = $alt_post_name;
3128 // Post slugs must be unique across all posts.
3129 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d LIMIT 1";
3130 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID ) );
3132 if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) {
3135 $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
3136 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID ) );
3138 } while ( $post_name_check );
3139 $slug = $alt_post_name;
3143 return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug );
3147 * Adds tags to a post.
3149 * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true.
3151 * @package WordPress
3155 * @param int $post_id Post ID
3156 * @param string $tags The tags to set for the post, separated by commas.
3157 * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise
3159 function wp_add_post_tags($post_id = 0, $tags = '') {
3160 return wp_set_post_tags($post_id, $tags, true);
3164 * Set the tags for a post.
3167 * @uses wp_set_object_terms() Sets the tags for the post.
3169 * @param int $post_id Post ID.
3170 * @param string $tags The tags to set for the post, separated by commas.
3171 * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
3172 * @return mixed Array of affected term IDs. WP_Error or false on failure.
3174 function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
3175 return wp_set_post_terms( $post_id, $tags, 'post_tag', $append);
3179 * Set the terms for a post.
3182 * @uses wp_set_object_terms() Sets the tags for the post.
3184 * @param int $post_id Post ID.
3185 * @param string $tags The tags to set for the post, separated by commas.
3186 * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'.
3187 * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
3188 * @return mixed Array of affected term IDs. WP_Error or false on failure.
3190 function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
3191 $post_id = (int) $post_id;
3199 if ( ! is_array( $tags ) ) {
3200 $comma = _x( ',', 'tag delimiter' );
3201 if ( ',' !== $comma )
3202 $tags = str_replace( $comma, ',', $tags );
3203 $tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) );
3206 // Hierarchical taxonomies must always pass IDs rather than names so that children with the same
3207 // names but different parents aren't confused.
3208 if ( is_taxonomy_hierarchical( $taxonomy ) ) {
3209 $tags = array_unique( array_map( 'intval', $tags ) );
3212 return wp_set_object_terms( $post_id, $tags, $taxonomy, $append );
3216 * Set categories for a post.
3218 * If the post categories parameter is not set, then the default category is
3223 * @param int $post_ID Post ID.
3224 * @param array $post_categories Optional. List of categories.
3225 * @return bool|mixed
3227 function wp_set_post_categories($post_ID = 0, $post_categories = array()) {
3228 $post_ID = (int) $post_ID;
3229 $post_type = get_post_type( $post_ID );
3230 $post_status = get_post_status( $post_ID );
3231 // If $post_categories isn't already an array, make it one:
3232 if ( !is_array($post_categories) || empty($post_categories) ) {
3233 if ( 'post' == $post_type && 'auto-draft' != $post_status )
3234 $post_categories = array( get_option('default_category') );
3236 $post_categories = array();
3237 } else if ( 1 == count($post_categories) && '' == reset($post_categories) ) {
3241 return wp_set_post_terms($post_ID, $post_categories, 'category');
3245 * Transition the post status of a post.
3247 * Calls hooks to transition post status.
3249 * The first is 'transition_post_status' with new status, old status, and post data.
3251 * The next action called is 'OLDSTATUS_to_NEWSTATUS' the 'NEWSTATUS' is the
3252 * $new_status parameter and the 'OLDSTATUS' is $old_status parameter; it has the
3255 * The final action is named 'NEWSTATUS_POSTTYPE', 'NEWSTATUS' is from the $new_status
3256 * parameter and POSTTYPE is post_type post data.
3259 * @link http://codex.wordpress.org/Post_Status_Transitions
3261 * @uses do_action() Calls 'transition_post_status' on $new_status, $old_status and
3262 * $post if there is a status change.
3263 * @uses do_action() Calls '{$old_status}_to_{$new_status}' on $post if there is a status change.
3264 * @uses do_action() Calls '{$new_status}_{$post->post_type}' on post ID and $post.
3266 * @param string $new_status Transition to this post status.
3267 * @param string $old_status Previous post status.
3268 * @param object $post Post data.
3270 function wp_transition_post_status($new_status, $old_status, $post) {
3271 do_action('transition_post_status', $new_status, $old_status, $post);
3272 do_action("{$old_status}_to_{$new_status}", $post);
3273 do_action("{$new_status}_{$post->post_type}", $post->ID, $post);
3277 // Trackback and ping functions
3281 * Add a URL to those already pung.
3286 * @param int $post_id Post ID.
3287 * @param string $uri Ping URI.
3288 * @return int How many rows were updated.
3290 function add_ping($post_id, $uri) {
3292 $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
3293 $pung = trim($pung);
3294 $pung = preg_split('/\s/', $pung);
3296 $new = implode("\n", $pung);
3297 $new = apply_filters('add_ping', $new);
3298 // expected_slashed ($new)
3299 $new = stripslashes($new);
3300 return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) );
3304 * Retrieve enclosures already enclosed for a post.
3309 * @param int $post_id Post ID.
3310 * @return array List of enclosures
3312 function get_enclosed($post_id) {
3313 $custom_fields = get_post_custom( $post_id );
3315 if ( !is_array( $custom_fields ) )
3318 foreach ( $custom_fields as $key => $val ) {
3319 if ( 'enclosure' != $key || !is_array( $val ) )
3321 foreach( $val as $enc ) {
3322 $enclosure = explode( "\n", $enc );
3323 $pung[] = trim( $enclosure[ 0 ] );
3326 $pung = apply_filters('get_enclosed', $pung, $post_id);
3331 * Retrieve URLs already pinged for a post.
3336 * @param int $post_id Post ID.
3339 function get_pung($post_id) {
3341 $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
3342 $pung = trim($pung);
3343 $pung = preg_split('/\s/', $pung);
3344 $pung = apply_filters('get_pung', $pung);
3349 * Retrieve URLs that need to be pinged.
3354 * @param int $post_id Post ID
3357 function get_to_ping($post_id) {
3359 $to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id ));
3360 $to_ping = sanitize_trackback_urls( $to_ping );
3361 $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY);
3362 $to_ping = apply_filters('get_to_ping', $to_ping);
3367 * Do trackbacks for a list of URLs.
3371 * @param string $tb_list Comma separated list of URLs
3372 * @param int $post_id Post ID
3374 function trackback_url_list($tb_list, $post_id) {
3375 if ( ! empty( $tb_list ) ) {
3377 $postdata = get_post($post_id, ARRAY_A);
3379 // import postdata as variables
3380 extract($postdata, EXTR_SKIP);
3383 $excerpt = strip_tags($post_excerpt ? $post_excerpt : $post_content);
3385 if (strlen($excerpt) > 255) {
3386 $excerpt = substr($excerpt,0,252) . '...';
3389 $trackback_urls = explode(',', $tb_list);
3390 foreach( (array) $trackback_urls as $tb_url) {
3391 $tb_url = trim($tb_url);
3392 trackback($tb_url, stripslashes($post_title), $excerpt, $post_id);
3402 * Get a list of page IDs.
3407 * @return array List of page IDs.
3409 function get_all_page_ids() {
3412 $page_ids = wp_cache_get('all_page_ids', 'posts');
3413 if ( ! is_array( $page_ids ) ) {
3414 $page_ids = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE post_type = 'page'");
3415 wp_cache_add('all_page_ids', $page_ids, 'posts');
3422 * Retrieves page data given a page ID or page object.
3424 * Use get_post() instead of get_page().
3429 * @param mixed $page Page object or page ID. Passed by reference.
3430 * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N.
3431 * @param string $filter How the return value should be filtered.
3432 * @return WP_Post|null WP_Post on success or null on failure
3434 function get_page( $page, $output = OBJECT, $filter = 'raw') {
3435 return get_post( $page, $output, $filter );
3439 * Retrieves a page given its path.
3444 * @param string $page_path Page path
3445 * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
3446 * @param string $post_type Optional. Post type. Default page.
3447 * @return WP_Post|null WP_Post on success or null on failure
3449 function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') {
3452 $page_path = rawurlencode(urldecode($page_path));
3453 $page_path = str_replace('%2F', '/', $page_path);
3454 $page_path = str_replace('%20', ' ', $page_path);
3455 $parts = explode( '/', trim( $page_path, '/' ) );
3456 $parts = array_map( 'esc_sql', $parts );
3457 $parts = array_map( 'sanitize_title_for_query', $parts );
3459 $in_string = "'". implode( "','", $parts ) . "'";
3460 $post_type_sql = $post_type;
3461 $wpdb->escape_by_ref( $post_type_sql );
3462 $pages = $wpdb->get_results( "SELECT ID, post_name, post_parent, post_type FROM $wpdb->posts WHERE post_name IN ($in_string) AND (post_type = '$post_type_sql' OR post_type = 'attachment')", OBJECT_K );
3464 $revparts = array_reverse( $parts );
3467 foreach ( (array) $pages as $page ) {
3468 if ( $page->post_name == $revparts[0] ) {
3471 while ( $p->post_parent != 0 && isset( $pages[ $p->post_parent ] ) ) {
3473 $parent = $pages[ $p->post_parent ];
3474 if ( ! isset( $revparts[ $count ] ) || $parent->post_name != $revparts[ $count ] )
3479 if ( $p->post_parent == 0 && $count+1 == count( $revparts ) && $p->post_name == $revparts[ $count ] ) {
3480 $foundid = $page->ID;
3481 if ( $page->post_type == $post_type )
3488 return get_post( $foundid, $output );
3494 * Retrieve a page given its title.
3499 * @param string $page_title Page title
3500 * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
3501 * @param string $post_type Optional. Post type. Default page.
3502 * @return WP_Post|null WP_Post on success or null on failure
3504 function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) {
3506 $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type= %s", $page_title, $post_type ) );
3508 return get_post( $page, $output );
3514 * Retrieve child pages from list of pages matching page ID.
3516 * Matches against the pages parameter against the page ID. Also matches all
3517 * children for the same to retrieve all children of a page. Does not make any
3518 * SQL queries to get the children.
3522 * @param int $page_id Page ID.
3523 * @param array $pages List of pages' objects.
3526 function get_page_children($page_id, $pages) {
3527 $page_list = array();
3528 foreach ( (array) $pages as $page ) {
3529 if ( $page->post_parent == $page_id ) {
3530 $page_list[] = $page;
3531 if ( $children = get_page_children($page->ID, $pages) )
3532 $page_list = array_merge($page_list, $children);
3539 * Order the pages with children under parents in a flat list.
3541 * It uses auxiliary structure to hold parent-children relationships and
3542 * runs in O(N) complexity
3546 * @param array $pages Posts array.
3547 * @param int $page_id Parent page ID.
3548 * @return array A list arranged by hierarchy. Children immediately follow their parents.
3550 function get_page_hierarchy( &$pages, $page_id = 0 ) {
3551 if ( empty( $pages ) ) {
3556 $children = array();
3557 foreach ( (array) $pages as $p ) {
3558 $parent_id = intval( $p->post_parent );
3559 $children[ $parent_id ][] = $p;
3563 _page_traverse_name( $page_id, $children, $result );
3569 * function to traverse and return all the nested children post names of a root page.
3570 * $children contains parent-children relations
3574 function _page_traverse_name( $page_id, &$children, &$result ){
3575 if ( isset( $children[ $page_id ] ) ){
3576 foreach( (array)$children[ $page_id ] as $child ) {
3577 $result[ $child->ID ] = $child->post_name;
3578 _page_traverse_name( $child->ID, $children, $result );
3584 * Builds URI for a page.
3586 * Sub pages will be in the "directory" under the parent page post name.
3590 * @param mixed $page Page object or page ID.
3591 * @return string Page URI.
3593 function get_page_uri($page) {
3594 $page = get_post( $page );
3596 $uri = $page->post_name;
3598 foreach ( $page->ancestors as $parent ) {
3599 $uri = get_post( $parent )->post_name . "/" . $uri;
3606 * Retrieve a list of pages.
3608 * The defaults that can be overridden are the following: 'child_of',
3609 * 'sort_order', 'sort_column', 'post_title', 'hierarchical', 'exclude',
3610 * 'include', 'meta_key', 'meta_value','authors', 'number', and 'offset'.
3615 * @param mixed $args Optional. Array or string of options that overrides defaults.
3616 * @return array List of pages matching defaults or $args
3618 function get_pages($args = '') {
3624 'child_of' => 0, 'sort_order' => 'ASC',
3625 'sort_column' => 'post_title', 'hierarchical' => 1,
3626 'exclude' => array(), 'include' => array(),
3627 'meta_key' => '', 'meta_value' => '',
3628 'authors' => '', 'parent' => -1, 'exclude_tree' => '',
3629 'number' => '', 'offset' => 0,
3630 'post_type' => 'page', 'post_status' => 'publish',
3633 $r = wp_parse_args( $args, $defaults );
3634 extract( $r, EXTR_SKIP );
3635 $number = (int) $number;
3636 $offset = (int) $offset;
3638 // Make sure the post type is hierarchical
3639 $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
3640 if ( !in_array( $post_type, $hierarchical_post_types ) )
3643 // Make sure we have a valid post status
3644 if ( !is_array( $post_status ) )
3645 $post_status = explode( ',', $post_status );
3646 if ( array_diff( $post_status, get_post_stati() ) )
3650 $key = md5( serialize( compact(array_keys($defaults)) ) );
3651 if ( $cache = wp_cache_get( 'get_pages', 'posts' ) ) {
3652 if ( is_array($cache) && isset( $cache[ $key ] ) && is_array( $cache[ $key ] ) ) {
3653 // Convert to WP_Post instances
3654 $pages = array_map( 'get_post', $cache[ $key ] );
3655 $pages = apply_filters( 'get_pages', $pages, $r );
3660 if ( !is_array($cache) )
3664 if ( !empty($include) ) {
3665 $child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
3670 $hierarchical = false;
3671 $incpages = wp_parse_id_list( $include );
3672 if ( ! empty( $incpages ) ) {
3673 foreach ( $incpages as $incpage ) {
3674 if (empty($inclusions))
3675 $inclusions = $wpdb->prepare(' AND ( ID = %d ', $incpage);
3677 $inclusions .= $wpdb->prepare(' OR ID = %d ', $incpage);
3681 if (!empty($inclusions))
3685 if ( !empty($exclude) ) {
3686 $expages = wp_parse_id_list( $exclude );
3687 if ( ! empty( $expages ) ) {
3688 foreach ( $expages as $expage ) {
3689 if (empty($exclusions))
3690 $exclusions = $wpdb->prepare(' AND ( ID <> %d ', $expage);
3692 $exclusions .= $wpdb->prepare(' AND ID <> %d ', $expage);
3696 if (!empty($exclusions))
3700 if (!empty($authors)) {
3701 $post_authors = preg_split('/[\s,]+/',$authors);
3703 if ( ! empty( $post_authors ) ) {
3704 foreach ( $post_authors as $post_author ) {
3705 //Do we have an author id or an author login?
3706 if ( 0 == intval($post_author) ) {
3707 $post_author = get_user_by('login', $post_author);
3708 if ( empty($post_author) )
3710 if ( empty($post_author->ID) )
3712 $post_author = $post_author->ID;
3715 if ( '' == $author_query )
3716 $author_query = $wpdb->prepare(' post_author = %d ', $post_author);
3718 $author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author);
3720 if ( '' != $author_query )
3721 $author_query = " AND ($author_query)";
3726 $where = "$exclusions $inclusions ";
3727 if ( ! empty( $meta_key ) || ! empty( $meta_value ) ) {
3728 $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )";
3730 // meta_key and meta_value might be slashed
3731 $meta_key = stripslashes($meta_key);
3732 $meta_value = stripslashes($meta_value);
3733 if ( ! empty( $meta_key ) )
3734 $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key);
3735 if ( ! empty( $meta_value ) )
3736 $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value);
3741 $where .= $wpdb->prepare(' AND post_parent = %d ', $parent);
3743 if ( 1 == count( $post_status ) ) {
3744 $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $post_type, array_shift( $post_status ) );
3746 $post_status = implode( "', '", $post_status );
3747 $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $post_type );
3750 $orderby_array = array();
3751 $allowed_keys = array('author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified',
3752 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent',
3753 'ID', 'rand', 'comment_count');
3754 foreach ( explode( ',', $sort_column ) as $orderby ) {
3755 $orderby = trim( $orderby );
3756 if ( !in_array( $orderby, $allowed_keys ) )
3759 switch ( $orderby ) {
3763 $orderby = "$wpdb->posts.ID";
3766 $orderby = 'RAND()';
3768 case 'comment_count':
3769 $orderby = "$wpdb->posts.comment_count";
3772 if ( 0 === strpos( $orderby, 'post_' ) )
3773 $orderby = "$wpdb->posts." . $orderby;
3775 $orderby = "$wpdb->posts.post_" . $orderby;
3778 $orderby_array[] = $orderby;
3781 $sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title";
3783 $sort_order = strtoupper( $sort_order );
3784 if ( '' !== $sort_order && !in_array( $sort_order, array( 'ASC', 'DESC' ) ) )
3785 $sort_order = 'ASC';
3787 $query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where ";
3788 $query .= $author_query;
3789 $query .= " ORDER BY " . $sort_column . " " . $sort_order ;
3791 if ( !empty($number) )
3792 $query .= ' LIMIT ' . $offset . ',' . $number;
3794 $pages = $wpdb->get_results($query);
3796 if ( empty($pages) ) {
3797 $pages = apply_filters('get_pages', array(), $r);
3801 // Sanitize before caching so it'll only get done once
3802 $num_pages = count($pages);
3803 for ($i = 0; $i < $num_pages; $i++) {
3804 $pages[$i] = sanitize_post($pages[$i], 'raw');
3808 update_post_cache( $pages );
3810 if ( $child_of || $hierarchical )
3811 $pages = get_page_children($child_of, $pages);
3813 if ( !empty($exclude_tree) ) {
3814 $exclude = (int) $exclude_tree;
3815 $children = get_page_children($exclude, $pages);
3816 $excludes = array();
3817 foreach ( $children as $child )
3818 $excludes[] = $child->ID;
3819 $excludes[] = $exclude;
3820 $num_pages = count($pages);
3821 for ( $i = 0; $i < $num_pages; $i++ ) {
3822 if ( in_array($pages[$i]->ID, $excludes) )
3827 $cache[ $key ] = $pages;
3828 wp_cache_set( 'get_pages', $cache, 'posts' );
3830 // Convert to WP_Post instances
3831 $pages = array_map( 'get_post', $pages );
3833 $pages = apply_filters('get_pages', $pages, $r);
3839 // Attachment functions
3843 * Check if the attachment URI is local one and is really an attachment.
3847 * @param string $url URL to check
3848 * @return bool True on success, false on failure.
3850 function is_local_attachment($url) {
3851 if (strpos($url, home_url()) === false)
3853 if (strpos($url, home_url('/?attachment_id=')) !== false)
3855 if ( $id = url_to_postid($url) ) {
3856 $post = get_post($id);
3857 if ( 'attachment' == $post->post_type )
3864 * Insert an attachment.
3866 * If you set the 'ID' in the $object parameter, it will mean that you are
3867 * updating and attempt to update the attachment. You can also set the
3868 * attachment name or title by setting the key 'post_name' or 'post_title'.
3870 * You can set the dates for the attachment manually by setting the 'post_date'
3871 * and 'post_date_gmt' keys' values.
3873 * By default, the comments will use the default settings for whether the
3874 * comments are allowed. You can close them manually or keep them open by
3875 * setting the value for the 'comment_status' key.
3877 * The $object parameter can have the following:
3878 * 'post_status' - Default is 'draft'. Can not be overridden, set the same as parent post.
3879 * 'post_type' - Default is 'post', will be set to attachment. Can not override.
3880 * 'post_author' - Default is current user ID. The ID of the user, who added the attachment.
3881 * 'ping_status' - Default is the value in default ping status option. Whether the attachment
3883 * 'post_parent' - Default is 0. Can use $parent parameter or set this for the post it belongs
3885 * 'menu_order' - Default is 0. The order it is displayed.
3886 * 'to_ping' - Whether to ping.
3887 * 'pinged' - Default is empty string.
3888 * 'post_password' - Default is empty string. The password to access the attachment.
3889 * 'guid' - Global Unique ID for referencing the attachment.
3890 * 'post_content_filtered' - Attachment post content filtered.
3891 * 'post_excerpt' - Attachment excerpt.
3896 * @uses do_action() Calls 'edit_attachment' on $post_ID if this is an update.
3897 * @uses do_action() Calls 'add_attachment' on $post_ID if this is not an update.
3899 * @param string|array $object Arguments to override defaults.
3900 * @param string $file Optional filename.
3901 * @param int $parent Parent post ID.
3902 * @return int Attachment ID.
3904 function wp_insert_attachment($object, $file = false, $parent = 0) {
3905 global $wpdb, $user_ID;
3907 $defaults = array('post_status' => 'inherit', 'post_type' => 'post', 'post_author' => $user_ID,
3908 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
3909 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '',
3910 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0, 'context' => '');
3912 $object = wp_parse_args($object, $defaults);
3913 if ( !empty($parent) )
3914 $object['post_parent'] = $parent;
3916 unset( $object[ 'filter' ] );
3918 $object = sanitize_post($object, 'db');
3920 // export array as variables
3921 extract($object, EXTR_SKIP);
3923 if ( empty($post_author) )
3924 $post_author = $user_ID;
3926 $post_type = 'attachment';
3928 if ( ! in_array( $post_status, array( 'inherit', 'private' ) ) )
3929 $post_status = 'inherit';
3931 if ( !empty($post_category) )
3932 $post_category = array_filter($post_category); // Filter out empty terms
3934 // Make sure we set a valid category.
3935 if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
3936 $post_category = array();
3939 // Are we updating or creating?
3940 if ( !empty($ID) ) {
3942 $post_ID = (int) $ID;
3948 // Create a valid post name.
3949 if ( empty($post_name) )
3950 $post_name = sanitize_title($post_title);
3952 $post_name = sanitize_title($post_name);
3954 // expected_slashed ($post_name)
3955 $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
3957 if ( empty($post_date) )
3958 $post_date = current_time('mysql');
3959 if ( empty($post_date_gmt) )
3960 $post_date_gmt = current_time('mysql', 1);
3962 if ( empty($post_modified) )
3963 $post_modified = $post_date;
3964 if ( empty($post_modified_gmt) )
3965 $post_modified_gmt = $post_date_gmt;
3967 if ( empty($comment_status) ) {
3969 $comment_status = 'closed';
3971 $comment_status = get_option('default_comment_status');
3973 if ( empty($ping_status) )
3974 $ping_status = get_option('default_ping_status');
3976 if ( isset($to_ping) )
3977 $to_ping = preg_replace('|\s+|', "\n", $to_ping);
3981 if ( isset($post_parent) )
3982 $post_parent = (int) $post_parent;
3986 if ( isset($menu_order) )
3987 $menu_order = (int) $menu_order;
3991 if ( !isset($post_password) )
3992 $post_password = '';
3994 if ( ! isset($pinged) )
3997 // expected_slashed (everything!)
3998 $data = compact( array( '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' ) );
3999 $data = stripslashes_deep( $data );
4002 $wpdb->update( $wpdb->posts, $data, array( 'ID' => $post_ID ) );
4004 // If there is a suggested ID, use it if not already present
4005 if ( !empty($import_id) ) {
4006 $import_id = (int) $import_id;
4007 if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
4008 $data['ID'] = $import_id;
4012 $wpdb->insert( $wpdb->posts, $data );
4013 $post_ID = (int) $wpdb->insert_id;
4016 if ( empty($post_name) ) {
4017 $post_name = sanitize_title($post_title, $post_ID);
4018 $wpdb->update( $wpdb->posts, compact("post_name"), array( 'ID' => $post_ID ) );
4021 if ( is_object_in_taxonomy($post_type, 'category') )
4022 wp_set_post_categories( $post_ID, $post_category );
4024 if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') )
4025 wp_set_post_tags( $post_ID, $tags_input );
4027 // support for all custom taxonomies
4028 if ( !empty($tax_input) ) {
4029 foreach ( $tax_input as $taxonomy => $tags ) {
4030 $taxonomy_obj = get_taxonomy($taxonomy);
4031 if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical.
4032 $tags = array_filter($tags);
4033 if ( current_user_can($taxonomy_obj->cap->assign_terms) )
4034 wp_set_post_terms( $post_ID, $tags, $taxonomy );
4039 update_attached_file( $post_ID, $file );
4041 clean_post_cache( $post_ID );
4043 if ( ! empty( $context ) )
4044 add_post_meta( $post_ID, '_wp_attachment_context', $context, true );
4047 do_action('edit_attachment', $post_ID);
4049 do_action('add_attachment', $post_ID);
4056 * Trashes or deletes an attachment.
4058 * When an attachment is permanently deleted, the file will also be removed.
4059 * Deletion removes all post meta fields, taxonomy, comments, etc. associated
4060 * with the attachment (except the main post).
4062 * The attachment is moved to the trash instead of permanently deleted unless trash
4063 * for media is disabled, item is already in the trash, or $force_delete is true.
4067 * @uses do_action() Calls 'delete_attachment' hook on Attachment ID.
4069 * @param int $post_id Attachment ID.
4070 * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
4071 * @return mixed False on failure. Post data on success.
4073 function wp_delete_attachment( $post_id, $force_delete = false ) {
4076 if ( !$post = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $post_id) ) )
4079 if ( 'attachment' != $post->post_type )
4082 if ( !$force_delete && EMPTY_TRASH_DAYS && MEDIA_TRASH && 'trash' != $post->post_status )
4083 return wp_trash_post( $post_id );
4085 delete_post_meta($post_id, '_wp_trash_meta_status');
4086 delete_post_meta($post_id, '_wp_trash_meta_time');
4088 $meta = wp_get_attachment_metadata( $post_id );
4089 $backup_sizes = get_post_meta( $post->ID, '_wp_attachment_backup_sizes', true );
4090 $file = get_attached_file( $post_id );
4092 $intermediate_sizes = array();
4093 foreach ( get_intermediate_image_sizes() as $size ) {
4094 if ( $intermediate = image_get_intermediate_size( $post_id, $size ) )
4095 $intermediate_sizes[] = $intermediate;
4098 if ( is_multisite() )
4099 delete_transient( 'dirsize_cache' );
4101 do_action('delete_attachment', $post_id);
4103 wp_delete_object_term_relationships($post_id, array('category', 'post_tag'));
4104 wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type));
4106 delete_metadata( 'post', null, '_thumbnail_id', $post_id, true ); // delete all for any posts.
4108 $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id ));
4109 foreach ( $comment_ids as $comment_id )
4110 wp_delete_comment( $comment_id, true );
4112 $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $post_id ));
4113 foreach ( $post_meta_ids as $mid )
4114 delete_metadata_by_mid( 'post', $mid );
4116 do_action( 'delete_post', $post_id );
4117 $wpdb->delete( $wpdb->posts, array( 'ID' => $post_id ) );
4118 do_action( 'deleted_post', $post_id );
4120 $uploadpath = wp_upload_dir();
4122 if ( ! empty($meta['thumb']) ) {
4123 // Don't delete the thumb if another attachment uses it
4124 if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $meta['thumb'] . '%', $post_id)) ) {
4125 $thumbfile = str_replace(basename($file), $meta['thumb'], $file);
4126 $thumbfile = apply_filters('wp_delete_file', $thumbfile);
4127 @ unlink( path_join($uploadpath['basedir'], $thumbfile) );
4131 // remove intermediate and backup images if there are any
4132 foreach ( $intermediate_sizes as $intermediate ) {
4133 $intermediate_file = apply_filters( 'wp_delete_file', $intermediate['path'] );
4134 @ unlink( path_join($uploadpath['basedir'], $intermediate_file) );
4137 if ( is_array($backup_sizes) ) {
4138 foreach ( $backup_sizes as $size ) {
4139 $del_file = path_join( dirname($meta['file']), $size['file'] );
4140 $del_file = apply_filters('wp_delete_file', $del_file);
4141 @ unlink( path_join($uploadpath['basedir'], $del_file) );
4145 $file = apply_filters('wp_delete_file', $file);
4147 if ( ! empty($file) )
4150 clean_post_cache( $post );
4156 * Retrieve attachment meta field for attachment ID.
4160 * @param int $post_id Attachment ID
4161 * @param bool $unfiltered Optional, default is false. If true, filters are not run.
4162 * @return string|bool Attachment meta field. False on failure.
4164 function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
4165 $post_id = (int) $post_id;
4166 if ( !$post = get_post( $post_id ) )
4169 $data = get_post_meta( $post->ID, '_wp_attachment_metadata', true );
4174 return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID );
4178 * Update metadata for an attachment.
4182 * @param int $post_id Attachment ID.
4183 * @param array $data Attachment data.
4186 function wp_update_attachment_metadata( $post_id, $data ) {
4187 $post_id = (int) $post_id;
4188 if ( !$post = get_post( $post_id ) )
4191 if ( $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ) )
4192 return update_post_meta( $post->ID, '_wp_attachment_metadata', $data );
4194 return delete_post_meta( $post->ID, '_wp_attachment_metadata' );
4198 * Retrieve the URL for an attachment.
4202 * @param int $post_id Attachment ID.
4205 function wp_get_attachment_url( $post_id = 0 ) {
4206 $post_id = (int) $post_id;
4207 if ( !$post = get_post( $post_id ) )
4210 if ( 'attachment' != $post->post_type )
4214 if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) { //Get attached file
4215 if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { //Get upload directory
4216 if ( 0 === strpos($file, $uploads['basedir']) ) //Check that the upload base exists in the file location
4217 $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file); //replace file location with url location
4218 elseif ( false !== strpos($file, 'wp-content/uploads') )
4219 $url = $uploads['baseurl'] . substr( $file, strpos($file, 'wp-content/uploads') + 18 );
4221 $url = $uploads['baseurl'] . "/$file"; //Its a newly uploaded file, therefor $file is relative to the basedir.
4225 if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recommended to rely upon this.
4226 $url = get_the_guid( $post->ID );
4228 $url = apply_filters( 'wp_get_attachment_url', $url, $post->ID );
4230 if ( empty( $url ) )
4237 * Retrieve thumbnail for an attachment.
4241 * @param int $post_id Attachment ID.
4242 * @return mixed False on failure. Thumbnail file path on success.
4244 function wp_get_attachment_thumb_file( $post_id = 0 ) {
4245 $post_id = (int) $post_id;
4246 if ( !$post = get_post( $post_id ) )
4248 if ( !is_array( $imagedata = wp_get_attachment_metadata( $post->ID ) ) )
4251 $file = get_attached_file( $post->ID );
4253 if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) )
4254 return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );
4259 * Retrieve URL for an attachment thumbnail.
4263 * @param int $post_id Attachment ID
4264 * @return string|bool False on failure. Thumbnail URL on success.
4266 function wp_get_attachment_thumb_url( $post_id = 0 ) {
4267 $post_id = (int) $post_id;
4268 if ( !$post = get_post( $post_id ) )
4270 if ( !$url = wp_get_attachment_url( $post->ID ) )
4273 $sized = image_downsize( $post_id, 'thumbnail' );
4277 if ( !$thumb = wp_get_attachment_thumb_file( $post->ID ) )
4280 $url = str_replace(basename($url), basename($thumb), $url);
4282 return apply_filters( 'wp_get_attachment_thumb_url', $url, $post->ID );
4286 * Check if the attachment is an image.
4290 * @param int $post_id Attachment ID
4293 function wp_attachment_is_image( $post_id = 0 ) {
4294 $post_id = (int) $post_id;
4295 if ( !$post = get_post( $post_id ) )
4298 if ( !$file = get_attached_file( $post->ID ) )
4301 $ext = preg_match('/\.([^.]+)$/', $file, $matches) ? strtolower($matches[1]) : false;
4303 $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' );
4305 if ( 'image/' == substr($post->post_mime_type, 0, 6) || $ext && 'import' == $post->post_mime_type && in_array($ext, $image_exts) )
4311 * Retrieve the icon for a MIME type.
4315 * @param string|int $mime MIME type or attachment ID.
4316 * @return string|bool
4318 function wp_mime_type_icon( $mime = 0 ) {
4319 if ( !is_numeric($mime) )
4320 $icon = wp_cache_get("mime_type_icon_$mime");
4323 if ( empty($icon) ) {
4324 $post_mimes = array();
4325 if ( is_numeric($mime) ) {
4326 $mime = (int) $mime;
4327 if ( $post = get_post( $mime ) ) {
4328 $post_id = (int) $post->ID;
4329 $ext = preg_replace('/^.+?\.([^.]+)$/', '$1', $post->guid);
4330 if ( !empty($ext) ) {
4331 $post_mimes[] = $ext;
4332 if ( $ext_type = wp_ext2type( $ext ) )
4333 $post_mimes[] = $ext_type;
4335 $mime = $post->post_mime_type;
4340 $post_mimes[] = $mime;
4343 $icon_files = wp_cache_get('icon_files');
4345 if ( !is_array($icon_files) ) {
4346 $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' );
4347 $icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url('images/crystal') );
4348 $dirs = apply_filters( 'icon_dirs', array($icon_dir => $icon_dir_uri) );
4349 $icon_files = array();
4351 $keys = array_keys( $dirs );
4352 $dir = array_shift( $keys );
4353 $uri = array_shift($dirs);
4354 if ( $dh = opendir($dir) ) {
4355 while ( false !== $file = readdir($dh) ) {
4356 $file = basename($file);
4357 if ( substr($file, 0, 1) == '.' )
4359 if ( !in_array(strtolower(substr($file, -4)), array('.png', '.gif', '.jpg') ) ) {
4360 if ( is_dir("$dir/$file") )
4361 $dirs["$dir/$file"] = "$uri/$file";
4364 $icon_files["$dir/$file"] = "$uri/$file";
4369 wp_cache_add( 'icon_files', $icon_files, 'default', 600 );
4372 // Icon basename - extension = MIME wildcard
4373 foreach ( $icon_files as $file => $uri )
4374 $types[ preg_replace('/^([^.]*).*$/', '$1', basename($file)) ] =& $icon_files[$file];
4376 if ( ! empty($mime) ) {
4377 $post_mimes[] = substr($mime, 0, strpos($mime, '/'));
4378 $post_mimes[] = substr($mime, strpos($mime, '/') + 1);
4379 $post_mimes[] = str_replace('/', '_', $mime);
4382 $matches = wp_match_mime_types(array_keys($types), $post_mimes);
4383 $matches['default'] = array('default');
4385 foreach ( $matches as $match => $wilds ) {
4386 if ( isset($types[$wilds[0]])) {
4387 $icon = $types[$wilds[0]];
4388 if ( !is_numeric($mime) )
4389 wp_cache_add("mime_type_icon_$mime", $icon);
4395 return apply_filters( 'wp_mime_type_icon', $icon, $mime, $post_id ); // Last arg is 0 if function pass mime type.
4399 * Checked for changed slugs for published post objects and save the old slug.
4401 * The function is used when a post object of any type is updated,
4402 * by comparing the current and previous post objects.
4404 * If the slug was changed and not already part of the old slugs then it will be
4405 * added to the post meta field ('_wp_old_slug') for storing old slugs for that
4408 * The most logically usage of this function is redirecting changed post objects, so
4409 * that those that linked to an changed post will be redirected to the new post.
4413 * @param int $post_id Post ID.
4414 * @param object $post The Post Object
4415 * @param object $post_before The Previous Post Object
4416 * @return int Same as $post_id
4418 function wp_check_for_changed_slugs($post_id, $post, $post_before) {
4419 // dont bother if it hasnt changed
4420 if ( $post->post_name == $post_before->post_name )
4423 // we're only concerned with published, non-hierarchical objects
4424 if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) )
4427 $old_slugs = (array) get_post_meta($post_id, '_wp_old_slug');
4429 // if we haven't added this old slug before, add it now
4430 if ( !empty( $post_before->post_name ) && !in_array($post_before->post_name, $old_slugs) )
4431 add_post_meta($post_id, '_wp_old_slug', $post_before->post_name);
4433 // if the new slug was used previously, delete it from the list
4434 if ( in_array($post->post_name, $old_slugs) )
4435 delete_post_meta($post_id, '_wp_old_slug', $post->post_name);
4439 * Retrieve the private post SQL based on capability.
4441 * This function provides a standardized way to appropriately select on the
4442 * post_status of a post type. The function will return a piece of SQL code
4443 * that can be added to a WHERE clause; this SQL is constructed to allow all
4444 * published posts, and all private posts to which the user has access.
4450 * @param string $post_type currently only supports 'post' or 'page'.
4451 * @return string SQL code that can be added to a where clause.
4453 function get_private_posts_cap_sql( $post_type ) {
4454 return get_posts_by_author_sql( $post_type, false );
4458 * Retrieve the post SQL based on capability, author, and type.
4460 * @see get_private_posts_cap_sql() for full description.
4463 * @param string $post_type Post type.
4464 * @param bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term.
4465 * @param int $post_author Optional. Query posts having a single author ID.
4466 * @param bool $public_only Optional. Only return public posts. Skips cap checks for $current_user. Default is false.
4467 * @return string SQL WHERE code that can be added to a query.
4469 function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) {
4470 global $user_ID, $wpdb;
4473 $post_type_obj = get_post_type_object( $post_type );
4474 if ( ! $post_type_obj )
4475 return $full ? 'WHERE 1 = 0' : ' 1 = 0 ';
4477 // This hook is deprecated. Why you'd want to use it, I dunno.
4478 if ( ! $cap = apply_filters( 'pub_priv_sql_capability', '' ) )
4479 $cap = $post_type_obj->cap->read_private_posts;
4482 if ( null === $post_author ) {
4483 $sql = $wpdb->prepare( 'WHERE post_type = %s AND ', $post_type );
4485 $sql = $wpdb->prepare( 'WHERE post_author = %d AND post_type = %s AND ', $post_author, $post_type );
4491 $sql .= "(post_status = 'publish'";
4493 // Only need to check the cap if $public_only is false
4494 if ( false === $public_only ) {
4495 if ( current_user_can( $cap ) ) {
4496 // Does the user have the capability to view private posts? Guess so.
4497 $sql .= " OR post_status = 'private'";
4498 } elseif ( is_user_logged_in() ) {
4499 // Users can view their own private posts.
4500 $id = (int) $user_ID;
4501 if ( null === $post_author || ! $full ) {
4502 $sql .= " OR post_status = 'private' AND post_author = $id";
4503 } elseif ( $id == (int) $post_author ) {
4504 $sql .= " OR post_status = 'private'";
4515 * Retrieve the date that the last post was published.
4517 * The server timezone is the default and is the difference between GMT and
4518 * server time. The 'blog' value is the date when the last post was posted. The
4519 * 'gmt' is when the last post was posted in GMT formatted date.
4523 * @uses apply_filters() Calls 'get_lastpostdate' filter
4525 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
4526 * @return string The date of the last post.
4528 function get_lastpostdate($timezone = 'server') {
4529 return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date' ), $timezone );
4533 * Retrieve last post modified date depending on timezone.
4535 * The server timezone is the default and is the difference between GMT and
4536 * server time. The 'blog' value is just when the last post was modified. The
4537 * 'gmt' is when the last post was modified in GMT time.
4540 * @uses apply_filters() Calls 'get_lastpostmodified' filter
4542 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
4543 * @return string The date the post was last modified.
4545 function get_lastpostmodified($timezone = 'server') {
4546 $lastpostmodified = _get_last_post_time( $timezone, 'modified' );
4548 $lastpostdate = get_lastpostdate($timezone);
4549 if ( $lastpostdate > $lastpostmodified )
4550 $lastpostmodified = $lastpostdate;
4552 return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
4556 * Retrieve latest post date data based on timezone.
4561 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
4562 * @param string $field Field to check. Can be 'date' or 'modified'.
4563 * @return string The date.
4565 function _get_last_post_time( $timezone, $field ) {
4568 if ( !in_array( $field, array( 'date', 'modified' ) ) )
4571 $timezone = strtolower( $timezone );
4573 $key = "lastpost{$field}:$timezone";
4575 $date = wp_cache_get( $key, 'timeinfo' );
4578 $add_seconds_server = date('Z');
4580 $post_types = get_post_types( array( 'public' => true ) );
4581 array_walk( $post_types, array( &$wpdb, 'escape_by_ref' ) );
4582 $post_types = "'" . implode( "', '", $post_types ) . "'";
4584 switch ( $timezone ) {
4586 $date = $wpdb->get_var("SELECT post_{$field}_gmt FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
4589 $date = $wpdb->get_var("SELECT post_{$field} FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
4592 $date = $wpdb->get_var("SELECT DATE_ADD(post_{$field}_gmt, INTERVAL '$add_seconds_server' SECOND) FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
4597 wp_cache_set( $key, $date, 'timeinfo' );
4604 * Updates posts in cache.
4606 * @package WordPress
4610 * @param array $posts Array of post objects
4612 function update_post_cache( &$posts ) {
4616 foreach ( $posts as $post )
4617 wp_cache_add( $post->ID, $post, 'posts' );
4621 * Will clean the post in the cache.
4623 * Cleaning means delete from the cache of the post. Will call to clean the term
4624 * object cache associated with the post ID.
4626 * This function not run if $_wp_suspend_cache_invalidation is not empty. See
4627 * wp_suspend_cache_invalidation().
4629 * @package WordPress
4633 * @uses do_action() Calls 'clean_post_cache' on $id before adding children (if any).
4635 * @param object|int $post The post object or ID to remove from the cache
4637 function clean_post_cache( $post ) {
4638 global $_wp_suspend_cache_invalidation, $wpdb;
4640 if ( ! empty( $_wp_suspend_cache_invalidation ) )
4643 $post = get_post( $post );
4644 if ( empty( $post ) )
4647 wp_cache_delete( $post->ID, 'posts' );
4648 wp_cache_delete( $post->ID, 'post_meta' );
4650 clean_object_term_cache( $post->ID, $post->post_type );
4652 wp_cache_delete( 'wp_get_archives', 'general' );
4654 do_action( 'clean_post_cache', $post->ID, $post );
4656 if ( is_post_type_hierarchical( $post->post_type ) )
4657 wp_cache_delete( 'get_pages', 'posts' );
4659 if ( 'page' == $post->post_type ) {
4660 wp_cache_delete( 'all_page_ids', 'posts' );
4661 do_action( 'clean_page_cache', $post->ID );
4666 * Call major cache updating functions for list of Post objects.
4668 * @package WordPress
4673 * @uses update_post_cache()
4674 * @uses update_object_term_cache()
4675 * @uses update_postmeta_cache()
4677 * @param array $posts Array of Post objects
4678 * @param string $post_type The post type of the posts in $posts. Default is 'post'.
4679 * @param bool $update_term_cache Whether to update the term cache. Default is true.
4680 * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
4682 function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) {
4683 // No point in doing all this work if we didn't match any posts.
4687 update_post_cache($posts);
4689 $post_ids = array();
4690 foreach ( $posts as $post )
4691 $post_ids[] = $post->ID;
4696 if ( $update_term_cache ) {
4697 if ( is_array($post_type) ) {
4698 $ptypes = $post_type;
4699 } elseif ( 'any' == $post_type ) {
4700 // Just use the post_types in the supplied posts.
4701 foreach ( $posts as $post )
4702 $ptypes[] = $post->post_type;
4703 $ptypes = array_unique($ptypes);
4705 $ptypes = array($post_type);
4708 if ( ! empty($ptypes) )
4709 update_object_term_cache($post_ids, $ptypes);
4712 if ( $update_meta_cache )
4713 update_postmeta_cache($post_ids);
4717 * Updates metadata cache for list of post IDs.
4719 * Performs SQL query to retrieve the metadata for the post IDs and updates the
4720 * metadata cache for the posts. Therefore, the functions, which call this
4721 * function, do not need to perform SQL queries on their own.
4723 * @package WordPress
4729 * @param array $post_ids List of post IDs.
4730 * @return bool|array Returns false if there is nothing to update or an array of metadata.
4732 function update_postmeta_cache($post_ids) {
4733 return update_meta_cache('post', $post_ids);
4737 * Will clean the attachment in the cache.
4739 * Cleaning means delete from the cache. Optionally will clean the term
4740 * object cache associated with the attachment ID.
4742 * This function will not run if $_wp_suspend_cache_invalidation is not empty. See
4743 * wp_suspend_cache_invalidation().
4745 * @package WordPress
4749 * @uses do_action() Calls 'clean_attachment_cache' on $id.
4751 * @param int $id The attachment ID in the cache to clean
4752 * @param bool $clean_terms optional. Whether to clean terms cache
4754 function clean_attachment_cache($id, $clean_terms = false) {
4755 global $_wp_suspend_cache_invalidation;
4757 if ( !empty($_wp_suspend_cache_invalidation) )
4762 wp_cache_delete($id, 'posts');
4763 wp_cache_delete($id, 'post_meta');
4766 clean_object_term_cache($id, 'attachment');
4768 do_action('clean_attachment_cache', $id);
4776 * Hook for managing future post transitions to published.
4781 * @uses do_action() Calls 'private_to_published' on post ID if this is a 'private_to_published' call.
4782 * @uses wp_clear_scheduled_hook() with 'publish_future_post' and post ID.
4784 * @param string $new_status New post status
4785 * @param string $old_status Previous post status
4786 * @param object $post Object type containing the post information
4788 function _transition_post_status($new_status, $old_status, $post) {
4791 if ( $old_status != 'publish' && $new_status == 'publish' ) {
4792 // Reset GUID if transitioning to publish and it is empty
4793 if ( '' == get_the_guid($post->ID) )
4794 $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post->ID ) ), array( 'ID' => $post->ID ) );
4795 do_action('private_to_published', $post->ID); // Deprecated, use private_to_publish
4798 // If published posts changed clear the lastpostmodified cache
4799 if ( 'publish' == $new_status || 'publish' == $old_status) {
4800 foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
4801 wp_cache_delete( "lastpostmodified:$timezone", 'timeinfo' );
4802 wp_cache_delete( "lastpostdate:$timezone", 'timeinfo' );
4806 // Always clears the hook in case the post status bounced from future to draft.
4807 wp_clear_scheduled_hook('publish_future_post', array( $post->ID ) );
4811 * Hook used to schedule publication for a post marked for the future.
4813 * The $post properties used and must exist are 'ID' and 'post_date_gmt'.
4818 * @param int $deprecated Not used. Can be set to null. Never implemented.
4819 * Not marked as deprecated with _deprecated_argument() as it conflicts with
4820 * wp_transition_post_status() and the default filter for _future_post_hook().
4821 * @param object $post Object type containing the post information
4823 function _future_post_hook( $deprecated = '', $post ) {
4824 wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) );
4825 wp_schedule_single_event( strtotime( get_gmt_from_date( $post->post_date ) . ' GMT') , 'publish_future_post', array( $post->ID ) );
4829 * Hook to schedule pings and enclosures when a post is published.
4834 * @uses XMLRPC_REQUEST constant.
4835 * @uses do_action() Calls 'xmlprc_publish_post' on post ID if XMLRPC_REQUEST is defined.
4837 * @param int $post_id The ID in the database table of the post being published
4839 function _publish_post_hook($post_id) {
4842 if ( defined('XMLRPC_REQUEST') )
4843 do_action('xmlrpc_publish_post', $post_id);
4845 if ( defined('WP_IMPORTING') )
4848 if ( get_option('default_pingback_flag') )
4849 add_post_meta( $post_id, '_pingme', '1' );
4850 add_post_meta( $post_id, '_encloseme', '1' );
4852 wp_schedule_single_event(time(), 'do_pings');
4856 * Determines which fields of posts are to be saved in revisions.
4858 * Does two things. If passed a post *array*, it will return a post array ready
4859 * to be inserted into the posts table as a post revision. Otherwise, returns
4860 * an array whose keys are the post fields to be saved for post revisions.
4862 * @package WordPress
4863 * @subpackage Post_Revisions
4866 * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields.
4868 * @param array $post Optional a post array to be processed for insertion as a post revision.
4869 * @param bool $autosave optional Is the revision an autosave?
4870 * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
4872 function _wp_post_revision_fields( $post = null, $autosave = false ) {
4873 static $fields = false;
4876 // Allow these to be versioned
4878 'post_title' => __( 'Title' ),
4879 'post_content' => __( 'Content' ),
4880 'post_excerpt' => __( 'Excerpt' ),
4884 $fields = apply_filters( '_wp_post_revision_fields', $fields );
4886 // WP uses these internally either in versioning or elsewhere - they cannot be versioned
4887 foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect )
4888 unset( $fields[$protect] );
4891 if ( !is_array($post) )
4895 foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field )
4896 $return[$field] = $post[$field];
4898 $return['post_parent'] = $post['ID'];
4899 $return['post_status'] = 'inherit';
4900 $return['post_type'] = 'revision';
4901 $return['post_name'] = $autosave ? "$post[ID]-autosave" : "$post[ID]-revision";
4902 $return['post_date'] = isset($post['post_modified']) ? $post['post_modified'] : '';
4903 $return['post_date_gmt'] = isset($post['post_modified_gmt']) ? $post['post_modified_gmt'] : '';
4909 * Saves an already existing post as a post revision.
4911 * Typically used immediately prior to post updates.
4913 * @package WordPress
4914 * @subpackage Post_Revisions
4917 * @uses _wp_put_post_revision()
4919 * @param int $post_id The ID of the post to save as a revision.
4920 * @return mixed Null or 0 if error, new revision ID, if success.
4922 function wp_save_post_revision( $post_id ) {
4923 // We do autosaves manually with wp_create_post_autosave()
4924 if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
4927 // WP_POST_REVISIONS = 0, false
4928 if ( ! WP_POST_REVISIONS )
4931 if ( !$post = get_post( $post_id, ARRAY_A ) )
4934 if ( 'auto-draft' == $post['post_status'] )
4937 if ( !post_type_supports($post['post_type'], 'revisions') )
4940 $return = _wp_put_post_revision( $post );
4942 // WP_POST_REVISIONS = true (default), -1
4943 if ( !is_numeric( WP_POST_REVISIONS ) || WP_POST_REVISIONS < 0 )
4946 // all revisions and (possibly) one autosave
4947 $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
4949 // WP_POST_REVISIONS = (int) (# of autosaves to save)
4950 $delete = count($revisions) - WP_POST_REVISIONS;
4955 $revisions = array_slice( $revisions, 0, $delete );
4957 for ( $i = 0; isset($revisions[$i]); $i++ ) {
4958 if ( false !== strpos( $revisions[$i]->post_name, 'autosave' ) )
4960 wp_delete_post_revision( $revisions[$i]->ID );
4967 * Retrieve the autosaved data of the specified post.
4969 * Returns a post object containing the information that was autosaved for the
4972 * @package WordPress
4973 * @subpackage Post_Revisions
4976 * @param int $post_id The post ID.
4977 * @return object|bool The autosaved data or false on failure or when no autosave exists.
4979 function wp_get_post_autosave( $post_id ) {
4981 if ( !$post = get_post( $post_id ) )
4985 'name' => "{$post->ID}-autosave",
4986 'post_parent' => $post->ID,
4987 'post_type' => 'revision',
4988 'post_status' => 'inherit'
4991 // Use WP_Query so that the result gets cached
4992 $autosave_query = new WP_Query;
4994 add_action( 'parse_query', '_wp_get_post_autosave_hack' );
4995 $autosave = $autosave_query->query( $q );
4996 remove_action( 'parse_query', '_wp_get_post_autosave_hack' );
4998 if ( $autosave && is_array($autosave) && is_object($autosave[0]) )
4999 return $autosave[0];
5005 * Internally used to hack WP_Query into submission.
5007 * @package WordPress
5008 * @subpackage Post_Revisions
5011 * @param object $query WP_Query object
5013 function _wp_get_post_autosave_hack( $query ) {
5014 $query->is_single = false;
5018 * Determines if the specified post is a revision.
5020 * @package WordPress
5021 * @subpackage Post_Revisions
5024 * @param int|object $post Post ID or post object.
5025 * @return bool|int False if not a revision, ID of revision's parent otherwise.
5027 function wp_is_post_revision( $post ) {
5028 if ( !$post = wp_get_post_revision( $post ) )
5030 return (int) $post->post_parent;
5034 * Determines if the specified post is an autosave.
5036 * @package WordPress
5037 * @subpackage Post_Revisions
5040 * @param int|object $post Post ID or post object.
5041 * @return bool|int False if not a revision, ID of autosave's parent otherwise
5043 function wp_is_post_autosave( $post ) {
5044 if ( !$post = wp_get_post_revision( $post ) )
5046 if ( "{$post->post_parent}-autosave" !== $post->post_name )
5048 return (int) $post->post_parent;
5052 * Inserts post data into the posts table as a post revision.
5054 * @package WordPress
5055 * @subpackage Post_Revisions
5058 * @uses wp_insert_post()
5060 * @param int|object|array $post Post ID, post object OR post array.
5061 * @param bool $autosave Optional. Is the revision an autosave?
5062 * @return mixed Null or 0 if error, new revision ID if success.
5064 function _wp_put_post_revision( $post = null, $autosave = false ) {
5065 if ( is_object($post) )
5066 $post = get_object_vars( $post );
5067 elseif ( !is_array($post) )
5068 $post = get_post($post, ARRAY_A);
5069 if ( !$post || empty($post['ID']) )
5072 if ( isset($post['post_type']) && 'revision' == $post['post_type'] )
5073 return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
5075 $post = _wp_post_revision_fields( $post, $autosave );
5076 $post = add_magic_quotes($post); //since data is from db
5078 $revision_id = wp_insert_post( $post );
5079 if ( is_wp_error($revision_id) )
5080 return $revision_id;
5083 do_action( '_wp_put_post_revision', $revision_id );
5084 return $revision_id;
5088 * Gets a post revision.
5090 * @package WordPress
5091 * @subpackage Post_Revisions
5096 * @param int|object $post Post ID or post object
5097 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
5098 * @param string $filter Optional sanitation filter. @see sanitize_post()
5099 * @return mixed Null if error or post object if success
5101 function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
5103 if ( !$revision = get_post( $post, OBJECT, $filter ) )
5105 if ( 'revision' !== $revision->post_type )
5108 if ( $output == OBJECT ) {
5110 } elseif ( $output == ARRAY_A ) {
5111 $_revision = get_object_vars($revision);
5113 } elseif ( $output == ARRAY_N ) {
5114 $_revision = array_values(get_object_vars($revision));
5122 * Restores a post to the specified revision.
5124 * Can restore a past revision using all fields of the post revision, or only selected fields.
5126 * @package WordPress
5127 * @subpackage Post_Revisions
5130 * @uses wp_get_post_revision()
5131 * @uses wp_update_post()
5132 * @uses do_action() Calls 'wp_restore_post_revision' on post ID and revision ID if wp_update_post()
5135 * @param int|object $revision_id Revision ID or revision object.
5136 * @param array $fields Optional. What fields to restore from. Defaults to all.
5137 * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
5139 function wp_restore_post_revision( $revision_id, $fields = null ) {
5140 if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) )
5143 if ( !is_array( $fields ) )
5144 $fields = array_keys( _wp_post_revision_fields() );
5147 foreach( array_intersect( array_keys( $revision ), $fields ) as $field )
5148 $update[$field] = $revision[$field];
5153 $update['ID'] = $revision['post_parent'];
5155 $update = add_magic_quotes( $update ); //since data is from db
5157 $post_id = wp_update_post( $update );
5158 if ( is_wp_error( $post_id ) )
5162 do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
5168 * Deletes a revision.
5170 * Deletes the row from the posts table corresponding to the specified revision.
5172 * @package WordPress
5173 * @subpackage Post_Revisions
5176 * @uses wp_get_post_revision()
5177 * @uses wp_delete_post()
5179 * @param int|object $revision_id Revision ID or revision object.
5180 * @return mixed Null or WP_Error if error, deleted post if success.
5182 function wp_delete_post_revision( $revision_id ) {
5183 if ( !$revision = wp_get_post_revision( $revision_id ) )
5186 $delete = wp_delete_post( $revision->ID );
5187 if ( is_wp_error( $delete ) )
5191 do_action( 'wp_delete_post_revision', $revision->ID, $revision );
5197 * Returns all revisions of specified post.
5199 * @package WordPress
5200 * @subpackage Post_Revisions
5203 * @uses get_children()
5205 * @param int|object $post_id Post ID or post object
5206 * @return array empty if no revisions
5208 function wp_get_post_revisions( $post_id = 0, $args = null ) {
5209 if ( ! WP_POST_REVISIONS )
5211 if ( ( !$post = get_post( $post_id ) ) || empty( $post->ID ) )
5214 $defaults = array( 'order' => 'DESC', 'orderby' => 'date' );
5215 $args = wp_parse_args( $args, $defaults );
5216 $args = array_merge( $args, array( 'post_parent' => $post->ID, 'post_type' => 'revision', 'post_status' => 'inherit' ) );
5218 if ( !$revisions = get_children( $args ) )
5223 function _set_preview($post) {
5225 if ( ! is_object($post) )
5228 $preview = wp_get_post_autosave($post->ID);
5230 if ( ! is_object($preview) )
5233 $preview = sanitize_post($preview);
5235 $post->post_content = $preview->post_content;
5236 $post->post_title = $preview->post_title;
5237 $post->post_excerpt = $preview->post_excerpt;
5242 function _show_post_preview() {
5244 if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) {
5245 $id = (int) $_GET['preview_id'];
5247 if ( false == wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) )
5248 wp_die( __('You do not have permission to preview drafts.') );
5250 add_filter('the_preview', '_set_preview');
5255 * Returns the post's parent's post_ID
5259 * @param int $post_id
5261 * @return int|bool false on error
5263 function wp_get_post_parent_id( $post_ID ) {
5264 $post = get_post( $post_ID );
5265 if ( !$post || is_wp_error( $post ) )
5267 return (int) $post->post_parent;
5271 * Checks the given subset of the post hierarchy for hierarchy loops.
5272 * Prevents loops from forming and breaks those that it finds.
5274 * Attached to the wp_insert_post_parent filter.
5277 * @uses wp_find_hierarchy_loop()
5279 * @param int $post_parent ID of the parent for the post we're checking.
5280 * @param int $post_ID ID of the post we're checking.
5282 * @return int The new post_parent for the post.
5284 function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) {
5285 // Nothing fancy here - bail
5286 if ( !$post_parent )
5289 // New post can't cause a loop
5290 if ( empty( $post_ID ) )
5291 return $post_parent;
5293 // Can't be its own parent
5294 if ( $post_parent == $post_ID )
5297 // Now look for larger loops
5299 if ( !$loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent ) )
5300 return $post_parent; // No loop
5302 // Setting $post_parent to the given value causes a loop
5303 if ( isset( $loop[$post_ID] ) )
5306 // There's a loop, but it doesn't contain $post_ID. Break the loop.
5307 foreach ( array_keys( $loop ) as $loop_member )
5308 wp_update_post( array( 'ID' => $loop_member, 'post_parent' => 0 ) );
5310 return $post_parent;
5314 * Returns an array of post format slugs to their translated and pretty display versions
5318 * @return array The array of translations
5320 function get_post_format_strings() {
5322 'standard' => _x( 'Standard', 'Post format' ), // Special case. any value that evals to false will be considered standard
5323 'aside' => _x( 'Aside', 'Post format' ),
5324 'chat' => _x( 'Chat', 'Post format' ),
5325 'gallery' => _x( 'Gallery', 'Post format' ),
5326 'link' => _x( 'Link', 'Post format' ),
5327 'image' => _x( 'Image', 'Post format' ),
5328 'quote' => _x( 'Quote', 'Post format' ),
5329 'status' => _x( 'Status', 'Post format' ),
5330 'video' => _x( 'Video', 'Post format' ),
5331 'audio' => _x( 'Audio', 'Post format' ),
5337 * Retrieves an array of post format slugs.
5341 * @return array The array of post format slugs.
5343 function get_post_format_slugs() {
5344 $slugs = array_keys( get_post_format_strings() );
5345 return array_combine( $slugs, $slugs );
5349 * Returns a pretty, translated version of a post format slug
5353 * @param string $slug A post format slug
5354 * @return string The translated post format name
5356 function get_post_format_string( $slug ) {
5357 $strings = get_post_format_strings();
5359 return $strings['standard'];
5361 return ( isset( $strings[$slug] ) ) ? $strings[$slug] : '';
5365 * Sets a post thumbnail.
5369 * @param int|object $post Post ID or object where thumbnail should be attached.
5370 * @param int $thumbnail_id Thumbnail to attach.
5371 * @return bool True on success, false on failure.
5373 function set_post_thumbnail( $post, $thumbnail_id ) {
5374 $post = get_post( $post );
5375 $thumbnail_id = absint( $thumbnail_id );
5376 if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) {
5377 if ( $thumbnail_html = wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) )
5378 return update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id );
5380 return delete_post_meta( $post->ID, '_thumbnail_id' );
5386 * Removes a post thumbnail.
5390 * @param int|object $post Post ID or object where thumbnail should be removed from.
5391 * @return bool True on success, false on failure.
5393 function delete_post_thumbnail( $post ) {
5394 $post = get_post( $post );
5396 return delete_post_meta( $post->ID, '_thumbnail_id' );
5401 * Returns a link to a post format index.
5405 * @param string $format Post format
5406 * @return string Link
5408 function get_post_format_link( $format ) {
5409 $term = get_term_by('slug', 'post-format-' . $format, 'post_format' );
5410 if ( ! $term || is_wp_error( $term ) )
5412 return get_term_link( $term );
5416 * Deletes auto-drafts for new posts that are > 7 days old
5420 function wp_delete_auto_drafts() {
5423 // Cleanup old auto-drafts more than 7 days old
5424 $old_posts = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_status = 'auto-draft' AND DATE_SUB( NOW(), INTERVAL 7 DAY ) > post_date" );
5425 foreach ( (array) $old_posts as $delete )
5426 wp_delete_post( $delete, true ); // Force delete
5430 * Filters the request to allow for the format prefix.
5435 function _post_format_request( $qvs ) {
5436 if ( ! isset( $qvs['post_format'] ) )
5438 $slugs = get_post_format_slugs();
5439 if ( isset( $slugs[ $qvs['post_format'] ] ) )
5440 $qvs['post_format'] = 'post-format-' . $slugs[ $qvs['post_format'] ];
5441 $tax = get_taxonomy( 'post_format' );
5443 $qvs['post_type'] = $tax->object_type;
5446 add_filter( 'request', '_post_format_request' );
5449 * Filters the post format term link to remove the format prefix.
5454 function _post_format_link( $link, $term, $taxonomy ) {
5456 if ( 'post_format' != $taxonomy )
5458 if ( $wp_rewrite->get_extra_permastruct( $taxonomy ) ) {
5459 return str_replace( "/{$term->slug}", '/' . str_replace( 'post-format-', '', $term->slug ), $link );
5461 $link = remove_query_arg( 'post_format', $link );
5462 return add_query_arg( 'post_format', str_replace( 'post-format-', '', $term->slug ), $link );
5465 add_filter( 'term_link', '_post_format_link', 10, 3 );
5468 * Remove the post format prefix from the name property of the term object created by get_term().
5473 function _post_format_get_term( $term ) {
5474 if ( isset( $term->slug ) ) {
5475 $term->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
5479 add_filter( 'get_post_format', '_post_format_get_term' );
5482 * Remove the post format prefix from the name property of the term objects created by get_terms().
5487 function _post_format_get_terms( $terms, $taxonomies, $args ) {
5488 if ( in_array( 'post_format', (array) $taxonomies ) ) {
5489 if ( isset( $args['fields'] ) && 'names' == $args['fields'] ) {
5490 foreach( $terms as $order => $name ) {
5491 $terms[$order] = get_post_format_string( str_replace( 'post-format-', '', $name ) );
5494 foreach ( (array) $terms as $order => $term ) {
5495 if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) {
5496 $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
5503 add_filter( 'get_terms', '_post_format_get_terms', 10, 3 );
5506 * Remove the post format prefix from the name property of the term objects created by wp_get_object_terms().
5511 function _post_format_wp_get_object_terms( $terms ) {
5512 foreach ( (array) $terms as $order => $term ) {
5513 if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) {
5514 $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
5519 add_filter( 'wp_get_object_terms', '_post_format_wp_get_object_terms' );
5522 * Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts.
5525 * @param string $new_status
5526 * @param string $old_status
5527 * @param object $post
5530 function _update_term_count_on_transition_post_status( $new_status, $old_status, $post ) {
5531 // Update counts for the post's terms.
5532 foreach ( (array) get_object_taxonomies( $post->post_type ) as $taxonomy ) {
5533 $tt_ids = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'tt_ids' ) );
5534 wp_update_term_count( $tt_ids, $taxonomy );
5539 * Adds any posts from the given ids to the cache that do not already exist in cache
5545 * @param array $post_ids ID list
5546 * @param bool $update_term_cache Whether to update the term cache. Default is true.
5547 * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
5549 function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) {
5552 $non_cached_ids = _get_non_cached_ids( $ids, 'posts' );
5553 if ( !empty( $non_cached_ids ) ) {
5554 $fresh_posts = $wpdb->get_results( sprintf( "SELECT $wpdb->posts.* FROM $wpdb->posts WHERE ID IN (%s)", join( ",", $non_cached_ids ) ) );
5556 update_post_caches( $fresh_posts, 'any', $update_term_cache, $update_meta_cache );