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 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
23 '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
24 'capability_type' => 'post',
25 'map_meta_cap' => true,
26 'hierarchical' => false,
29 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ),
32 register_post_type( 'page', array(
34 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
35 '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
36 'capability_type' => 'page',
37 'map_meta_cap' => true,
38 'hierarchical' => true,
41 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ),
44 register_post_type( 'attachment', array(
46 'name' => __( 'Media' ),
50 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
51 '_edit_link' => 'media.php?attachment_id=%d', /* internal use only. don't use this when registering your own post type. */
52 'capability_type' => 'post',
53 'map_meta_cap' => true,
54 'hierarchical' => false,
57 'show_in_nav_menus' => false,
60 register_post_type( 'revision', array(
62 'name' => __( 'Revisions' ),
63 'singular_name' => __( 'Revision' ),
66 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
67 '_edit_link' => 'revision.php?revision=%d', /* internal use only. don't use this when registering your own post type. */
68 'capability_type' => 'post',
69 'map_meta_cap' => true,
70 'hierarchical' => false,
73 'can_export' => false,
76 register_post_type( 'nav_menu_item', array(
78 'name' => __( 'Navigation Menu Items' ),
79 'singular_name' => __( 'Navigation Menu Item' ),
82 '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
83 'hierarchical' => false,
88 register_post_status( 'publish', array(
89 'label' => _x( 'Published', 'post' ),
91 '_builtin' => true, /* internal use only. */
92 'label_count' => _n_noop( 'Published <span class="count">(%s)</span>', 'Published <span class="count">(%s)</span>' ),
95 register_post_status( 'future', array(
96 'label' => _x( 'Scheduled', 'post' ),
98 '_builtin' => true, /* internal use only. */
99 'label_count' => _n_noop('Scheduled <span class="count">(%s)</span>', 'Scheduled <span class="count">(%s)</span>' ),
102 register_post_status( 'draft', array(
103 'label' => _x( 'Draft', 'post' ),
105 '_builtin' => true, /* internal use only. */
106 'label_count' => _n_noop( 'Draft <span class="count">(%s)</span>', 'Drafts <span class="count">(%s)</span>' ),
109 register_post_status( 'pending', array(
110 'label' => _x( 'Pending', 'post' ),
112 '_builtin' => true, /* internal use only. */
113 'label_count' => _n_noop( 'Pending <span class="count">(%s)</span>', 'Pending <span class="count">(%s)</span>' ),
116 register_post_status( 'private', array(
117 'label' => _x( 'Private', 'post' ),
119 '_builtin' => true, /* internal use only. */
120 'label_count' => _n_noop( 'Private <span class="count">(%s)</span>', 'Private <span class="count">(%s)</span>' ),
123 register_post_status( 'trash', array(
124 'label' => _x( 'Trash', 'post' ),
126 '_builtin' => true, /* internal use only. */
127 'label_count' => _n_noop( 'Trash <span class="count">(%s)</span>', 'Trash <span class="count">(%s)</span>' ),
128 'show_in_admin_status_list' => true,
131 register_post_status( 'auto-draft', array(
132 'label' => 'auto-draft',
134 '_builtin' => true, /* internal use only. */
137 register_post_status( 'inherit', array(
138 'label' => 'inherit',
140 '_builtin' => true, /* internal use only. */
141 'exclude_from_search' => false,
144 add_action( 'init', 'create_initial_post_types', 0 ); // highest priority
147 * Retrieve attached file path based on attachment ID.
149 * You can optionally send it through the 'get_attached_file' filter, but by
150 * default it will just return the file path unfiltered.
152 * The function works by getting the single post meta name, named
153 * '_wp_attached_file' and returning it. This is a convenience function to
154 * prevent looking up the meta name and provide a mechanism for sending the
155 * attached filename through a filter.
158 * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID.
160 * @param int $attachment_id Attachment ID.
161 * @param bool $unfiltered Whether to apply filters.
162 * @return string The file path to the attached file.
164 function get_attached_file( $attachment_id, $unfiltered = false ) {
165 $file = get_post_meta( $attachment_id, '_wp_attached_file', true );
166 // If the file is relative, prepend upload dir
167 if ( 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) )
168 $file = $uploads['basedir'] . "/$file";
171 return apply_filters( 'get_attached_file', $file, $attachment_id );
175 * Update attachment file path based on attachment ID.
177 * Used to update the file path of the attachment, which uses post meta name
178 * '_wp_attached_file' to store the path of the attachment.
181 * @uses apply_filters() Calls 'update_attached_file' on file path and attachment ID.
183 * @param int $attachment_id Attachment ID
184 * @param string $file File path for the attachment
185 * @return bool False on failure, true on success.
187 function update_attached_file( $attachment_id, $file ) {
188 if ( !get_post( $attachment_id ) )
191 $file = apply_filters( 'update_attached_file', $file, $attachment_id );
192 $file = _wp_relative_upload_path($file);
194 return update_post_meta( $attachment_id, '_wp_attached_file', $file );
198 * Return relative path to an uploaded file.
200 * The path is relative to the current upload dir.
203 * @uses apply_filters() Calls '_wp_relative_upload_path' on file path.
205 * @param string $path Full path to the file
206 * @return string relative path on success, unchanged path on failure.
208 function _wp_relative_upload_path( $path ) {
211 if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) {
212 if ( 0 === strpos($new_path, $uploads['basedir']) ) {
213 $new_path = str_replace($uploads['basedir'], '', $new_path);
214 $new_path = ltrim($new_path, '/');
218 return apply_filters( '_wp_relative_upload_path', $new_path, $path );
222 * Retrieve all children of the post parent ID.
224 * Normally, without any enhancements, the children would apply to pages. In the
225 * context of the inner workings of WordPress, pages, posts, and attachments
226 * share the same table, so therefore the functionality could apply to any one
227 * of them. It is then noted that while this function does not work on posts, it
228 * does not mean that it won't work on posts. It is recommended that you know
229 * what context you wish to retrieve the children of.
231 * Attachments may also be made the child of a post, so if that is an accurate
232 * statement (which needs to be verified), it would then be possible to get
233 * all of the attachments for a post. Attachments have since changed since
234 * version 2.5, so this is most likely unaccurate, but serves generally as an
235 * example of what is possible.
237 * The arguments listed as defaults are for this function and also of the
238 * {@link get_posts()} function. The arguments are combined with the
239 * get_children defaults and are then passed to the {@link get_posts()}
240 * function, which accepts additional arguments. You can replace the defaults in
241 * this function, listed below and the additional arguments listed in the
242 * {@link get_posts()} function.
244 * The 'post_parent' is the most important argument and important attention
245 * needs to be paid to the $args parameter. If you pass either an object or an
246 * integer (number), then just the 'post_parent' is grabbed and everything else
247 * is lost. If you don't specify any arguments, then it is assumed that you are
248 * in The Loop and the post parent will be grabbed for from the current post.
250 * The 'post_parent' argument is the ID to get the children. The 'numberposts'
251 * is the amount of posts to retrieve that has a default of '-1', which is
252 * used to get all of the posts. Giving a number higher than 0 will only
253 * retrieve that amount of posts.
255 * The 'post_type' and 'post_status' arguments can be used to choose what
256 * criteria of posts to retrieve. The 'post_type' can be anything, but WordPress
257 * post types are 'post', 'pages', and 'attachments'. The 'post_status'
258 * argument will accept any post status within the write administration panels.
260 * @see get_posts() Has additional arguments that can be replaced.
261 * @internal Claims made in the long description might be inaccurate.
265 * @param mixed $args Optional. User defined arguments for replacing the defaults.
266 * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N.
267 * @return array|bool False on failure and the type will be determined by $output parameter.
269 function get_children($args = '', $output = OBJECT) {
271 if ( empty( $args ) ) {
272 if ( isset( $GLOBALS['post'] ) ) {
273 $args = array('post_parent' => (int) $GLOBALS['post']->post_parent );
277 } elseif ( is_object( $args ) ) {
278 $args = array('post_parent' => (int) $args->post_parent );
279 } elseif ( is_numeric( $args ) ) {
280 $args = array('post_parent' => (int) $args);
284 'numberposts' => -1, 'post_type' => 'any',
285 'post_status' => 'any', 'post_parent' => 0,
288 $r = wp_parse_args( $args, $defaults );
290 $children = get_posts( $r );
295 update_post_cache($children);
297 foreach ( $children as $key => $child )
298 $kids[$child->ID] = $children[$key];
300 if ( $output == OBJECT ) {
302 } elseif ( $output == ARRAY_A ) {
303 foreach ( (array) $kids as $kid )
304 $weeuns[$kid->ID] = get_object_vars($kids[$kid->ID]);
306 } elseif ( $output == ARRAY_N ) {
307 foreach ( (array) $kids as $kid )
308 $babes[$kid->ID] = array_values(get_object_vars($kids[$kid->ID]));
316 * Get extended entry info (<!--more-->).
318 * There should not be any space after the second dash and before the word
319 * 'more'. There can be text or space(s) after the word 'more', but won't be
322 * The returned array has 'main' and 'extended' keys. Main has the text before
323 * the <code><!--more--></code>. The 'extended' key has the content after the
324 * <code><!--more--></code> comment.
328 * @param string $post Post content.
329 * @return array Post before ('main') and after ('extended').
331 function get_extended($post) {
332 //Match the new style more links
333 if ( preg_match('/<!--more(.*?)?-->/', $post, $matches) ) {
334 list($main, $extended) = explode($matches[0], $post, 2);
340 // Strip leading and trailing whitespace
341 $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main);
342 $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended);
344 return array('main' => $main, 'extended' => $extended);
348 * Retrieves post data given a post ID or post object.
350 * See {@link sanitize_post()} for optional $filter values. Also, the parameter
351 * $post, must be given as a variable, since it is passed by reference.
355 * @link http://codex.wordpress.org/Function_Reference/get_post
357 * @param int|object $post Post ID or post object.
358 * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N.
359 * @param string $filter Optional, default is raw.
360 * @return mixed Post data
362 function &get_post(&$post, $output = OBJECT, $filter = 'raw') {
366 if ( empty($post) ) {
367 if ( isset($GLOBALS['post']) )
368 $_post = & $GLOBALS['post'];
371 } elseif ( is_object($post) && empty($post->filter) ) {
372 _get_post_ancestors($post);
373 $_post = sanitize_post($post, 'raw');
374 wp_cache_add($post->ID, $_post, 'posts');
376 if ( is_object($post) )
377 $post_id = $post->ID;
381 $post_id = (int) $post_id;
382 if ( ! $_post = wp_cache_get($post_id, 'posts') ) {
383 $_post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id));
386 _get_post_ancestors($_post);
387 $_post = sanitize_post($_post, 'raw');
388 wp_cache_add($_post->ID, $_post, 'posts');
392 if ($filter != 'raw')
393 $_post = sanitize_post($_post, $filter);
395 if ( $output == OBJECT ) {
397 } elseif ( $output == ARRAY_A ) {
398 $__post = get_object_vars($_post);
400 } elseif ( $output == ARRAY_N ) {
401 $__post = array_values(get_object_vars($_post));
409 * Retrieve ancestors of a post.
413 * @param int|object $post Post ID or post object
414 * @return array Ancestor IDs or empty array if none are found.
416 function get_post_ancestors($post) {
417 $post = get_post($post);
419 if ( !empty($post->ancestors) )
420 return $post->ancestors;
426 * Retrieve data from a post field based on Post ID.
428 * Examples of the post field will be, 'post_type', 'post_status', 'content',
429 * etc and based off of the post object property or key names.
431 * The context values are based off of the taxonomy filter functions and
432 * supported values are found within those functions.
435 * @uses sanitize_post_field() See for possible $context values.
437 * @param string $field Post field name
438 * @param id $post Post ID
439 * @param string $context Optional. How to filter the field. Default is display.
440 * @return WP_Error|string Value in post field or WP_Error on failure
442 function get_post_field( $field, $post, $context = 'display' ) {
444 $post = get_post( $post );
446 if ( is_wp_error($post) )
449 if ( !is_object($post) )
452 if ( !isset($post->$field) )
455 return sanitize_post_field($field, $post->$field, $post->ID, $context);
459 * Retrieve the mime type of an attachment based on the ID.
461 * This function can be used with any post type, but it makes more sense with
466 * @param int $ID Optional. Post ID.
467 * @return bool|string False on failure or returns the mime type
469 function get_post_mime_type($ID = '') {
470 $post = & get_post($ID);
472 if ( is_object($post) )
473 return $post->post_mime_type;
479 * Retrieve the format slug for a post
483 * @param int|object $post A post
485 * @return mixed The format if successful. False if no format is set. WP_Error if errors.
487 function get_post_format( $post = null ) {
488 $post = get_post($post);
490 if ( ! post_type_supports( $post->post_type, 'post-formats' ) )
493 $_format = get_the_terms( $post->ID, 'post_format' );
495 if ( empty( $_format ) )
498 $format = array_shift( $_format );
500 return ( str_replace('post-format-', '', $format->slug ) );
504 * Check if a post has a particular format
509 * @param string $format The format to check for
510 * @param object|id $post The post to check. If not supplied, defaults to the current post if used in the loop.
511 * @return bool True if the post has the format, false otherwise.
513 function has_post_format( $format, $post = null ) {
514 return has_term('post-format-' . sanitize_key($format), 'post_format', $post);
518 * Assign a format to a post
522 * @param int|object $post The post for which to assign a format
523 * @param string $format A format to assign. Use an empty string or array to remove all formats from the post.
524 * @return mixed WP_Error on error. Array of affected term IDs on success.
526 function set_post_format( $post, $format ) {
527 $post = get_post($post);
530 return new WP_Error('invalid_post', __('Invalid post'));
532 if ( !empty($format) ) {
533 $format = sanitize_key($format);
534 if ( 'standard' == $format || !in_array( $format, array_keys( get_post_format_slugs() ) ) )
537 $format = 'post-format-' . $format;
540 return wp_set_post_terms($post->ID, $format, 'post_format');
544 * Retrieve the post status based on the Post ID.
546 * If the post ID is of an attachment, then the parent post status will be given
551 * @param int $ID Post ID
552 * @return string|bool Post status or false on failure.
554 function get_post_status($ID = '') {
555 $post = get_post($ID);
557 if ( !is_object($post) )
560 // Unattached attachments are assumed to be published.
561 if ( ('attachment' == $post->post_type) && ('inherit' == $post->post_status) && ( 0 == $post->post_parent) )
564 if ( ('attachment' == $post->post_type) && $post->post_parent && ($post->ID != $post->post_parent) )
565 return get_post_status($post->post_parent);
567 return $post->post_status;
571 * Retrieve all of the WordPress supported post statuses.
573 * Posts have a limited set of valid status values, this provides the
574 * post_status values and descriptions.
578 * @return array List of post statuses.
580 function get_post_statuses( ) {
582 'draft' => __('Draft'),
583 'pending' => __('Pending Review'),
584 'private' => __('Private'),
585 'publish' => __('Published')
592 * Retrieve all of the WordPress support page statuses.
594 * Pages have a limited set of valid status values, this provides the
595 * post_status values and descriptions.
599 * @return array List of page statuses.
601 function get_page_statuses( ) {
603 'draft' => __('Draft'),
604 'private' => __('Private'),
605 'publish' => __('Published')
612 * Register a post type. Do not use before init.
614 * A simple function for creating or modifying a post status based on the
615 * parameters given. The function will accept an array (second optional
616 * parameter), along with a string for the post status name.
619 * Optional $args contents:
621 * label - A descriptive name for the post status marked for translation. Defaults to $post_status.
622 * public - Whether posts of this status should be shown in the front end of the site. Defaults to true.
623 * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to true.
624 * show_in_admin_all_list - Whether to include posts in the edit listing for their post type
625 * show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit
626 * listings, e.g. All (12) | Published (9) | My Custom Status (2) ...
628 * Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
633 * @uses $wp_post_statuses Inserts new post status object into the list
635 * @param string $post_status Name of the post status.
636 * @param array|string $args See above description.
638 function register_post_status($post_status, $args = array()) {
639 global $wp_post_statuses;
641 if (!is_array($wp_post_statuses))
642 $wp_post_statuses = array();
644 // Args prefixed with an underscore are reserved for internal use.
645 $defaults = array('label' => false, 'label_count' => false, 'exclude_from_search' => null, '_builtin' => false, '_edit_link' => 'post.php?post=%d', 'capability_type' => 'post', 'hierarchical' => false, 'public' => null, 'internal' => null, 'protected' => null, 'private' => null, 'show_in_admin_all' => null, 'publicly_queryable' => null, 'show_in_admin_status_list' => null, 'show_in_admin_all_list' => null, 'single_view_cap' => null);
646 $args = wp_parse_args($args, $defaults);
647 $args = (object) $args;
649 $post_status = sanitize_key($post_status);
650 $args->name = $post_status;
652 if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private )
653 $args->internal = true;
655 if ( null === $args->public )
656 $args->public = false;
658 if ( null === $args->private )
659 $args->private = false;
661 if ( null === $args->protected )
662 $args->protected = false;
664 if ( null === $args->internal )
665 $args->internal = false;
667 if ( null === $args->publicly_queryable )
668 $args->publicly_queryable = $args->public;
670 if ( null === $args->exclude_from_search )
671 $args->exclude_from_search = $args->internal;
673 if ( null === $args->show_in_admin_all_list )
674 $args->show_in_admin_all_list = !$args->internal;
676 if ( null === $args->show_in_admin_status_list )
677 $args->show_in_admin_status_list = !$args->internal;
679 if ( null === $args->single_view_cap )
680 $args->single_view_cap = $args->public ? '' : 'edit';
682 if ( false === $args->label )
683 $args->label = $post_status;
685 if ( false === $args->label_count )
686 $args->label_count = array( $args->label, $args->label );
688 $wp_post_statuses[$post_status] = $args;
694 * Retrieve a post status object by name
699 * @uses $wp_post_statuses
700 * @see register_post_status
701 * @see get_post_statuses
703 * @param string $post_status The name of a registered post status
704 * @return object A post status object
706 function get_post_status_object( $post_status ) {
707 global $wp_post_statuses;
709 if ( empty($wp_post_statuses[$post_status]) )
712 return $wp_post_statuses[$post_status];
716 * Get a list of all registered post status objects.
721 * @uses $wp_post_statuses
722 * @see register_post_status
723 * @see get_post_status_object
725 * @param array|string $args An array of key => value arguments to match against the post status objects.
726 * @param string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default.
727 * @param string $operator The logical operation to perform. 'or' means only one element
728 * from the array needs to match; 'and' means all elements must match. The default is 'and'.
729 * @return array A list of post type names or objects
731 function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {
732 global $wp_post_statuses;
734 $field = ('names' == $output) ? 'name' : false;
736 return wp_filter_object_list($wp_post_statuses, $args, $operator, $field);
740 * Whether the post type is hierarchical.
742 * A false return value might also mean that the post type does not exist.
745 * @see get_post_type_object
747 * @param string $post_type Post type name
748 * @return bool Whether post type is hierarchical.
750 function is_post_type_hierarchical( $post_type ) {
751 if ( ! post_type_exists( $post_type ) )
754 $post_type = get_post_type_object( $post_type );
755 return $post_type->hierarchical;
759 * Checks if a post type is registered.
762 * @uses get_post_type_object()
764 * @param string $post_type Post type name
765 * @return bool Whether post type is registered.
767 function post_type_exists( $post_type ) {
768 return (bool) get_post_type_object( $post_type );
772 * Retrieve the post type of the current post or of a given post.
776 * @uses $post The Loop current post global
778 * @param mixed $the_post Optional. Post object or post ID.
779 * @return bool|string post type or false on failure.
781 function get_post_type( $the_post = false ) {
784 if ( false === $the_post )
786 elseif ( is_numeric($the_post) )
787 $the_post = get_post($the_post);
789 if ( is_object($the_post) )
790 return $the_post->post_type;
796 * Retrieve a post type object by name
801 * @uses $wp_post_types
802 * @see register_post_type
803 * @see get_post_types
805 * @param string $post_type The name of a registered post type
806 * @return object A post type object
808 function get_post_type_object( $post_type ) {
809 global $wp_post_types;
811 if ( empty($wp_post_types[$post_type]) )
814 return $wp_post_types[$post_type];
818 * Get a list of all registered post type objects.
823 * @uses $wp_post_types
824 * @see register_post_type
826 * @param array|string $args An array of key => value arguments to match against the post type objects.
827 * @param string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default.
828 * @param string $operator The logical operation to perform. 'or' means only one element
829 * from the array needs to match; 'and' means all elements must match. The default is 'and'.
830 * @return array A list of post type names or objects
832 function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) {
833 global $wp_post_types;
835 $field = ('names' == $output) ? 'name' : false;
837 return wp_filter_object_list($wp_post_types, $args, $operator, $field);
841 * Register a post type. Do not use before init.
843 * A function for creating or modifying a post type based on the
844 * parameters given. The function will accept an array (second optional
845 * parameter), along with a string for the post type name.
847 * Optional $args contents:
849 * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used.
850 * - description - A short descriptive summary of what the post type is. Defaults to blank.
851 * - public - Whether posts of this type should be shown in the admin UI. Defaults to false.
852 * - exclude_from_search - Whether to exclude posts with this post type from search results.
853 * Defaults to true if the type is not public, false if the type is public.
854 * - publicly_queryable - Whether post_type queries can be performed from the front page.
855 * Defaults to whatever public is set as.
856 * - show_ui - Whether to generate a default UI for managing this post type. Defaults to true
857 * if the type is public, false if the type is not public.
858 * - show_in_menu - Where to show the post type in the admin menu. True for a top level menu,
859 * false for no menu, or can be a top level page like 'tools.php' or 'edit.php?post_type=page'.
860 * show_ui must be true.
861 * - menu_position - The position in the menu order the post type should appear. Defaults to the bottom.
862 * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon.
863 * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'.
864 * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the
865 * capabilities, e.g. array('story', 'stories').
866 * - capabilities - Array of capabilities for this post type. By default the capability_type is used
867 * as a base to construct capabilities. You can see accepted values in {@link get_post_type_capabilities()}.
868 * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false.
869 * - hierarchical - Whether the post type is hierarchical. Defaults to false.
870 * - supports - An alias for calling add_post_type_support() directly. See {@link add_post_type_support()}
871 * for documentation. Defaults to none.
872 * - register_meta_box_cb - Provide a callback function that will be called when setting up the
873 * meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback.
874 * - taxonomies - An array of taxonomy identifiers that will be registered for the post type.
875 * Default is no taxonomies. Taxonomies can be registered later with register_taxonomy() or
876 * register_taxonomy_for_object_type().
877 * - labels - An array of labels for this post type. By default post labels are used for non-hierarchical
878 * types and page labels for hierarchical ones. You can see accepted values in {@link get_post_type_labels()}.
879 * - permalink_epmask - The default rewrite endpoint bitmasks.
880 * - has_archive - True to enable post type archives. Will generate the proper rewrite rules if rewrite is enabled.
881 * - rewrite - false to prevent rewrite. Defaults to true. Use array('slug'=>$slug) to customize permastruct;
882 * default will use $post_type as slug. Other options include 'with_front', 'feeds', and 'pages'.
883 * - query_var - false to prevent queries, or string to value of the query var to use for this post type
884 * - can_export - true allows this post type to be exported.
885 * - show_in_nav_menus - true makes this post type available for selection in navigation menus.
886 * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY!
887 * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY!
890 * @uses $wp_post_types Inserts new post type object into the list
892 * @param string $post_type Name of the post type.
893 * @param array|string $args See above description.
894 * @return object|WP_Error the registered post type object, or an error object
896 function register_post_type($post_type, $args = array()) {
897 global $wp_post_types, $wp_rewrite, $wp;
899 if ( !is_array($wp_post_types) )
900 $wp_post_types = array();
902 // Args prefixed with an underscore are reserved for internal use.
904 'labels' => array(), 'description' => '', 'publicly_queryable' => null, 'exclude_from_search' => null,
905 'capability_type' => 'post', 'capabilities' => array(), 'map_meta_cap' => null,
906 '_builtin' => false, '_edit_link' => 'post.php?post=%d', 'hierarchical' => false,
907 'public' => false, 'rewrite' => true, 'has_archive' => false, 'query_var' => true,
908 'supports' => array(), 'register_meta_box_cb' => null,
909 'taxonomies' => array(), 'show_ui' => null, 'menu_position' => null, 'menu_icon' => null,
910 'permalink_epmask' => EP_PERMALINK, 'can_export' => true, 'show_in_nav_menus' => null, 'show_in_menu' => null,
912 $args = wp_parse_args($args, $defaults);
913 $args = (object) $args;
915 $post_type = sanitize_key($post_type);
916 $args->name = $post_type;
918 if ( strlen( $post_type ) > 20 )
919 return new WP_Error( 'post_type_too_long', __( 'Post types cannot exceed 20 characters in length' ) );
921 // If not set, default to the setting for public.
922 if ( null === $args->publicly_queryable )
923 $args->publicly_queryable = $args->public;
925 // If not set, default to the setting for public.
926 if ( null === $args->show_ui )
927 $args->show_ui = $args->public;
929 // If not set, default to the setting for show_ui.
930 if ( null === $args->show_in_menu || ! $args->show_ui )
931 $args->show_in_menu = $args->show_ui;
933 // Whether to show this type in nav-menus.php. Defaults to the setting for public.
934 if ( null === $args->show_in_nav_menus )
935 $args->show_in_nav_menus = $args->public;
937 // If not set, default to true if not public, false if public.
938 if ( null === $args->exclude_from_search )
939 $args->exclude_from_search = !$args->public;
941 // Back compat with quirky handling in version 3.0. #14122
942 if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
943 $args->map_meta_cap = true;
945 if ( null === $args->map_meta_cap )
946 $args->map_meta_cap = false;
948 $args->cap = get_post_type_capabilities( $args );
949 unset($args->capabilities);
951 if ( is_array( $args->capability_type ) )
952 $args->capability_type = $args->capability_type[0];
954 if ( ! empty($args->supports) ) {
955 add_post_type_support($post_type, $args->supports);
956 unset($args->supports);
958 // Add default features
959 add_post_type_support($post_type, array('title', 'editor'));
962 if ( false !== $args->query_var && !empty($wp) ) {
963 if ( true === $args->query_var )
964 $args->query_var = $post_type;
965 $args->query_var = sanitize_title_with_dashes($args->query_var);
966 $wp->add_query_var($args->query_var);
969 if ( false !== $args->rewrite && '' != get_option('permalink_structure') ) {
970 if ( ! is_array( $args->rewrite ) )
971 $args->rewrite = array();
972 if ( empty( $args->rewrite['slug'] ) )
973 $args->rewrite['slug'] = $post_type;
974 if ( ! isset( $args->rewrite['with_front'] ) )
975 $args->rewrite['with_front'] = true;
976 if ( ! isset( $args->rewrite['pages'] ) )
977 $args->rewrite['pages'] = true;
978 if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive )
979 $args->rewrite['feeds'] = (bool) $args->has_archive;
981 if ( $args->hierarchical )
982 $wp_rewrite->add_rewrite_tag("%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=");
984 $wp_rewrite->add_rewrite_tag("%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=");
986 if ( $args->has_archive ) {
987 $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive;
988 $wp_rewrite->add_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' );
989 if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) {
990 $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';
991 $wp_rewrite->add_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
992 $wp_rewrite->add_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
994 if ( $args->rewrite['pages'] )
995 $wp_rewrite->add_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' );
998 $wp_rewrite->add_permastruct($post_type, "{$args->rewrite['slug']}/%$post_type%", $args->rewrite['with_front'], $args->permalink_epmask);
1001 if ( $args->register_meta_box_cb )
1002 add_action('add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1);
1004 $args->labels = get_post_type_labels( $args );
1005 $args->label = $args->labels->name;
1007 $wp_post_types[$post_type] = $args;
1009 add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 );
1011 foreach ( $args->taxonomies as $taxonomy ) {
1012 register_taxonomy_for_object_type( $taxonomy, $post_type );
1019 * Builds an object with all post type capabilities out of a post type object
1021 * Post type capabilities use the 'capability_type' argument as a base, if the
1022 * capability is not set in the 'capabilities' argument array or if the
1023 * 'capabilities' argument is not supplied.
1025 * The capability_type argument can optionally be registered as an array, with
1026 * the first value being singular and the second plural, e.g. array('story, 'stories')
1027 * Otherwise, an 's' will be added to the value for the plural form. After
1028 * registration, capability_type will always be a string of the singular value.
1030 * By default, seven keys are accepted as part of the capabilities array:
1032 * - edit_post, read_post, and delete_post are meta capabilities, which are then
1033 * generally mapped to corresponding primitive capabilities depending on the
1034 * context, which would be the post being edited/read/deleted and the user or
1035 * role being checked. Thus these capabilities would generally not be granted
1036 * directly to users or roles.
1038 * - edit_posts - Controls whether objects of this post type can be edited.
1039 * - edit_others_posts - Controls whether objects of this type owned by other users
1040 * can be edited. If the post type does not support an author, then this will
1041 * behave like edit_posts.
1042 * - publish_posts - Controls publishing objects of this post type.
1043 * - read_private_posts - Controls whether private objects can be read.
1045 * These four primitive capabilities are checked in core in various locations.
1046 * There are also seven other primitive capabilities which are not referenced
1047 * directly in core, except in map_meta_cap(), which takes the three aforementioned
1048 * meta capabilities and translates them into one or more primitive capabilities
1049 * that must then be checked against the user or role, depending on the context.
1051 * - read - Controls whether objects of this post type can be read.
1052 * - delete_posts - Controls whether objects of this post type can be deleted.
1053 * - delete_private_posts - Controls whether private objects can be deleted.
1054 * - delete_published_posts - Controls whether published objects can be deleted.
1055 * - delete_others_posts - Controls whether objects owned by other users can be
1056 * can be deleted. If the post type does not support an author, then this will
1057 * behave like delete_posts.
1058 * - edit_private_posts - Controls whether private objects can be edited.
1059 * - edit_published_posts - Controls whether published objects can be deleted.
1061 * These additional capabilities are only used in map_meta_cap(). Thus, they are
1062 * only assigned by default if the post type is registered with the 'map_meta_cap'
1063 * argument set to true (default is false).
1065 * @see map_meta_cap()
1068 * @param object $args Post type registration arguments
1069 * @return object object with all the capabilities as member variables
1071 function get_post_type_capabilities( $args ) {
1072 if ( ! is_array( $args->capability_type ) )
1073 $args->capability_type = array( $args->capability_type, $args->capability_type . 's' );
1075 // Singular base for meta capabilities, plural base for primitive capabilities.
1076 list( $singular_base, $plural_base ) = $args->capability_type;
1078 $default_capabilities = array(
1079 // Meta capabilities
1080 'edit_post' => 'edit_' . $singular_base,
1081 'read_post' => 'read_' . $singular_base,
1082 'delete_post' => 'delete_' . $singular_base,
1083 // Primitive capabilities used outside of map_meta_cap():
1084 'edit_posts' => 'edit_' . $plural_base,
1085 'edit_others_posts' => 'edit_others_' . $plural_base,
1086 'publish_posts' => 'publish_' . $plural_base,
1087 'read_private_posts' => 'read_private_' . $plural_base,
1090 // Primitive capabilities used within map_meta_cap():
1091 if ( $args->map_meta_cap ) {
1092 $default_capabilities_for_mapping = array(
1094 'delete_posts' => 'delete_' . $plural_base,
1095 'delete_private_posts' => 'delete_private_' . $plural_base,
1096 'delete_published_posts' => 'delete_published_' . $plural_base,
1097 'delete_others_posts' => 'delete_others_' . $plural_base,
1098 'edit_private_posts' => 'edit_private_' . $plural_base,
1099 'edit_published_posts' => 'edit_published_' . $plural_base,
1101 $default_capabilities = array_merge( $default_capabilities, $default_capabilities_for_mapping );
1104 $capabilities = array_merge( $default_capabilities, $args->capabilities );
1106 // Remember meta capabilities for future reference.
1107 if ( $args->map_meta_cap )
1108 _post_type_meta_capabilities( $capabilities );
1110 return (object) $capabilities;
1114 * Stores or returns a list of post type meta caps for map_meta_cap().
1119 function _post_type_meta_capabilities( $capabilities = null ) {
1120 static $meta_caps = array();
1121 if ( null === $capabilities )
1123 foreach ( $capabilities as $core => $custom ) {
1124 if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) )
1125 $meta_caps[ $custom ] = $core;
1130 * Builds an object with all post type labels out of a post type object
1132 * Accepted keys of the label array in the post type object:
1133 * - name - general name for the post type, usually plural. The same and overriden by $post_type_object->label. Default is Posts/Pages
1134 * - singular_name - name for one object of this post type. Default is Post/Page
1135 * - 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>
1136 * - add_new_item - Default is Add New Post/Add New Page
1137 * - edit_item - Default is Edit Post/Edit Page
1138 * - new_item - Default is New Post/New Page
1139 * - view_item - Default is View Post/View Page
1140 * - search_items - Default is Search Posts/Search Pages
1141 * - not_found - Default is No posts found/No pages found
1142 * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash
1143 * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page:
1145 * Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages).
1148 * @param object $post_type_object
1149 * @return object object with all the labels as member variables
1151 function get_post_type_labels( $post_type_object ) {
1152 $nohier_vs_hier_defaults = array(
1153 'name' => array( _x('Posts', 'post type general name'), _x('Pages', 'post type general name') ),
1154 'singular_name' => array( _x('Post', 'post type singular name'), _x('Page', 'post type singular name') ),
1155 'add_new' => array( _x('Add New', 'post'), _x('Add New', 'page') ),
1156 'add_new_item' => array( __('Add New Post'), __('Add New Page') ),
1157 'edit_item' => array( __('Edit Post'), __('Edit Page') ),
1158 'new_item' => array( __('New Post'), __('New Page') ),
1159 'view_item' => array( __('View Post'), __('View Page') ),
1160 'search_items' => array( __('Search Posts'), __('Search Pages') ),
1161 'not_found' => array( __('No posts found.'), __('No pages found.') ),
1162 'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ),
1163 'parent_item_colon' => array( null, __('Parent Page:') ),
1165 $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
1166 return _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults );
1170 * Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object
1175 function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
1177 if ( isset( $object->label ) && empty( $object->labels['name'] ) )
1178 $object->labels['name'] = $object->label;
1180 if ( !isset( $object->labels['singular_name'] ) && isset( $object->labels['name'] ) )
1181 $object->labels['singular_name'] = $object->labels['name'];
1183 if ( !isset( $object->labels['menu_name'] ) && isset( $object->labels['name'] ) )
1184 $object->labels['menu_name'] = $object->labels['name'];
1186 foreach ( $nohier_vs_hier_defaults as $key => $value )
1187 $defaults[$key] = $object->hierarchical ? $value[1] : $value[0];
1189 $labels = array_merge( $defaults, $object->labels );
1190 return (object)$labels;
1194 * Adds submenus for post types.
1199 function _add_post_type_submenus() {
1200 foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) {
1201 $ptype_obj = get_post_type_object( $ptype );
1203 if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true )
1205 add_submenu_page( $ptype_obj->show_in_menu, $ptype_obj->labels->name, $ptype_obj->labels->menu_name, $ptype_obj->cap->edit_posts, "edit.php?post_type=$ptype" );
1208 add_action( 'admin_menu', '_add_post_type_submenus' );
1211 * Register support of certain features for a post type.
1213 * All features are directly associated with a functional area of the edit screen, such as the
1214 * editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author',
1215 * 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'.
1217 * Additionally, the 'revisions' feature dictates whether the post type will store revisions,
1218 * and the 'comments' feature dicates whether the comments count will show on the edit screen.
1221 * @param string $post_type The post type for which to add the feature
1222 * @param string|array $feature the feature being added, can be an array of feature strings or a single string
1224 function add_post_type_support( $post_type, $feature ) {
1225 global $_wp_post_type_features;
1227 $features = (array) $feature;
1228 foreach ($features as $feature) {
1229 if ( func_num_args() == 2 )
1230 $_wp_post_type_features[$post_type][$feature] = true;
1232 $_wp_post_type_features[$post_type][$feature] = array_slice( func_get_args(), 2 );
1237 * Remove support for a feature from a post type.
1240 * @param string $post_type The post type for which to remove the feature
1241 * @param string $feature The feature being removed
1243 function remove_post_type_support( $post_type, $feature ) {
1244 global $_wp_post_type_features;
1246 if ( !isset($_wp_post_type_features[$post_type]) )
1249 if ( isset($_wp_post_type_features[$post_type][$feature]) )
1250 unset($_wp_post_type_features[$post_type][$feature]);
1254 * Checks a post type's support for a given feature
1257 * @param string $post_type The post type being checked
1258 * @param string $feature the feature being checked
1262 function post_type_supports( $post_type, $feature ) {
1263 global $_wp_post_type_features;
1265 if ( !isset( $_wp_post_type_features[$post_type][$feature] ) )
1268 // If no args passed then no extra checks need be performed
1269 if ( func_num_args() <= 2 )
1272 // @todo Allow pluggable arg checking
1273 //$args = array_slice( func_get_args(), 2 );
1279 * Updates the post type for the post ID.
1281 * The page or post cache will be cleaned for the post ID.
1287 * @param int $post_id Post ID to change post type. Not actually optional.
1288 * @param string $post_type Optional, default is post. Supported values are 'post' or 'page' to
1290 * @return int Amount of rows changed. Should be 1 for success and 0 for failure.
1292 function set_post_type( $post_id = 0, $post_type = 'post' ) {
1295 $post_type = sanitize_post_field('post_type', $post_type, $post_id, 'db');
1296 $return = $wpdb->update($wpdb->posts, array('post_type' => $post_type), array('ID' => $post_id) );
1298 if ( 'page' == $post_type )
1299 clean_page_cache($post_id);
1301 clean_post_cache($post_id);
1307 * Retrieve list of latest posts or posts matching criteria.
1309 * The defaults are as follows:
1310 * 'numberposts' - Default is 5. Total number of posts to retrieve.
1311 * 'offset' - Default is 0. See {@link WP_Query::query()} for more.
1312 * 'category' - What category to pull the posts from.
1313 * 'orderby' - Default is 'post_date'. How to order the posts.
1314 * 'order' - Default is 'DESC'. The order to retrieve the posts.
1315 * 'include' - See {@link WP_Query::query()} for more.
1316 * 'exclude' - See {@link WP_Query::query()} for more.
1317 * 'meta_key' - See {@link WP_Query::query()} for more.
1318 * 'meta_value' - See {@link WP_Query::query()} for more.
1319 * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few.
1320 * 'post_parent' - The parent of the post or post type.
1321 * 'post_status' - Default is 'published'. Post status to retrieve.
1325 * @uses WP_Query::query() See for more default arguments and information.
1326 * @link http://codex.wordpress.org/Template_Tags/get_posts
1328 * @param array $args Optional. Overrides defaults.
1329 * @return array List of posts.
1331 function get_posts($args = null) {
1333 'numberposts' => 5, 'offset' => 0,
1334 'category' => 0, 'orderby' => 'post_date',
1335 'order' => 'DESC', 'include' => array(),
1336 'exclude' => array(), 'meta_key' => '',
1337 'meta_value' =>'', 'post_type' => 'post',
1338 'suppress_filters' => true
1341 $r = wp_parse_args( $args, $defaults );
1342 if ( empty( $r['post_status'] ) )
1343 $r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish';
1344 if ( ! empty($r['numberposts']) && empty($r['posts_per_page']) )
1345 $r['posts_per_page'] = $r['numberposts'];
1346 if ( ! empty($r['category']) )
1347 $r['cat'] = $r['category'];
1348 if ( ! empty($r['include']) ) {
1349 $incposts = wp_parse_id_list( $r['include'] );
1350 $r['posts_per_page'] = count($incposts); // only the number of posts included
1351 $r['post__in'] = $incposts;
1352 } elseif ( ! empty($r['exclude']) )
1353 $r['post__not_in'] = wp_parse_id_list( $r['exclude'] );
1355 $r['ignore_sticky_posts'] = true;
1356 $r['no_found_rows'] = true;
1358 $get_posts = new WP_Query;
1359 return $get_posts->query($r);
1364 // Post meta functions
1368 * Add meta data field to a post.
1370 * Post meta data is called "Custom Fields" on the Administration Panels.
1374 * @link http://codex.wordpress.org/Function_Reference/add_post_meta
1376 * @param int $post_id Post ID.
1377 * @param string $meta_key Metadata name.
1378 * @param mixed $meta_value Metadata value.
1379 * @param bool $unique Optional, default is false. Whether the same key should not be added.
1380 * @return bool False for failure. True for success.
1382 function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) {
1383 // make sure meta is added to the post, not a revision
1384 if ( $the_post = wp_is_post_revision($post_id) )
1385 $post_id = $the_post;
1387 return add_metadata('post', $post_id, $meta_key, $meta_value, $unique);
1391 * Remove metadata matching criteria from a post.
1393 * You can match based on the key, or key and value. Removing based on key and
1394 * value, will keep from removing duplicate metadata with the same key. It also
1395 * allows removing all metadata matching key, if needed.
1399 * @link http://codex.wordpress.org/Function_Reference/delete_post_meta
1401 * @param int $post_id post ID
1402 * @param string $meta_key Metadata name.
1403 * @param mixed $meta_value Optional. Metadata value.
1404 * @return bool False for failure. True for success.
1406 function delete_post_meta($post_id, $meta_key, $meta_value = '') {
1407 // make sure meta is added to the post, not a revision
1408 if ( $the_post = wp_is_post_revision($post_id) )
1409 $post_id = $the_post;
1411 return delete_metadata('post', $post_id, $meta_key, $meta_value);
1415 * Retrieve post meta field for a post.
1419 * @link http://codex.wordpress.org/Function_Reference/get_post_meta
1421 * @param int $post_id Post ID.
1422 * @param string $key The meta key to retrieve.
1423 * @param bool $single Whether to return a single value.
1424 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
1427 function get_post_meta($post_id, $key, $single = false) {
1428 return get_metadata('post', $post_id, $key, $single);
1432 * Update post meta field based on post ID.
1434 * Use the $prev_value parameter to differentiate between meta fields with the
1435 * same key and post ID.
1437 * If the meta field for the post does not exist, it will be added.
1441 * @link http://codex.wordpress.org/Function_Reference/update_post_meta
1443 * @param int $post_id Post ID.
1444 * @param string $meta_key Metadata key.
1445 * @param mixed $meta_value Metadata value.
1446 * @param mixed $prev_value Optional. Previous value to check before removing.
1447 * @return bool False on failure, true if success.
1449 function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {
1450 // make sure meta is added to the post, not a revision
1451 if ( $the_post = wp_is_post_revision($post_id) )
1452 $post_id = $the_post;
1454 return update_metadata('post', $post_id, $meta_key, $meta_value, $prev_value);
1458 * Delete everything from post meta matching meta key.
1463 * @param string $post_meta_key Key to search for when deleting.
1464 * @return bool Whether the post meta key was deleted from the database
1466 function delete_post_meta_by_key($post_meta_key) {
1467 if ( !$post_meta_key )
1471 $post_ids = $wpdb->get_col($wpdb->prepare("SELECT DISTINCT post_id FROM $wpdb->postmeta WHERE meta_key = %s", $post_meta_key));
1473 $postmetaids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = %s", $post_meta_key ) );
1474 $in = implode( ',', array_fill(1, count($postmetaids), '%d'));
1475 do_action( 'delete_postmeta', $postmetaids );
1476 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->postmeta WHERE meta_id IN($in)", $postmetaids ));
1477 do_action( 'deleted_postmeta', $postmetaids );
1478 foreach ( $post_ids as $post_id )
1479 wp_cache_delete($post_id, 'post_meta');
1486 * Retrieve post meta fields, based on post ID.
1488 * The post meta fields are retrieved from the cache, so the function is
1489 * optimized to be called more than once. It also applies to the functions, that
1490 * use this function.
1493 * @link http://codex.wordpress.org/Function_Reference/get_post_custom
1495 * @uses $id Current Loop Post ID
1497 * @param int $post_id post ID
1500 function get_post_custom( $post_id = 0 ) {
1501 $post_id = absint( $post_id );
1504 $post_id = get_the_ID();
1506 if ( ! wp_cache_get( $post_id, 'post_meta' ) )
1507 update_postmeta_cache( $post_id );
1509 return wp_cache_get( $post_id, 'post_meta' );
1513 * Retrieve meta field names for a post.
1515 * If there are no meta fields, then nothing (null) will be returned.
1518 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys
1520 * @param int $post_id post ID
1521 * @return array|null Either array of the keys, or null if keys could not be retrieved.
1523 function get_post_custom_keys( $post_id = 0 ) {
1524 $custom = get_post_custom( $post_id );
1526 if ( !is_array($custom) )
1529 if ( $keys = array_keys($custom) )
1534 * Retrieve values for a custom post field.
1536 * The parameters must not be considered optional. All of the post meta fields
1537 * will be retrieved and only the meta field key values returned.
1540 * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values
1542 * @param string $key Meta field key.
1543 * @param int $post_id Post ID
1544 * @return array Meta field values.
1546 function get_post_custom_values( $key = '', $post_id = 0 ) {
1550 $custom = get_post_custom($post_id);
1552 return isset($custom[$key]) ? $custom[$key] : null;
1556 * Check if post is sticky.
1558 * Sticky posts should remain at the top of The Loop. If the post ID is not
1559 * given, then The Loop ID for the current post will be used.
1563 * @param int $post_id Optional. Post ID.
1564 * @return bool Whether post is sticky.
1566 function is_sticky( $post_id = 0 ) {
1567 $post_id = absint( $post_id );
1570 $post_id = get_the_ID();
1572 $stickies = get_option( 'sticky_posts' );
1574 if ( ! is_array( $stickies ) )
1577 if ( in_array( $post_id, $stickies ) )
1584 * Sanitize every post field.
1586 * If the context is 'raw', then the post object or array will get minimal santization of the int fields.
1589 * @uses sanitize_post_field() Used to sanitize the fields.
1591 * @param object|array $post The Post Object or Array
1592 * @param string $context Optional, default is 'display'. How to sanitize post fields.
1593 * @return object|array The now sanitized Post Object or Array (will be the same type as $post)
1595 function sanitize_post($post, $context = 'display') {
1596 if ( is_object($post) ) {
1597 // Check if post already filtered for this context
1598 if ( isset($post->filter) && $context == $post->filter )
1600 if ( !isset($post->ID) )
1602 foreach ( array_keys(get_object_vars($post)) as $field )
1603 $post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context);
1604 $post->filter = $context;
1606 // Check if post already filtered for this context
1607 if ( isset($post['filter']) && $context == $post['filter'] )
1609 if ( !isset($post['ID']) )
1611 foreach ( array_keys($post) as $field )
1612 $post[$field] = sanitize_post_field($field, $post[$field], $post['ID'], $context);
1613 $post['filter'] = $context;
1619 * Sanitize post field based on context.
1621 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1622 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1623 * when calling filters.
1626 * @uses apply_filters() Calls 'edit_$field' and '{$field_no_prefix}_edit_pre' passing $value and
1627 * $post_id if $context == 'edit' and field name prefix == 'post_'.
1629 * @uses apply_filters() Calls 'edit_post_$field' passing $value and $post_id if $context == 'db'.
1630 * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db' and field name prefix == 'post_'.
1631 * @uses apply_filters() Calls '{$field}_pre' passing $value if $context == 'db' and field name prefix != 'post_'.
1633 * @uses apply_filters() Calls '$field' passing $value, $post_id and $context if $context == anything
1634 * other than 'raw', 'edit' and 'db' and field name prefix == 'post_'.
1635 * @uses apply_filters() Calls 'post_$field' passing $value if $context == anything other than 'raw',
1636 * 'edit' and 'db' and field name prefix != 'post_'.
1638 * @param string $field The Post Object field name.
1639 * @param mixed $value The Post Object value.
1640 * @param int $post_id Post ID.
1641 * @param string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display',
1642 * 'attribute' and 'js'.
1643 * @return mixed Sanitized value.
1645 function sanitize_post_field($field, $value, $post_id, $context) {
1646 $int_fields = array('ID', 'post_parent', 'menu_order');
1647 if ( in_array($field, $int_fields) )
1648 $value = (int) $value;
1650 // Fields which contain arrays of ints.
1651 $array_int_fields = array( 'ancestors' );
1652 if ( in_array($field, $array_int_fields) ) {
1653 $value = array_map( 'absint', $value);
1657 if ( 'raw' == $context )
1661 if ( false !== strpos($field, 'post_') ) {
1663 $field_no_prefix = str_replace('post_', '', $field);
1666 if ( 'edit' == $context ) {
1667 $format_to_edit = array('post_content', 'post_excerpt', 'post_title', 'post_password');
1670 $value = apply_filters("edit_{$field}", $value, $post_id);
1672 $value = apply_filters("{$field_no_prefix}_edit_pre", $value, $post_id);
1674 $value = apply_filters("edit_post_{$field}", $value, $post_id);
1677 if ( in_array($field, $format_to_edit) ) {
1678 if ( 'post_content' == $field )
1679 $value = format_to_edit($value, user_can_richedit());
1681 $value = format_to_edit($value);
1683 $value = esc_attr($value);
1685 } else if ( 'db' == $context ) {
1687 $value = apply_filters("pre_{$field}", $value);
1688 $value = apply_filters("{$field_no_prefix}_save_pre", $value);
1690 $value = apply_filters("pre_post_{$field}", $value);
1691 $value = apply_filters("{$field}_pre", $value);
1694 // Use display filters by default.
1696 $value = apply_filters($field, $value, $post_id, $context);
1698 $value = apply_filters("post_{$field}", $value, $post_id, $context);
1701 if ( 'attribute' == $context )
1702 $value = esc_attr($value);
1703 else if ( 'js' == $context )
1704 $value = esc_js($value);
1710 * Make a post sticky.
1712 * Sticky posts should be displayed at the top of the front page.
1716 * @param int $post_id Post ID.
1718 function stick_post($post_id) {
1719 $stickies = get_option('sticky_posts');
1721 if ( !is_array($stickies) )
1722 $stickies = array($post_id);
1724 if ( ! in_array($post_id, $stickies) )
1725 $stickies[] = $post_id;
1727 update_option('sticky_posts', $stickies);
1733 * Sticky posts should be displayed at the top of the front page.
1737 * @param int $post_id Post ID.
1739 function unstick_post($post_id) {
1740 $stickies = get_option('sticky_posts');
1742 if ( !is_array($stickies) )
1745 if ( ! in_array($post_id, $stickies) )
1748 $offset = array_search($post_id, $stickies);
1749 if ( false === $offset )
1752 array_splice($stickies, $offset, 1);
1754 update_option('sticky_posts', $stickies);
1758 * Count number of posts of a post type and is user has permissions to view.
1760 * This function provides an efficient method of finding the amount of post's
1761 * type a blog has. Another method is to count the amount of items in
1762 * get_posts(), but that method has a lot of overhead with doing so. Therefore,
1763 * when developing for 2.5+, use this function instead.
1765 * The $perm parameter checks for 'readable' value and if the user can read
1766 * private posts, it will display that for the user that is signed in.
1769 * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
1771 * @param string $type Optional. Post type to retrieve count
1772 * @param string $perm Optional. 'readable' or empty.
1773 * @return object Number of posts for each status
1775 function wp_count_posts( $type = 'post', $perm = '' ) {
1778 $user = wp_get_current_user();
1782 $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s";
1783 if ( 'readable' == $perm && is_user_logged_in() ) {
1784 $post_type_object = get_post_type_object($type);
1785 if ( !current_user_can( $post_type_object->cap->read_private_posts ) ) {
1786 $cache_key .= '_' . $perm . '_' . $user->ID;
1787 $query .= " AND (post_status != 'private' OR ( post_author = '$user->ID' AND post_status = 'private' ))";
1790 $query .= ' GROUP BY post_status';
1792 $count = wp_cache_get($cache_key, 'counts');
1793 if ( false !== $count )
1796 $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A );
1799 foreach ( get_post_stati() as $state )
1802 foreach ( (array) $count as $row )
1803 $stats[$row['post_status']] = $row['num_posts'];
1805 $stats = (object) $stats;
1806 wp_cache_set($cache_key, $stats, 'counts');
1813 * Count number of attachments for the mime type(s).
1815 * If you set the optional mime_type parameter, then an array will still be
1816 * returned, but will only have the item you are looking for. It does not give
1817 * you the number of attachments that are children of a post. You can get that
1818 * by counting the number of children that post has.
1822 * @param string|array $mime_type Optional. Array or comma-separated list of MIME patterns.
1823 * @return array Number of posts for each mime type.
1825 function wp_count_attachments( $mime_type = '' ) {
1828 $and = wp_post_mime_type_where( $mime_type );
1829 $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 );
1832 foreach( (array) $count as $row ) {
1833 $stats[$row['post_mime_type']] = $row['num_posts'];
1835 $stats['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and");
1837 return (object) $stats;
1841 * Check a MIME-Type against a list.
1843 * If the wildcard_mime_types parameter is a string, it must be comma separated
1844 * list. If the real_mime_types is a string, it is also comma separated to
1849 * @param string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or
1850 * flash (same as *flash*).
1851 * @param string|array $real_mime_types post_mime_type values
1852 * @return array array(wildcard=>array(real types))
1854 function wp_match_mime_types($wildcard_mime_types, $real_mime_types) {
1856 if ( is_string($wildcard_mime_types) )
1857 $wildcard_mime_types = array_map('trim', explode(',', $wildcard_mime_types));
1858 if ( is_string($real_mime_types) )
1859 $real_mime_types = array_map('trim', explode(',', $real_mime_types));
1860 $wild = '[-._a-z0-9]*';
1861 foreach ( (array) $wildcard_mime_types as $type ) {
1862 $type = str_replace('*', $wild, $type);
1863 $patternses[1][$type] = "^$type$";
1864 if ( false === strpos($type, '/') ) {
1865 $patternses[2][$type] = "^$type/";
1866 $patternses[3][$type] = $type;
1870 foreach ( $patternses as $patterns )
1871 foreach ( $patterns as $type => $pattern )
1872 foreach ( (array) $real_mime_types as $real )
1873 if ( preg_match("#$pattern#", $real) && ( empty($matches[$type]) || false === array_search($real, $matches[$type]) ) )
1874 $matches[$type][] = $real;
1879 * Convert MIME types into SQL.
1883 * @param string|array $post_mime_types List of mime types or comma separated string of mime types.
1884 * @param string $table_alias Optional. Specify a table alias, if needed.
1885 * @return string The SQL AND clause for mime searching.
1887 function wp_post_mime_type_where($post_mime_types, $table_alias = '') {
1889 $wildcards = array('', '%', '%/%');
1890 if ( is_string($post_mime_types) )
1891 $post_mime_types = array_map('trim', explode(',', $post_mime_types));
1892 foreach ( (array) $post_mime_types as $mime_type ) {
1893 $mime_type = preg_replace('/\s/', '', $mime_type);
1894 $slashpos = strpos($mime_type, '/');
1895 if ( false !== $slashpos ) {
1896 $mime_group = preg_replace('/[^-*.a-zA-Z0-9]/', '', substr($mime_type, 0, $slashpos));
1897 $mime_subgroup = preg_replace('/[^-*.+a-zA-Z0-9]/', '', substr($mime_type, $slashpos + 1));
1898 if ( empty($mime_subgroup) )
1899 $mime_subgroup = '*';
1901 $mime_subgroup = str_replace('/', '', $mime_subgroup);
1902 $mime_pattern = "$mime_group/$mime_subgroup";
1904 $mime_pattern = preg_replace('/[^-*.a-zA-Z0-9]/', '', $mime_type);
1905 if ( false === strpos($mime_pattern, '*') )
1906 $mime_pattern .= '/*';
1909 $mime_pattern = preg_replace('/\*+/', '%', $mime_pattern);
1911 if ( in_array( $mime_type, $wildcards ) )
1914 if ( false !== strpos($mime_pattern, '%') )
1915 $wheres[] = empty($table_alias) ? "post_mime_type LIKE '$mime_pattern'" : "$table_alias.post_mime_type LIKE '$mime_pattern'";
1917 $wheres[] = empty($table_alias) ? "post_mime_type = '$mime_pattern'" : "$table_alias.post_mime_type = '$mime_pattern'";
1919 if ( !empty($wheres) )
1920 $where = ' AND (' . join(' OR ', $wheres) . ') ';
1925 * Trashes or deletes a post or page.
1927 * When the post and page is permanently deleted, everything that is tied to it is deleted also.
1928 * This includes comments, post meta fields, and terms associated with the post.
1930 * The post or page is moved to trash instead of permanently deleted unless trash is
1931 * disabled, item is already in the trash, or $force_delete is true.
1934 * @uses do_action() on 'delete_post' before deletion unless post type is 'attachment'.
1935 * @uses do_action() on 'deleted_post' after deletion unless post type is 'attachment'.
1936 * @uses wp_delete_attachment() if post type is 'attachment'.
1937 * @uses wp_trash_post() if item should be trashed.
1939 * @param int $postid Post ID.
1940 * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
1941 * @return mixed False on failure
1943 function wp_delete_post( $postid = 0, $force_delete = false ) {
1944 global $wpdb, $wp_rewrite;
1946 if ( !$post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) )
1949 if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS )
1950 return wp_trash_post($postid);
1952 if ( $post->post_type == 'attachment' )
1953 return wp_delete_attachment( $postid, $force_delete );
1955 do_action('delete_post', $postid);
1957 delete_post_meta($postid,'_wp_trash_meta_status');
1958 delete_post_meta($postid,'_wp_trash_meta_time');
1960 wp_delete_object_term_relationships($postid, get_object_taxonomies($post->post_type));
1962 $parent_data = array( 'post_parent' => $post->post_parent );
1963 $parent_where = array( 'post_parent' => $postid );
1965 if ( 'page' == $post->post_type) {
1966 // if the page is defined in option page_on_front or post_for_posts,
1967 // adjust the corresponding options
1968 if ( get_option('page_on_front') == $postid ) {
1969 update_option('show_on_front', 'posts');
1970 delete_option('page_on_front');
1972 if ( get_option('page_for_posts') == $postid ) {
1973 delete_option('page_for_posts');
1976 // Point children of this page to its parent, also clean the cache of affected children
1977 $children_query = $wpdb->prepare("SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type='page'", $postid);
1978 $children = $wpdb->get_results($children_query);
1980 $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'page' ) );
1982 unstick_post($postid);
1985 // Do raw query. wp_get_post_revisions() is filtered
1986 $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
1987 // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
1988 foreach ( $revision_ids as $revision_id )
1989 wp_delete_post_revision( $revision_id );
1991 // Point all attachments to this post up one level
1992 $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
1994 $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid ));
1995 if ( ! empty($comment_ids) ) {
1996 do_action( 'delete_comment', $comment_ids );
1997 foreach ( $comment_ids as $comment_id )
1998 wp_delete_comment( $comment_id, true );
1999 do_action( 'deleted_comment', $comment_ids );
2002 $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $postid ));
2003 if ( !empty($post_meta_ids) ) {
2004 do_action( 'delete_postmeta', $post_meta_ids );
2005 $in_post_meta_ids = "'" . implode("', '", $post_meta_ids) . "'";
2006 $wpdb->query( "DELETE FROM $wpdb->postmeta WHERE meta_id IN($in_post_meta_ids)" );
2007 do_action( 'deleted_postmeta', $post_meta_ids );
2010 do_action( 'delete_post', $postid );
2011 $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->posts WHERE ID = %d", $postid ));
2012 do_action( 'deleted_post', $postid );
2014 if ( 'page' == $post->post_type ) {
2015 clean_page_cache($postid);
2017 foreach ( (array) $children as $child )
2018 clean_page_cache($child->ID);
2020 $wp_rewrite->flush_rules(false);
2022 clean_post_cache($postid);
2025 wp_clear_scheduled_hook('publish_future_post', array( $postid ) );
2027 do_action('deleted_post', $postid);
2033 * Moves a post or page to the Trash
2035 * If trash is disabled, the post or page is permanently deleted.
2038 * @uses do_action() on 'trash_post' before trashing
2039 * @uses do_action() on 'trashed_post' after trashing
2040 * @uses wp_delete_post() if trash is disabled
2042 * @param int $post_id Post ID.
2043 * @return mixed False on failure
2045 function wp_trash_post($post_id = 0) {
2046 if ( !EMPTY_TRASH_DAYS )
2047 return wp_delete_post($post_id, true);
2049 if ( !$post = wp_get_single_post($post_id, ARRAY_A) )
2052 if ( $post['post_status'] == 'trash' )
2055 do_action('trash_post', $post_id);
2057 add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']);
2058 add_post_meta($post_id,'_wp_trash_meta_time', time());
2060 $post['post_status'] = 'trash';
2061 wp_insert_post($post);
2063 wp_trash_post_comments($post_id);
2065 do_action('trashed_post', $post_id);
2071 * Restores a post or page from the Trash
2074 * @uses do_action() on 'untrash_post' before undeletion
2075 * @uses do_action() on 'untrashed_post' after undeletion
2077 * @param int $post_id Post ID.
2078 * @return mixed False on failure
2080 function wp_untrash_post($post_id = 0) {
2081 if ( !$post = wp_get_single_post($post_id, ARRAY_A) )
2084 if ( $post['post_status'] != 'trash' )
2087 do_action('untrash_post', $post_id);
2089 $post_status = get_post_meta($post_id, '_wp_trash_meta_status', true);
2091 $post['post_status'] = $post_status;
2093 delete_post_meta($post_id, '_wp_trash_meta_status');
2094 delete_post_meta($post_id, '_wp_trash_meta_time');
2096 wp_insert_post($post);
2098 wp_untrash_post_comments($post_id);
2100 do_action('untrashed_post', $post_id);
2106 * Moves comments for a post to the trash
2109 * @uses do_action() on 'trash_post_comments' before trashing
2110 * @uses do_action() on 'trashed_post_comments' after trashing
2112 * @param int $post Post ID or object.
2113 * @return mixed False on failure
2115 function wp_trash_post_comments($post = null) {
2118 $post = get_post($post);
2122 $post_id = $post->ID;
2124 do_action('trash_post_comments', $post_id);
2126 $comments = $wpdb->get_results( $wpdb->prepare("SELECT comment_ID, comment_approved FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id) );
2127 if ( empty($comments) )
2130 // Cache current status for each comment
2131 $statuses = array();
2132 foreach ( $comments as $comment )
2133 $statuses[$comment->comment_ID] = $comment->comment_approved;
2134 add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses);
2136 // Set status for all comments to post-trashed
2137 $result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id));
2139 clean_comment_cache( array_keys($statuses) );
2141 do_action('trashed_post_comments', $post_id, $statuses);
2147 * Restore comments for a post from the trash
2150 * @uses do_action() on 'untrash_post_comments' before trashing
2151 * @uses do_action() on 'untrashed_post_comments' after trashing
2153 * @param int $post Post ID or object.
2154 * @return mixed False on failure
2156 function wp_untrash_post_comments($post = null) {
2159 $post = get_post($post);
2163 $post_id = $post->ID;
2165 $statuses = get_post_meta($post_id, '_wp_trash_meta_comments_status', true);
2167 if ( empty($statuses) )
2170 do_action('untrash_post_comments', $post_id);
2172 // Restore each comment to its original status
2173 $group_by_status = array();
2174 foreach ( $statuses as $comment_id => $comment_status )
2175 $group_by_status[$comment_status][] = $comment_id;
2177 foreach ( $group_by_status as $status => $comments ) {
2178 // Sanity check. This shouldn't happen.
2179 if ( 'post-trashed' == $status )
2181 $comments_in = implode( "', '", $comments );
2182 $wpdb->query( "UPDATE $wpdb->comments SET comment_approved = '$status' WHERE comment_ID IN ('" . $comments_in . "')" );
2185 clean_comment_cache( array_keys($statuses) );
2187 delete_post_meta($post_id, '_wp_trash_meta_comments_status');
2189 do_action('untrashed_post_comments', $post_id);
2193 * Retrieve the list of categories for a post.
2195 * Compatibility layer for themes and plugins. Also an easy layer of abstraction
2196 * away from the complexity of the taxonomy layer.
2200 * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here.
2202 * @param int $post_id Optional. The Post ID.
2203 * @param array $args Optional. Overwrite the defaults.
2206 function wp_get_post_categories( $post_id = 0, $args = array() ) {
2207 $post_id = (int) $post_id;
2209 $defaults = array('fields' => 'ids');
2210 $args = wp_parse_args( $args, $defaults );
2212 $cats = wp_get_object_terms($post_id, 'category', $args);
2217 * Retrieve the tags for a post.
2219 * There is only one default for this function, called 'fields' and by default
2220 * is set to 'all'. There are other defaults that can be overridden in
2221 * {@link wp_get_object_terms()}.
2223 * @package WordPress
2227 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
2229 * @param int $post_id Optional. The Post ID
2230 * @param array $args Optional. Overwrite the defaults
2231 * @return array List of post tags.
2233 function wp_get_post_tags( $post_id = 0, $args = array() ) {
2234 return wp_get_post_terms( $post_id, 'post_tag', $args);
2238 * Retrieve the terms for a post.
2240 * There is only one default for this function, called 'fields' and by default
2241 * is set to 'all'. There are other defaults that can be overridden in
2242 * {@link wp_get_object_terms()}.
2244 * @package WordPress
2248 * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
2250 * @param int $post_id Optional. The Post ID
2251 * @param string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag.
2252 * @param array $args Optional. Overwrite the defaults
2253 * @return array List of post tags.
2255 function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
2256 $post_id = (int) $post_id;
2258 $defaults = array('fields' => 'all');
2259 $args = wp_parse_args( $args, $defaults );
2261 $tags = wp_get_object_terms($post_id, $taxonomy, $args);
2267 * Retrieve number of recent posts.
2270 * @uses wp_parse_args()
2273 * @param string $deprecated Deprecated.
2274 * @param array $args Optional. Overrides defaults.
2275 * @param string $output Optional.
2278 function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
2280 if ( is_numeric( $args ) ) {
2281 _deprecated_argument( __FUNCTION__, '3.1', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) );
2282 $args = array( 'numberposts' => absint( $args ) );
2285 // Set default arguments
2287 'numberposts' => 10, 'offset' => 0,
2288 'category' => 0, 'orderby' => 'post_date',
2289 'order' => 'DESC', 'include' => '',
2290 'exclude' => '', 'meta_key' => '',
2291 'meta_value' =>'', 'post_type' => 'post', 'post_status' => 'draft, publish, future, pending, private',
2292 'suppress_filters' => true
2295 $r = wp_parse_args( $args, $defaults );
2297 $results = get_posts( $r );
2299 // Backward compatibility. Prior to 3.1 expected posts to be returned in array
2300 if ( ARRAY_A == $output ){
2301 foreach( $results as $key => $result ) {
2302 $results[$key] = get_object_vars( $result );
2304 return $results ? $results : array();
2307 return $results ? $results : false;
2312 * Retrieve a single post, based on post ID.
2314 * Has categories in 'post_category' property or key. Has tags in 'tags_input'
2319 * @param int $postid Post ID.
2320 * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A.
2321 * @return object|array Post object or array holding post contents and information
2323 function wp_get_single_post($postid = 0, $mode = OBJECT) {
2324 $postid = (int) $postid;
2326 $post = get_post($postid, $mode);
2329 ( OBJECT == $mode && empty( $post->ID ) ) ||
2330 ( OBJECT != $mode && empty( $post['ID'] ) )
2332 return ( OBJECT == $mode ? null : array() );
2334 // Set categories and tags
2335 if ( $mode == OBJECT ) {
2336 $post->post_category = array();
2337 if ( is_object_in_taxonomy($post->post_type, 'category') )
2338 $post->post_category = wp_get_post_categories($postid);
2339 $post->tags_input = array();
2340 if ( is_object_in_taxonomy($post->post_type, 'post_tag') )
2341 $post->tags_input = wp_get_post_tags($postid, array('fields' => 'names'));
2343 $post['post_category'] = array();
2344 if ( is_object_in_taxonomy($post['post_type'], 'category') )
2345 $post['post_category'] = wp_get_post_categories($postid);
2346 $post['tags_input'] = array();
2347 if ( is_object_in_taxonomy($post['post_type'], 'post_tag') )
2348 $post['tags_input'] = wp_get_post_tags($postid, array('fields' => 'names'));
2357 * If the $postarr parameter has 'ID' set to a value, then post will be updated.
2359 * You can set the post date manually, but setting the values for 'post_date'
2360 * and 'post_date_gmt' keys. You can close the comments or open the comments by
2361 * setting the value for 'comment_status' key.
2363 * The defaults for the parameter $postarr are:
2364 * 'post_status' - Default is 'draft'.
2365 * 'post_type' - Default is 'post'.
2366 * 'post_author' - Default is current user ID ($user_ID). The ID of the user who added the post.
2367 * 'ping_status' - Default is the value in 'default_ping_status' option.
2368 * Whether the attachment can accept pings.
2369 * 'post_parent' - Default is 0. Set this for the post it belongs to, if any.
2370 * 'menu_order' - Default is 0. The order it is displayed.
2371 * 'to_ping' - Whether to ping.
2372 * 'pinged' - Default is empty string.
2373 * 'post_password' - Default is empty string. The password to access the attachment.
2374 * 'guid' - Global Unique ID for referencing the attachment.
2375 * 'post_content_filtered' - Post content filtered.
2376 * 'post_excerpt' - Post excerpt.
2382 * @uses do_action() Calls 'pre_post_update' on post ID if this is an update.
2383 * @uses do_action() Calls 'edit_post' action on post ID and post data if this is an update.
2384 * @uses do_action() Calls 'save_post' and 'wp_insert_post' on post id and post data just before returning.
2385 * @uses apply_filters() Calls 'wp_insert_post_data' passing $data, $postarr prior to database update or insert.
2386 * @uses wp_transition_post_status()
2388 * @param array $postarr Elements that make up post to insert.
2389 * @param bool $wp_error Optional. Allow return of WP_Error on failure.
2390 * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
2392 function wp_insert_post($postarr, $wp_error = false) {
2393 global $wpdb, $wp_rewrite, $user_ID;
2395 $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID,
2396 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
2397 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '',
2398 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0,
2399 'post_content' => '', 'post_title' => '');
2401 $postarr = wp_parse_args($postarr, $defaults);
2402 $postarr = sanitize_post($postarr, 'db');
2404 // export array as variables
2405 extract($postarr, EXTR_SKIP);
2407 // Are we updating or creating?
2409 if ( !empty($ID) ) {
2411 $previous_status = get_post_field('post_status', $ID);
2413 $previous_status = 'new';
2416 if ( ('' == $post_content) && ('' == $post_title) && ('' == $post_excerpt) && ('attachment' != $post_type) ) {
2418 return new WP_Error('empty_content', __('Content, title, and excerpt are empty.'));
2423 if ( empty($post_type) )
2424 $post_type = 'post';
2426 if ( empty($post_status) )
2427 $post_status = 'draft';
2429 if ( !empty($post_category) )
2430 $post_category = array_filter($post_category); // Filter out empty terms
2432 // Make sure we set a valid category.
2433 if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
2434 // 'post' requires at least one category.
2435 if ( 'post' == $post_type && 'auto-draft' != $post_status )
2436 $post_category = array( get_option('default_category') );
2438 $post_category = array();
2441 if ( empty($post_author) )
2442 $post_author = $user_ID;
2446 // Get the post ID and GUID
2448 $post_ID = (int) $ID;
2449 $guid = get_post_field( 'guid', $post_ID );
2450 $post_before = get_post($post_ID);
2453 // Don't allow contributors to set to set the post slug for pending review posts
2454 if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) )
2457 // Create a valid post name. Drafts and pending posts are allowed to have an empty
2459 if ( empty($post_name) ) {
2460 if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2461 $post_name = sanitize_title($post_title);
2465 $post_name = sanitize_title($post_name);
2468 // 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
2469 if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date )
2470 $post_date = current_time('mysql');
2472 if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) {
2473 if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2474 $post_date_gmt = get_gmt_from_date($post_date);
2476 $post_date_gmt = '0000-00-00 00:00:00';
2479 if ( $update || '0000-00-00 00:00:00' == $post_date ) {
2480 $post_modified = current_time( 'mysql' );
2481 $post_modified_gmt = current_time( 'mysql', 1 );
2483 $post_modified = $post_date;
2484 $post_modified_gmt = $post_date_gmt;
2487 if ( 'publish' == $post_status ) {
2488 $now = gmdate('Y-m-d H:i:59');
2489 if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) )
2490 $post_status = 'future';
2491 } elseif( 'future' == $post_status ) {
2492 $now = gmdate('Y-m-d H:i:59');
2493 if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) )
2494 $post_status = 'publish';
2497 if ( empty($comment_status) ) {
2499 $comment_status = 'closed';
2501 $comment_status = get_option('default_comment_status');
2503 if ( empty($ping_status) )
2504 $ping_status = get_option('default_ping_status');
2506 if ( isset($to_ping) )
2507 $to_ping = preg_replace('|\s+|', "\n", $to_ping);
2511 if ( ! isset($pinged) )
2514 if ( isset($post_parent) )
2515 $post_parent = (int) $post_parent;
2519 // Check the post_parent to see if it will cause a hierarchy loop
2520 $post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr );
2522 if ( isset($menu_order) )
2523 $menu_order = (int) $menu_order;
2527 if ( !isset($post_password) || 'private' == $post_status )
2528 $post_password = '';
2530 $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
2532 // expected_slashed (everything!)
2533 $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' ) );
2534 $data = apply_filters('wp_insert_post_data', $data, $postarr);
2535 $data = stripslashes_deep( $data );
2536 $where = array( 'ID' => $post_ID );
2539 do_action( 'pre_post_update', $post_ID );
2540 if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) {
2542 return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error);
2547 if ( isset($post_mime_type) )
2548 $data['post_mime_type'] = stripslashes( $post_mime_type ); // This isn't in the update
2549 // If there is a suggested ID, use it if not already present
2550 if ( !empty($import_id) ) {
2551 $import_id = (int) $import_id;
2552 if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
2553 $data['ID'] = $import_id;
2556 if ( false === $wpdb->insert( $wpdb->posts, $data ) ) {
2558 return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error);
2562 $post_ID = (int) $wpdb->insert_id;
2564 // use the newly generated $post_ID
2565 $where = array( 'ID' => $post_ID );
2568 if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) {
2569 $data['post_name'] = sanitize_title($data['post_title'], $post_ID);
2570 $wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where );
2573 if ( is_object_in_taxonomy($post_type, 'category') )
2574 wp_set_post_categories( $post_ID, $post_category );
2576 if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') )
2577 wp_set_post_tags( $post_ID, $tags_input );
2579 // new-style support for all custom taxonomies
2580 if ( !empty($tax_input) ) {
2581 foreach ( $tax_input as $taxonomy => $tags ) {
2582 $taxonomy_obj = get_taxonomy($taxonomy);
2583 if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical.
2584 $tags = array_filter($tags);
2585 if ( current_user_can($taxonomy_obj->cap->assign_terms) )
2586 wp_set_post_terms( $post_ID, $tags, $taxonomy );
2590 $current_guid = get_post_field( 'guid', $post_ID );
2592 if ( 'page' == $data['post_type'] )
2593 clean_page_cache($post_ID);
2595 clean_post_cache($post_ID);
2598 if ( !$update && '' == $current_guid )
2599 $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where );
2601 $post = get_post($post_ID);
2603 if ( !empty($page_template) && 'page' == $data['post_type'] ) {
2604 $post->page_template = $page_template;
2605 $page_templates = get_page_templates();
2606 if ( 'default' != $page_template && !in_array($page_template, $page_templates) ) {
2608 return new WP_Error('invalid_page_template', __('The page template is invalid.'));
2612 update_post_meta($post_ID, '_wp_page_template', $page_template);
2615 wp_transition_post_status($data['post_status'], $previous_status, $post);
2618 do_action('edit_post', $post_ID, $post);
2619 $post_after = get_post($post_ID);
2620 do_action( 'post_updated', $post_ID, $post_after, $post_before);
2623 do_action('save_post', $post_ID, $post);
2624 do_action('wp_insert_post', $post_ID, $post);
2630 * Update a post with new post data.
2632 * The date does not have to be set for drafts. You can set the date and it will
2633 * not be overridden.
2637 * @param array|object $postarr Post data. Arrays are expected to be escaped, objects are not.
2638 * @return int 0 on failure, Post ID on success.
2640 function wp_update_post($postarr = array()) {
2641 if ( is_object($postarr) ) {
2642 // non-escaped post was passed
2643 $postarr = get_object_vars($postarr);
2644 $postarr = add_magic_quotes($postarr);
2647 // First, get all of the original fields
2648 $post = wp_get_single_post($postarr['ID'], ARRAY_A);
2650 // Escape data pulled from DB.
2651 $post = add_magic_quotes($post);
2653 // Passed post category list overwrites existing category list if not empty.
2654 if ( isset($postarr['post_category']) && is_array($postarr['post_category'])
2655 && 0 != count($postarr['post_category']) )
2656 $post_cats = $postarr['post_category'];
2658 $post_cats = $post['post_category'];
2660 // Drafts shouldn't be assigned a date unless explicitly done so by the user
2661 if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) &&
2662 ('0000-00-00 00:00:00' == $post['post_date_gmt']) )
2665 $clear_date = false;
2667 // Merge old and new fields with new fields overwriting old ones.
2668 $postarr = array_merge($post, $postarr);
2669 $postarr['post_category'] = $post_cats;
2670 if ( $clear_date ) {
2671 $postarr['post_date'] = current_time('mysql');
2672 $postarr['post_date_gmt'] = '';
2675 if ($postarr['post_type'] == 'attachment')
2676 return wp_insert_attachment($postarr);
2678 return wp_insert_post($postarr);
2682 * Publish a post by transitioning the post status.
2686 * @uses do_action() Calls 'edit_post', 'save_post', and 'wp_insert_post' on post_id and post data.
2688 * @param int $post_id Post ID.
2691 function wp_publish_post($post_id) {
2694 $post = get_post($post_id);
2699 if ( 'publish' == $post->post_status )
2702 $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $post_id ) );
2704 $old_status = $post->post_status;
2705 $post->post_status = 'publish';
2706 wp_transition_post_status('publish', $old_status, $post);
2708 // Update counts for the post's terms.
2709 foreach ( (array) get_object_taxonomies('post') as $taxonomy ) {
2710 $tt_ids = wp_get_object_terms($post_id, $taxonomy, array('fields' => 'tt_ids'));
2711 wp_update_term_count($tt_ids, $taxonomy);
2714 do_action('edit_post', $post_id, $post);
2715 do_action('save_post', $post_id, $post);
2716 do_action('wp_insert_post', $post_id, $post);
2720 * Publish future post and make sure post ID has future post status.
2722 * Invoked by cron 'publish_future_post' event. This safeguard prevents cron
2723 * from publishing drafts, etc.
2727 * @param int $post_id Post ID.
2728 * @return null Nothing is returned. Which can mean that no action is required or post was published.
2730 function check_and_publish_future_post($post_id) {
2732 $post = get_post($post_id);
2737 if ( 'future' != $post->post_status )
2740 $time = strtotime( $post->post_date_gmt . ' GMT' );
2742 if ( $time > time() ) { // Uh oh, someone jumped the gun!
2743 wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
2744 wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
2748 return wp_publish_post($post_id);
2753 * Computes a unique slug for the post, when given the desired slug and some post details.
2757 * @global wpdb $wpdb
2758 * @global WP_Rewrite $wp_rewrite
2759 * @param string $slug the desired slug (post_name)
2760 * @param integer $post_ID
2761 * @param string $post_status no uniqueness checks are made if the post is still draft or pending
2762 * @param string $post_type
2763 * @param integer $post_parent
2764 * @return string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
2766 function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) {
2767 if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
2770 global $wpdb, $wp_rewrite;
2772 $feeds = $wp_rewrite->feeds;
2773 if ( ! is_array( $feeds ) )
2776 $hierarchical_post_types = get_post_types( array('hierarchical' => true) );
2777 if ( 'attachment' == $post_type ) {
2778 // Attachment slugs must be unique across all types.
2779 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND ID != %d LIMIT 1";
2780 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) );
2782 if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) {
2785 $alt_post_name = substr ($slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
2786 $post_name_check = $wpdb->get_var( $wpdb->prepare($check_sql, $alt_post_name, $post_ID ) );
2788 } while ( $post_name_check );
2789 $slug = $alt_post_name;
2791 } elseif ( in_array( $post_type, $hierarchical_post_types ) ) {
2792 // Page slugs must be unique within their own trees. Pages are in a separate
2793 // namespace than posts so page slugs are allowed to overlap post slugs.
2794 $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";
2795 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID, $post_parent ) );
2797 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 ) ) {
2800 $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
2801 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID, $post_parent ) );
2803 } while ( $post_name_check );
2804 $slug = $alt_post_name;
2807 // Post slugs must be unique across all posts.
2808 $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d LIMIT 1";
2809 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID ) );
2811 if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) {
2814 $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
2815 $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID ) );
2817 } while ( $post_name_check );
2818 $slug = $alt_post_name;
2826 * Adds tags to a post.
2828 * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true.
2830 * @package WordPress
2834 * @param int $post_id Post ID
2835 * @param string $tags The tags to set for the post, separated by commas.
2836 * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise
2838 function wp_add_post_tags($post_id = 0, $tags = '') {
2839 return wp_set_post_tags($post_id, $tags, true);
2844 * Set the tags for a post.
2847 * @uses wp_set_object_terms() Sets the tags for the post.
2849 * @param int $post_id Post ID.
2850 * @param string $tags The tags to set for the post, separated by commas.
2851 * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
2852 * @return mixed Array of affected term IDs. WP_Error or false on failure.
2854 function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
2855 return wp_set_post_terms( $post_id, $tags, 'post_tag', $append);
2859 * Set the terms for a post.
2862 * @uses wp_set_object_terms() Sets the tags for the post.
2864 * @param int $post_id Post ID.
2865 * @param string $tags The tags to set for the post, separated by commas.
2866 * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
2867 * @return mixed Array of affected term IDs. WP_Error or false on failure.
2869 function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
2870 $post_id = (int) $post_id;
2878 $tags = is_array($tags) ? $tags : explode( ',', trim($tags, " \n\t\r\0\x0B,") );
2880 // Hierarchical taxonomies must always pass IDs rather than names so that children with the same
2881 // names but different parents aren't confused.
2882 if ( is_taxonomy_hierarchical( $taxonomy ) ) {
2883 $tags = array_map( 'intval', $tags );
2884 $tags = array_unique( $tags );
2887 return wp_set_object_terms($post_id, $tags, $taxonomy, $append);
2891 * Set categories for a post.
2893 * If the post categories parameter is not set, then the default category is
2898 * @param int $post_ID Post ID.
2899 * @param array $post_categories Optional. List of categories.
2900 * @return bool|mixed
2902 function wp_set_post_categories($post_ID = 0, $post_categories = array()) {
2903 $post_ID = (int) $post_ID;
2904 $post_type = get_post_type( $post_ID );
2905 $post_status = get_post_status( $post_ID );
2906 // If $post_categories isn't already an array, make it one:
2907 if ( !is_array($post_categories) || empty($post_categories) ) {
2908 if ( 'post' == $post_type && 'auto-draft' != $post_status )
2909 $post_categories = array( get_option('default_category') );
2911 $post_categories = array();
2912 } else if ( 1 == count($post_categories) && '' == reset($post_categories) ) {
2916 if ( !empty($post_categories) ) {
2917 $post_categories = array_map('intval', $post_categories);
2918 $post_categories = array_unique($post_categories);
2921 return wp_set_object_terms($post_ID, $post_categories, 'category');
2925 * Transition the post status of a post.
2927 * Calls hooks to transition post status.
2929 * The first is 'transition_post_status' with new status, old status, and post data.
2931 * The next action called is 'OLDSTATUS_to_NEWSTATUS' the 'NEWSTATUS' is the
2932 * $new_status parameter and the 'OLDSTATUS' is $old_status parameter; it has the
2935 * The final action is named 'NEWSTATUS_POSTTYPE', 'NEWSTATUS' is from the $new_status
2936 * parameter and POSTTYPE is post_type post data.
2939 * @link http://codex.wordpress.org/Post_Status_Transitions
2941 * @uses do_action() Calls 'transition_post_status' on $new_status, $old_status and
2942 * $post if there is a status change.
2943 * @uses do_action() Calls '{$old_status}_to_{$new_status}' on $post if there is a status change.
2944 * @uses do_action() Calls '{$new_status}_{$post->post_type}' on post ID and $post.
2946 * @param string $new_status Transition to this post status.
2947 * @param string $old_status Previous post status.
2948 * @param object $post Post data.
2950 function wp_transition_post_status($new_status, $old_status, $post) {
2951 do_action('transition_post_status', $new_status, $old_status, $post);
2952 do_action("{$old_status}_to_{$new_status}", $post);
2953 do_action("{$new_status}_{$post->post_type}", $post->ID, $post);
2957 // Trackback and ping functions
2961 * Add a URL to those already pung.
2966 * @param int $post_id Post ID.
2967 * @param string $uri Ping URI.
2968 * @return int How many rows were updated.
2970 function add_ping($post_id, $uri) {
2972 $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
2973 $pung = trim($pung);
2974 $pung = preg_split('/\s/', $pung);
2976 $new = implode("\n", $pung);
2977 $new = apply_filters('add_ping', $new);
2978 // expected_slashed ($new)
2979 $new = stripslashes($new);
2980 return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) );
2984 * Retrieve enclosures already enclosed for a post.
2989 * @param int $post_id Post ID.
2990 * @return array List of enclosures
2992 function get_enclosed($post_id) {
2993 $custom_fields = get_post_custom( $post_id );
2995 if ( !is_array( $custom_fields ) )
2998 foreach ( $custom_fields as $key => $val ) {
2999 if ( 'enclosure' != $key || !is_array( $val ) )
3001 foreach( $val as $enc ) {
3002 $enclosure = split( "\n", $enc );
3003 $pung[] = trim( $enclosure[ 0 ] );
3006 $pung = apply_filters('get_enclosed', $pung, $post_id);
3011 * Retrieve URLs already pinged for a post.
3016 * @param int $post_id Post ID.
3019 function get_pung($post_id) {
3021 $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
3022 $pung = trim($pung);
3023 $pung = preg_split('/\s/', $pung);
3024 $pung = apply_filters('get_pung', $pung);
3029 * Retrieve URLs that need to be pinged.
3034 * @param int $post_id Post ID
3037 function get_to_ping($post_id) {
3039 $to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id ));
3040 $to_ping = trim($to_ping);
3041 $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY);
3042 $to_ping = apply_filters('get_to_ping', $to_ping);
3047 * Do trackbacks for a list of URLs.
3051 * @param string $tb_list Comma separated list of URLs
3052 * @param int $post_id Post ID
3054 function trackback_url_list($tb_list, $post_id) {
3055 if ( ! empty( $tb_list ) ) {
3057 $postdata = wp_get_single_post($post_id, ARRAY_A);
3059 // import postdata as variables
3060 extract($postdata, EXTR_SKIP);
3063 $excerpt = strip_tags($post_excerpt ? $post_excerpt : $post_content);
3065 if (strlen($excerpt) > 255) {
3066 $excerpt = substr($excerpt,0,252) . '...';
3069 $trackback_urls = explode(',', $tb_list);
3070 foreach( (array) $trackback_urls as $tb_url) {
3071 $tb_url = trim($tb_url);
3072 trackback($tb_url, stripslashes($post_title), $excerpt, $post_id);
3082 * Get a list of page IDs.
3087 * @return array List of page IDs.
3089 function get_all_page_ids() {
3092 if ( ! $page_ids = wp_cache_get('all_page_ids', 'posts') ) {
3093 $page_ids = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE post_type = 'page'");
3094 wp_cache_add('all_page_ids', $page_ids, 'posts');
3101 * Retrieves page data given a page ID or page object.
3105 * @param mixed $page Page object or page ID. Passed by reference.
3106 * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N.
3107 * @param string $filter How the return value should be filtered.
3108 * @return mixed Page data.
3110 function &get_page(&$page, $output = OBJECT, $filter = 'raw') {
3111 $p = get_post($page, $output, $filter);
3116 * Retrieves a page given its path.
3121 * @param string $page_path Page path
3122 * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
3123 * @param string $post_type Optional. Post type. Default page.
3124 * @return mixed Null when complete.
3126 function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') {
3129 $page_path = rawurlencode(urldecode($page_path));
3130 $page_path = str_replace('%2F', '/', $page_path);
3131 $page_path = str_replace('%20', ' ', $page_path);
3132 $page_paths = '/' . trim($page_path, '/');
3133 $leaf_path = sanitize_title(basename($page_paths));
3134 $page_paths = explode('/', $page_paths);
3136 foreach ( (array) $page_paths as $pathdir )
3137 $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title($pathdir);
3139 $pages = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_name = %s AND (post_type = %s OR post_type = 'attachment')", $leaf_path, $post_type ));
3141 if ( empty($pages) )
3144 foreach ( $pages as $page ) {
3145 $path = '/' . $leaf_path;
3147 while ( $curpage->post_parent != 0 ) {
3148 $post_parent = $curpage->post_parent;
3149 $curpage = wp_cache_get( $post_parent, 'posts' );
3150 if ( false === $curpage )
3151 $curpage = $wpdb->get_row( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE ID = %d and post_type = %s", $post_parent, $post_type ) );
3152 $path = '/' . $curpage->post_name . $path;
3155 if ( $path == $full_path )
3156 return get_page($page->ID, $output, $post_type);
3163 * Retrieve a page given its title.
3168 * @param string $page_title Page title
3169 * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
3170 * @param string $post_type Optional. Post type. Default page.
3173 function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) {
3175 $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type= %s", $page_title, $post_type ) );
3177 return get_page($page, $output);
3183 * Retrieve child pages from list of pages matching page ID.
3185 * Matches against the pages parameter against the page ID. Also matches all
3186 * children for the same to retrieve all children of a page. Does not make any
3187 * SQL queries to get the children.
3191 * @param int $page_id Page ID.
3192 * @param array $pages List of pages' objects.
3195 function &get_page_children($page_id, $pages) {
3196 $page_list = array();
3197 foreach ( (array) $pages as $page ) {
3198 if ( $page->post_parent == $page_id ) {
3199 $page_list[] = $page;
3200 if ( $children = get_page_children($page->ID, $pages) )
3201 $page_list = array_merge($page_list, $children);
3208 * Order the pages with children under parents in a flat list.
3210 * It uses auxiliary structure to hold parent-children relationships and
3211 * runs in O(N) complexity
3215 * @param array $pages Posts array.
3216 * @param int $page_id Parent page ID.
3217 * @return array A list arranged by hierarchy. Children immediately follow their parents.
3219 function &get_page_hierarchy( &$pages, $page_id = 0 ) {
3220 if ( empty( $pages ) ) {
3225 $children = array();
3226 foreach ( (array) $pages as $p ) {
3227 $parent_id = intval( $p->post_parent );
3228 $children[ $parent_id ][] = $p;
3232 _page_traverse_name( $page_id, $children, $result );
3238 * function to traverse and return all the nested children post names of a root page.
3239 * $children contains parent-chilren relations
3243 function _page_traverse_name( $page_id, &$children, &$result ){
3244 if ( isset( $children[ $page_id ] ) ){
3245 foreach( (array)$children[ $page_id ] as $child ) {
3246 $result[ $child->ID ] = $child->post_name;
3247 _page_traverse_name( $child->ID, $children, $result );
3253 * Builds URI for a page.
3255 * Sub pages will be in the "directory" under the parent page post name.
3259 * @param mixed $page Page object or page ID.
3260 * @return string Page URI.
3262 function get_page_uri($page) {
3263 if ( ! is_object($page) )
3264 $page = get_page($page);
3265 $uri = $page->post_name;
3267 // A page cannot be it's own parent.
3268 if ( $page->post_parent == $page->ID )
3271 while ($page->post_parent != 0) {
3272 $page = get_page($page->post_parent);
3273 $uri = $page->post_name . "/" . $uri;
3280 * Retrieve a list of pages.
3282 * The defaults that can be overridden are the following: 'child_of',
3283 * 'sort_order', 'sort_column', 'post_title', 'hierarchical', 'exclude',
3284 * 'include', 'meta_key', 'meta_value','authors', 'number', and 'offset'.
3289 * @param mixed $args Optional. Array or string of options that overrides defaults.
3290 * @return array List of pages matching defaults or $args
3292 function &get_pages($args = '') {
3296 'child_of' => 0, 'sort_order' => 'ASC',
3297 'sort_column' => 'post_title', 'hierarchical' => 1,
3298 'exclude' => array(), 'include' => array(),
3299 'meta_key' => '', 'meta_value' => '',
3300 'authors' => '', 'parent' => -1, 'exclude_tree' => '',
3301 'number' => '', 'offset' => 0,
3302 'post_type' => 'page', 'post_status' => 'publish',
3305 $r = wp_parse_args( $args, $defaults );
3306 extract( $r, EXTR_SKIP );
3307 $number = (int) $number;
3308 $offset = (int) $offset;
3310 // Make sure the post type is hierarchical
3311 $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
3312 if ( !in_array( $post_type, $hierarchical_post_types ) )
3315 // Make sure we have a valid post status
3316 if ( !in_array($post_status, get_post_stati()) )
3320 $key = md5( serialize( compact(array_keys($defaults)) ) );
3321 if ( $cache = wp_cache_get( 'get_pages', 'posts' ) ) {
3322 if ( is_array($cache) && isset( $cache[ $key ] ) ) {
3323 $pages = apply_filters('get_pages', $cache[ $key ], $r );
3328 if ( !is_array($cache) )
3332 if ( !empty($include) ) {
3333 $child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
3338 $hierarchical = false;
3339 $incpages = wp_parse_id_list( $include );
3340 if ( ! empty( $incpages ) ) {
3341 foreach ( $incpages as $incpage ) {
3342 if (empty($inclusions))
3343 $inclusions = $wpdb->prepare(' AND ( ID = %d ', $incpage);
3345 $inclusions .= $wpdb->prepare(' OR ID = %d ', $incpage);
3349 if (!empty($inclusions))
3353 if ( !empty($exclude) ) {
3354 $expages = wp_parse_id_list( $exclude );
3355 if ( ! empty( $expages ) ) {
3356 foreach ( $expages as $expage ) {
3357 if (empty($exclusions))
3358 $exclusions = $wpdb->prepare(' AND ( ID <> %d ', $expage);
3360 $exclusions .= $wpdb->prepare(' AND ID <> %d ', $expage);
3364 if (!empty($exclusions))
3368 if (!empty($authors)) {
3369 $post_authors = preg_split('/[\s,]+/',$authors);
3371 if ( ! empty( $post_authors ) ) {
3372 foreach ( $post_authors as $post_author ) {
3373 //Do we have an author id or an author login?
3374 if ( 0 == intval($post_author) ) {
3375 $post_author = get_userdatabylogin($post_author);
3376 if ( empty($post_author) )
3378 if ( empty($post_author->ID) )
3380 $post_author = $post_author->ID;
3383 if ( '' == $author_query )
3384 $author_query = $wpdb->prepare(' post_author = %d ', $post_author);
3386 $author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author);
3388 if ( '' != $author_query )
3389 $author_query = " AND ($author_query)";
3394 $where = "$exclusions $inclusions ";
3395 if ( ! empty( $meta_key ) || ! empty( $meta_value ) ) {
3396 $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )";
3398 // meta_key and meta_value might be slashed
3399 $meta_key = stripslashes($meta_key);
3400 $meta_value = stripslashes($meta_value);
3401 if ( ! empty( $meta_key ) )
3402 $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key);
3403 if ( ! empty( $meta_value ) )
3404 $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value);
3409 $where .= $wpdb->prepare(' AND post_parent = %d ', $parent);
3411 $where_post_type = $wpdb->prepare( "post_type = '%s' AND post_status = '%s'", $post_type, $post_status );
3413 $query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where ";
3414 $query .= $author_query;
3415 $query .= " ORDER BY " . $sort_column . " " . $sort_order ;
3417 if ( !empty($number) )
3418 $query .= ' LIMIT ' . $offset . ',' . $number;
3420 $pages = $wpdb->get_results($query);
3422 if ( empty($pages) ) {
3423 $pages = apply_filters('get_pages', array(), $r);
3427 // Sanitize before caching so it'll only get done once
3428 $num_pages = count($pages);
3429 for ($i = 0; $i < $num_pages; $i++) {
3430 $pages[$i] = sanitize_post($pages[$i], 'raw');
3434 update_page_cache($pages);
3436 if ( $child_of || $hierarchical )
3437 $pages = & get_page_children($child_of, $pages);
3439 if ( !empty($exclude_tree) ) {
3440 $exclude = (int) $exclude_tree;
3441 $children = get_page_children($exclude, $pages);
3442 $excludes = array();
3443 foreach ( $children as $child )
3444 $excludes[] = $child->ID;
3445 $excludes[] = $exclude;
3446 $num_pages = count($pages);
3447 for ( $i = 0; $i < $num_pages; $i++ ) {
3448 if ( in_array($pages[$i]->ID, $excludes) )
3453 $cache[ $key ] = $pages;
3454 wp_cache_set( 'get_pages', $cache, 'posts' );
3456 $pages = apply_filters('get_pages', $pages, $r);
3462 // Attachment functions
3466 * Check if the attachment URI is local one and is really an attachment.
3470 * @param string $url URL to check
3471 * @return bool True on success, false on failure.
3473 function is_local_attachment($url) {
3474 if (strpos($url, home_url()) === false)
3476 if (strpos($url, home_url('/?attachment_id=')) !== false)
3478 if ( $id = url_to_postid($url) ) {
3479 $post = & get_post($id);
3480 if ( 'attachment' == $post->post_type )
3487 * Insert an attachment.
3489 * If you set the 'ID' in the $object parameter, it will mean that you are
3490 * updating and attempt to update the attachment. You can also set the
3491 * attachment name or title by setting the key 'post_name' or 'post_title'.
3493 * You can set the dates for the attachment manually by setting the 'post_date'
3494 * and 'post_date_gmt' keys' values.
3496 * By default, the comments will use the default settings for whether the
3497 * comments are allowed. You can close them manually or keep them open by
3498 * setting the value for the 'comment_status' key.
3500 * The $object parameter can have the following:
3501 * 'post_status' - Default is 'draft'. Can not be overridden, set the same as parent post.
3502 * 'post_type' - Default is 'post', will be set to attachment. Can not override.
3503 * 'post_author' - Default is current user ID. The ID of the user, who added the attachment.
3504 * 'ping_status' - Default is the value in default ping status option. Whether the attachment
3506 * 'post_parent' - Default is 0. Can use $parent parameter or set this for the post it belongs
3508 * 'menu_order' - Default is 0. The order it is displayed.
3509 * 'to_ping' - Whether to ping.
3510 * 'pinged' - Default is empty string.
3511 * 'post_password' - Default is empty string. The password to access the attachment.
3512 * 'guid' - Global Unique ID for referencing the attachment.
3513 * 'post_content_filtered' - Attachment post content filtered.
3514 * 'post_excerpt' - Attachment excerpt.
3519 * @uses do_action() Calls 'edit_attachment' on $post_ID if this is an update.
3520 * @uses do_action() Calls 'add_attachment' on $post_ID if this is not an update.
3522 * @param string|array $object Arguments to override defaults.
3523 * @param string $file Optional filename.
3524 * @param int $parent Parent post ID.
3525 * @return int Attachment ID.
3527 function wp_insert_attachment($object, $file = false, $parent = 0) {
3528 global $wpdb, $user_ID;
3530 $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID,
3531 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
3532 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '',
3533 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0);
3535 $object = wp_parse_args($object, $defaults);
3536 if ( !empty($parent) )
3537 $object['post_parent'] = $parent;
3539 $object = sanitize_post($object, 'db');
3541 // export array as variables
3542 extract($object, EXTR_SKIP);
3544 if ( empty($post_author) )
3545 $post_author = $user_ID;
3547 $post_type = 'attachment';
3548 $post_status = 'inherit';
3550 // Make sure we set a valid category.
3551 if ( !isset($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
3552 // 'post' requires at least one category.
3553 if ( 'post' == $post_type )
3554 $post_category = array( get_option('default_category') );
3556 $post_category = array();
3559 // Are we updating or creating?
3560 if ( !empty($ID) ) {
3562 $post_ID = (int) $ID;
3568 // Create a valid post name.
3569 if ( empty($post_name) )
3570 $post_name = sanitize_title($post_title);
3572 $post_name = sanitize_title($post_name);
3574 // expected_slashed ($post_name)
3575 $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
3577 if ( empty($post_date) )
3578 $post_date = current_time('mysql');
3579 if ( empty($post_date_gmt) )
3580 $post_date_gmt = current_time('mysql', 1);
3582 if ( empty($post_modified) )
3583 $post_modified = $post_date;
3584 if ( empty($post_modified_gmt) )
3585 $post_modified_gmt = $post_date_gmt;
3587 if ( empty($comment_status) ) {
3589 $comment_status = 'closed';
3591 $comment_status = get_option('default_comment_status');
3593 if ( empty($ping_status) )
3594 $ping_status = get_option('default_ping_status');
3596 if ( isset($to_ping) )
3597 $to_ping = preg_replace('|\s+|', "\n", $to_ping);
3601 if ( isset($post_parent) )
3602 $post_parent = (int) $post_parent;
3606 if ( isset($menu_order) )
3607 $menu_order = (int) $menu_order;
3611 if ( !isset($post_password) )
3612 $post_password = '';
3614 if ( ! isset($pinged) )
3617 // expected_slashed (everything!)
3618 $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' ) );
3619 $data = stripslashes_deep( $data );
3622 $wpdb->update( $wpdb->posts, $data, array( 'ID' => $post_ID ) );
3624 // If there is a suggested ID, use it if not already present
3625 if ( !empty($import_id) ) {
3626 $import_id = (int) $import_id;
3627 if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
3628 $data['ID'] = $import_id;
3632 $wpdb->insert( $wpdb->posts, $data );
3633 $post_ID = (int) $wpdb->insert_id;
3636 if ( empty($post_name) ) {
3637 $post_name = sanitize_title($post_title, $post_ID);
3638 $wpdb->update( $wpdb->posts, compact("post_name"), array( 'ID' => $post_ID ) );
3641 wp_set_post_categories($post_ID, $post_category);
3644 update_attached_file( $post_ID, $file );
3646 clean_post_cache($post_ID);
3648 if ( isset($post_parent) && $post_parent < 0 )
3649 add_post_meta($post_ID, '_wp_attachment_temp_parent', $post_parent, true);
3652 do_action('edit_attachment', $post_ID);
3654 do_action('add_attachment', $post_ID);
3661 * Trashes or deletes an attachment.
3663 * When an attachment is permanently deleted, the file will also be removed.
3664 * Deletion removes all post meta fields, taxonomy, comments, etc. associated
3665 * with the attachment (except the main post).
3667 * The attachment is moved to the trash instead of permanently deleted unless trash
3668 * for media is disabled, item is already in the trash, or $force_delete is true.
3672 * @uses do_action() Calls 'delete_attachment' hook on Attachment ID.
3674 * @param int $post_id Attachment ID.
3675 * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
3676 * @return mixed False on failure. Post data on success.
3678 function wp_delete_attachment( $post_id, $force_delete = false ) {
3681 if ( !$post = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $post_id) ) )
3684 if ( 'attachment' != $post->post_type )
3687 if ( !$force_delete && EMPTY_TRASH_DAYS && MEDIA_TRASH && 'trash' != $post->post_status )
3688 return wp_trash_post( $post_id );
3690 delete_post_meta($post_id, '_wp_trash_meta_status');
3691 delete_post_meta($post_id, '_wp_trash_meta_time');
3693 $meta = wp_get_attachment_metadata( $post_id );
3694 $backup_sizes = get_post_meta( $post->ID, '_wp_attachment_backup_sizes', true );
3695 $file = get_attached_file( $post_id );
3697 if ( is_multisite() )
3698 delete_transient( 'dirsize_cache' );
3700 do_action('delete_attachment', $post_id);
3702 wp_delete_object_term_relationships($post_id, array('category', 'post_tag'));
3703 wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type));
3705 $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE meta_key = '_thumbnail_id' AND meta_value = %d", $post_id ));
3707 $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id ));
3708 if ( ! empty( $comment_ids ) ) {
3709 do_action( 'delete_comment', $comment_ids );
3710 foreach ( $comment_ids as $comment_id )
3711 wp_delete_comment( $comment_id, true );
3712 do_action( 'deleted_comment', $comment_ids );
3715 $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $post_id ));
3716 if ( !empty($post_meta_ids) ) {
3717 do_action( 'delete_postmeta', $post_meta_ids );
3718 $in_post_meta_ids = "'" . implode("', '", $post_meta_ids) . "'";
3719 $wpdb->query( "DELETE FROM $wpdb->postmeta WHERE meta_id IN($in_post_meta_ids)" );
3720 do_action( 'deleted_postmeta', $post_meta_ids );
3723 do_action( 'delete_post', $post_id );
3724 $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->posts WHERE ID = %d", $post_id ));
3725 do_action( 'deleted_post', $post_id );
3727 $uploadpath = wp_upload_dir();
3729 if ( ! empty($meta['thumb']) ) {
3730 // Don't delete the thumb if another attachment uses it
3731 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)) ) {
3732 $thumbfile = str_replace(basename($file), $meta['thumb'], $file);
3733 $thumbfile = apply_filters('wp_delete_file', $thumbfile);
3734 @ unlink( path_join($uploadpath['basedir'], $thumbfile) );
3738 // remove intermediate and backup images if there are any
3739 foreach ( get_intermediate_image_sizes() as $size ) {
3740 if ( $intermediate = image_get_intermediate_size($post_id, $size) ) {
3741 $intermediate_file = apply_filters('wp_delete_file', $intermediate['path']);
3742 @ unlink( path_join($uploadpath['basedir'], $intermediate_file) );
3746 if ( is_array($backup_sizes) ) {
3747 foreach ( $backup_sizes as $size ) {
3748 $del_file = path_join( dirname($meta['file']), $size['file'] );
3749 $del_file = apply_filters('wp_delete_file', $del_file);
3750 @ unlink( path_join($uploadpath['basedir'], $del_file) );
3754 $file = apply_filters('wp_delete_file', $file);
3756 if ( ! empty($file) )
3759 clean_post_cache($post_id);
3765 * Retrieve attachment meta field for attachment ID.
3769 * @param int $post_id Attachment ID
3770 * @param bool $unfiltered Optional, default is false. If true, filters are not run.
3771 * @return string|bool Attachment meta field. False on failure.
3773 function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
3774 $post_id = (int) $post_id;
3775 if ( !$post =& get_post( $post_id ) )
3778 $data = get_post_meta( $post->ID, '_wp_attachment_metadata', true );
3783 return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID );
3787 * Update metadata for an attachment.
3791 * @param int $post_id Attachment ID.
3792 * @param array $data Attachment data.
3795 function wp_update_attachment_metadata( $post_id, $data ) {
3796 $post_id = (int) $post_id;
3797 if ( !$post =& get_post( $post_id ) )
3800 $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID );
3802 return update_post_meta( $post->ID, '_wp_attachment_metadata', $data);
3806 * Retrieve the URL for an attachment.
3810 * @param int $post_id Attachment ID.
3813 function wp_get_attachment_url( $post_id = 0 ) {
3814 $post_id = (int) $post_id;
3815 if ( !$post =& get_post( $post_id ) )
3819 if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) { //Get attached file
3820 if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { //Get upload directory
3821 if ( 0 === strpos($file, $uploads['basedir']) ) //Check that the upload base exists in the file location
3822 $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file); //replace file location with url location
3823 elseif ( false !== strpos($file, 'wp-content/uploads') )
3824 $url = $uploads['baseurl'] . substr( $file, strpos($file, 'wp-content/uploads') + 18 );
3826 $url = $uploads['baseurl'] . "/$file"; //Its a newly uploaded file, therefor $file is relative to the basedir.
3830 if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recomended to rely upon this.
3831 $url = get_the_guid( $post->ID );
3833 $url = apply_filters( 'wp_get_attachment_url', $url, $post->ID );
3835 if ( 'attachment' != $post->post_type || empty( $url ) )
3842 * Retrieve thumbnail for an attachment.
3846 * @param int $post_id Attachment ID.
3847 * @return mixed False on failure. Thumbnail file path on success.
3849 function wp_get_attachment_thumb_file( $post_id = 0 ) {
3850 $post_id = (int) $post_id;
3851 if ( !$post =& get_post( $post_id ) )
3853 if ( !is_array( $imagedata = wp_get_attachment_metadata( $post->ID ) ) )
3856 $file = get_attached_file( $post->ID );
3858 if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) )
3859 return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );
3864 * Retrieve URL for an attachment thumbnail.
3868 * @param int $post_id Attachment ID
3869 * @return string|bool False on failure. Thumbnail URL on success.
3871 function wp_get_attachment_thumb_url( $post_id = 0 ) {
3872 $post_id = (int) $post_id;
3873 if ( !$post =& get_post( $post_id ) )
3875 if ( !$url = wp_get_attachment_url( $post->ID ) )
3878 $sized = image_downsize( $post_id, 'thumbnail' );
3882 if ( !$thumb = wp_get_attachment_thumb_file( $post->ID ) )
3885 $url = str_replace(basename($url), basename($thumb), $url);
3887 return apply_filters( 'wp_get_attachment_thumb_url', $url, $post->ID );
3891 * Check if the attachment is an image.
3895 * @param int $post_id Attachment ID
3898 function wp_attachment_is_image( $post_id = 0 ) {
3899 $post_id = (int) $post_id;
3900 if ( !$post =& get_post( $post_id ) )
3903 if ( !$file = get_attached_file( $post->ID ) )
3906 $ext = preg_match('/\.([^.]+)$/', $file, $matches) ? strtolower($matches[1]) : false;
3908 $image_exts = array('jpg', 'jpeg', 'gif', 'png');
3910 if ( 'image/' == substr($post->post_mime_type, 0, 6) || $ext && 'import' == $post->post_mime_type && in_array($ext, $image_exts) )
3916 * Retrieve the icon for a MIME type.
3920 * @param string $mime MIME type
3921 * @return string|bool
3923 function wp_mime_type_icon( $mime = 0 ) {
3924 if ( !is_numeric($mime) )
3925 $icon = wp_cache_get("mime_type_icon_$mime");
3926 if ( empty($icon) ) {
3928 $post_mimes = array();
3929 if ( is_numeric($mime) ) {
3930 $mime = (int) $mime;
3931 if ( $post =& get_post( $mime ) ) {
3932 $post_id = (int) $post->ID;
3933 $ext = preg_replace('/^.+?\.([^.]+)$/', '$1', $post->guid);
3934 if ( !empty($ext) ) {
3935 $post_mimes[] = $ext;
3936 if ( $ext_type = wp_ext2type( $ext ) )
3937 $post_mimes[] = $ext_type;
3939 $mime = $post->post_mime_type;
3944 $post_mimes[] = $mime;
3947 $icon_files = wp_cache_get('icon_files');
3949 if ( !is_array($icon_files) ) {
3950 $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' );
3951 $icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url('images/crystal') );
3952 $dirs = apply_filters( 'icon_dirs', array($icon_dir => $icon_dir_uri) );
3953 $icon_files = array();
3955 $dir = array_shift($keys = array_keys($dirs));
3956 $uri = array_shift($dirs);
3957 if ( $dh = opendir($dir) ) {
3958 while ( false !== $file = readdir($dh) ) {
3959 $file = basename($file);
3960 if ( substr($file, 0, 1) == '.' )
3962 if ( !in_array(strtolower(substr($file, -4)), array('.png', '.gif', '.jpg') ) ) {
3963 if ( is_dir("$dir/$file") )
3964 $dirs["$dir/$file"] = "$uri/$file";
3967 $icon_files["$dir/$file"] = "$uri/$file";
3972 wp_cache_set('icon_files', $icon_files, 600);
3975 // Icon basename - extension = MIME wildcard
3976 foreach ( $icon_files as $file => $uri )
3977 $types[ preg_replace('/^([^.]*).*$/', '$1', basename($file)) ] =& $icon_files[$file];
3979 if ( ! empty($mime) ) {
3980 $post_mimes[] = substr($mime, 0, strpos($mime, '/'));
3981 $post_mimes[] = substr($mime, strpos($mime, '/') + 1);
3982 $post_mimes[] = str_replace('/', '_', $mime);
3985 $matches = wp_match_mime_types(array_keys($types), $post_mimes);
3986 $matches['default'] = array('default');
3988 foreach ( $matches as $match => $wilds ) {
3989 if ( isset($types[$wilds[0]])) {
3990 $icon = $types[$wilds[0]];
3991 if ( !is_numeric($mime) )
3992 wp_cache_set("mime_type_icon_$mime", $icon);
3998 return apply_filters( 'wp_mime_type_icon', $icon, $mime, $post_id ); // Last arg is 0 if function pass mime type.
4002 * Checked for changed slugs for published post objects and save the old slug.
4004 * The function is used when a post object of any type is updated,
4005 * by comparing the current and previous post objects.
4007 * If the slug was changed and not already part of the old slugs then it will be
4008 * added to the post meta field ('_wp_old_slug') for storing old slugs for that
4011 * The most logically usage of this function is redirecting changed post objects, so
4012 * that those that linked to an changed post will be redirected to the new post.
4016 * @param int $post_id Post ID.
4017 * @param object $post The Post Object
4018 * @param object $post_before The Previous Post Object
4019 * @return int Same as $post_id
4021 function wp_check_for_changed_slugs($post_id, $post, $post_before) {
4022 // dont bother if it hasnt changed
4023 if ( $post->post_name == $post_before->post_name )
4026 // we're only concerned with published, non-hierarchical objects
4027 if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) )
4030 $old_slugs = (array) get_post_meta($post_id, '_wp_old_slug');
4032 // if we haven't added this old slug before, add it now
4033 if ( !empty( $post_before->post_name ) && !in_array($post_before->post_name, $old_slugs) )
4034 add_post_meta($post_id, '_wp_old_slug', $post_before->post_name);
4036 // if the new slug was used previously, delete it from the list
4037 if ( in_array($post->post_name, $old_slugs) )
4038 delete_post_meta($post_id, '_wp_old_slug', $post->post_name);
4042 * Retrieve the private post SQL based on capability.
4044 * This function provides a standardized way to appropriately select on the
4045 * post_status of posts/pages. The function will return a piece of SQL code that
4046 * can be added to a WHERE clause; this SQL is constructed to allow all
4047 * published posts, and all private posts to which the user has access.
4049 * It also allows plugins that define their own post type to control the cap by
4050 * using the hook 'pub_priv_sql_capability'. The plugin is expected to return
4051 * the capability the user must have to read the private post type.
4056 * @uses apply_filters() Call 'pub_priv_sql_capability' filter for plugins with different post types.
4058 * @param string $post_type currently only supports 'post' or 'page'.
4059 * @return string SQL code that can be added to a where clause.
4061 function get_private_posts_cap_sql($post_type) {
4062 return get_posts_by_author_sql($post_type, FALSE);
4066 * Retrieve the post SQL based on capability, author, and type.
4068 * See above for full description.
4071 * @param string $post_type currently only supports 'post' or 'page'.
4072 * @param bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term.
4073 * @param int $post_author Optional. Query posts having a single author ID.
4074 * @return string SQL WHERE code that can be added to a query.
4076 function get_posts_by_author_sql($post_type, $full = TRUE, $post_author = NULL) {
4077 global $user_ID, $wpdb;
4080 if ($post_type == 'post') {
4081 $cap = 'read_private_posts';
4083 } elseif ($post_type == 'page') {
4084 $cap = 'read_private_pages';
4085 // Dunno what it is, maybe plugins have their own post type?
4088 $cap = apply_filters('pub_priv_sql_capability', $cap);
4091 // We don't know what it is, filters don't change anything,
4092 // so set the SQL up to return nothing.
4098 if (is_null($post_author)) {
4099 $sql = $wpdb->prepare('WHERE post_type = %s AND ', $post_type);
4101 $sql = $wpdb->prepare('WHERE post_author = %d AND post_type = %s AND ', $post_author, $post_type);
4107 $sql .= "(post_status = 'publish'";
4109 if (current_user_can($cap)) {
4110 // Does the user have the capability to view private posts? Guess so.
4111 $sql .= " OR post_status = 'private'";
4112 } elseif (is_user_logged_in()) {
4113 // Users can view their own private posts.
4114 $id = (int) $user_ID;
4115 if (is_null($post_author) || !$full) {
4116 $sql .= " OR post_status = 'private' AND post_author = $id";
4117 } elseif ($id == (int)$post_author) {
4118 $sql .= " OR post_status = 'private'";
4128 * Retrieve the date that the last post was published.
4130 * The server timezone is the default and is the difference between GMT and
4131 * server time. The 'blog' value is the date when the last post was posted. The
4132 * 'gmt' is when the last post was posted in GMT formatted date.
4136 * @uses apply_filters() Calls 'get_lastpostdate' filter
4138 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
4139 * @return string The date of the last post.
4141 function get_lastpostdate($timezone = 'server') {
4142 return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date' ), $timezone );
4146 * Retrieve last post modified date depending on timezone.
4148 * The server timezone is the default and is the difference between GMT and
4149 * server time. The 'blog' value is just when the last post was modified. The
4150 * 'gmt' is when the last post was modified in GMT time.
4153 * @uses apply_filters() Calls 'get_lastpostmodified' filter
4155 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
4156 * @return string The date the post was last modified.
4158 function get_lastpostmodified($timezone = 'server') {
4159 $lastpostmodified = _get_last_post_time( $timezone, 'modified' );
4161 $lastpostdate = get_lastpostdate($timezone);
4162 if ( $lastpostdate > $lastpostmodified )
4163 $lastpostmodified = $lastpostdate;
4165 return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
4169 * Retrieve latest post date data based on timezone.
4174 * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
4175 * @param string $field Field to check. Can be 'date' or 'modified'.
4176 * @return string The date.
4178 function _get_last_post_time( $timezone, $field ) {
4181 if ( !in_array( $field, array( 'date', 'modified' ) ) )
4184 $timezone = strtolower( $timezone );
4186 $key = "lastpost{$field}:$timezone";
4188 $date = wp_cache_get( $key, 'timeinfo' );
4191 $add_seconds_server = date('Z');
4193 $post_types = get_post_types( array( 'publicly_queryable' => true ) );
4194 array_walk( $post_types, array( &$wpdb, 'escape_by_ref' ) );
4195 $post_types = "'" . implode( "', '", $post_types ) . "'";
4197 switch ( $timezone ) {
4199 $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");
4202 $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");
4205 $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");
4210 wp_cache_set( $key, $date, 'timeinfo' );
4217 * Updates posts in cache.
4219 * @usedby update_page_cache() Aliased by this function.
4221 * @package WordPress
4225 * @param array $posts Array of post objects
4227 function update_post_cache(&$posts) {
4231 foreach ( $posts as $post )
4232 wp_cache_add($post->ID, $post, 'posts');
4236 * Will clean the post in the cache.
4238 * Cleaning means delete from the cache of the post. Will call to clean the term
4239 * object cache associated with the post ID.
4241 * clean_post_cache() will call itself recursively for each child post.
4243 * This function not run if $_wp_suspend_cache_invalidation is not empty. See
4244 * wp_suspend_cache_invalidation().
4246 * @package WordPress
4250 * @uses do_action() Calls 'clean_post_cache' on $id before adding children (if any).
4252 * @param int $id The Post ID in the cache to clean
4254 function clean_post_cache($id) {
4255 global $_wp_suspend_cache_invalidation, $wpdb;
4257 if ( !empty($_wp_suspend_cache_invalidation) )
4265 wp_cache_delete($id, 'posts');
4266 wp_cache_delete($id, 'post_meta');
4268 clean_object_term_cache($id, 'post');
4270 wp_cache_delete( 'wp_get_archives', 'general' );
4272 do_action('clean_post_cache', $id);
4274 if ( $children = $wpdb->get_col( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_parent = %d", $id) ) ) {
4275 foreach ( $children as $cid ) {
4279 clean_post_cache( $cid );
4283 if ( is_multisite() )
4284 wp_cache_delete( $wpdb->blogid . '-' . $id, 'global-posts' );
4288 * Alias of update_post_cache().
4290 * @see update_post_cache() Posts and pages are the same, alias is intentional
4292 * @package WordPress
4296 * @param array $pages list of page objects
4298 function update_page_cache(&$pages) {
4299 update_post_cache($pages);
4303 * Will clean the page in the cache.
4305 * Clean (read: delete) page from cache that matches $id. Will also clean cache
4306 * associated with 'all_page_ids' and 'get_pages'.
4308 * @package WordPress
4312 * @uses do_action() Will call the 'clean_page_cache' hook action.
4314 * @param int $id Page ID to clean
4316 function clean_page_cache($id) {
4317 clean_post_cache($id);
4319 wp_cache_delete( 'all_page_ids', 'posts' );
4320 wp_cache_delete( 'get_pages', 'posts' );
4322 do_action('clean_page_cache', $id);
4326 * Call major cache updating functions for list of Post objects.
4328 * @package WordPress
4333 * @uses update_post_cache()
4334 * @uses update_object_term_cache()
4335 * @uses update_postmeta_cache()
4337 * @param array $posts Array of Post objects
4338 * @param string $post_type The post type of the posts in $posts. Default is 'post'.
4339 * @param bool $update_term_cache Whether to update the term cache. Default is true.
4340 * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
4342 function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) {
4343 // No point in doing all this work if we didn't match any posts.
4347 update_post_cache($posts);
4349 $post_ids = array();
4350 foreach ( $posts as $post )
4351 $post_ids[] = $post->ID;
4353 if ( empty($post_type) )
4354 $post_type = 'post';
4356 if ( $update_term_cache ) {
4357 if ( is_array($post_type) ) {
4358 $ptypes = $post_type;
4359 } elseif ( 'any' == $post_type ) {
4360 // Just use the post_types in the supplied posts.
4361 foreach ( $posts as $post )
4362 $ptypes[] = $post->post_type;
4363 $ptypes = array_unique($ptypes);
4365 $ptypes = array($post_type);
4368 if ( ! empty($ptypes) )
4369 update_object_term_cache($post_ids, $ptypes);
4372 if ( $update_meta_cache )
4373 update_postmeta_cache($post_ids);
4377 * Updates metadata cache for list of post IDs.
4379 * Performs SQL query to retrieve the metadata for the post IDs and updates the
4380 * metadata cache for the posts. Therefore, the functions, which call this
4381 * function, do not need to perform SQL queries on their own.
4383 * @package WordPress
4389 * @param array $post_ids List of post IDs.
4390 * @return bool|array Returns false if there is nothing to update or an array of metadata.
4392 function update_postmeta_cache($post_ids) {
4393 return update_meta_cache('post', $post_ids);
4397 * Will clean the attachment in the cache.
4399 * Cleaning means delete from the cache. Optionaly will clean the term
4400 * object cache associated with the attachment ID.
4402 * This function will not run if $_wp_suspend_cache_invalidation is not empty. See
4403 * wp_suspend_cache_invalidation().
4405 * @package WordPress
4409 * @uses do_action() Calls 'clean_attachment_cache' on $id.
4411 * @param int $id The attachment ID in the cache to clean
4412 * @param bool $clean_terms optional. Whether to clean terms cache
4414 function clean_attachment_cache($id, $clean_terms = false) {
4415 global $_wp_suspend_cache_invalidation;
4417 if ( !empty($_wp_suspend_cache_invalidation) )
4422 wp_cache_delete($id, 'posts');
4423 wp_cache_delete($id, 'post_meta');
4426 clean_object_term_cache($id, 'attachment');
4428 do_action('clean_attachment_cache', $id);
4436 * Hook for managing future post transitions to published.
4441 * @uses do_action() Calls 'private_to_published' on post ID if this is a 'private_to_published' call.
4442 * @uses wp_clear_scheduled_hook() with 'publish_future_post' and post ID.
4444 * @param string $new_status New post status
4445 * @param string $old_status Previous post status
4446 * @param object $post Object type containing the post information
4448 function _transition_post_status($new_status, $old_status, $post) {
4451 if ( $old_status != 'publish' && $new_status == 'publish' ) {
4452 // Reset GUID if transitioning to publish and it is empty
4453 if ( '' == get_the_guid($post->ID) )
4454 $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post->ID ) ), array( 'ID' => $post->ID ) );
4455 do_action('private_to_published', $post->ID); // Deprecated, use private_to_publish
4458 // If published posts changed clear the lastpostmodified cache
4459 if ( 'publish' == $new_status || 'publish' == $old_status) {
4460 foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
4461 wp_cache_delete( "lastpostmodified:$timezone", 'timeinfo' );
4462 wp_cache_delete( "lastpostdate:$timezone", 'timeinfo' );
4466 // Always clears the hook in case the post status bounced from future to draft.
4467 wp_clear_scheduled_hook('publish_future_post', array( $post->ID ) );
4471 * Hook used to schedule publication for a post marked for the future.
4473 * The $post properties used and must exist are 'ID' and 'post_date_gmt'.
4478 * @param int $deprecated Not used. Can be set to null. Never implemented.
4479 * Not marked as deprecated with _deprecated_argument() as it conflicts with
4480 * wp_transition_post_status() and the default filter for _future_post_hook().
4481 * @param object $post Object type containing the post information
4483 function _future_post_hook( $deprecated = '', $post ) {
4484 wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) );
4485 wp_schedule_single_event( strtotime( get_gmt_from_date( $post->post_date ) . ' GMT') , 'publish_future_post', array( $post->ID ) );
4489 * Hook to schedule pings and enclosures when a post is published.
4494 * @uses XMLRPC_REQUEST and APP_REQUEST constants.
4495 * @uses do_action() Calls 'xmlprc_publish_post' on post ID if XMLRPC_REQUEST is defined.
4496 * @uses do_action() Calls 'app_publish_post' on post ID if APP_REQUEST is defined.
4498 * @param int $post_id The ID in the database table of the post being published
4500 function _publish_post_hook($post_id) {
4503 if ( defined('XMLRPC_REQUEST') )
4504 do_action('xmlrpc_publish_post', $post_id);
4505 if ( defined('APP_REQUEST') )
4506 do_action('app_publish_post', $post_id);
4508 if ( defined('WP_IMPORTING') )
4511 $data = array( 'post_id' => $post_id, 'meta_value' => '1' );
4512 if ( get_option('default_pingback_flag') ) {
4513 $wpdb->insert( $wpdb->postmeta, $data + array( 'meta_key' => '_pingme' ) );
4514 do_action( 'added_postmeta', $wpdb->insert_id, $post_id, '_pingme', 1 );
4516 $wpdb->insert( $wpdb->postmeta, $data + array( 'meta_key' => '_encloseme' ) );
4517 do_action( 'added_postmeta', $wpdb->insert_id, $post_id, '_encloseme', 1 );
4519 wp_schedule_single_event(time(), 'do_pings');
4523 * Hook used to prevent page/post cache and rewrite rules from staying dirty.
4525 * Does two things. If the post is a page and has a template then it will
4526 * update/add that template to the meta. For both pages and posts, it will clean
4527 * the post cache to make sure that the cache updates to the changes done
4528 * recently. For pages, the rewrite rules of WordPress are flushed to allow for
4531 * The $post parameter, only uses 'post_type' property and 'page_template'
4536 * @uses $wp_rewrite Flushes Rewrite Rules.
4538 * @param int $post_id The ID in the database table for the $post
4539 * @param object $post Object type containing the post information
4541 function _save_post_hook($post_id, $post) {
4542 if ( $post->post_type == 'page' ) {
4543 clean_page_cache($post_id);
4544 // Avoid flushing rules for every post during import.
4545 if ( !defined('WP_IMPORTING') ) {
4547 $wp_rewrite->flush_rules(false);
4550 clean_post_cache($post_id);
4555 * Retrieve post ancestors and append to post ancestors property.
4557 * Will only retrieve ancestors once, if property is already set, then nothing
4558 * will be done. If there is not a parent post, or post ID and post parent ID
4559 * are the same then nothing will be done.
4561 * The parameter is passed by reference, so nothing needs to be returned. The
4562 * property will be updated and can be referenced after the function is
4563 * complete. The post parent will be an ancestor and the parent of the post
4564 * parent will be an ancestor. There will only be two ancestors at the most.
4570 * @param object $_post Post data.
4571 * @return null When nothing needs to be done.
4573 function _get_post_ancestors(&$_post) {
4576 if ( isset($_post->ancestors) )
4579 $_post->ancestors = array();
4581 if ( empty($_post->post_parent) || $_post->ID == $_post->post_parent )
4584 $id = $_post->ancestors[] = $_post->post_parent;
4585 while ( $ancestor = $wpdb->get_var( $wpdb->prepare("SELECT `post_parent` FROM $wpdb->posts WHERE ID = %d LIMIT 1", $id) ) ) {
4586 // Loop detection: If the ancestor has been seen before, break.
4587 if ( ( $ancestor == $_post->ID ) || in_array($ancestor, $_post->ancestors) )
4589 $id = $_post->ancestors[] = $ancestor;
4594 * Determines which fields of posts are to be saved in revisions.
4596 * Does two things. If passed a post *array*, it will return a post array ready
4597 * to be insterted into the posts table as a post revision. Otherwise, returns
4598 * an array whose keys are the post fields to be saved for post revisions.
4600 * @package WordPress
4601 * @subpackage Post_Revisions
4604 * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields.
4606 * @param array $post Optional a post array to be processed for insertion as a post revision.
4607 * @param bool $autosave optional Is the revision an autosave?
4608 * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
4610 function _wp_post_revision_fields( $post = null, $autosave = false ) {
4611 static $fields = false;
4614 // Allow these to be versioned
4616 'post_title' => __( 'Title' ),
4617 'post_content' => __( 'Content' ),
4618 'post_excerpt' => __( 'Excerpt' ),
4622 $fields = apply_filters( '_wp_post_revision_fields', $fields );
4624 // WP uses these internally either in versioning or elsewhere - they cannot be versioned
4625 foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect )
4626 unset( $fields[$protect] );
4629 if ( !is_array($post) )
4633 foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field )
4634 $return[$field] = $post[$field];
4636 $return['post_parent'] = $post['ID'];
4637 $return['post_status'] = 'inherit';
4638 $return['post_type'] = 'revision';
4639 $return['post_name'] = $autosave ? "$post[ID]-autosave" : "$post[ID]-revision";
4640 $return['post_date'] = isset($post['post_modified']) ? $post['post_modified'] : '';
4641 $return['post_date_gmt'] = isset($post['post_modified_gmt']) ? $post['post_modified_gmt'] : '';
4647 * Saves an already existing post as a post revision.
4649 * Typically used immediately prior to post updates.
4651 * @package WordPress
4652 * @subpackage Post_Revisions
4655 * @uses _wp_put_post_revision()
4657 * @param int $post_id The ID of the post to save as a revision.
4658 * @return mixed Null or 0 if error, new revision ID, if success.
4660 function wp_save_post_revision( $post_id ) {
4661 // We do autosaves manually with wp_create_post_autosave()
4662 if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
4665 // WP_POST_REVISIONS = 0, false
4666 if ( ! WP_POST_REVISIONS )
4669 if ( !$post = get_post( $post_id, ARRAY_A ) )
4672 if ( !post_type_supports($post['post_type'], 'revisions') )
4675 $return = _wp_put_post_revision( $post );
4677 // WP_POST_REVISIONS = true (default), -1
4678 if ( !is_numeric( WP_POST_REVISIONS ) || WP_POST_REVISIONS < 0 )
4681 // all revisions and (possibly) one autosave
4682 $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
4684 // WP_POST_REVISIONS = (int) (# of autosaves to save)
4685 $delete = count($revisions) - WP_POST_REVISIONS;
4690 $revisions = array_slice( $revisions, 0, $delete );
4692 for ( $i = 0; isset($revisions[$i]); $i++ ) {
4693 if ( false !== strpos( $revisions[$i]->post_name, 'autosave' ) )
4695 wp_delete_post_revision( $revisions[$i]->ID );
4702 * Retrieve the autosaved data of the specified post.
4704 * Returns a post object containing the information that was autosaved for the
4707 * @package WordPress
4708 * @subpackage Post_Revisions
4711 * @param int $post_id The post ID.
4712 * @return object|bool The autosaved data or false on failure or when no autosave exists.
4714 function wp_get_post_autosave( $post_id ) {
4716 if ( !$post = get_post( $post_id ) )
4720 'name' => "{$post->ID}-autosave",
4721 'post_parent' => $post->ID,
4722 'post_type' => 'revision',
4723 'post_status' => 'inherit'
4726 // Use WP_Query so that the result gets cached
4727 $autosave_query = new WP_Query;
4729 add_action( 'parse_query', '_wp_get_post_autosave_hack' );
4730 $autosave = $autosave_query->query( $q );
4731 remove_action( 'parse_query', '_wp_get_post_autosave_hack' );
4733 if ( $autosave && is_array($autosave) && is_object($autosave[0]) )
4734 return $autosave[0];
4740 * Internally used to hack WP_Query into submission.
4742 * @package WordPress
4743 * @subpackage Post_Revisions
4746 * @param object $query WP_Query object
4748 function _wp_get_post_autosave_hack( $query ) {
4749 $query->is_single = false;
4753 * Determines if the specified post is a revision.
4755 * @package WordPress
4756 * @subpackage Post_Revisions
4759 * @param int|object $post Post ID or post object.
4760 * @return bool|int False if not a revision, ID of revision's parent otherwise.
4762 function wp_is_post_revision( $post ) {
4763 if ( !$post = wp_get_post_revision( $post ) )
4765 return (int) $post->post_parent;
4769 * Determines if the specified post is an autosave.
4771 * @package WordPress
4772 * @subpackage Post_Revisions
4775 * @param int|object $post Post ID or post object.
4776 * @return bool|int False if not a revision, ID of autosave's parent otherwise
4778 function wp_is_post_autosave( $post ) {
4779 if ( !$post = wp_get_post_revision( $post ) )
4781 if ( "{$post->post_parent}-autosave" !== $post->post_name )
4783 return (int) $post->post_parent;
4787 * Inserts post data into the posts table as a post revision.
4789 * @package WordPress
4790 * @subpackage Post_Revisions
4793 * @uses wp_insert_post()
4795 * @param int|object|array $post Post ID, post object OR post array.
4796 * @param bool $autosave Optional. Is the revision an autosave?
4797 * @return mixed Null or 0 if error, new revision ID if success.
4799 function _wp_put_post_revision( $post = null, $autosave = false ) {
4800 if ( is_object($post) )
4801 $post = get_object_vars( $post );
4802 elseif ( !is_array($post) )
4803 $post = get_post($post, ARRAY_A);
4804 if ( !$post || empty($post['ID']) )
4807 if ( isset($post['post_type']) && 'revision' == $post['post_type'] )
4808 return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
4810 $post = _wp_post_revision_fields( $post, $autosave );
4811 $post = add_magic_quotes($post); //since data is from db
4813 $revision_id = wp_insert_post( $post );
4814 if ( is_wp_error($revision_id) )
4815 return $revision_id;
4818 do_action( '_wp_put_post_revision', $revision_id );
4819 return $revision_id;
4823 * Gets a post revision.
4825 * @package WordPress
4826 * @subpackage Post_Revisions
4831 * @param int|object $post Post ID or post object
4832 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
4833 * @param string $filter Optional sanitation filter. @see sanitize_post()
4834 * @return mixed Null if error or post object if success
4836 function &wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
4838 if ( !$revision = get_post( $post, OBJECT, $filter ) )
4840 if ( 'revision' !== $revision->post_type )
4843 if ( $output == OBJECT ) {
4845 } elseif ( $output == ARRAY_A ) {
4846 $_revision = get_object_vars($revision);
4848 } elseif ( $output == ARRAY_N ) {
4849 $_revision = array_values(get_object_vars($revision));
4857 * Restores a post to the specified revision.
4859 * Can restore a past revision using all fields of the post revision, or only selected fields.
4861 * @package WordPress
4862 * @subpackage Post_Revisions
4865 * @uses wp_get_post_revision()
4866 * @uses wp_update_post()
4867 * @uses do_action() Calls 'wp_restore_post_revision' on post ID and revision ID if wp_update_post()
4870 * @param int|object $revision_id Revision ID or revision object.
4871 * @param array $fields Optional. What fields to restore from. Defaults to all.
4872 * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
4874 function wp_restore_post_revision( $revision_id, $fields = null ) {
4875 if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) )
4878 if ( !is_array( $fields ) )
4879 $fields = array_keys( _wp_post_revision_fields() );
4882 foreach( array_intersect( array_keys( $revision ), $fields ) as $field )
4883 $update[$field] = $revision[$field];
4888 $update['ID'] = $revision['post_parent'];
4890 $update = add_magic_quotes( $update ); //since data is from db
4892 $post_id = wp_update_post( $update );
4893 if ( is_wp_error( $post_id ) )
4897 do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
4903 * Deletes a revision.
4905 * Deletes the row from the posts table corresponding to the specified revision.
4907 * @package WordPress
4908 * @subpackage Post_Revisions
4911 * @uses wp_get_post_revision()
4912 * @uses wp_delete_post()
4914 * @param int|object $revision_id Revision ID or revision object.
4915 * @return mixed Null or WP_Error if error, deleted post if success.
4917 function wp_delete_post_revision( $revision_id ) {
4918 if ( !$revision = wp_get_post_revision( $revision_id ) )
4921 $delete = wp_delete_post( $revision->ID );
4922 if ( is_wp_error( $delete ) )
4926 do_action( 'wp_delete_post_revision', $revision->ID, $revision );
4932 * Returns all revisions of specified post.
4934 * @package WordPress
4935 * @subpackage Post_Revisions
4938 * @uses get_children()
4940 * @param int|object $post_id Post ID or post object
4941 * @return array empty if no revisions
4943 function wp_get_post_revisions( $post_id = 0, $args = null ) {
4944 if ( ! WP_POST_REVISIONS )
4946 if ( ( !$post = get_post( $post_id ) ) || empty( $post->ID ) )
4949 $defaults = array( 'order' => 'DESC', 'orderby' => 'date' );
4950 $args = wp_parse_args( $args, $defaults );
4951 $args = array_merge( $args, array( 'post_parent' => $post->ID, 'post_type' => 'revision', 'post_status' => 'inherit' ) );
4953 if ( !$revisions = get_children( $args ) )
4958 function _set_preview($post) {
4960 if ( ! is_object($post) )
4963 $preview = wp_get_post_autosave($post->ID);
4965 if ( ! is_object($preview) )
4968 $preview = sanitize_post($preview);
4970 $post->post_content = $preview->post_content;
4971 $post->post_title = $preview->post_title;
4972 $post->post_excerpt = $preview->post_excerpt;
4977 function _show_post_preview() {
4979 if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) {
4980 $id = (int) $_GET['preview_id'];
4982 if ( false == wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) )
4983 wp_die( __('You do not have permission to preview drafts.') );
4985 add_filter('the_preview', '_set_preview');
4990 * Returns the post's parent's post_ID
4994 * @param int $post_id
4996 * @return int|bool false on error
4998 function wp_get_post_parent_id( $post_ID ) {
4999 $post = get_post( $post_ID );
5000 if ( !$post || is_wp_error( $post ) )
5002 return (int) $post->post_parent;
5006 * Checks the given subset of the post hierarchy for hierarchy loops.
5007 * Prevents loops from forming and breaks those that it finds.
5009 * Attached to the wp_insert_post_parent filter.
5012 * @uses wp_find_hierarchy_loop()
5014 * @param int $post_parent ID of the parent for the post we're checking.
5015 * @parem int $post_ID ID of the post we're checking.
5017 * @return int The new post_parent for the post.
5019 function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) {
5020 // Nothing fancy here - bail
5021 if ( !$post_parent )
5024 // New post can't cause a loop
5025 if ( empty( $post_ID ) )
5026 return $post_parent;
5028 // Can't be its own parent
5029 if ( $post_parent == $post_ID )
5032 // Now look for larger loops
5034 if ( !$loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent ) )
5035 return $post_parent; // No loop
5037 // Setting $post_parent to the given value causes a loop
5038 if ( isset( $loop[$post_ID] ) )
5041 // There's a loop, but it doesn't contain $post_ID. Break the loop.
5042 foreach ( array_keys( $loop ) as $loop_member )
5043 wp_update_post( array( 'ID' => $loop_member, 'post_parent' => 0 ) );
5045 return $post_parent;
5049 * Returns an array of post format slugs to their translated and pretty display versions
5053 * @return array The array of translations
5055 function get_post_format_strings() {
5057 'standard' => _x( 'Standard', 'Post format' ), // Special case. any value that evals to false will be considered standard
5058 'aside' => _x( 'Aside', 'Post format' ),
5059 'chat' => _x( 'Chat', 'Post format' ),
5060 'gallery' => _x( 'Gallery', 'Post format' ),
5061 'link' => _x( 'Link', 'Post format' ),
5062 'image' => _x( 'Image', 'Post format' ),
5063 'quote' => _x( 'Quote', 'Post format' ),
5064 'status' => _x( 'Status', 'Post format' ),
5065 'video' => _x( 'Video', 'Post format' ),
5066 'audio' => _x( 'Audio', 'Post format' ),
5072 * Retrieves an array of post format slugs.
5076 * @return array The array of post format slugs.
5078 function get_post_format_slugs() {
5079 // 3.2-early: use array_combine() and array_keys( get_post_format_strings() )
5081 'standard' => 'standard', // Special case. any value that evals to false will be considered standard
5084 'gallery' => 'gallery',
5088 'status' => 'status',
5096 * Returns a pretty, translated version of a post format slug
5100 * @param string $slug A post format slug
5101 * @return string The translated post format name
5103 function get_post_format_string( $slug ) {
5104 $strings = get_post_format_strings();
5106 return $strings['standard'];
5108 return ( isset( $strings[$slug] ) ) ? $strings[$slug] : '';
5112 * Sets a post thumbnail.
5116 * @param int|object $post Post ID or object where thumbnail should be attached.
5117 * @param int $thumbnail_id Thumbnail to attach.
5118 * @return bool True on success, false on failure.
5120 function set_post_thumbnail( $post, $thumbnail_id ) {
5121 $post = get_post( $post );
5122 $thumbnail_id = absint( $thumbnail_id );
5123 if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) {
5124 $thumbnail_html = wp_get_attachment_image( $thumbnail_id, 'thumbnail' );
5125 if ( ! empty( $thumbnail_html ) ) {
5126 update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id );
5134 * Returns a link to a post format index.
5138 * @param $format string Post format
5139 * @return string Link
5141 function get_post_format_link( $format ) {
5142 $term = get_term_by('slug', 'post-format-' . $format, 'post_format' );
5143 if ( ! $term || is_wp_error( $term ) )
5145 return get_term_link( $term );
5149 * Filters the request to allow for the format prefix.
5154 function _post_format_request( $qvs ) {
5155 if ( ! isset( $qvs['post_format'] ) )
5157 $slugs = get_post_format_slugs();
5158 if ( isset( $slugs[ $qvs['post_format'] ] ) )
5159 $qvs['post_format'] = 'post-format-' . $slugs[ $qvs['post_format'] ];
5160 $tax = get_taxonomy( 'post_format' );
5161 $qvs['post_type'] = $tax->object_type;
5164 add_filter( 'request', '_post_format_request' );
5167 * Filters the post format term link to remove the format prefix.
5172 function _post_format_link( $link, $term, $taxonomy ) {
5174 if ( 'post_format' != $taxonomy )
5176 if ( $wp_rewrite->get_extra_permastruct( $taxonomy ) ) {
5177 return str_replace( "/{$term->slug}", '/' . str_replace( 'post-format-', '', $term->slug ), $link );
5179 $link = remove_query_arg( 'post_format', $link );
5180 return add_query_arg( 'post_format', str_replace( 'post-format-', '', $term->slug ), $link );
5183 add_filter( 'term_link', '_post_format_link', 10, 3 );
5186 * Remove the post format prefix from the name property of the term object created by get_term().
5191 function _post_format_get_term( $term ) {
5192 if ( isset( $term->slug ) ) {
5193 $term->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
5197 add_filter( 'get_post_format', '_post_format_get_term' );
5200 * Remove the post format prefix from the name property of the term objects created by get_terms().
5205 function _post_format_get_terms( $terms, $taxonomies, $args ) {
5206 if ( in_array( 'post_format', (array) $taxonomies ) ) {
5207 if ( isset( $args['fields'] ) && 'names' == $args['fields'] ) {
5208 foreach( $terms as $order => $name ) {
5209 $terms[$order] = get_post_format_string( str_replace( 'post-format-', '', $name ) );
5212 foreach ( (array) $terms as $order => $term ) {
5213 if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) {
5214 $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
5221 add_filter( 'get_terms', '_post_format_get_terms', 10, 3 );
5224 * Remove the post format prefix from the name property of the term objects created by wp_get_object_terms().
5229 function _post_format_wp_get_object_terms( $terms ) {
5230 foreach ( (array) $terms as $order => $term ) {
5231 if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) {
5232 $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) );
5237 add_filter( 'wp_get_object_terms', '_post_format_wp_get_object_terms' );