X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/16b9f61a8ab25bd6c9fbfd0cea00c7bda22f6a71..baca9ce86a38dc54c4574890ee2d352fd81f78b2:/wp-includes/post.php diff --git a/wp-includes/post.php b/wp-includes/post.php index 2e980713..870bec7a 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -13,12 +13,154 @@ /** * Creates the initial post types when 'init' action is fired. + * + * @since 2.9.0 */ function create_initial_post_types() { - register_post_type( 'post', array('exclude_from_search' => false) ); - register_post_type( 'page', array('exclude_from_search' => false) ); - register_post_type( 'attachment', array('exclude_from_search' => false) ); - register_post_type( 'revision', array('exclude_from_search' => true) ); + register_post_type( 'post', array( + 'labels' => array( + 'name_admin_bar' => _x( 'Post', 'add new on admin bar' ), + ), + 'public' => true, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'post', + 'map_meta_cap' => true, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'delete_with_user' => true, + 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ), + ) ); + + register_post_type( 'page', array( + 'labels' => array( + 'name_admin_bar' => _x( 'Page', 'add new on admin bar' ), + ), + 'public' => true, + 'publicly_queryable' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'page', + 'map_meta_cap' => true, + 'hierarchical' => true, + 'rewrite' => false, + 'query_var' => false, + 'delete_with_user' => true, + 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ), + ) ); + + register_post_type( 'attachment', array( + 'labels' => array( + 'name' => _x('Media', 'post type general name'), + 'name_admin_bar' => _x( 'Media', 'add new from admin bar' ), + 'add_new' => _x( 'Add New', 'add new media' ), + 'edit_item' => __( 'Edit Media' ), + 'view_item' => __( 'View Attachment Page' ), + ), + 'public' => true, + 'show_ui' => true, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'post', + 'capabilities' => array( + 'create_posts' => 'upload_files', + ), + 'map_meta_cap' => true, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'show_in_nav_menus' => false, + 'delete_with_user' => true, + 'supports' => array( 'title', 'author', 'comments' ), + ) ); + + register_post_type( 'revision', array( + 'labels' => array( + 'name' => __( 'Revisions' ), + 'singular_name' => __( 'Revision' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'revision.php?revision=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'post', + 'map_meta_cap' => true, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'can_export' => false, + 'delete_with_user' => true, + 'supports' => array( 'author' ), + ) ); + + register_post_type( 'nav_menu_item', array( + 'labels' => array( + 'name' => __( 'Navigation Menu Items' ), + 'singular_name' => __( 'Navigation Menu Item' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'hierarchical' => false, + 'rewrite' => false, + 'delete_with_user' => false, + 'query_var' => false, + ) ); + + register_post_status( 'publish', array( + 'label' => _x( 'Published', 'post' ), + 'public' => true, + '_builtin' => true, /* internal use only. */ + 'label_count' => _n_noop( 'Published (%s)', 'Published (%s)' ), + ) ); + + register_post_status( 'future', array( + 'label' => _x( 'Scheduled', 'post' ), + 'protected' => true, + '_builtin' => true, /* internal use only. */ + 'label_count' => _n_noop('Scheduled (%s)', 'Scheduled (%s)' ), + ) ); + + register_post_status( 'draft', array( + 'label' => _x( 'Draft', 'post' ), + 'protected' => true, + '_builtin' => true, /* internal use only. */ + 'label_count' => _n_noop( 'Draft (%s)', 'Drafts (%s)' ), + ) ); + + register_post_status( 'pending', array( + 'label' => _x( 'Pending', 'post' ), + 'protected' => true, + '_builtin' => true, /* internal use only. */ + 'label_count' => _n_noop( 'Pending (%s)', 'Pending (%s)' ), + ) ); + + register_post_status( 'private', array( + 'label' => _x( 'Private', 'post' ), + 'private' => true, + '_builtin' => true, /* internal use only. */ + 'label_count' => _n_noop( 'Private (%s)', 'Private (%s)' ), + ) ); + + register_post_status( 'trash', array( + 'label' => _x( 'Trash', 'post' ), + 'internal' => true, + '_builtin' => true, /* internal use only. */ + 'label_count' => _n_noop( 'Trash (%s)', 'Trash (%s)' ), + 'show_in_admin_status_list' => true, + ) ); + + register_post_status( 'auto-draft', array( + 'label' => 'auto-draft', + 'internal' => true, + '_builtin' => true, /* internal use only. */ + ) ); + + register_post_status( 'inherit', array( + 'label' => 'inherit', + 'internal' => true, + '_builtin' => true, /* internal use only. */ + 'exclude_from_search' => false, + ) ); } add_action( 'init', 'create_initial_post_types', 0 ); // highest priority @@ -37,13 +179,13 @@ add_action( 'init', 'create_initial_post_types', 0 ); // highest priority * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID. * * @param int $attachment_id Attachment ID. - * @param bool $unfiltered Whether to apply filters or not. - * @return string The file path to the attached file. + * @param bool $unfiltered Whether to apply filters. + * @return string|bool The file path to the attached file, or false if the attachment does not exist. */ function get_attached_file( $attachment_id, $unfiltered = false ) { $file = get_post_meta( $attachment_id, '_wp_attached_file', true ); // If the file is relative, prepend upload dir - if ( 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) ) + if ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) ) $file = $uploads['basedir'] . "/$file"; if ( $unfiltered ) return $file; @@ -68,9 +210,10 @@ function update_attached_file( $attachment_id, $file ) { return false; $file = apply_filters( 'update_attached_file', $file, $attachment_id ); - $file = _wp_relative_upload_path($file); - - return update_post_meta( $attachment_id, '_wp_attached_file', $file ); + if ( $file = _wp_relative_upload_path( $file ) ) + return update_post_meta( $attachment_id, '_wp_attached_file', $file ); + else + return delete_post_meta( $attachment_id, '_wp_attached_file' ); } /** @@ -78,7 +221,7 @@ function update_attached_file( $attachment_id, $file ) { * * The path is relative to the current upload dir. * - * @since 2.9 + * @since 2.9.0 * @uses apply_filters() Calls '_wp_relative_upload_path' on file path. * * @param string $path Full path to the file @@ -87,11 +230,10 @@ function update_attached_file( $attachment_id, $file ) { function _wp_relative_upload_path( $path ) { $new_path = $path; - if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { - if ( 0 === strpos($new_path, $uploads['basedir']) ) { - $new_path = str_replace($uploads['basedir'], '', $new_path); - $new_path = ltrim($new_path, '/'); - } + $uploads = wp_upload_dir(); + if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) { + $new_path = str_replace( $uploads['basedir'], '', $new_path ); + $new_path = ltrim( $new_path, '/' ); } return apply_filters( '_wp_relative_upload_path', $new_path, $path ); @@ -145,7 +287,7 @@ function _wp_relative_upload_path( $path ) { * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N. * @return array|bool False on failure and the type will be determined by $output parameter. */ -function &get_children($args = '', $output = OBJECT) { +function get_children($args = '', $output = OBJECT) { $kids = array(); if ( empty( $args ) ) { if ( isset( $GLOBALS['post'] ) ) { @@ -174,7 +316,7 @@ function &get_children($args = '', $output = OBJECT) { update_post_cache($children); foreach ( $children as $key => $child ) - $kids[$child->ID] =& $children[$key]; + $kids[$child->ID] = $children[$key]; if ( $output == OBJECT ) { return $kids; @@ -198,29 +340,32 @@ function &get_children($args = '', $output = OBJECT) { * 'more'. There can be text or space(s) after the word 'more', but won't be * referenced. * - * The returned array has 'main' and 'extended' keys. Main has the text before + * The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before * the . The 'extended' key has the content after the - * comment. + * comment. The 'more_text' key has the custom "Read More" text. * * @since 1.0.0 * * @param string $post Post content. - * @return array Post before ('main') and after ('extended'). + * @return array Post before ('main'), after ('extended'), and custom readmore ('more_text'). */ function get_extended($post) { //Match the new style more links if ( preg_match('//', $post, $matches) ) { list($main, $extended) = explode($matches[0], $post, 2); + $more_text = $matches[1]; } else { $main = $post; $extended = ''; + $more_text = ''; } // Strip leading and trailing whitespace $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main); $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended); + $more_text = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $more_text); - return array('main' => $main, 'extended' => $extended); + return array( 'main' => $main, 'extended' => $extended, 'more_text' => $more_text ); } /** @@ -233,51 +378,297 @@ function get_extended($post) { * @uses $wpdb * @link http://codex.wordpress.org/Function_Reference/get_post * - * @param int|object $post Post ID or post object. + * @param int|object $post Post ID or post object. Optional, default is the current post from the loop. * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N. * @param string $filter Optional, default is raw. - * @return mixed Post data + * @return WP_Post|null WP_Post on success or null on failure */ -function &get_post(&$post, $output = OBJECT, $filter = 'raw') { - global $wpdb; - $null = null; - - if ( empty($post) ) { - if ( isset($GLOBALS['post']) ) - $_post = & $GLOBALS['post']; - else - return $null; - } elseif ( is_object($post) && empty($post->filter) ) { - _get_post_ancestors($post); - $_post = sanitize_post($post, 'raw'); - wp_cache_add($post->ID, $_post, 'posts'); +function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) { + if ( empty( $post ) && isset( $GLOBALS['post'] ) ) + $post = $GLOBALS['post']; + + if ( is_a( $post, 'WP_Post' ) ) { + $_post = $post; + } elseif ( is_object( $post ) ) { + if ( empty( $post->filter ) ) { + $_post = sanitize_post( $post, 'raw' ); + $_post = new WP_Post( $_post ); + } elseif ( 'raw' == $post->filter ) { + $_post = new WP_Post( $post ); + } else { + $_post = WP_Post::get_instance( $post->ID ); + } } else { - if ( is_object($post) ) - $post = $post->ID; - $post = (int) $post; - if ( ! $_post = wp_cache_get($post, 'posts') ) { - $_post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post)); + $_post = WP_Post::get_instance( $post ); + } + + if ( ! $_post ) + return null; + + $_post = $_post->filter( $filter ); + + if ( $output == ARRAY_A ) + return $_post->to_array(); + elseif ( $output == ARRAY_N ) + return array_values( $_post->to_array() ); + + return $_post; +} + +/** + * WordPress Post class. + * + * @since 3.5.0 + * + */ +final class WP_Post { + + /** + * + * @var int + */ + public $ID; + + /** + * + * @var int + */ + public $post_author = 0; + + /** + * + * @var string + */ + public $post_date = '0000-00-00 00:00:00'; + + /** + * + * @var string + */ + public $post_date_gmt = '0000-00-00 00:00:00'; + + /** + * + * @var string + */ + public $post_content = ''; + + /** + * + * @var string + */ + public $post_title = ''; + + /** + * + * @var string + */ + public $post_excerpt = ''; + + /** + * + * @var string + */ + public $post_status = 'publish'; + + /** + * + * @var string + */ + public $comment_status = 'open'; + + /** + * + * @var string + */ + public $ping_status = 'open'; + + /** + * + * @var string + */ + public $post_password = ''; + + /** + * + * @var string + */ + public $post_name = ''; + + /** + * + * @var string + */ + public $to_ping = ''; + + /** + * + * @var string + */ + public $pinged = ''; + + /** + * + * @var string + */ + public $post_modified = '0000-00-00 00:00:00'; + + /** + * + * @var string + */ + public $post_modified_gmt = '0000-00-00 00:00:00'; + + /** + * + * @var string + */ + public $post_content_filtered = ''; + + /** + * + * @var int + */ + public $post_parent = 0; + + /** + * + * @var string + */ + public $guid = ''; + + /** + * + * @var int + */ + public $menu_order = 0; + + /** + * + * @var string + */ + public $post_type = 'post'; + + /** + * + * @var string + */ + public $post_mime_type = ''; + + /** + * + * @var int + */ + public $comment_count = 0; + + /** + * + * @var string + */ + public $filter; + + public static function get_instance( $post_id ) { + global $wpdb; + + $post_id = (int) $post_id; + if ( ! $post_id ) + return false; + + $_post = wp_cache_get( $post_id, 'posts' ); + + if ( ! $_post ) { + $_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id ) ); + if ( ! $_post ) - return $null; - _get_post_ancestors($_post); - $_post = sanitize_post($_post, 'raw'); - wp_cache_add($_post->ID, $_post, 'posts'); + return false; + + $_post = sanitize_post( $_post, 'raw' ); + wp_cache_add( $_post->ID, $_post, 'posts' ); + } elseif ( empty( $_post->filter ) ) { + $_post = sanitize_post( $_post, 'raw' ); } + + return new WP_Post( $_post ); + } + + public function __construct( $post ) { + foreach ( get_object_vars( $post ) as $key => $value ) + $this->$key = $value; } - if ($filter != 'raw') - $_post = sanitize_post($_post, $filter); + public function __isset( $key ) { + if ( 'ancestors' == $key ) + return true; - if ( $output == OBJECT ) { - return $_post; - } elseif ( $output == ARRAY_A ) { - $__post = get_object_vars($_post); - return $__post; - } elseif ( $output == ARRAY_N ) { - $__post = array_values(get_object_vars($_post)); - return $__post; - } else { - return $_post; + if ( 'page_template' == $key ) + return ( 'page' == $this->post_type ); + + if ( 'post_category' == $key ) + return true; + + if ( 'tags_input' == $key ) + return true; + + return metadata_exists( 'post', $this->ID, $key ); + } + + public function __get( $key ) { + if ( 'page_template' == $key && $this->__isset( $key ) ) { + return get_post_meta( $this->ID, '_wp_page_template', true ); + } + + if ( 'post_category' == $key ) { + if ( is_object_in_taxonomy( $this->post_type, 'category' ) ) + $terms = get_the_terms( $this, 'category' ); + + if ( empty( $terms ) ) + return array(); + + return wp_list_pluck( $terms, 'term_id' ); + } + + if ( 'tags_input' == $key ) { + if ( is_object_in_taxonomy( $this->post_type, 'post_tag' ) ) + $terms = get_the_terms( $this, 'post_tag' ); + + if ( empty( $terms ) ) + return array(); + + return wp_list_pluck( $terms, 'name' ); + } + + // Rest of the values need filtering + + if ( 'ancestors' == $key ) + $value = get_post_ancestors( $this ); + else + $value = get_post_meta( $this->ID, $key, true ); + + if ( $this->filter ) + $value = sanitize_post_field( $key, $value, $this->ID, $this->filter ); + + return $value; + } + + public function filter( $filter ) { + if ( $this->filter == $filter ) + return $this; + + if ( $filter == 'raw' ) + return self::get_instance( $this->ID ); + + return sanitize_post( $this, $filter ); + } + + public function to_array() { + $post = get_object_vars( $this ); + + foreach ( array( 'ancestors', 'page_template', 'post_category', 'tags_input' ) as $key ) { + if ( $this->__isset( $key ) ) + $post[ $key ] = $this->__get( $key ); + } + + return $post; } } @@ -289,19 +680,31 @@ function &get_post(&$post, $output = OBJECT, $filter = 'raw') { * @param int|object $post Post ID or post object * @return array Ancestor IDs or empty array if none are found. */ -function get_post_ancestors($post) { - $post = get_post($post); +function get_post_ancestors( $post ) { + $post = get_post( $post ); - if ( !empty($post->ancestors) ) - return $post->ancestors; + if ( ! $post || empty( $post->post_parent ) || $post->post_parent == $post->ID ) + return array(); - return array(); + $ancestors = array(); + + $id = $ancestors[] = $post->post_parent; + + while ( $ancestor = get_post( $id ) ) { + // Loop detection: If the ancestor has been seen before, break. + if ( empty( $ancestor->post_parent ) || ( $ancestor->post_parent == $post->ID ) || in_array( $ancestor->post_parent, $ancestors ) ) + break; + + $id = $ancestors[] = $ancestor->post_parent; + } + + return $ancestors; } /** * Retrieve data from a post field based on Post ID. * - * Examples of the post field will be, 'post_type', 'post_status', 'content', + * Examples of the post field will be, 'post_type', 'post_status', 'post_content', * etc and based off of the post object property or key names. * * The context values are based off of the taxonomy filter functions and @@ -313,16 +716,12 @@ function get_post_ancestors($post) { * @param string $field Post field name * @param id $post Post ID * @param string $context Optional. How to filter the field. Default is display. - * @return WP_Error|string Value in post field or WP_Error on failure + * @return bool|string False on failure or returns the value in post field */ function get_post_field( $field, $post, $context = 'display' ) { - $post = (int) $post; $post = get_post( $post ); - if ( is_wp_error($post) ) - return $post; - - if ( !is_object($post) ) + if ( !$post ) return ''; if ( !isset($post->$field) ) @@ -343,7 +742,7 @@ function get_post_field( $field, $post, $context = 'display' ) { * @return bool|string False on failure or returns the mime type */ function get_post_mime_type($ID = '') { - $post = & get_post($ID); + $post = get_post($ID); if ( is_object($post) ) return $post->post_mime_type; @@ -351,6 +750,71 @@ function get_post_mime_type($ID = '') { return false; } +/** + * Retrieve the format slug for a post + * + * @since 3.1.0 + * + * @param int|object $post A post + * + * @return mixed The format if successful. False if no format is set. WP_Error if errors. + */ +function get_post_format( $post = null ) { + $post = get_post($post); + + if ( ! post_type_supports( $post->post_type, 'post-formats' ) ) + return false; + + $_format = get_the_terms( $post->ID, 'post_format' ); + + if ( empty( $_format ) ) + return false; + + $format = array_shift( $_format ); + + return ( str_replace('post-format-', '', $format->slug ) ); +} + +/** + * Check if a post has a particular format + * + * @since 3.1.0 + * @uses has_term() + * + * @param string $format The format to check for + * @param object|id $post The post to check. If not supplied, defaults to the current post if used in the loop. + * @return bool True if the post has the format, false otherwise. + */ +function has_post_format( $format, $post = null ) { + return has_term('post-format-' . sanitize_key($format), 'post_format', $post); +} + +/** + * Assign a format to a post + * + * @since 3.1.0 + * + * @param int|object $post The post for which to assign a format + * @param string $format A format to assign. Use an empty string or array to remove all formats from the post. + * @return mixed WP_Error on error. Array of affected term IDs on success. + */ +function set_post_format( $post, $format ) { + $post = get_post($post); + + if ( empty($post) ) + return new WP_Error('invalid_post', __('Invalid post')); + + if ( !empty($format) ) { + $format = sanitize_key($format); + if ( 'standard' == $format || !in_array( $format, array_keys( get_post_format_slugs() ) ) ) + $format = ''; + else + $format = 'post-format-' . $format; + } + + return wp_set_post_terms($post->ID, $format, 'post_format'); +} + /** * Retrieve the post status based on the Post ID. * @@ -365,14 +829,23 @@ function get_post_mime_type($ID = '') { function get_post_status($ID = '') { $post = get_post($ID); - if ( is_object($post) ) { - if ( ('attachment' == $post->post_type) && $post->post_parent && ($post->ID != $post->post_parent) ) + if ( !is_object($post) ) + return false; + + if ( 'attachment' == $post->post_type ) { + if ( 'private' == $post->post_status ) + return 'private'; + + // Unattached attachments are assumed to be published + if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) ) + return 'publish'; + + // Inherit status from the parent + if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) return get_post_status($post->post_parent); - else - return $post->post_status; } - return false; + return $post->post_status; } /** @@ -416,31 +889,214 @@ function get_page_statuses( ) { return $status; } +/** + * Register a post status. Do not use before init. + * + * A simple function for creating or modifying a post status based on the + * parameters given. The function will accept an array (second optional + * parameter), along with a string for the post status name. + * + * + * Optional $args contents: + * + * label - A descriptive name for the post status marked for translation. Defaults to $post_status. + * public - Whether posts of this status should be shown in the front end of the site. Defaults to true. + * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to false. + * show_in_admin_all_list - Whether to include posts in the edit listing for their post type + * show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit + * listings, e.g. All (12) | Published (9) | My Custom Status (2) ... + * + * Arguments prefixed with an _underscore shouldn't be used by plugins and themes. + * + * @package WordPress + * @subpackage Post + * @since 3.0.0 + * @uses $wp_post_statuses Inserts new post status object into the list + * + * @param string $post_status Name of the post status. + * @param array|string $args See above description. + */ +function register_post_status($post_status, $args = array()) { + global $wp_post_statuses; + + if (!is_array($wp_post_statuses)) + $wp_post_statuses = array(); + + // Args prefixed with an underscore are reserved for internal use. + $defaults = array( + 'label' => false, + 'label_count' => false, + 'exclude_from_search' => null, + '_builtin' => false, + 'public' => null, + 'internal' => null, + 'protected' => null, + 'private' => null, + 'publicly_queryable' => null, + 'show_in_admin_status_list' => null, + 'show_in_admin_all_list' => null, + ); + $args = wp_parse_args($args, $defaults); + $args = (object) $args; + + $post_status = sanitize_key($post_status); + $args->name = $post_status; + + if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private ) + $args->internal = true; + + if ( null === $args->public ) + $args->public = false; + + if ( null === $args->private ) + $args->private = false; + + if ( null === $args->protected ) + $args->protected = false; + + if ( null === $args->internal ) + $args->internal = false; + + if ( null === $args->publicly_queryable ) + $args->publicly_queryable = $args->public; + + if ( null === $args->exclude_from_search ) + $args->exclude_from_search = $args->internal; + + if ( null === $args->show_in_admin_all_list ) + $args->show_in_admin_all_list = !$args->internal; + + if ( null === $args->show_in_admin_status_list ) + $args->show_in_admin_status_list = !$args->internal; + + if ( false === $args->label ) + $args->label = $post_status; + + if ( false === $args->label_count ) + $args->label_count = array( $args->label, $args->label ); + + $wp_post_statuses[$post_status] = $args; + + return $args; +} + +/** + * Retrieve a post status object by name + * + * @package WordPress + * @subpackage Post + * @since 3.0.0 + * @uses $wp_post_statuses + * @see register_post_status + * @see get_post_statuses + * + * @param string $post_status The name of a registered post status + * @return object A post status object + */ +function get_post_status_object( $post_status ) { + global $wp_post_statuses; + + if ( empty($wp_post_statuses[$post_status]) ) + return null; + + return $wp_post_statuses[$post_status]; +} + +/** + * Get a list of all registered post status objects. + * + * @package WordPress + * @subpackage Post + * @since 3.0.0 + * @uses $wp_post_statuses + * @see register_post_status + * @see get_post_status_object + * + * @param array|string $args An array of key => value arguments to match against the post status objects. + * @param string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default. + * @param string $operator The logical operation to perform. 'or' means only one element + * from the array needs to match; 'and' means all elements must match. The default is 'and'. + * @return array A list of post status names or objects + */ +function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) { + global $wp_post_statuses; + + $field = ('names' == $output) ? 'name' : false; + + return wp_filter_object_list($wp_post_statuses, $args, $operator, $field); +} + +/** + * Whether the post type is hierarchical. + * + * A false return value might also mean that the post type does not exist. + * + * @since 3.0.0 + * @see get_post_type_object + * + * @param string $post_type Post type name + * @return bool Whether post type is hierarchical. + */ +function is_post_type_hierarchical( $post_type ) { + if ( ! post_type_exists( $post_type ) ) + return false; + + $post_type = get_post_type_object( $post_type ); + return $post_type->hierarchical; +} + +/** + * Checks if a post type is registered. + * + * @since 3.0.0 + * @uses get_post_type_object() + * + * @param string $post_type Post type name + * @return bool Whether post type is registered. + */ +function post_type_exists( $post_type ) { + return (bool) get_post_type_object( $post_type ); +} + /** * Retrieve the post type of the current post or of a given post. * * @since 2.1.0 * - * @uses $wpdb - * @uses $posts The Loop post global + * @uses $post The Loop current post global * * @param mixed $post Optional. Post object or post ID. * @return bool|string post type or false on failure. */ -function get_post_type($post = false) { - global $posts; - - if ( false === $post ) - $post = $posts[0]; - elseif ( (int) $post ) - $post = get_post($post, OBJECT); - - if ( is_object($post) ) +function get_post_type( $post = null ) { + if ( $post = get_post( $post ) ) return $post->post_type; return false; } +/** + * Retrieve a post type object by name + * + * @package WordPress + * @subpackage Post + * @since 3.0.0 + * @uses $wp_post_types + * @see register_post_type + * @see get_post_types + * + * @param string $post_type The name of a registered post type + * @return object A post type object + */ +function get_post_type_object( $post_type ) { + global $wp_post_types; + + if ( empty($wp_post_types[$post_type]) ) + return null; + + return $wp_post_types[$post_type]; +} + /** * Get a list of all registered post type objects. * @@ -449,70 +1105,542 @@ function get_post_type($post = false) { * @since 2.9.0 * @uses $wp_post_types * @see register_post_type - * @see get_post_types * - * @param array|string $args An array of key => value arguments to match against the post types. - * Only post types having attributes that match all arguments are returned. + * @param array|string $args An array of key => value arguments to match against the post type objects. * @param string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default. + * @param string $operator The logical operation to perform. 'or' means only one element + * from the array needs to match; 'and' means all elements must match. The default is 'and'. * @return array A list of post type names or objects */ -function get_post_types( $args = array(), $output = 'names' ) { +function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) { global $wp_post_types; - $do_names = false; - if ( 'names' == $output ) - $do_names = true; - - $post_types = array(); - foreach ( (array) $wp_post_types as $post_type ) { - if ( empty($args) ) { - if ( $do_names ) - $post_types[] = $post_type->name; - else - $post_types[] = $post_type; - } elseif ( array_intersect_assoc((array) $post_type, $args) ) { - if ( $do_names ) - $post_types[] = $post_type->name; - else - $post_types[] = $post_type; - } - } + $field = ('names' == $output) ? 'name' : false; - return $post_types; + return wp_filter_object_list($wp_post_types, $args, $operator, $field); } /** * Register a post type. Do not use before init. * - * A simple function for creating or modifying a post type based on the + * A function for creating or modifying a post type based on the * parameters given. The function will accept an array (second optional * parameter), along with a string for the post type name. * - * * Optional $args contents: * - * exclude_from_search - Whether to exclude posts with this post type from search results. Defaults to true. + * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used. + * - labels - An array of labels for this post type. + * * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones. + * * You can see accepted values in {@link get_post_type_labels()}. + * - description - A short descriptive summary of what the post type is. Defaults to blank. + * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users. + * * Defaults to false. + * * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are + * inherited from public, each does not rely on this relationship and controls a very specific intention. + * - exclude_from_search - Whether to exclude posts with this post type from front end search results. + * * If not set, the the opposite of public's current value is used. + * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request(). + * * ?post_type={post_type_key} + * * ?{post_type_key}={single_post_slug} + * * ?{post_type_query_var}={single_post_slug} + * * If not set, the default is inherited from public. + * - show_ui - Whether to generate a default UI for managing this post type in the admin. + * * If not set, the default is inherited from public. + * - show_in_nav_menus - Makes this post type available for selection in navigation menus. + * * If not set, the default is inherited from public. + * - show_in_menu - Where to show the post type in the admin menu. + * * If true, the post type is shown in its own top level menu. + * * If false, no menu is shown + * * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will + * be placed as a sub menu of that. + * * show_ui must be true. + * * If not set, the default is inherited from show_ui + * - show_in_admin_bar - Makes this post type available via the admin bar. + * * If not set, the default is inherited from show_in_menu + * - menu_position - The position in the menu order the post type should appear. + * * show_in_menu must be true + * * Defaults to null, which places it at the bottom of its area. + * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon. + * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'. + * * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the + * capabilities, e.g. array('story', 'stories'). + * - capabilities - Array of capabilities for this post type. + * * By default the capability_type is used as a base to construct capabilities. + * * You can see accepted values in {@link get_post_type_capabilities()}. + * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false. + * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false. + * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor. + * * See {@link add_post_type_support()} for documentation. + * - register_meta_box_cb - Provide a callback function that will be called when setting up the + * meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback. + * - taxonomies - An array of taxonomy identifiers that will be registered for the post type. + * * Default is no taxonomies. + * * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type(). + * - has_archive - True to enable post type archives. Default is false. + * * Will generate the proper rewrite rules if rewrite is enabled. + * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug. + * * To prevent rewrite, set to false. + * * To specify rewrite rules, an array can be passed with any of these keys + * * 'slug' => string Customize the permastruct slug. Defaults to $post_type key + * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true. + * * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive. + * * 'pages' => bool Should the permastruct provide for pagination. Defaults to true. + * * 'ep_mask' => const Assign an endpoint mask. + * * If not specified and permalink_epmask is set, inherits from permalink_epmask. + * * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK + * - query_var - Sets the query_var key for this post type. Defaults to $post_type key + * * If false, a post type cannot be loaded at ?{query_var}={post_slug} + * * If specified as a string, the query ?{query_var_string}={post_slug} will be valid. + * - can_export - Allows this post type to be exported. Defaults to true. + * - delete_with_user - Whether to delete posts of this type when deleting a user. + * * If true, posts of this type belonging to the user will be moved to trash when then user is deleted. + * * If false, posts of this type belonging to the user will *not* be trashed or deleted. + * * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted. + * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY! + * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY! * - * @package WordPress - * @subpackage Post * @since 2.9.0 * @uses $wp_post_types Inserts new post type object into the list * - * @param string $post_type Name of the post type. - * @param array|string $args See above description. + * @param string $post_type Post type key, must not exceed 20 characters + * @param array|string $args See optional args description above. + * @return object|WP_Error the registered post type object, or an error object */ -function register_post_type($post_type, $args = array()) { - global $wp_post_types; +function register_post_type( $post_type, $args = array() ) { + global $wp_post_types, $wp_rewrite, $wp; - if (!is_array($wp_post_types)) + if ( !is_array($wp_post_types) ) $wp_post_types = array(); - $defaults = array('exclude_from_search' => true); + // Args prefixed with an underscore are reserved for internal use. + $defaults = array( + 'labels' => array(), 'description' => '', 'publicly_queryable' => null, 'exclude_from_search' => null, + 'capability_type' => 'post', 'capabilities' => array(), 'map_meta_cap' => null, + '_builtin' => false, '_edit_link' => 'post.php?post=%d', 'hierarchical' => false, + 'public' => false, 'rewrite' => true, 'has_archive' => false, 'query_var' => true, + 'supports' => array(), 'register_meta_box_cb' => null, + 'taxonomies' => array(), 'show_ui' => null, 'menu_position' => null, 'menu_icon' => null, + 'can_export' => true, + 'show_in_nav_menus' => null, 'show_in_menu' => null, 'show_in_admin_bar' => null, + 'delete_with_user' => null, + ); $args = wp_parse_args($args, $defaults); + $args = (object) $args; + + $post_type = sanitize_key($post_type); + $args->name = $post_type; + + if ( strlen( $post_type ) > 20 ) + return new WP_Error( 'post_type_too_long', __( 'Post types cannot exceed 20 characters in length' ) ); + + // If not set, default to the setting for public. + if ( null === $args->publicly_queryable ) + $args->publicly_queryable = $args->public; + + // If not set, default to the setting for public. + if ( null === $args->show_ui ) + $args->show_ui = $args->public; + + // If not set, default to the setting for show_ui. + if ( null === $args->show_in_menu || ! $args->show_ui ) + $args->show_in_menu = $args->show_ui; + + // If not set, default to the whether the full UI is shown. + if ( null === $args->show_in_admin_bar ) + $args->show_in_admin_bar = true === $args->show_in_menu; + + // Whether to show this type in nav-menus.php. Defaults to the setting for public. + if ( null === $args->show_in_nav_menus ) + $args->show_in_nav_menus = $args->public; - $post_type = sanitize_user($post_type, true); - $args['name'] = $post_type; - $wp_post_types[$post_type] = (object) $args; + // If not set, default to true if not public, false if public. + if ( null === $args->exclude_from_search ) + $args->exclude_from_search = !$args->public; + + // Back compat with quirky handling in version 3.0. #14122 + if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) ) + $args->map_meta_cap = true; + + if ( null === $args->map_meta_cap ) + $args->map_meta_cap = false; + + $args->cap = get_post_type_capabilities( $args ); + unset($args->capabilities); + + if ( is_array( $args->capability_type ) ) + $args->capability_type = $args->capability_type[0]; + + if ( ! empty($args->supports) ) { + add_post_type_support($post_type, $args->supports); + unset($args->supports); + } elseif ( false !== $args->supports ) { + // Add default features + add_post_type_support($post_type, array('title', 'editor')); + } + + if ( false !== $args->query_var && !empty($wp) ) { + if ( true === $args->query_var ) + $args->query_var = $post_type; + else + $args->query_var = sanitize_title_with_dashes($args->query_var); + $wp->add_query_var($args->query_var); + } + + if ( false !== $args->rewrite && ( is_admin() || '' != get_option('permalink_structure') ) ) { + if ( ! is_array( $args->rewrite ) ) + $args->rewrite = array(); + if ( empty( $args->rewrite['slug'] ) ) + $args->rewrite['slug'] = $post_type; + if ( ! isset( $args->rewrite['with_front'] ) ) + $args->rewrite['with_front'] = true; + if ( ! isset( $args->rewrite['pages'] ) ) + $args->rewrite['pages'] = true; + if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive ) + $args->rewrite['feeds'] = (bool) $args->has_archive; + if ( ! isset( $args->rewrite['ep_mask'] ) ) { + if ( isset( $args->permalink_epmask ) ) + $args->rewrite['ep_mask'] = $args->permalink_epmask; + else + $args->rewrite['ep_mask'] = EP_PERMALINK; + } + + if ( $args->hierarchical ) + add_rewrite_tag("%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name="); + else + add_rewrite_tag("%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name="); + + if ( $args->has_archive ) { + $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive; + if ( $args->rewrite['with_front'] ) + $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug; + else + $archive_slug = $wp_rewrite->root . $archive_slug; + + add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' ); + if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) { + $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')'; + add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' ); + add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' ); + } + if ( $args->rewrite['pages'] ) + add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' ); + } + + add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $args->rewrite ); + } + + if ( $args->register_meta_box_cb ) + add_action('add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1); + + $args->labels = get_post_type_labels( $args ); + $args->label = $args->labels->name; + + $wp_post_types[$post_type] = $args; + + add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 ); + + foreach ( $args->taxonomies as $taxonomy ) { + register_taxonomy_for_object_type( $taxonomy, $post_type ); + } + + do_action( 'registered_post_type', $post_type, $args ); + + return $args; +} + +/** + * Builds an object with all post type capabilities out of a post type object + * + * Post type capabilities use the 'capability_type' argument as a base, if the + * capability is not set in the 'capabilities' argument array or if the + * 'capabilities' argument is not supplied. + * + * The capability_type argument can optionally be registered as an array, with + * the first value being singular and the second plural, e.g. array('story, 'stories') + * Otherwise, an 's' will be added to the value for the plural form. After + * registration, capability_type will always be a string of the singular value. + * + * By default, seven keys are accepted as part of the capabilities array: + * + * - edit_post, read_post, and delete_post are meta capabilities, which are then + * generally mapped to corresponding primitive capabilities depending on the + * context, which would be the post being edited/read/deleted and the user or + * role being checked. Thus these capabilities would generally not be granted + * directly to users or roles. + * + * - edit_posts - Controls whether objects of this post type can be edited. + * - edit_others_posts - Controls whether objects of this type owned by other users + * can be edited. If the post type does not support an author, then this will + * behave like edit_posts. + * - publish_posts - Controls publishing objects of this post type. + * - read_private_posts - Controls whether private objects can be read. + * + * These four primitive capabilities are checked in core in various locations. + * There are also seven other primitive capabilities which are not referenced + * directly in core, except in map_meta_cap(), which takes the three aforementioned + * meta capabilities and translates them into one or more primitive capabilities + * that must then be checked against the user or role, depending on the context. + * + * - read - Controls whether objects of this post type can be read. + * - delete_posts - Controls whether objects of this post type can be deleted. + * - delete_private_posts - Controls whether private objects can be deleted. + * - delete_published_posts - Controls whether published objects can be deleted. + * - delete_others_posts - Controls whether objects owned by other users can be + * can be deleted. If the post type does not support an author, then this will + * behave like delete_posts. + * - edit_private_posts - Controls whether private objects can be edited. + * - edit_published_posts - Controls whether published objects can be edited. + * + * These additional capabilities are only used in map_meta_cap(). Thus, they are + * only assigned by default if the post type is registered with the 'map_meta_cap' + * argument set to true (default is false). + * + * @see map_meta_cap() + * @since 3.0.0 + * + * @param object $args Post type registration arguments + * @return object object with all the capabilities as member variables + */ +function get_post_type_capabilities( $args ) { + if ( ! is_array( $args->capability_type ) ) + $args->capability_type = array( $args->capability_type, $args->capability_type . 's' ); + + // Singular base for meta capabilities, plural base for primitive capabilities. + list( $singular_base, $plural_base ) = $args->capability_type; + + $default_capabilities = array( + // Meta capabilities + 'edit_post' => 'edit_' . $singular_base, + 'read_post' => 'read_' . $singular_base, + 'delete_post' => 'delete_' . $singular_base, + // Primitive capabilities used outside of map_meta_cap(): + 'edit_posts' => 'edit_' . $plural_base, + 'edit_others_posts' => 'edit_others_' . $plural_base, + 'publish_posts' => 'publish_' . $plural_base, + 'read_private_posts' => 'read_private_' . $plural_base, + ); + + // Primitive capabilities used within map_meta_cap(): + if ( $args->map_meta_cap ) { + $default_capabilities_for_mapping = array( + 'read' => 'read', + 'delete_posts' => 'delete_' . $plural_base, + 'delete_private_posts' => 'delete_private_' . $plural_base, + 'delete_published_posts' => 'delete_published_' . $plural_base, + 'delete_others_posts' => 'delete_others_' . $plural_base, + 'edit_private_posts' => 'edit_private_' . $plural_base, + 'edit_published_posts' => 'edit_published_' . $plural_base, + ); + $default_capabilities = array_merge( $default_capabilities, $default_capabilities_for_mapping ); + } + + $capabilities = array_merge( $default_capabilities, $args->capabilities ); + + // Post creation capability simply maps to edit_posts by default: + if ( ! isset( $capabilities['create_posts'] ) ) + $capabilities['create_posts'] = $capabilities['edit_posts']; + + // Remember meta capabilities for future reference. + if ( $args->map_meta_cap ) + _post_type_meta_capabilities( $capabilities ); + + return (object) $capabilities; +} + +/** + * Stores or returns a list of post type meta caps for map_meta_cap(). + * + * @since 3.1.0 + * @access private + */ +function _post_type_meta_capabilities( $capabilities = null ) { + static $meta_caps = array(); + if ( null === $capabilities ) + return $meta_caps; + foreach ( $capabilities as $core => $custom ) { + if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) ) + $meta_caps[ $custom ] = $core; + } +} + +/** + * Builds an object with all post type labels out of a post type object + * + * Accepted keys of the label array in the post type object: + * - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages + * - singular_name - name for one object of this post type. Default is Post/Page + * - 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: _x('Add New', 'product'); + * - add_new_item - Default is Add New Post/Add New Page + * - edit_item - Default is Edit Post/Edit Page + * - new_item - Default is New Post/New Page + * - view_item - Default is View Post/View Page + * - search_items - Default is Search Posts/Search Pages + * - not_found - Default is No posts found/No pages found + * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash + * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page: + * - all_items - String for the submenu. Default is All Posts/All Pages + * - menu_name - Default is the same as name + * + * Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages). + * + * @since 3.0.0 + * @param object $post_type_object + * @return object object with all the labels as member variables + */ +function get_post_type_labels( $post_type_object ) { + $nohier_vs_hier_defaults = array( + 'name' => array( _x('Posts', 'post type general name'), _x('Pages', 'post type general name') ), + 'singular_name' => array( _x('Post', 'post type singular name'), _x('Page', 'post type singular name') ), + 'add_new' => array( _x('Add New', 'post'), _x('Add New', 'page') ), + 'add_new_item' => array( __('Add New Post'), __('Add New Page') ), + 'edit_item' => array( __('Edit Post'), __('Edit Page') ), + 'new_item' => array( __('New Post'), __('New Page') ), + 'view_item' => array( __('View Post'), __('View Page') ), + 'search_items' => array( __('Search Posts'), __('Search Pages') ), + 'not_found' => array( __('No posts found.'), __('No pages found.') ), + 'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ), + 'parent_item_colon' => array( null, __('Parent Page:') ), + 'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) ) + ); + $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name']; + + $labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults ); + + $post_type = $post_type_object->name; + return apply_filters( "post_type_labels_{$post_type}", $labels ); +} + +/** + * Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object + * + * @access private + * @since 3.0.0 + */ +function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) { + + if ( isset( $object->label ) && empty( $object->labels['name'] ) ) + $object->labels['name'] = $object->label; + + if ( !isset( $object->labels['singular_name'] ) && isset( $object->labels['name'] ) ) + $object->labels['singular_name'] = $object->labels['name']; + + if ( ! isset( $object->labels['name_admin_bar'] ) ) + $object->labels['name_admin_bar'] = isset( $object->labels['singular_name'] ) ? $object->labels['singular_name'] : $object->name; + + if ( !isset( $object->labels['menu_name'] ) && isset( $object->labels['name'] ) ) + $object->labels['menu_name'] = $object->labels['name']; + + if ( !isset( $object->labels['all_items'] ) && isset( $object->labels['menu_name'] ) ) + $object->labels['all_items'] = $object->labels['menu_name']; + + foreach ( $nohier_vs_hier_defaults as $key => $value ) + $defaults[$key] = $object->hierarchical ? $value[1] : $value[0]; + + $labels = array_merge( $defaults, $object->labels ); + return (object)$labels; +} + +/** + * Adds submenus for post types. + * + * @access private + * @since 3.1.0 + */ +function _add_post_type_submenus() { + foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) { + $ptype_obj = get_post_type_object( $ptype ); + // Submenus only. + if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true ) + continue; + add_submenu_page( $ptype_obj->show_in_menu, $ptype_obj->labels->name, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, "edit.php?post_type=$ptype" ); + } +} +add_action( 'admin_menu', '_add_post_type_submenus' ); + +/** + * Register support of certain features for a post type. + * + * All features are directly associated with a functional area of the edit screen, such as the + * editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author', + * 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'. + * + * Additionally, the 'revisions' feature dictates whether the post type will store revisions, + * and the 'comments' feature dictates whether the comments count will show on the edit screen. + * + * @since 3.0.0 + * @param string $post_type The post type for which to add the feature + * @param string|array $feature the feature being added, can be an array of feature strings or a single string + */ +function add_post_type_support( $post_type, $feature ) { + global $_wp_post_type_features; + + $features = (array) $feature; + foreach ($features as $feature) { + if ( func_num_args() == 2 ) + $_wp_post_type_features[$post_type][$feature] = true; + else + $_wp_post_type_features[$post_type][$feature] = array_slice( func_get_args(), 2 ); + } +} + +/** + * Remove support for a feature from a post type. + * + * @since 3.0.0 + * @param string $post_type The post type for which to remove the feature + * @param string $feature The feature being removed + */ +function remove_post_type_support( $post_type, $feature ) { + global $_wp_post_type_features; + + if ( !isset($_wp_post_type_features[$post_type]) ) + return; + + if ( isset($_wp_post_type_features[$post_type][$feature]) ) + unset($_wp_post_type_features[$post_type][$feature]); +} + +/** + * Get all the post type features + * + * @since 3.4.0 + * @param string $post_type The post type + * @return array + */ + +function get_all_post_type_supports( $post_type ) { + global $_wp_post_type_features; + + if ( isset( $_wp_post_type_features[$post_type] ) ) + return $_wp_post_type_features[$post_type]; + + return array(); +} + +/** + * Checks a post type's support for a given feature + * + * @since 3.0.0 + * @param string $post_type The post type being checked + * @param string $feature the feature being checked + * @return boolean + */ + +function post_type_supports( $post_type, $feature ) { + global $_wp_post_type_features; + + if ( !isset( $_wp_post_type_features[$post_type][$feature] ) ) + return false; + + // If no args passed then no extra checks need be performed + if ( func_num_args() <= 2 ) + return true; + + // @todo Allow pluggable arg checking + //$args = array_slice( func_get_args(), 2 ); + + return true; } /** @@ -533,12 +1661,9 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) { global $wpdb; $post_type = sanitize_post_field('post_type', $post_type, $post_id, 'db'); - $return = $wpdb->update($wpdb->posts, array('post_type' => $post_type), array('ID' => $post_id) ); + $return = $wpdb->update( $wpdb->posts, array('post_type' => $post_type), array('ID' => $post_id) ); - if ( 'page' == $post_type ) - clean_page_cache($post_id); - else - clean_post_cache($post_id); + clean_post_cache( $post_id ); return $return; } @@ -558,7 +1683,7 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) { * 'meta_value' - See {@link WP_Query::query()} for more. * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few. * 'post_parent' - The parent of the post or post type. - * 'post_status' - Default is 'published'. Post status to retrieve. + * 'post_status' - Default is 'publish'. Post status to retrieve. * * @since 1.2.0 * @uses $wpdb @@ -572,8 +1697,8 @@ function get_posts($args = null) { $defaults = array( 'numberposts' => 5, 'offset' => 0, 'category' => 0, 'orderby' => 'post_date', - 'order' => 'DESC', 'include' => '', - 'exclude' => '', 'meta_key' => '', + 'order' => 'DESC', 'include' => array(), + 'exclude' => array(), 'meta_key' => '', 'meta_value' =>'', 'post_type' => 'post', 'suppress_filters' => true ); @@ -581,18 +1706,19 @@ function get_posts($args = null) { $r = wp_parse_args( $args, $defaults ); if ( empty( $r['post_status'] ) ) $r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish'; - if ( ! empty($r['numberposts']) ) + if ( ! empty($r['numberposts']) && empty($r['posts_per_page']) ) $r['posts_per_page'] = $r['numberposts']; if ( ! empty($r['category']) ) $r['cat'] = $r['category']; if ( ! empty($r['include']) ) { - $incposts = preg_split('/[\s,]+/',$r['include']); + $incposts = wp_parse_id_list( $r['include'] ); $r['posts_per_page'] = count($incposts); // only the number of posts included $r['post__in'] = $incposts; } elseif ( ! empty($r['exclude']) ) - $r['post__not_in'] = preg_split('/[\s,]+/',$r['exclude']); + $r['post__not_in'] = wp_parse_id_list( $r['exclude'] ); - $r['caller_get_posts'] = true; + $r['ignore_sticky_posts'] = true; + $r['no_found_rows'] = true; $get_posts = new WP_Query; return $get_posts->query($r); @@ -606,15 +1732,15 @@ function get_posts($args = null) { /** * Add meta data field to a post. * - * Post meta data is called "Custom Fields" on the Administration Panels. + * Post meta data is called "Custom Fields" on the Administration Screen. * * @since 1.5.0 * @uses $wpdb * @link http://codex.wordpress.org/Function_Reference/add_post_meta * * @param int $post_id Post ID. - * @param string $key Metadata name. - * @param mixed $value Metadata value. + * @param string $meta_key Metadata name. + * @param mixed $meta_value Metadata value. * @param bool $unique Optional, default is false. Whether the same key should not be added. * @return bool False for failure. True for success. */ @@ -658,12 +1784,12 @@ function delete_post_meta($post_id, $meta_key, $meta_value = '') { * @link http://codex.wordpress.org/Function_Reference/get_post_meta * * @param int $post_id Post ID. - * @param string $key The meta key to retrieve. + * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys. * @param bool $single Whether to return a single value. * @return mixed Will be an array if $single is false. Will be value of meta data field if $single * is true. */ -function get_post_meta($post_id, $key, $single = false) { +function get_post_meta($post_id, $key = '', $single = false) { return get_metadata('post', $post_id, $key, $single); } @@ -675,13 +1801,13 @@ function get_post_meta($post_id, $key, $single = false) { * * If the meta field for the post does not exist, it will be added. * - * @since 1.5 + * @since 1.5.0 * @uses $wpdb * @link http://codex.wordpress.org/Function_Reference/update_post_meta * * @param int $post_id Post ID. - * @param string $key Metadata key. - * @param mixed $value Metadata value. + * @param string $meta_key Metadata key. + * @param mixed $meta_value Metadata value. * @param mixed $prev_value Optional. Previous value to check before removing. * @return bool False on failure, true if success. */ @@ -703,51 +1829,27 @@ function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') { * @return bool Whether the post meta key was deleted from the database */ function delete_post_meta_by_key($post_meta_key) { - if ( !$post_meta_key ) - return false; - - global $wpdb; - $post_ids = $wpdb->get_col($wpdb->prepare("SELECT DISTINCT post_id FROM $wpdb->postmeta WHERE meta_key = %s", $post_meta_key)); - if ( $post_ids ) { - $postmetaids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = %s", $post_meta_key ) ); - $in = implode( ',', array_fill(1, count($postmetaids), '%d')); - do_action( 'delete_postmeta', $postmetaids ); - $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->postmeta WHERE meta_id IN($in)", $postmetaids )); - do_action( 'deleted_postmeta', $postmetaids ); - foreach ( $post_ids as $post_id ) - wp_cache_delete($post_id, 'post_meta'); - return true; - } - return false; + return delete_metadata( 'post', null, $post_meta_key, '', true ); } /** * Retrieve post meta fields, based on post ID. * - * The post meta fields are retrieved from the cache, so the function is - * optimized to be called more than once. It also applies to the functions, that - * use this function. + * The post meta fields are retrieved from the cache where possible, + * so the function is optimized to be called more than once. * * @since 1.2.0 * @link http://codex.wordpress.org/Function_Reference/get_post_custom * - * @uses $id Current Loop Post ID - * - * @param int $post_id post ID + * @param int $post_id Post ID. * @return array */ -function get_post_custom($post_id = 0) { - global $id; - - if ( !$post_id ) - $post_id = (int) $id; +function get_post_custom( $post_id = 0 ) { + $post_id = absint( $post_id ); + if ( ! $post_id ) + $post_id = get_the_ID(); - $post_id = (int) $post_id; - - if ( ! wp_cache_get($post_id, 'post_meta') ) - update_postmeta_cache($post_id); - - return wp_cache_get($post_id, 'post_meta'); + return get_post_meta( $post_id ); } /** @@ -802,22 +1904,20 @@ function get_post_custom_values( $key = '', $post_id = 0 ) { * @since 2.7.0 * * @param int $post_id Optional. Post ID. - * @return bool Whether post is sticky (true) or not sticky (false). + * @return bool Whether post is sticky. */ -function is_sticky($post_id = null) { - global $id; +function is_sticky( $post_id = 0 ) { + $post_id = absint( $post_id ); - $post_id = absint($post_id); - - if ( !$post_id ) - $post_id = absint($id); + if ( ! $post_id ) + $post_id = get_the_ID(); - $stickies = get_option('sticky_posts'); + $stickies = get_option( 'sticky_posts' ); - if ( !is_array($stickies) ) + if ( ! is_array( $stickies ) ) return false; - if ( in_array($post_id, $stickies) ) + if ( in_array( $post_id, $stickies ) ) return true; return false; @@ -831,9 +1931,9 @@ function is_sticky($post_id = null) { * @since 2.3.0 * @uses sanitize_post_field() Used to sanitize the fields. * - * @param object|array $post The Post Object or Array + * @param object|WP_Post|array $post The Post Object or Array * @param string $context Optional, default is 'display'. How to sanitize post fields. - * @return object|array The now sanitized Post Object or Array (will be the same type as $post) + * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post) */ function sanitize_post($post, $context = 'display') { if ( is_object($post) ) { @@ -855,7 +1955,6 @@ function sanitize_post($post, $context = 'display') { $post[$field] = sanitize_post_field($field, $post[$field], $post['ID'], $context); $post['filter'] = $context; } - return $post; } @@ -867,12 +1966,12 @@ function sanitize_post($post, $context = 'display') { * when calling filters. * * @since 2.3.0 - * @uses apply_filters() Calls 'edit_$field' and '${field_no_prefix}_edit_pre' passing $value and + * @uses apply_filters() Calls 'edit_$field' and '{$field_no_prefix}_edit_pre' passing $value and * $post_id if $context == 'edit' and field name prefix == 'post_'. * * @uses apply_filters() Calls 'edit_post_$field' passing $value and $post_id if $context == 'db'. * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db' and field name prefix == 'post_'. - * @uses apply_filters() Calls '${field}_pre' passing $value if $context == 'db' and field name prefix != 'post_'. + * @uses apply_filters() Calls '{$field}_pre' passing $value if $context == 'db' and field name prefix != 'post_'. * * @uses apply_filters() Calls '$field' passing $value, $post_id and $context if $context == anything * other than 'raw', 'edit' and 'db' and field name prefix == 'post_'. @@ -891,6 +1990,13 @@ function sanitize_post_field($field, $value, $post_id, $context) { if ( in_array($field, $int_fields) ) $value = (int) $value; + // Fields which contain arrays of ints. + $array_int_fields = array( 'ancestors' ); + if ( in_array($field, $array_int_fields) ) { + $value = array_map( 'absint', $value); + return $value; + } + if ( 'raw' == $context ) return $value; @@ -904,11 +2010,11 @@ function sanitize_post_field($field, $value, $post_id, $context) { $format_to_edit = array('post_content', 'post_excerpt', 'post_title', 'post_password'); if ( $prefixed ) { - $value = apply_filters("edit_$field", $value, $post_id); + $value = apply_filters("edit_{$field}", $value, $post_id); // Old school - $value = apply_filters("${field_no_prefix}_edit_pre", $value, $post_id); + $value = apply_filters("{$field_no_prefix}_edit_pre", $value, $post_id); } else { - $value = apply_filters("edit_post_$field", $value, $post_id); + $value = apply_filters("edit_post_{$field}", $value, $post_id); } if ( in_array($field, $format_to_edit) ) { @@ -921,18 +2027,18 @@ function sanitize_post_field($field, $value, $post_id, $context) { } } else if ( 'db' == $context ) { if ( $prefixed ) { - $value = apply_filters("pre_$field", $value); - $value = apply_filters("${field_no_prefix}_save_pre", $value); + $value = apply_filters("pre_{$field}", $value); + $value = apply_filters("{$field_no_prefix}_save_pre", $value); } else { - $value = apply_filters("pre_post_$field", $value); - $value = apply_filters("${field}_pre", $value); + $value = apply_filters("pre_post_{$field}", $value); + $value = apply_filters("{$field}_pre", $value); } } else { // Use display filters by default. if ( $prefixed ) $value = apply_filters($field, $value, $post_id, $context); else - $value = apply_filters("post_$field", $value, $post_id, $context); + $value = apply_filters("post_{$field}", $value, $post_id, $context); } if ( 'attribute' == $context ) @@ -1018,7 +2124,8 @@ function wp_count_posts( $type = 'post', $perm = '' ) { $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s"; if ( 'readable' == $perm && is_user_logged_in() ) { - if ( !current_user_can("read_private_{$type}s") ) { + $post_type_object = get_post_type_object($type); + if ( !current_user_can( $post_type_object->cap->read_private_posts ) ) { $cache_key .= '_' . $perm . '_' . $user->ID; $query .= " AND (post_status != 'private' OR ( post_author = '$user->ID' AND post_status = 'private' ))"; } @@ -1031,10 +2138,12 @@ function wp_count_posts( $type = 'post', $perm = '' ) { $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A ); - $stats = array( 'publish' => 0, 'private' => 0, 'draft' => 0, 'pending' => 0, 'future' => 0, 'trash' => 0 ); - foreach( (array) $count as $row_num => $row ) { + $stats = array(); + foreach ( get_post_stati() as $state ) + $stats[$state] = 0; + + foreach ( (array) $count as $row ) $stats[$row['post_status']] = $row['num_posts']; - } $stats = (object) $stats; wp_cache_set($cache_key, $stats, 'counts'); @@ -1042,7 +2151,6 @@ function wp_count_posts( $type = 'post', $perm = '' ) { return $stats; } - /** * Count number of attachments for the mime type(s). * @@ -1071,6 +2179,23 @@ function wp_count_attachments( $mime_type = '' ) { return (object) $stats; } +/** + * Get default post mime types + * + * @since 2.9.0 + * + * @return array + */ +function get_post_mime_types() { + $post_mime_types = array( // array( adj, noun ) + 'image' => array(__('Images'), __('Manage Images'), _n_noop('Image (%s)', 'Images (%s)')), + 'audio' => array(__('Audio'), __('Manage Audio'), _n_noop('Audio (%s)', 'Audio (%s)')), + 'video' => array(__('Video'), __('Manage Video'), _n_noop('Video (%s)', 'Video (%s)')), + ); + + return apply_filters('post_mime_types', $post_mime_types); +} + /** * Check a MIME-Type against a list. * @@ -1114,10 +2239,11 @@ function wp_match_mime_types($wildcard_mime_types, $real_mime_types) { * * @since 2.5.0 * - * @param string|array $mime_types List of mime types or comma separated string of mime types. + * @param string|array $post_mime_types List of mime types or comma separated string of mime types. + * @param string $table_alias Optional. Specify a table alias, if needed. * @return string The SQL AND clause for mime searching. */ -function wp_post_mime_type_where($post_mime_types) { +function wp_post_mime_type_where($post_mime_types, $table_alias = '') { $where = ''; $wildcards = array('', '%', '%/%'); if ( is_string($post_mime_types) ) @@ -1145,9 +2271,9 @@ function wp_post_mime_type_where($post_mime_types) { return ''; if ( false !== strpos($mime_pattern, '%') ) - $wheres[] = "post_mime_type LIKE '$mime_pattern'"; + $wheres[] = empty($table_alias) ? "post_mime_type LIKE '$mime_pattern'" : "$table_alias.post_mime_type LIKE '$mime_pattern'"; else - $wheres[] = "post_mime_type = '$mime_pattern'"; + $wheres[] = empty($table_alias) ? "post_mime_type = '$mime_pattern'" : "$table_alias.post_mime_type = '$mime_pattern'"; } if ( !empty($wheres) ) $where = ' AND (' . join(' OR ', $wheres) . ') '; @@ -1155,33 +2281,37 @@ function wp_post_mime_type_where($post_mime_types) { } /** - * Removes a post, attachment, or page. + * Trashes or deletes a post or page. * - * When the post and page goes, everything that is tied to it is deleted also. + * When the post and page is permanently deleted, everything that is tied to it is deleted also. * This includes comments, post meta fields, and terms associated with the post. * + * The post or page is moved to trash instead of permanently deleted unless trash is + * disabled, item is already in the trash, or $force_delete is true. + * * @since 1.0.0 * @uses do_action() on 'delete_post' before deletion unless post type is 'attachment'. * @uses do_action() on 'deleted_post' after deletion unless post type is 'attachment'. * @uses wp_delete_attachment() if post type is 'attachment'. + * @uses wp_trash_post() if item should be trashed. * * @param int $postid Post ID. - * @param bool $force_delete Whether to bypass trash and force deletion + * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false. * @return mixed False on failure */ function wp_delete_post( $postid = 0, $force_delete = false ) { - global $wpdb, $wp_rewrite; + global $wpdb; if ( !$post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) ) return $post; - if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS > 0 ) + if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS ) return wp_trash_post($postid); if ( $post->post_type == 'attachment' ) return wp_delete_attachment( $postid, $force_delete ); - do_action('delete_post', $postid); + do_action('before_delete_post', $postid); delete_post_meta($postid,'_wp_trash_meta_status'); delete_post_meta($postid,'_wp_trash_meta_time'); @@ -1191,6 +2321,14 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { $parent_data = array( 'post_parent' => $post->post_parent ); $parent_where = array( 'post_parent' => $postid ); + if ( is_post_type_hierarchical( $post->post_type ) ) { + // Point children of this page to its parent, also clean the cache of affected children + $children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type ); + $children = $wpdb->get_results( $children_query ); + + $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) ); + } + if ( 'page' == $post->post_type) { // if the page is defined in option page_on_front or post_for_posts, // adjust the corresponding options @@ -1201,19 +2339,13 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { if ( get_option('page_for_posts') == $postid ) { delete_option('page_for_posts'); } - - // Point children of this page to its parent, also clean the cache of affected children - $children_query = $wpdb->prepare("SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type='page'", $postid); - $children = $wpdb->get_results($children_query); - - $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'page' ) ); } else { unstick_post($postid); } - // Do raw query. wp_get_post_revisions() is filtered + // Do raw query. wp_get_post_revisions() is filtered $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) ); - // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up. + // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up. foreach ( $revision_ids as $revision_id ) wp_delete_post_revision( $revision_id ); @@ -1221,39 +2353,27 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) ); $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid )); - if ( ! empty($comment_ids) ) { - do_action( 'delete_comment', $comment_ids ); - $in_comment_ids = "'" . implode("', '", $comment_ids) . "'"; - $wpdb->query( "DELETE FROM $wpdb->comments WHERE comment_ID IN($in_comment_ids)" ); - do_action( 'deleted_comment', $comment_ids ); - } + foreach ( $comment_ids as $comment_id ) + wp_delete_comment( $comment_id, true ); $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $postid )); - if ( !empty($post_meta_ids) ) { - do_action( 'delete_postmeta', $post_meta_ids ); - $in_post_meta_ids = "'" . implode("', '", $post_meta_ids) . "'"; - $wpdb->query( "DELETE FROM $wpdb->postmeta WHERE meta_id IN($in_post_meta_ids)" ); - do_action( 'deleted_postmeta', $post_meta_ids ); - } + foreach ( $post_meta_ids as $mid ) + delete_metadata_by_mid( 'post', $mid ); do_action( 'delete_post', $postid ); - $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->posts WHERE ID = %d", $postid )); + $wpdb->delete( $wpdb->posts, array( 'ID' => $postid ) ); do_action( 'deleted_post', $postid ); - if ( 'page' == $post->post_type ) { - clean_page_cache($postid); - - foreach ( (array) $children as $child ) - clean_page_cache($child->ID); + clean_post_cache( $post ); - $wp_rewrite->flush_rules(false); - } else { - clean_post_cache($postid); + if ( is_post_type_hierarchical( $post->post_type ) && $children ) { + foreach ( $children as $child ) + clean_post_cache( $child ); } - wp_clear_scheduled_hook('publish_future_post', $postid); + wp_clear_scheduled_hook('publish_future_post', array( $postid ) ); - do_action('deleted_post', $postid); + do_action('after_delete_post', $postid); return $post; } @@ -1261,24 +2381,27 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { /** * Moves a post or page to the Trash * + * If trash is disabled, the post or page is permanently deleted. + * * @since 2.9.0 * @uses do_action() on 'trash_post' before trashing * @uses do_action() on 'trashed_post' after trashing + * @uses wp_delete_post() if trash is disabled * - * @param int $postid Post ID. + * @param int $post_id Post ID. * @return mixed False on failure */ function wp_trash_post($post_id = 0) { - if ( EMPTY_TRASH_DAYS == 0 ) - return wp_delete_post($post_id); + if ( !EMPTY_TRASH_DAYS ) + return wp_delete_post($post_id, true); - if ( !$post = wp_get_single_post($post_id, ARRAY_A) ) + if ( !$post = get_post($post_id, ARRAY_A) ) return $post; if ( $post['post_status'] == 'trash' ) return false; - do_action('trash_post', $post_id); + do_action('wp_trash_post', $post_id); add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']); add_post_meta($post_id,'_wp_trash_meta_time', time()); @@ -1300,11 +2423,11 @@ function wp_trash_post($post_id = 0) { * @uses do_action() on 'untrash_post' before undeletion * @uses do_action() on 'untrashed_post' after undeletion * - * @param int $postid Post ID. + * @param int $post_id Post ID. * @return mixed False on failure */ function wp_untrash_post($post_id = 0) { - if ( !$post = wp_get_single_post($post_id, ARRAY_A) ) + if ( !$post = get_post($post_id, ARRAY_A) ) return $post; if ( $post['post_status'] != 'trash' ) @@ -1493,54 +2616,45 @@ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array( * Retrieve number of recent posts. * * @since 1.0.0 - * @uses $wpdb + * @uses wp_parse_args() + * @uses get_posts() * - * @param int $num Optional, default is 10. Number of posts to get. - * @return array List of posts. + * @param string $deprecated Deprecated. + * @param array $args Optional. Overrides defaults. + * @param string $output Optional. + * @return unknown. */ -function wp_get_recent_posts($num = 10) { - global $wpdb; +function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { - // Set the limit clause, if we got a limit - $num = (int) $num; - if ( $num ) { - $limit = "LIMIT $num"; + if ( is_numeric( $args ) ) { + _deprecated_argument( __FUNCTION__, '3.1', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) ); + $args = array( 'numberposts' => absint( $args ) ); } - $sql = "SELECT * FROM $wpdb->posts WHERE post_type = 'post' AND post_status IN ( 'draft', 'publish', 'future', 'pending', 'private' ) ORDER BY post_date DESC $limit"; - $result = $wpdb->get_results($sql, ARRAY_A); - - return $result ? $result : array(); -} + // Set default arguments + $defaults = array( + 'numberposts' => 10, 'offset' => 0, + 'category' => 0, 'orderby' => 'post_date', + 'order' => 'DESC', 'include' => '', + 'exclude' => '', 'meta_key' => '', + 'meta_value' =>'', 'post_type' => 'post', 'post_status' => 'draft, publish, future, pending, private', + 'suppress_filters' => true + ); -/** - * Retrieve a single post, based on post ID. - * - * Has categories in 'post_category' property or key. Has tags in 'tags_input' - * property or key. - * - * @since 1.0.0 - * - * @param int $postid Post ID. - * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A. - * @return object|array Post object or array holding post contents and information - */ -function wp_get_single_post($postid = 0, $mode = OBJECT) { - $postid = (int) $postid; + $r = wp_parse_args( $args, $defaults ); - $post = get_post($postid, $mode); + $results = get_posts( $r ); - // Set categories and tags - if($mode == OBJECT) { - $post->post_category = wp_get_post_categories($postid); - $post->tags_input = wp_get_post_tags($postid, array('fields' => 'names')); - } - else { - $post['post_category'] = wp_get_post_categories($postid); - $post['tags_input'] = wp_get_post_tags($postid, array('fields' => 'names')); + // Backward compatibility. Prior to 3.1 expected posts to be returned in array + if ( ARRAY_A == $output ){ + foreach( $results as $key => $result ) { + $results[$key] = get_object_vars( $result ); + } + return $results ? $results : array(); } - return $post; + return $results ? $results : false; + } /** @@ -1568,33 +2682,31 @@ function wp_get_single_post($postid = 0, $mode = OBJECT) { * 'post_excerpt' - Post excerpt. * * @since 1.0.0 - * @link http://core.trac.wordpress.org/ticket/9084 Bug report on 'wp_insert_post_data' filter. * @uses $wpdb - * @uses $wp_rewrite * @uses $user_ID - * * @uses do_action() Calls 'pre_post_update' on post ID if this is an update. * @uses do_action() Calls 'edit_post' action on post ID and post data if this is an update. - * @uses do_action() Calls 'save_post' and 'wp_insert_post' on post id and post data just before - * returning. - * - * @uses apply_filters() Calls 'wp_insert_post_data' passing $data, $postarr prior to database - * update or insert. + * @uses do_action() Calls 'save_post' and 'wp_insert_post' on post id and post data just before returning. + * @uses apply_filters() Calls 'wp_insert_post_data' passing $data, $postarr prior to database update or insert. * @uses wp_transition_post_status() * - * @param array $postarr Optional. Overrides defaults. + * @param array $postarr Elements that make up post to insert. * @param bool $wp_error Optional. Allow return of WP_Error on failure. * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success. */ -function wp_insert_post($postarr = array(), $wp_error = false) { - global $wpdb, $wp_rewrite, $user_ID; +function wp_insert_post($postarr, $wp_error = false) { + global $wpdb, $user_ID; $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID, 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0, 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', - 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0); + 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0, + 'post_content' => '', 'post_title' => ''); $postarr = wp_parse_args($postarr, $defaults); + + unset( $postarr[ 'filter' ] ); + $postarr = sanitize_post($postarr, 'db'); // export array as variables @@ -1609,60 +2721,83 @@ function wp_insert_post($postarr = array(), $wp_error = false) { $previous_status = 'new'; } - if ( ('' == $post_content) && ('' == $post_title) && ('' == $post_excerpt) && ('attachment' != $post_type) ) { + $maybe_empty = ! $post_content && ! $post_title && ! $post_excerpt && post_type_supports( $post_type, 'editor' ) + && post_type_supports( $post_type, 'title' ) && post_type_supports( $post_type, 'excerpt' ); + if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) { if ( $wp_error ) - return new WP_Error('empty_content', __('Content, title, and excerpt are empty.')); + return new WP_Error( 'empty_content', __( 'Content, title, and excerpt are empty.' ) ); else return 0; } - // Make sure we set a valid category + if ( empty($post_type) ) + $post_type = 'post'; + + if ( empty($post_status) ) + $post_status = 'draft'; + + if ( !empty($post_category) ) + $post_category = array_filter($post_category); // Filter out empty terms + + // Make sure we set a valid category. if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) { - $post_category = array(get_option('default_category')); + // 'post' requires at least one category. + if ( 'post' == $post_type && 'auto-draft' != $post_status ) + $post_category = array( get_option('default_category') ); + else + $post_category = array(); } - //Set the default tag list - if ( !isset($tags_input) ) - $tags_input = array(); - if ( empty($post_author) ) $post_author = $user_ID; - if ( empty($post_status) ) - $post_status = 'draft'; - - if ( empty($post_type) ) - $post_type = 'post'; - $post_ID = 0; // Get the post ID and GUID if ( $update ) { $post_ID = (int) $ID; $guid = get_post_field( 'guid', $post_ID ); + $post_before = get_post($post_ID); } - // Don't allow contributors to set to set the post slug for pending review posts + // Don't allow contributors to set the post slug for pending review posts if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) ) $post_name = ''; - // Create a valid post name. Drafts and pending posts are allowed to have an empty + // Create a valid post name. Drafts and pending posts are allowed to have an empty // post name. - if ( !isset($post_name) || empty($post_name) ) { - if ( !in_array( $post_status, array( 'draft', 'pending' ) ) ) + if ( empty($post_name) ) { + if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) $post_name = sanitize_title($post_title); else $post_name = ''; } else { - $post_name = sanitize_title($post_name); + // On updates, we need to check to see if it's using the old, fixed sanitization context. + $check_name = sanitize_title( $post_name, '', 'old-save' ); + if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $ID ) == $check_name ) + $post_name = $check_name; + else // new post, or slug has changed. + $post_name = sanitize_title($post_name); } // 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 if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date ) $post_date = current_time('mysql'); + // validate the date + $mm = substr( $post_date, 5, 2 ); + $jj = substr( $post_date, 8, 2 ); + $aa = substr( $post_date, 0, 4 ); + $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date ); + if ( !$valid_date ) { + if ( $wp_error ) + return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) ); + else + return 0; + } + if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) { - if ( !in_array( $post_status, array( 'draft', 'pending' ) ) ) + if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) $post_date_gmt = get_gmt_from_date($post_date); else $post_date_gmt = '0000-00-00 00:00:00'; @@ -1680,6 +2815,10 @@ function wp_insert_post($postarr = array(), $wp_error = false) { $now = gmdate('Y-m-d H:i:59'); if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) ) $post_status = 'future'; + } elseif( 'future' == $post_status ) { + $now = gmdate('Y-m-d H:i:59'); + if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) ) + $post_status = 'publish'; } if ( empty($comment_status) ) { @@ -1692,7 +2831,7 @@ function wp_insert_post($postarr = array(), $wp_error = false) { $ping_status = get_option('default_ping_status'); if ( isset($to_ping) ) - $to_ping = preg_replace('|\s+|', "\n", $to_ping); + $to_ping = sanitize_trackback_urls( $to_ping ); else $to_ping = ''; @@ -1704,17 +2843,8 @@ function wp_insert_post($postarr = array(), $wp_error = false) { else $post_parent = 0; - if ( !empty($post_ID) ) { - if ( $post_parent == $post_ID ) { - // Post can't be its own parent - $post_parent = 0; - } elseif ( !empty($post_parent) ) { - $parent_post = get_post($post_parent); - // Check for circular dependency - if ( $parent_post->post_parent == $post_ID ) - $post_parent = 0; - } - } + // Check the post_parent to see if it will cause a hierarchy loop + $post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr ); if ( isset($menu_order) ) $menu_order = (int) $menu_order; @@ -1732,7 +2862,7 @@ function wp_insert_post($postarr = array(), $wp_error = false) { $data = stripslashes_deep( $data ); $where = array( 'ID' => $post_ID ); - if ($update) { + if ( $update ) { do_action( 'pre_post_update', $post_ID ); if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) { if ( $wp_error ) @@ -1762,39 +2892,42 @@ function wp_insert_post($postarr = array(), $wp_error = false) { $where = array( 'ID' => $post_ID ); } - if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending' ) ) ) { + if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) { $data['post_name'] = sanitize_title($data['post_title'], $post_ID); $wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where ); } - wp_set_post_categories( $post_ID, $post_category ); - // old-style tags_input - if ( !empty($tags_input) ) + if ( is_object_in_taxonomy($post_type, 'category') ) + wp_set_post_categories( $post_ID, $post_category ); + + if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') ) wp_set_post_tags( $post_ID, $tags_input ); - // new-style support for all tag-like taxonomies + + // new-style support for all custom taxonomies if ( !empty($tax_input) ) { foreach ( $tax_input as $taxonomy => $tags ) { - wp_set_post_terms( $post_ID, $tags, $taxonomy ); + $taxonomy_obj = get_taxonomy($taxonomy); + if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical. + $tags = array_filter($tags); + if ( current_user_can($taxonomy_obj->cap->assign_terms) ) + wp_set_post_terms( $post_ID, $tags, $taxonomy ); } } $current_guid = get_post_field( 'guid', $post_ID ); - if ( 'page' == $data['post_type'] ) - clean_page_cache($post_ID); - else - clean_post_cache($post_ID); - // Set GUID if ( !$update && '' == $current_guid ) $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where ); + clean_post_cache( $post_ID ); + $post = get_post($post_ID); if ( !empty($page_template) && 'page' == $data['post_type'] ) { $post->page_template = $page_template; - $page_templates = get_page_templates(); - if ( 'default' != $page_template && !in_array($page_template, $page_templates) ) { + $page_templates = wp_get_theme()->get_page_templates(); + if ( 'default' != $page_template && ! isset( $page_templates[ $page_template ] ) ) { if ( $wp_error ) return new WP_Error('invalid_page_template', __('The page template is invalid.')); else @@ -1805,8 +2938,11 @@ function wp_insert_post($postarr = array(), $wp_error = false) { wp_transition_post_status($data['post_status'], $previous_status, $post); - if ( $update) + if ( $update ) { do_action('edit_post', $post_ID, $post); + $post_after = get_post($post_ID); + do_action( 'post_updated', $post_ID, $post_after, $post_before); + } do_action('save_post', $post_ID, $post); do_action('wp_insert_post', $post_ID, $post); @@ -1823,9 +2959,10 @@ function wp_insert_post($postarr = array(), $wp_error = false) { * @since 1.0.0 * * @param array|object $postarr Post data. Arrays are expected to be escaped, objects are not. - * @return int 0 on failure, Post ID on success. + * @param bool $wp_error Optional. Allow return of WP_Error on failure. + * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success. */ -function wp_update_post($postarr = array()) { +function wp_update_post( $postarr = array(), $wp_error = false ) { if ( is_object($postarr) ) { // non-escaped post was passed $postarr = get_object_vars($postarr); @@ -1833,7 +2970,7 @@ function wp_update_post($postarr = array()) { } // First, get all of the original fields - $post = wp_get_single_post($postarr['ID'], ARRAY_A); + $post = get_post($postarr['ID'], ARRAY_A); // Escape data pulled from DB. $post = add_magic_quotes($post); @@ -1846,7 +2983,7 @@ function wp_update_post($postarr = array()) { $post_cats = $post['post_category']; // Drafts shouldn't be assigned a date unless explicitly done so by the user - if ( in_array($post['post_status'], array('draft', 'pending')) && empty($postarr['edit_date']) && + if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) && ('0000-00-00 00:00:00' == $post['post_date_gmt']) ) $clear_date = true; else @@ -1863,7 +3000,7 @@ function wp_update_post($postarr = array()) { if ($postarr['post_type'] == 'attachment') return wp_insert_attachment($postarr); - return wp_insert_post($postarr); + return wp_insert_post( $postarr, $wp_error ); } /** @@ -1873,35 +3010,28 @@ function wp_update_post($postarr = array()) { * @uses $wpdb * @uses do_action() Calls 'edit_post', 'save_post', and 'wp_insert_post' on post_id and post data. * - * @param int $post_id Post ID. - * @return null + * @param mixed $post Post ID or object. */ -function wp_publish_post($post_id) { +function wp_publish_post( $post ) { global $wpdb; - $post = get_post($post_id); - - if ( empty($post) ) + if ( ! $post = get_post( $post ) ) return; if ( 'publish' == $post->post_status ) return; - $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $post_id ) ); + $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $post->ID ) ); + + clean_post_cache( $post->ID ); $old_status = $post->post_status; $post->post_status = 'publish'; - wp_transition_post_status('publish', $old_status, $post); - - // Update counts for the post's terms. - foreach ( (array) get_object_taxonomies('post') as $taxonomy ) { - $tt_ids = wp_get_object_terms($post_id, $taxonomy, 'fields=tt_ids'); - wp_update_term_count($tt_ids, $taxonomy); - } + wp_transition_post_status( 'publish', $old_status, $post ); - do_action('edit_post', $post_id, $post); - do_action('save_post', $post_id, $post); - do_action('wp_insert_post', $post_id, $post); + do_action( 'edit_post', $post->ID, $post ); + do_action( 'save_post', $post->ID, $post ); + do_action( 'wp_insert_post', $post->ID, $post ); } /** @@ -1928,7 +3058,7 @@ function check_and_publish_future_post($post_id) { $time = strtotime( $post->post_date_gmt . ' GMT' ); if ( $time > time() ) { // Uh oh, someone jumped the gun! - wp_clear_scheduled_hook( 'publish_future_post', $post_id ); // clear anything else in the system + wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) ); return; } @@ -1936,12 +3066,13 @@ function check_and_publish_future_post($post_id) { return wp_publish_post($post_id); } - /** - * Given the desired slug and some post details computes a unique slug for the post. + * Computes a unique slug for the post, when given the desired slug and some post details. + * + * @since 2.8.0 * - * @global wpdb $wpdb - * @global WP_Rewrite $wp_rewrite + * @global wpdb $wpdb + * @global WP_Rewrite $wp_rewrite * @param string $slug the desired slug (post_name) * @param integer $post_ID * @param string $post_status no uniqueness checks are made if the post is still draft or pending @@ -1949,63 +3080,67 @@ function check_and_publish_future_post($post_id) { * @param integer $post_parent * @return string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix) */ -function wp_unique_post_slug($slug, $post_ID, $post_status, $post_type, $post_parent) { - if ( in_array( $post_status, array( 'draft', 'pending' ) ) ) +function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) { + if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) return $slug; global $wpdb, $wp_rewrite; + $original_slug = $slug; + $feeds = $wp_rewrite->feeds; - if ( !is_array($feeds) ) + if ( ! is_array( $feeds ) ) $feeds = array(); - $hierarchical_post_types = apply_filters('hierarchical_post_types', array('page')); + $hierarchical_post_types = get_post_types( array('hierarchical' => true) ); if ( 'attachment' == $post_type ) { // Attachment slugs must be unique across all types. $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND ID != %d LIMIT 1"; - $post_name_check = $wpdb->get_var($wpdb->prepare($check_sql, $slug, $post_ID)); + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) ); - if ( $post_name_check || in_array($slug, $feeds) ) { + if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) { $suffix = 2; do { - $alt_post_name = substr($slug, 0, 200-(strlen($suffix)+1)). "-$suffix"; - $post_name_check = $wpdb->get_var($wpdb->prepare($check_sql, $alt_post_name, $post_ID)); + $alt_post_name = substr ($slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; + $post_name_check = $wpdb->get_var( $wpdb->prepare($check_sql, $alt_post_name, $post_ID ) ); $suffix++; - } while ($post_name_check); + } while ( $post_name_check ); $slug = $alt_post_name; } - } elseif ( in_array($post_type, $hierarchical_post_types) ) { - // Page slugs must be unique within their own trees. Pages are in a - // separate namespace than posts so page slugs are allowed to overlap post slugs. - $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"; - $post_name_check = $wpdb->get_var($wpdb->prepare($check_sql, $slug, $post_ID, $post_parent)); - - if ( $post_name_check || in_array($slug, $feeds) ) { + } elseif ( in_array( $post_type, $hierarchical_post_types ) ) { + if ( 'nav_menu_item' == $post_type ) + return $slug; + // Page slugs must be unique within their own trees. Pages are in a separate + // namespace than posts so page slugs are allowed to overlap post slugs. + $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"; + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID, $post_parent ) ); + + 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 ) ) { $suffix = 2; do { - $alt_post_name = substr($slug, 0, 200-(strlen($suffix)+1)). "-$suffix"; - $post_name_check = $wpdb->get_var($wpdb->prepare($check_sql, $alt_post_name, $post_ID, $post_parent)); + $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID, $post_parent ) ); $suffix++; - } while ($post_name_check); + } while ( $post_name_check ); $slug = $alt_post_name; } } else { // Post slugs must be unique across all posts. $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d LIMIT 1"; - $post_name_check = $wpdb->get_var($wpdb->prepare($check_sql, $slug, $post_type, $post_ID)); + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID ) ); - if ( $post_name_check || in_array($slug, $wp_rewrite->feeds) ) { + if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) { $suffix = 2; do { - $alt_post_name = substr($slug, 0, 200-(strlen($suffix)+1)). "-$suffix"; - $post_name_check = $wpdb->get_var($wpdb->prepare($check_sql, $alt_post_name, $post_type, $post_ID)); + $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID ) ); $suffix++; - } while ($post_name_check); + } while ( $post_name_check ); $slug = $alt_post_name; } } - return $slug; + return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug ); } /** @@ -2025,7 +3160,6 @@ function wp_add_post_tags($post_id = 0, $tags = '') { return wp_set_post_tags($post_id, $tags, true); } - /** * Set the tags for a post. * @@ -2035,7 +3169,7 @@ function wp_add_post_tags($post_id = 0, $tags = '') { * @param int $post_id Post ID. * @param string $tags The tags to set for the post, separated by commas. * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. - * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise + * @return mixed Array of affected term IDs. WP_Error or false on failure. */ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { return wp_set_post_terms( $post_id, $tags, 'post_tag', $append); @@ -2049,8 +3183,9 @@ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { * * @param int $post_id Post ID. * @param string $tags The tags to set for the post, separated by commas. + * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'. * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. - * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise + * @return mixed Array of affected term IDs. WP_Error or false on failure. */ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) { $post_id = (int) $post_id; @@ -2061,8 +3196,20 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a if ( empty($tags) ) $tags = array(); - $tags = is_array($tags) ? $tags : explode( ',', trim($tags, " \n\t\r\0\x0B,") ); - wp_set_object_terms($post_id, $tags, $taxonomy, $append); + if ( ! is_array( $tags ) ) { + $comma = _x( ',', 'tag delimiter' ); + if ( ',' !== $comma ) + $tags = str_replace( $comma, ',', $tags ); + $tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) ); + } + + // Hierarchical taxonomies must always pass IDs rather than names so that children with the same + // names but different parents aren't confused. + if ( is_taxonomy_hierarchical( $taxonomy ) ) { + $tags = array_unique( array_map( 'intval', $tags ) ); + } + + return wp_set_object_terms( $post_id, $tags, $taxonomy, $append ); } /** @@ -2079,16 +3226,19 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a */ function wp_set_post_categories($post_ID = 0, $post_categories = array()) { $post_ID = (int) $post_ID; + $post_type = get_post_type( $post_ID ); + $post_status = get_post_status( $post_ID ); // If $post_categories isn't already an array, make it one: - if (!is_array($post_categories) || 0 == count($post_categories) || empty($post_categories)) - $post_categories = array(get_option('default_category')); - else if ( 1 == count($post_categories) && '' == $post_categories[0] ) + if ( !is_array($post_categories) || empty($post_categories) ) { + if ( 'post' == $post_type && 'auto-draft' != $post_status ) + $post_categories = array( get_option('default_category') ); + else + $post_categories = array(); + } else if ( 1 == count($post_categories) && '' == reset($post_categories) ) { return true; + } - $post_categories = array_map('intval', $post_categories); - $post_categories = array_unique($post_categories); - - return wp_set_object_terms($post_ID, $post_categories, 'category'); + return wp_set_post_terms($post_ID, $post_categories, 'category'); } /** @@ -2110,8 +3260,8 @@ function wp_set_post_categories($post_ID = 0, $post_categories = array()) { * * @uses do_action() Calls 'transition_post_status' on $new_status, $old_status and * $post if there is a status change. - * @uses do_action() Calls '${old_status}_to_$new_status' on $post if there is a status change. - * @uses do_action() Calls '${new_status}_$post->post_type' on post ID and $post. + * @uses do_action() Calls '{$old_status}_to_{$new_status}' on $post if there is a status change. + * @uses do_action() Calls '{$new_status}_{$post->post_type}' on post ID and $post. * * @param string $new_status Transition to this post status. * @param string $old_status Previous post status. @@ -2119,8 +3269,8 @@ function wp_set_post_categories($post_ID = 0, $post_categories = array()) { */ function wp_transition_post_status($new_status, $old_status, $post) { do_action('transition_post_status', $new_status, $old_status, $post); - do_action("${old_status}_to_$new_status", $post); - do_action("${new_status}_$post->post_type", $post->ID, $post); + do_action("{$old_status}_to_{$new_status}", $post); + do_action("{$new_status}_{$post->post_type}", $post->ID, $post); } // @@ -2169,11 +3319,11 @@ function get_enclosed($post_id) { if ( 'enclosure' != $key || !is_array( $val ) ) continue; foreach( $val as $enc ) { - $enclosure = split( "\n", $enc ); + $enclosure = explode( "\n", $enc ); $pung[] = trim( $enclosure[ 0 ] ); } } - $pung = apply_filters('get_enclosed', $pung); + $pung = apply_filters('get_enclosed', $pung, $post_id); return $pung; } @@ -2207,7 +3357,7 @@ function get_pung($post_id) { function get_to_ping($post_id) { global $wpdb; $to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id )); - $to_ping = trim($to_ping); + $to_ping = sanitize_trackback_urls( $to_ping ); $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY); $to_ping = apply_filters('get_to_ping', $to_ping); return $to_ping; @@ -2224,7 +3374,7 @@ function get_to_ping($post_id) { function trackback_url_list($tb_list, $post_id) { if ( ! empty( $tb_list ) ) { // get post data - $postdata = wp_get_single_post($post_id, ARRAY_A); + $postdata = get_post($post_id, ARRAY_A); // import postdata as variables extract($postdata, EXTR_SKIP); @@ -2259,7 +3409,8 @@ function trackback_url_list($tb_list, $post_id) { function get_all_page_ids() { global $wpdb; - if ( ! $page_ids = wp_cache_get('all_page_ids', 'posts') ) { + $page_ids = wp_cache_get('all_page_ids', 'posts'); + if ( ! is_array( $page_ids ) ) { $page_ids = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE post_type = 'page'"); wp_cache_add('all_page_ids', $page_ids, 'posts'); } @@ -2270,25 +3421,18 @@ function get_all_page_ids() { /** * Retrieves page data given a page ID or page object. * + * Use get_post() instead of get_page(). + * * @since 1.5.1 + * @deprecated 3.5.0 * * @param mixed $page Page object or page ID. Passed by reference. * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N. * @param string $filter How the return value should be filtered. - * @return mixed Page data. + * @return WP_Post|null WP_Post on success or null on failure */ -function &get_page(&$page, $output = OBJECT, $filter = 'raw') { - if ( empty($page) ) { - if ( isset( $GLOBALS['post'] ) && isset( $GLOBALS['post']->ID ) ) { - return get_post($GLOBALS['post'], $output, $filter); - } else { - $page = null; - return $page; - } - } - - $the_page = get_post($page, $output, $filter); - return $the_page; +function get_page( $page, $output = OBJECT, $filter = 'raw') { + return get_post( $page, $output, $filter ); } /** @@ -2298,38 +3442,51 @@ function &get_page(&$page, $output = OBJECT, $filter = 'raw') { * @uses $wpdb * * @param string $page_path Page path - * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. - * @return mixed Null when complete. + * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT. + * @param string $post_type Optional. Post type. Default page. + * @return WP_Post|null WP_Post on success or null on failure */ -function get_page_by_path($page_path, $output = OBJECT) { +function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') { global $wpdb; + $page_path = rawurlencode(urldecode($page_path)); $page_path = str_replace('%2F', '/', $page_path); $page_path = str_replace('%20', ' ', $page_path); - $page_paths = '/' . trim($page_path, '/'); - $leaf_path = sanitize_title(basename($page_paths)); - $page_paths = explode('/', $page_paths); - $full_path = ''; - foreach( (array) $page_paths as $pathdir) - $full_path .= ($pathdir!=''?'/':'') . sanitize_title($pathdir); + $parts = explode( '/', trim( $page_path, '/' ) ); + $parts = array_map( 'esc_sql', $parts ); + $parts = array_map( 'sanitize_title_for_query', $parts ); - $pages = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_name = %s AND (post_type = 'page' OR post_type = 'attachment')", $leaf_path )); + $in_string = "'". implode( "','", $parts ) . "'"; + $post_type_sql = $post_type; + $wpdb->escape_by_ref( $post_type_sql ); + $pages = $wpdb->get_results( "SELECT ID, post_name, post_parent, post_type FROM $wpdb->posts WHERE post_name IN ($in_string) AND (post_type = '$post_type_sql' OR post_type = 'attachment')", OBJECT_K ); - if ( empty($pages) ) - return null; + $revparts = array_reverse( $parts ); - foreach ($pages as $page) { - $path = '/' . $leaf_path; - $curpage = $page; - while ($curpage->post_parent != 0) { - $curpage = $wpdb->get_row( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE ID = %d and post_type='page'", $curpage->post_parent )); - $path = '/' . $curpage->post_name . $path; - } + $foundid = 0; + foreach ( (array) $pages as $page ) { + if ( $page->post_name == $revparts[0] ) { + $count = 0; + $p = $page; + while ( $p->post_parent != 0 && isset( $pages[ $p->post_parent ] ) ) { + $count++; + $parent = $pages[ $p->post_parent ]; + if ( ! isset( $revparts[ $count ] ) || $parent->post_name != $revparts[ $count ] ) + break; + $p = $parent; + } - if ( $path == $full_path ) - return get_page($page->ID, $output); + if ( $p->post_parent == 0 && $count+1 == count( $revparts ) && $p->post_name == $revparts[ $count ] ) { + $foundid = $page->ID; + if ( $page->post_type == $post_type ) + break; + } + } } + if ( $foundid ) + return get_post( $foundid, $output ); + return null; } @@ -2340,14 +3497,15 @@ function get_page_by_path($page_path, $output = OBJECT) { * @uses $wpdb * * @param string $page_title Page title - * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. - * @return mixed + * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT. + * @param string $post_type Optional. Post type. Default page. + * @return WP_Post|null WP_Post on success or null on failure */ -function get_page_by_title($page_title, $output = OBJECT) { +function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) { global $wpdb; - $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type='page'", $page_title )); + $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type= %s", $page_title, $post_type ) ); if ( $page ) - return get_page($page, $output); + return get_post( $page, $output ); return null; } @@ -2365,7 +3523,7 @@ function get_page_by_title($page_title, $output = OBJECT) { * @param array $pages List of pages' objects. * @return array */ -function &get_page_children($page_id, $pages) { +function get_page_children($page_id, $pages) { $page_list = array(); foreach ( (array) $pages as $page ) { if ( $page->post_parent == $page_id ) { @@ -2385,41 +3543,37 @@ function &get_page_children($page_id, $pages) { * * @since 2.0.0 * - * @param array $posts Posts array. - * @param int $parent Parent page ID. + * @param array $pages Posts array. + * @param int $page_id Parent page ID. * @return array A list arranged by hierarchy. Children immediately follow their parents. */ -function &get_page_hierarchy( &$pages, $page_id = 0 ) { - +function get_page_hierarchy( &$pages, $page_id = 0 ) { if ( empty( $pages ) ) { - $return = array(); - return $return; + $result = array(); + return $result; } $children = array(); foreach ( (array) $pages as $p ) { - $parent_id = intval( $p->post_parent ); $children[ $parent_id ][] = $p; - } + } - $result = array(); - _page_traverse_name( $page_id, $children, $result ); + $result = array(); + _page_traverse_name( $page_id, $children, $result ); return $result; } /** * function to traverse and return all the nested children post names of a root page. - * $children contains parent-chilren relations + * $children contains parent-children relations * + * @since 2.9.0 */ function _page_traverse_name( $page_id, &$children, &$result ){ - if ( isset( $children[ $page_id ] ) ){ - foreach( (array)$children[ $page_id ] as $child ) { - $result[ $child->ID ] = $child->post_name; _page_traverse_name( $child->ID, $children, $result ); } @@ -2433,20 +3587,16 @@ function _page_traverse_name( $page_id, &$children, &$result ){ * * @since 1.5.0 * - * @param int $page_id Page ID. + * @param mixed $page Page object or page ID. * @return string Page URI. */ -function get_page_uri($page_id) { - $page = get_page($page_id); - $uri = $page->post_name; +function get_page_uri($page) { + $page = get_post( $page ); - // A page cannot be it's own parent. - if ( $page->post_parent == $page->ID ) - return $uri; + $uri = $page->post_name; - while ($page->post_parent != 0) { - $page = get_page($page->post_parent); - $uri = $page->post_name . "/" . $uri; + foreach ( $page->ancestors as $parent ) { + $uri = get_post( $parent )->post_name . "/" . $uri; } return $uri; @@ -2465,16 +3615,19 @@ function get_page_uri($page_id) { * @param mixed $args Optional. Array or string of options that overrides defaults. * @return array List of pages matching defaults or $args */ -function &get_pages($args = '') { +function get_pages($args = '') { global $wpdb; + $pages = false; + $defaults = array( 'child_of' => 0, 'sort_order' => 'ASC', 'sort_column' => 'post_title', 'hierarchical' => 1, - 'exclude' => '', 'include' => '', + 'exclude' => array(), 'include' => array(), 'meta_key' => '', 'meta_value' => '', 'authors' => '', 'parent' => -1, 'exclude_tree' => '', - 'number' => '', 'offset' => 0 + 'number' => '', 'offset' => 0, + 'post_type' => 'page', 'post_status' => 'publish', ); $r = wp_parse_args( $args, $defaults ); @@ -2482,11 +3635,24 @@ function &get_pages($args = '') { $number = (int) $number; $offset = (int) $offset; + // Make sure the post type is hierarchical + $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) ); + if ( !in_array( $post_type, $hierarchical_post_types ) ) + return $pages; + + // Make sure we have a valid post status + if ( !is_array( $post_status ) ) + $post_status = explode( ',', $post_status ); + if ( array_diff( $post_status, get_post_stati() ) ) + return $pages; + $cache = array(); $key = md5( serialize( compact(array_keys($defaults)) ) ); if ( $cache = wp_cache_get( 'get_pages', 'posts' ) ) { - if ( is_array($cache) && isset( $cache[ $key ] ) ) { - $pages = apply_filters('get_pages', $cache[ $key ], $r ); + if ( is_array($cache) && isset( $cache[ $key ] ) && is_array( $cache[ $key ] ) ) { + // Convert to WP_Post instances + $pages = array_map( 'get_post', $cache[ $key ] ); + $pages = apply_filters( 'get_pages', $pages, $r ); return $pages; } } @@ -2502,8 +3668,8 @@ function &get_pages($args = '') { $meta_key = ''; $meta_value = ''; $hierarchical = false; - $incpages = preg_split('/[\s,]+/',$include); - if ( count($incpages) ) { + $incpages = wp_parse_id_list( $include ); + if ( ! empty( $incpages ) ) { foreach ( $incpages as $incpage ) { if (empty($inclusions)) $inclusions = $wpdb->prepare(' AND ( ID = %d ', $incpage); @@ -2517,8 +3683,8 @@ function &get_pages($args = '') { $exclusions = ''; if ( !empty($exclude) ) { - $expages = preg_split('/[\s,]+/',$exclude); - if ( count($expages) ) { + $expages = wp_parse_id_list( $exclude ); + if ( ! empty( $expages ) ) { foreach ( $expages as $expage ) { if (empty($exclusions)) $exclusions = $wpdb->prepare(' AND ( ID <> %d ', $expage); @@ -2534,11 +3700,11 @@ function &get_pages($args = '') { if (!empty($authors)) { $post_authors = preg_split('/[\s,]+/',$authors); - if ( count($post_authors) ) { + if ( ! empty( $post_authors ) ) { foreach ( $post_authors as $post_author ) { //Do we have an author id or an author login? if ( 0 == intval($post_author) ) { - $post_author = get_userdatabylogin($post_author); + $post_author = get_user_by('login', $post_author); if ( empty($post_author) ) continue; if ( empty($post_author->ID) ) @@ -2574,7 +3740,51 @@ function &get_pages($args = '') { if ( $parent >= 0 ) $where .= $wpdb->prepare(' AND post_parent = %d ', $parent); - $query = "SELECT * FROM $wpdb->posts $join WHERE (post_type = 'page' AND post_status = 'publish') $where "; + if ( 1 == count( $post_status ) ) { + $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $post_type, array_shift( $post_status ) ); + } else { + $post_status = implode( "', '", $post_status ); + $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $post_type ); + } + + $orderby_array = array(); + $allowed_keys = array('author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified', + 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent', + 'ID', 'rand', 'comment_count'); + foreach ( explode( ',', $sort_column ) as $orderby ) { + $orderby = trim( $orderby ); + if ( !in_array( $orderby, $allowed_keys ) ) + continue; + + switch ( $orderby ) { + case 'menu_order': + break; + case 'ID': + $orderby = "$wpdb->posts.ID"; + break; + case 'rand': + $orderby = 'RAND()'; + break; + case 'comment_count': + $orderby = "$wpdb->posts.comment_count"; + break; + default: + if ( 0 === strpos( $orderby, 'post_' ) ) + $orderby = "$wpdb->posts." . $orderby; + else + $orderby = "$wpdb->posts.post_" . $orderby; + } + + $orderby_array[] = $orderby; + + } + $sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title"; + + $sort_order = strtoupper( $sort_order ); + if ( '' !== $sort_order && !in_array( $sort_order, array( 'ASC', 'DESC' ) ) ) + $sort_order = 'ASC'; + + $query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where "; $query .= $author_query; $query .= " ORDER BY " . $sort_column . " " . $sort_order ; @@ -2595,10 +3805,10 @@ function &get_pages($args = '') { } // Update cache. - update_page_cache($pages); + update_post_cache( $pages ); if ( $child_of || $hierarchical ) - $pages = & get_page_children($child_of, $pages); + $pages = get_page_children($child_of, $pages); if ( !empty($exclude_tree) ) { $exclude = (int) $exclude_tree; @@ -2617,6 +3827,9 @@ function &get_pages($args = '') { $cache[ $key ] = $pages; wp_cache_set( 'get_pages', $cache, 'posts' ); + // Convert to WP_Post instances + $pages = array_map( 'get_post', $pages ); + $pages = apply_filters('get_pages', $pages, $r); return $pages; @@ -2635,12 +3848,12 @@ function &get_pages($args = '') { * @return bool True on success, false on failure. */ function is_local_attachment($url) { - if (strpos($url, get_bloginfo('url')) === false) + if (strpos($url, home_url()) === false) return false; - if (strpos($url, get_bloginfo('url') . '/?attachment_id=') !== false) + if (strpos($url, home_url('/?attachment_id=')) !== false) return true; if ( $id = url_to_postid($url) ) { - $post = & get_post($id); + $post = get_post($id); if ( 'attachment' == $post->post_type ) return true; } @@ -2685,36 +3898,43 @@ function is_local_attachment($url) { * * @param string|array $object Arguments to override defaults. * @param string $file Optional filename. - * @param int $post_parent Parent post ID. + * @param int $parent Parent post ID. * @return int Attachment ID. */ function wp_insert_attachment($object, $file = false, $parent = 0) { global $wpdb, $user_ID; - $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID, + $defaults = array('post_status' => 'inherit', 'post_type' => 'post', 'post_author' => $user_ID, 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0, 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', - 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0); + 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0, 'context' => ''); $object = wp_parse_args($object, $defaults); if ( !empty($parent) ) $object['post_parent'] = $parent; + unset( $object[ 'filter' ] ); + $object = sanitize_post($object, 'db'); // export array as variables extract($object, EXTR_SKIP); - // Make sure we set a valid category - if ( !isset($post_category) || 0 == count($post_category) || !is_array($post_category)) { - $post_category = array(get_option('default_category')); - } - if ( empty($post_author) ) $post_author = $user_ID; $post_type = 'attachment'; - $post_status = 'inherit'; + + if ( ! in_array( $post_status, array( 'inherit', 'private' ) ) ) + $post_status = 'inherit'; + + if ( !empty($post_category) ) + $post_category = array_filter($post_category); // Filter out empty terms + + // Make sure we set a valid category. + if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) { + $post_category = array(); + } // Are we updating or creating? if ( !empty($ID) ) { @@ -2798,15 +4018,30 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { $wpdb->update( $wpdb->posts, compact("post_name"), array( 'ID' => $post_ID ) ); } - wp_set_post_categories($post_ID, $post_category); + if ( is_object_in_taxonomy($post_type, 'category') ) + wp_set_post_categories( $post_ID, $post_category ); + + if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') ) + wp_set_post_tags( $post_ID, $tags_input ); + + // support for all custom taxonomies + if ( !empty($tax_input) ) { + foreach ( $tax_input as $taxonomy => $tags ) { + $taxonomy_obj = get_taxonomy($taxonomy); + if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical. + $tags = array_filter($tags); + if ( current_user_can($taxonomy_obj->cap->assign_terms) ) + wp_set_post_terms( $post_ID, $tags, $taxonomy ); + } + } if ( $file ) update_attached_file( $post_ID, $file ); - clean_post_cache($post_ID); + clean_post_cache( $post_ID ); - if ( isset($post_parent) && $post_parent < 0 ) - add_post_meta($post_ID, '_wp_attachment_temp_parent', $post_parent, true); + if ( ! empty( $context ) ) + add_post_meta( $post_ID, '_wp_attachment_context', $context, true ); if ( $update) { do_action('edit_attachment', $post_ID); @@ -2818,18 +4053,21 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { } /** - * Delete an attachment. + * Trashes or deletes an attachment. * - * Will remove the file also, when the attachment is removed. Removes all post - * meta fields, taxonomy, comments, etc associated with the attachment (except - * the main post). + * When an attachment is permanently deleted, the file will also be removed. + * Deletion removes all post meta fields, taxonomy, comments, etc. associated + * with the attachment (except the main post). + * + * The attachment is moved to the trash instead of permanently deleted unless trash + * for media is disabled, item is already in the trash, or $force_delete is true. * * @since 2.0.0 * @uses $wpdb * @uses do_action() Calls 'delete_attachment' hook on Attachment ID. * - * @param int $postid Attachment ID. - * @param bool $force_delete Whether to bypass trash and force deletion + * @param int $post_id Attachment ID. + * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false. * @return mixed False on failure. Post data on success. */ function wp_delete_attachment( $post_id, $force_delete = false ) { @@ -2851,31 +4089,32 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { $backup_sizes = get_post_meta( $post->ID, '_wp_attachment_backup_sizes', true ); $file = get_attached_file( $post_id ); + $intermediate_sizes = array(); + foreach ( get_intermediate_image_sizes() as $size ) { + if ( $intermediate = image_get_intermediate_size( $post_id, $size ) ) + $intermediate_sizes[] = $intermediate; + } + + if ( is_multisite() ) + delete_transient( 'dirsize_cache' ); + do_action('delete_attachment', $post_id); wp_delete_object_term_relationships($post_id, array('category', 'post_tag')); wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type)); - $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE meta_key = '_thumbnail_id' AND meta_value = %d", $post_id )); + delete_metadata( 'post', null, '_thumbnail_id', $post_id, true ); // delete all for any posts. $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id )); - if ( ! empty($comment_ids) ) { - do_action( 'delete_comment', $comment_ids ); - $in_comment_ids = "'" . implode("', '", $comment_ids) . "'"; - $wpdb->query( "DELETE FROM $wpdb->comments WHERE comment_ID IN($in_comment_ids)" ); - do_action( 'deleted_comment', $comment_ids ); - } + foreach ( $comment_ids as $comment_id ) + wp_delete_comment( $comment_id, true ); $post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $post_id )); - if ( !empty($post_meta_ids) ) { - do_action( 'delete_postmeta', $post_meta_ids ); - $in_post_meta_ids = "'" . implode("', '", $post_meta_ids) . "'"; - $wpdb->query( "DELETE FROM $wpdb->postmeta WHERE meta_id IN($in_post_meta_ids)" ); - do_action( 'deleted_postmeta', $post_meta_ids ); - } + foreach ( $post_meta_ids as $mid ) + delete_metadata_by_mid( 'post', $mid ); do_action( 'delete_post', $post_id ); - $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->posts WHERE ID = %d", $post_id )); + $wpdb->delete( $wpdb->posts, array( 'ID' => $post_id ) ); do_action( 'deleted_post', $post_id ); $uploadpath = wp_upload_dir(); @@ -2890,19 +4129,16 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { } // remove intermediate and backup images if there are any - $sizes = apply_filters('intermediate_image_sizes', array('thumbnail', 'medium', 'large')); - foreach ( $sizes as $size ) { - if ( $intermediate = image_get_intermediate_size($post_id, $size) ) { - $intermediate_file = apply_filters('wp_delete_file', $intermediate['path']); - @ unlink( path_join($uploadpath['basedir'], $intermediate_file) ); - } + foreach ( $intermediate_sizes as $intermediate ) { + $intermediate_file = apply_filters( 'wp_delete_file', $intermediate['path'] ); + @ unlink( path_join($uploadpath['basedir'], $intermediate_file) ); } if ( is_array($backup_sizes) ) { foreach ( $backup_sizes as $size ) { $del_file = path_join( dirname($meta['file']), $size['file'] ); $del_file = apply_filters('wp_delete_file', $del_file); - @ unlink( path_join($uploadpath['basedir'], $del_file) ); + @ unlink( path_join($uploadpath['basedir'], $del_file) ); } } @@ -2911,7 +4147,7 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { if ( ! empty($file) ) @ unlink($file); - clean_post_cache($post_id); + clean_post_cache( $post ); return $post; } @@ -2925,9 +4161,9 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { * @param bool $unfiltered Optional, default is false. If true, filters are not run. * @return string|bool Attachment meta field. False on failure. */ -function wp_get_attachment_metadata( $post_id, $unfiltered = false ) { +function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) { $post_id = (int) $post_id; - if ( !$post =& get_post( $post_id ) ) + if ( !$post = get_post( $post_id ) ) return false; $data = get_post_meta( $post->ID, '_wp_attachment_metadata', true ); @@ -2949,12 +4185,13 @@ function wp_get_attachment_metadata( $post_id, $unfiltered = false ) { */ function wp_update_attachment_metadata( $post_id, $data ) { $post_id = (int) $post_id; - if ( !$post =& get_post( $post_id ) ) + if ( !$post = get_post( $post_id ) ) return false; - $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ); - - return update_post_meta( $post->ID, '_wp_attachment_metadata', $data); + if ( $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ) ) + return update_post_meta( $post->ID, '_wp_attachment_metadata', $data ); + else + return delete_post_meta( $post->ID, '_wp_attachment_metadata' ); } /** @@ -2967,7 +4204,10 @@ function wp_update_attachment_metadata( $post_id, $data ) { */ function wp_get_attachment_url( $post_id = 0 ) { $post_id = (int) $post_id; - if ( !$post =& get_post( $post_id ) ) + if ( !$post = get_post( $post_id ) ) + return false; + + if ( 'attachment' != $post->post_type ) return false; $url = ''; @@ -2982,13 +4222,15 @@ function wp_get_attachment_url( $post_id = 0 ) { } } - 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. + if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recommended to rely upon this. $url = get_the_guid( $post->ID ); - if ( 'attachment' != $post->post_type || empty($url) ) + $url = apply_filters( 'wp_get_attachment_url', $url, $post->ID ); + + if ( empty( $url ) ) return false; - return apply_filters( 'wp_get_attachment_url', $url, $post->ID ); + return $url; } /** @@ -3001,7 +4243,7 @@ function wp_get_attachment_url( $post_id = 0 ) { */ function wp_get_attachment_thumb_file( $post_id = 0 ) { $post_id = (int) $post_id; - if ( !$post =& get_post( $post_id ) ) + if ( !$post = get_post( $post_id ) ) return false; if ( !is_array( $imagedata = wp_get_attachment_metadata( $post->ID ) ) ) return false; @@ -3023,7 +4265,7 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) { */ function wp_get_attachment_thumb_url( $post_id = 0 ) { $post_id = (int) $post_id; - if ( !$post =& get_post( $post_id ) ) + if ( !$post = get_post( $post_id ) ) return false; if ( !$url = wp_get_attachment_url( $post->ID ) ) return false; @@ -3050,7 +4292,7 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) { */ function wp_attachment_is_image( $post_id = 0 ) { $post_id = (int) $post_id; - if ( !$post =& get_post( $post_id ) ) + if ( !$post = get_post( $post_id ) ) return false; if ( !$file = get_attached_file( $post->ID ) ) @@ -3058,7 +4300,7 @@ function wp_attachment_is_image( $post_id = 0 ) { $ext = preg_match('/\.([^.]+)$/', $file, $matches) ? strtolower($matches[1]) : false; - $image_exts = array('jpg', 'jpeg', 'gif', 'png'); + $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' ); if ( 'image/' == substr($post->post_mime_type, 0, 6) || $ext && 'import' == $post->post_mime_type && in_array($ext, $image_exts) ) return true; @@ -3070,18 +4312,19 @@ function wp_attachment_is_image( $post_id = 0 ) { * * @since 2.1.0 * - * @param string $mime MIME type + * @param string|int $mime MIME type or attachment ID. * @return string|bool */ function wp_mime_type_icon( $mime = 0 ) { if ( !is_numeric($mime) ) $icon = wp_cache_get("mime_type_icon_$mime"); + + $post_id = 0; if ( empty($icon) ) { - $post_id = 0; $post_mimes = array(); if ( is_numeric($mime) ) { $mime = (int) $mime; - if ( $post =& get_post( $mime ) ) { + if ( $post = get_post( $mime ) ) { $post_id = (int) $post->ID; $ext = preg_replace('/^.+?\.([^.]+)$/', '$1', $post->guid); if ( !empty($ext) ) { @@ -3105,7 +4348,8 @@ function wp_mime_type_icon( $mime = 0 ) { $dirs = apply_filters( 'icon_dirs', array($icon_dir => $icon_dir_uri) ); $icon_files = array(); while ( $dirs ) { - $dir = array_shift($keys = array_keys($dirs)); + $keys = array_keys( $dirs ); + $dir = array_shift( $keys ); $uri = array_shift($dirs); if ( $dh = opendir($dir) ) { while ( false !== $file = readdir($dh) ) { @@ -3122,7 +4366,7 @@ function wp_mime_type_icon( $mime = 0 ) { closedir($dh); } } - wp_cache_set('icon_files', $icon_files, 600); + wp_cache_add( 'icon_files', $icon_files, 'default', 600 ); } // Icon basename - extension = MIME wildcard @@ -3142,7 +4386,7 @@ function wp_mime_type_icon( $mime = 0 ) { if ( isset($types[$wilds[0]])) { $icon = $types[$wilds[0]]; if ( !is_numeric($mime) ) - wp_cache_set("mime_type_icon_$mime", $icon); + wp_cache_add("mime_type_icon_$mime", $icon); break; } } @@ -3152,100 +4396,114 @@ function wp_mime_type_icon( $mime = 0 ) { } /** - * Checked for changed slugs for published posts and save old slug. + * Checked for changed slugs for published post objects and save the old slug. * - * The function is used along with form POST data. It checks for the wp-old-slug - * POST field. Will only be concerned with published posts and the slug actually - * changing. + * The function is used when a post object of any type is updated, + * by comparing the current and previous post objects. * * If the slug was changed and not already part of the old slugs then it will be * added to the post meta field ('_wp_old_slug') for storing old slugs for that * post. * - * The most logically usage of this function is redirecting changed posts, so + * The most logically usage of this function is redirecting changed post objects, so * that those that linked to an changed post will be redirected to the new post. * * @since 2.1.0 * * @param int $post_id Post ID. + * @param object $post The Post Object + * @param object $post_before The Previous Post Object * @return int Same as $post_id */ -function wp_check_for_changed_slugs($post_id) { - if ( !isset($_POST['wp-old-slug']) || !strlen($_POST['wp-old-slug']) ) - return $post_id; - - $post = &get_post($post_id); - - // we're only concerned with published posts - if ( $post->post_status != 'publish' || $post->post_type != 'post' ) - return $post_id; +function wp_check_for_changed_slugs($post_id, $post, $post_before) { + // dont bother if it hasnt changed + if ( $post->post_name == $post_before->post_name ) + return; - // only bother if the slug has changed - if ( $post->post_name == $_POST['wp-old-slug'] ) - return $post_id; + // we're only concerned with published, non-hierarchical objects + if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) ) + return; $old_slugs = (array) get_post_meta($post_id, '_wp_old_slug'); // if we haven't added this old slug before, add it now - if ( !count($old_slugs) || !in_array($_POST['wp-old-slug'], $old_slugs) ) - add_post_meta($post_id, '_wp_old_slug', $_POST['wp-old-slug']); + if ( !empty( $post_before->post_name ) && !in_array($post_before->post_name, $old_slugs) ) + add_post_meta($post_id, '_wp_old_slug', $post_before->post_name); // if the new slug was used previously, delete it from the list if ( in_array($post->post_name, $old_slugs) ) delete_post_meta($post_id, '_wp_old_slug', $post->post_name); - - return $post_id; } /** * Retrieve the private post SQL based on capability. * * This function provides a standardized way to appropriately select on the - * post_status of posts/pages. The function will return a piece of SQL code that - * can be added to a WHERE clause; this SQL is constructed to allow all + * post_status of a post type. The function will return a piece of SQL code + * that can be added to a WHERE clause; this SQL is constructed to allow all * published posts, and all private posts to which the user has access. * - * It also allows plugins that define their own post type to control the cap by - * using the hook 'pub_priv_sql_capability'. The plugin is expected to return - * the capability the user must have to read the private post type. - * * @since 2.2.0 * * @uses $user_ID - * @uses apply_filters() Call 'pub_priv_sql_capability' filter for plugins with different post types. * * @param string $post_type currently only supports 'post' or 'page'. * @return string SQL code that can be added to a where clause. */ -function get_private_posts_cap_sql($post_type) { - global $user_ID; - $cap = ''; +function get_private_posts_cap_sql( $post_type ) { + return get_posts_by_author_sql( $post_type, false ); +} + +/** + * Retrieve the post SQL based on capability, author, and type. + * + * @see get_private_posts_cap_sql() for full description. + * + * @since 3.0.0 + * @param string $post_type Post type. + * @param bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term. + * @param int $post_author Optional. Query posts having a single author ID. + * @param bool $public_only Optional. Only return public posts. Skips cap checks for $current_user. Default is false. + * @return string SQL WHERE code that can be added to a query. + */ +function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) { + global $user_ID, $wpdb; // Private posts - if ($post_type == 'post') { - $cap = 'read_private_posts'; - // Private pages - } elseif ($post_type == 'page') { - $cap = 'read_private_pages'; - // Dunno what it is, maybe plugins have their own post type? - } else { - $cap = apply_filters('pub_priv_sql_capability', $cap); + $post_type_obj = get_post_type_object( $post_type ); + if ( ! $post_type_obj ) + return $full ? 'WHERE 1 = 0' : ' 1 = 0 '; - if (empty($cap)) { - // We don't know what it is, filters don't change anything, - // so set the SQL up to return nothing. - return '1 = 0'; + // This hook is deprecated. Why you'd want to use it, I dunno. + if ( ! $cap = apply_filters( 'pub_priv_sql_capability', '' ) ) + $cap = $post_type_obj->cap->read_private_posts; + + if ( $full ) { + if ( null === $post_author ) { + $sql = $wpdb->prepare( 'WHERE post_type = %s AND ', $post_type ); + } else { + $sql = $wpdb->prepare( 'WHERE post_author = %d AND post_type = %s AND ', $post_author, $post_type ); } + } else { + $sql = ''; } - $sql = '(post_status = \'publish\''; - - if (current_user_can($cap)) { - // Does the user have the capability to view private posts? Guess so. - $sql .= ' OR post_status = \'private\''; - } elseif (is_user_logged_in()) { - // Users can view their own private posts. - $sql .= ' OR post_status = \'private\' AND post_author = \'' . $user_ID . '\''; + $sql .= "(post_status = 'publish'"; + + // Only need to check the cap if $public_only is false + if ( false === $public_only ) { + if ( current_user_can( $cap ) ) { + // Does the user have the capability to view private posts? Guess so. + $sql .= " OR post_status = 'private'"; + } elseif ( is_user_logged_in() ) { + // Users can view their own private posts. + $id = (int) $user_ID; + if ( null === $post_author || ! $full ) { + $sql .= " OR post_status = 'private' AND post_author = $id"; + } elseif ( $id == (int) $post_author ) { + $sql .= " OR post_status = 'private'"; + } // else none + } // else none } $sql .= ')'; @@ -3254,7 +4512,7 @@ function get_private_posts_cap_sql($post_type) { } /** - * Retrieve the date the the last post was published. + * Retrieve the date that the last post was published. * * The server timezone is the default and is the difference between GMT and * server time. The 'blog' value is the date when the last post was posted. The @@ -3262,36 +4520,13 @@ function get_private_posts_cap_sql($post_type) { * * @since 0.71 * - * @uses $wpdb - * @uses $blog_id * @uses apply_filters() Calls 'get_lastpostdate' filter * - * @global mixed $cache_lastpostdate Stores the last post date - * @global mixed $pagenow The current page being viewed - * * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. * @return string The date of the last post. */ function get_lastpostdate($timezone = 'server') { - global $cache_lastpostdate, $wpdb, $blog_id; - $add_seconds_server = date('Z'); - if ( !isset($cache_lastpostdate[$blog_id][$timezone]) ) { - switch(strtolower($timezone)) { - case 'gmt': - $lastpostdate = $wpdb->get_var("SELECT post_date_gmt FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_date_gmt DESC LIMIT 1"); - break; - case 'blog': - $lastpostdate = $wpdb->get_var("SELECT post_date FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_date_gmt DESC LIMIT 1"); - break; - case 'server': - $lastpostdate = $wpdb->get_var("SELECT DATE_ADD(post_date_gmt, INTERVAL '$add_seconds_server' SECOND) FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_date_gmt DESC LIMIT 1"); - break; - } - $cache_lastpostdate[$blog_id][$timezone] = $lastpostdate; - } else { - $lastpostdate = $cache_lastpostdate[$blog_id][$timezone]; - } - return apply_filters( 'get_lastpostdate', $lastpostdate, $timezone ); + return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date' ), $timezone ); } /** @@ -3302,58 +4537,84 @@ function get_lastpostdate($timezone = 'server') { * 'gmt' is when the last post was modified in GMT time. * * @since 1.2.0 - * @uses $wpdb - * @uses $blog_id * @uses apply_filters() Calls 'get_lastpostmodified' filter * - * @global mixed $cache_lastpostmodified Stores the date the last post was modified + * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. + * @return string The date the post was last modified. + */ +function get_lastpostmodified($timezone = 'server') { + $lastpostmodified = _get_last_post_time( $timezone, 'modified' ); + + $lastpostdate = get_lastpostdate($timezone); + if ( $lastpostdate > $lastpostmodified ) + $lastpostmodified = $lastpostdate; + + return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone ); +} + +/** + * Retrieve latest post date data based on timezone. + * + * @access private + * @since 3.1.0 * * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. - * @return string The date the post was last modified. + * @param string $field Field to check. Can be 'date' or 'modified'. + * @return string The date. */ -function get_lastpostmodified($timezone = 'server') { - global $cache_lastpostmodified, $wpdb, $blog_id; - $add_seconds_server = date('Z'); - if ( !isset($cache_lastpostmodified[$blog_id][$timezone]) ) { - switch(strtolower($timezone)) { +function _get_last_post_time( $timezone, $field ) { + global $wpdb; + + if ( !in_array( $field, array( 'date', 'modified' ) ) ) + return false; + + $timezone = strtolower( $timezone ); + + $key = "lastpost{$field}:$timezone"; + + $date = wp_cache_get( $key, 'timeinfo' ); + + if ( !$date ) { + $add_seconds_server = date('Z'); + + $post_types = get_post_types( array( 'public' => true ) ); + array_walk( $post_types, array( &$wpdb, 'escape_by_ref' ) ); + $post_types = "'" . implode( "', '", $post_types ) . "'"; + + switch ( $timezone ) { case 'gmt': - $lastpostmodified = $wpdb->get_var("SELECT post_modified_gmt FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_modified_gmt DESC LIMIT 1"); + $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"); break; case 'blog': - $lastpostmodified = $wpdb->get_var("SELECT post_modified FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_modified_gmt DESC LIMIT 1"); + $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"); break; case 'server': - $lastpostmodified = $wpdb->get_var("SELECT DATE_ADD(post_modified_gmt, INTERVAL '$add_seconds_server' SECOND) FROM $wpdb->posts WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_modified_gmt DESC LIMIT 1"); + $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"); break; } - $lastpostdate = get_lastpostdate($timezone); - if ( $lastpostdate > $lastpostmodified ) { - $lastpostmodified = $lastpostdate; - } - $cache_lastpostmodified[$blog_id][$timezone] = $lastpostmodified; - } else { - $lastpostmodified = $cache_lastpostmodified[$blog_id][$timezone]; + + if ( $date ) + wp_cache_set( $key, $date, 'timeinfo' ); } - return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone ); + + return $date; } /** * Updates posts in cache. * - * @usedby update_page_cache() Aliased by this function. - * * @package WordPress * @subpackage Cache * @since 1.5.1 * * @param array $posts Array of post objects */ -function update_post_cache(&$posts) { - if ( !$posts ) +function update_post_cache( &$posts ) { + if ( ! $posts ) return; foreach ( $posts as $post ) - wp_cache_add($post->ID, $post, 'posts'); + wp_cache_add( $post->ID, $post, 'posts' ); } /** @@ -3362,8 +4623,6 @@ function update_post_cache(&$posts) { * Cleaning means delete from the cache of the post. Will call to clean the term * object cache associated with the post ID. * - * clean_post_cache() will call itself recursively for each child post. - * * This function not run if $_wp_suspend_cache_invalidation is not empty. See * wp_suspend_cache_invalidation(). * @@ -3373,67 +4632,34 @@ function update_post_cache(&$posts) { * * @uses do_action() Calls 'clean_post_cache' on $id before adding children (if any). * - * @param int $id The Post ID in the cache to clean + * @param object|int $post The post object or ID to remove from the cache */ -function clean_post_cache($id) { +function clean_post_cache( $post ) { global $_wp_suspend_cache_invalidation, $wpdb; - if ( !empty($_wp_suspend_cache_invalidation) ) + if ( ! empty( $_wp_suspend_cache_invalidation ) ) return; - $id = (int) $id; + $post = get_post( $post ); + if ( empty( $post ) ) + return; - wp_cache_delete($id, 'posts'); - wp_cache_delete($id, 'post_meta'); + wp_cache_delete( $post->ID, 'posts' ); + wp_cache_delete( $post->ID, 'post_meta' ); - clean_object_term_cache($id, 'post'); + clean_object_term_cache( $post->ID, $post->post_type ); wp_cache_delete( 'wp_get_archives', 'general' ); - do_action('clean_post_cache', $id); - - if ( $children = $wpdb->get_col( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_parent = %d", $id) ) ) { - foreach( $children as $cid ) - clean_post_cache( $cid ); - } -} - -/** - * Alias of update_post_cache(). - * - * @see update_post_cache() Posts and pages are the same, alias is intentional - * - * @package WordPress - * @subpackage Cache - * @since 1.5.1 - * - * @param array $pages list of page objects - */ -function update_page_cache(&$pages) { - update_post_cache($pages); -} - -/** - * Will clean the page in the cache. - * - * Clean (read: delete) page from cache that matches $id. Will also clean cache - * associated with 'all_page_ids' and 'get_pages'. - * - * @package WordPress - * @subpackage Cache - * @since 2.0.0 - * - * @uses do_action() Will call the 'clean_page_cache' hook action. - * - * @param int $id Page ID to clean - */ -function clean_page_cache($id) { - clean_post_cache($id); + do_action( 'clean_post_cache', $post->ID, $post ); - wp_cache_delete( 'all_page_ids', 'posts' ); - wp_cache_delete( 'get_pages', 'posts' ); + if ( is_post_type_hierarchical( $post->post_type ) ) + wp_cache_delete( 'get_pages', 'posts' ); - do_action('clean_page_cache', $id); + if ( 'page' == $post->post_type ) { + wp_cache_delete( 'all_page_ids', 'posts' ); + do_action( 'clean_page_cache', $post->ID ); + } } /** @@ -3449,8 +4675,11 @@ function clean_page_cache($id) { * @uses update_postmeta_cache() * * @param array $posts Array of Post objects + * @param string $post_type The post type of the posts in $posts. Default is 'post'. + * @param bool $update_term_cache Whether to update the term cache. Default is true. + * @param bool $update_meta_cache Whether to update the meta cache. Default is true. */ -function update_post_caches(&$posts) { +function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) { // No point in doing all this work if we didn't match any posts. if ( !$posts ) return; @@ -3458,13 +4687,30 @@ function update_post_caches(&$posts) { update_post_cache($posts); $post_ids = array(); + foreach ( $posts as $post ) + $post_ids[] = $post->ID; + + if ( ! $post_type ) + $post_type = 'any'; + + if ( $update_term_cache ) { + if ( is_array($post_type) ) { + $ptypes = $post_type; + } elseif ( 'any' == $post_type ) { + // Just use the post_types in the supplied posts. + foreach ( $posts as $post ) + $ptypes[] = $post->post_type; + $ptypes = array_unique($ptypes); + } else { + $ptypes = array($post_type); + } - for ($i = 0; $i < count($posts); $i++) - $post_ids[] = $posts[$i]->ID; - - update_object_term_cache($post_ids, 'post'); + if ( ! empty($ptypes) ) + update_object_term_cache($post_ids, $ptypes); + } - update_postmeta_cache($post_ids); + if ( $update_meta_cache ) + update_postmeta_cache($post_ids); } /** @@ -3487,6 +4733,41 @@ function update_postmeta_cache($post_ids) { return update_meta_cache('post', $post_ids); } +/** + * Will clean the attachment in the cache. + * + * Cleaning means delete from the cache. Optionally will clean the term + * object cache associated with the attachment ID. + * + * This function will not run if $_wp_suspend_cache_invalidation is not empty. See + * wp_suspend_cache_invalidation(). + * + * @package WordPress + * @subpackage Cache + * @since 3.0.0 + * + * @uses do_action() Calls 'clean_attachment_cache' on $id. + * + * @param int $id The attachment ID in the cache to clean + * @param bool $clean_terms optional. Whether to clean terms cache + */ +function clean_attachment_cache($id, $clean_terms = false) { + global $_wp_suspend_cache_invalidation; + + if ( !empty($_wp_suspend_cache_invalidation) ) + return; + + $id = (int) $id; + + wp_cache_delete($id, 'posts'); + wp_cache_delete($id, 'post_meta'); + + if ( $clean_terms ) + clean_object_term_cache($id, 'attachment'); + + do_action('clean_attachment_cache', $id); +} + // // Hooks // @@ -3514,8 +4795,16 @@ function _transition_post_status($new_status, $old_status, $post) { do_action('private_to_published', $post->ID); // Deprecated, use private_to_publish } + // If published posts changed clear the lastpostmodified cache + if ( 'publish' == $new_status || 'publish' == $old_status) { + foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) { + wp_cache_delete( "lastpostmodified:$timezone", 'timeinfo' ); + wp_cache_delete( "lastpostdate:$timezone", 'timeinfo' ); + } + } + // Always clears the hook in case the post status bounced from future to draft. - wp_clear_scheduled_hook('publish_future_post', $post->ID); + wp_clear_scheduled_hook('publish_future_post', array( $post->ID ) ); } /** @@ -3526,12 +4815,14 @@ function _transition_post_status($new_status, $old_status, $post) { * @since 2.3.0 * @access private * - * @param int $deprecated Not Used. Can be set to null. + * @param int $deprecated Not used. Can be set to null. Never implemented. + * Not marked as deprecated with _deprecated_argument() as it conflicts with + * wp_transition_post_status() and the default filter for _future_post_hook(). * @param object $post Object type containing the post information */ -function _future_post_hook($deprecated = '', $post) { - wp_clear_scheduled_hook( 'publish_future_post', $post->ID ); - wp_schedule_single_event(strtotime($post->post_date_gmt. ' GMT'), 'publish_future_post', array($post->ID)); +function _future_post_hook( $deprecated = '', $post ) { + wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) ); + wp_schedule_single_event( strtotime( get_gmt_from_date( $post->post_date ) . ' GMT') , 'publish_future_post', array( $post->ID ) ); } /** @@ -3540,9 +4831,8 @@ function _future_post_hook($deprecated = '', $post) { * @since 2.3.0 * @access private * @uses $wpdb - * @uses XMLRPC_REQUEST and APP_REQUEST constants. + * @uses XMLRPC_REQUEST constant. * @uses do_action() Calls 'xmlprc_publish_post' on post ID if XMLRPC_REQUEST is defined. - * @uses do_action() Calls 'app_publish_post' on post ID if APP_REQUEST is defined. * * @param int $post_id The ID in the database table of the post being published */ @@ -3551,98 +4841,22 @@ function _publish_post_hook($post_id) { if ( defined('XMLRPC_REQUEST') ) do_action('xmlrpc_publish_post', $post_id); - if ( defined('APP_REQUEST') ) - do_action('app_publish_post', $post_id); if ( defined('WP_IMPORTING') ) return; - $data = array( 'post_id' => $post_id, 'meta_value' => '1' ); - if ( get_option('default_pingback_flag') ) { - $wpdb->insert( $wpdb->postmeta, $data + array( 'meta_key' => '_pingme' ) ); - do_action( 'added_postmeta', $wpdb->insert_id, $post_id, '_pingme', 1 ); - } - $wpdb->insert( $wpdb->postmeta, $data + array( 'meta_key' => '_encloseme' ) ); - do_action( 'added_postmeta', $wpdb->insert_id, $post_id, '_encloseme', 1 ); + if ( get_option('default_pingback_flag') ) + add_post_meta( $post_id, '_pingme', '1' ); + add_post_meta( $post_id, '_encloseme', '1' ); wp_schedule_single_event(time(), 'do_pings'); } -/** - * Hook used to prevent page/post cache and rewrite rules from staying dirty. - * - * Does two things. If the post is a page and has a template then it will - * update/add that template to the meta. For both pages and posts, it will clean - * the post cache to make sure that the cache updates to the changes done - * recently. For pages, the rewrite rules of WordPress are flushed to allow for - * any changes. - * - * The $post parameter, only uses 'post_type' property and 'page_template' - * property. - * - * @since 2.3.0 - * @access private - * @uses $wp_rewrite Flushes Rewrite Rules. - * - * @param int $post_id The ID in the database table for the $post - * @param object $post Object type containing the post information - */ -function _save_post_hook($post_id, $post) { - if ( $post->post_type == 'page' ) { - clean_page_cache($post_id); - // Avoid flushing rules for every post during import. - if ( !defined('WP_IMPORTING') ) { - global $wp_rewrite; - $wp_rewrite->flush_rules(false); - } - } else { - clean_post_cache($post_id); - } -} - -/** - * Retrieve post ancestors and append to post ancestors property. - * - * Will only retrieve ancestors once, if property is already set, then nothing - * will be done. If there is not a parent post, or post ID and post parent ID - * are the same then nothing will be done. - * - * The parameter is passed by reference, so nothing needs to be returned. The - * property will be updated and can be referenced after the function is - * complete. The post parent will be an ancestor and the parent of the post - * parent will be an ancestor. There will only be two ancestors at the most. - * - * @since unknown - * @access private - * @uses $wpdb - * - * @param object $_post Post data. - * @return null When nothing needs to be done. - */ -function _get_post_ancestors(&$_post) { - global $wpdb; - - if ( isset($_post->ancestors) ) - return; - - $_post->ancestors = array(); - - if ( empty($_post->post_parent) || $_post->ID == $_post->post_parent ) - return; - - $id = $_post->ancestors[] = $_post->post_parent; - while ( $ancestor = $wpdb->get_var( $wpdb->prepare("SELECT `post_parent` FROM $wpdb->posts WHERE ID = %d LIMIT 1", $id) ) ) { - if ( $id == $ancestor ) - break; - $id = $_post->ancestors[] = $ancestor; - } -} - /** * Determines which fields of posts are to be saved in revisions. * * Does two things. If passed a post *array*, it will return a post array ready - * to be insterted into the posts table as a post revision. Otherwise, returns + * to be inserted into the posts table as a post revision. Otherwise, returns * an array whose keys are the post fields to be saved for post revisions. * * @package WordPress @@ -3711,13 +4925,16 @@ function wp_save_post_revision( $post_id ) { return; // WP_POST_REVISIONS = 0, false - if ( !constant('WP_POST_REVISIONS') ) + if ( ! WP_POST_REVISIONS ) return; if ( !$post = get_post( $post_id, ARRAY_A ) ) return; - if ( !in_array( $post['post_type'], array( 'post', 'page' ) ) ) + if ( 'auto-draft' == $post['post_status'] ) + return; + + if ( !post_type_supports($post['post_type'], 'revisions') ) return; $return = _wp_put_post_revision( $post ); @@ -3729,7 +4946,7 @@ function wp_save_post_revision( $post_id ) { // all revisions and (possibly) one autosave $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) ); - // WP_POST_REVISIONS = (int) (# of autasaves to save) + // WP_POST_REVISIONS = (int) (# of autosaves to save) $delete = count($revisions) - WP_POST_REVISIONS; if ( $delete < 1 ) @@ -3878,10 +5095,10 @@ function _wp_put_post_revision( $post = null, $autosave = false ) { * * @param int|object $post Post ID or post object * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. - * @param string $filter Optional sanitation filter. @see sanitize_post() + * @param string $filter Optional sanitation filter. @see sanitize_post() * @return mixed Null if error or post object if success */ -function &wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') { +function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') { $null = null; if ( !$revision = get_post( $post, OBJECT, $filter ) ) return $revision; @@ -3960,8 +5177,7 @@ function wp_restore_post_revision( $revision_id, $fields = null ) { * @uses wp_delete_post() * * @param int|object $revision_id Revision ID or revision object. - * @param array $fields Optional. What fields to restore from. Defaults to all. - * @return mixed Null if error, false if no fields to restore, (int) post ID if success. + * @return mixed Null or WP_Error if error, deleted post if success. */ function wp_delete_post_revision( $revision_id ) { if ( !$revision = wp_get_post_revision( $revision_id ) ) @@ -3990,7 +5206,7 @@ function wp_delete_post_revision( $revision_id ) { * @return array empty if no revisions */ function wp_get_post_revisions( $post_id = 0, $args = null ) { - if ( !constant('WP_POST_REVISIONS') ) + if ( ! WP_POST_REVISIONS ) return array(); if ( ( !$post = get_post( $post_id ) ) || empty( $post->ID ) ) return array(); @@ -4034,3 +5250,309 @@ function _show_post_preview() { add_filter('the_preview', '_set_preview'); } } + +/** + * Returns the post's parent's post_ID + * + * @since 3.1.0 + * + * @param int $post_id + * + * @return int|bool false on error + */ +function wp_get_post_parent_id( $post_ID ) { + $post = get_post( $post_ID ); + if ( !$post || is_wp_error( $post ) ) + return false; + return (int) $post->post_parent; +} + +/** + * Checks the given subset of the post hierarchy for hierarchy loops. + * Prevents loops from forming and breaks those that it finds. + * + * Attached to the wp_insert_post_parent filter. + * + * @since 3.1.0 + * @uses wp_find_hierarchy_loop() + * + * @param int $post_parent ID of the parent for the post we're checking. + * @param int $post_ID ID of the post we're checking. + * + * @return int The new post_parent for the post. + */ +function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) { + // Nothing fancy here - bail + if ( !$post_parent ) + return 0; + + // New post can't cause a loop + if ( empty( $post_ID ) ) + return $post_parent; + + // Can't be its own parent + if ( $post_parent == $post_ID ) + return 0; + + // Now look for larger loops + + if ( !$loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent ) ) + return $post_parent; // No loop + + // Setting $post_parent to the given value causes a loop + if ( isset( $loop[$post_ID] ) ) + return 0; + + // There's a loop, but it doesn't contain $post_ID. Break the loop. + foreach ( array_keys( $loop ) as $loop_member ) + wp_update_post( array( 'ID' => $loop_member, 'post_parent' => 0 ) ); + + return $post_parent; +} + +/** + * Returns an array of post format slugs to their translated and pretty display versions + * + * @since 3.1.0 + * + * @return array The array of translations + */ +function get_post_format_strings() { + $strings = array( + 'standard' => _x( 'Standard', 'Post format' ), // Special case. any value that evals to false will be considered standard + 'aside' => _x( 'Aside', 'Post format' ), + 'chat' => _x( 'Chat', 'Post format' ), + 'gallery' => _x( 'Gallery', 'Post format' ), + 'link' => _x( 'Link', 'Post format' ), + 'image' => _x( 'Image', 'Post format' ), + 'quote' => _x( 'Quote', 'Post format' ), + 'status' => _x( 'Status', 'Post format' ), + 'video' => _x( 'Video', 'Post format' ), + 'audio' => _x( 'Audio', 'Post format' ), + ); + return $strings; +} + +/** + * Retrieves an array of post format slugs. + * + * @since 3.1.0 + * + * @return array The array of post format slugs. + */ +function get_post_format_slugs() { + $slugs = array_keys( get_post_format_strings() ); + return array_combine( $slugs, $slugs ); +} + +/** + * Returns a pretty, translated version of a post format slug + * + * @since 3.1.0 + * + * @param string $slug A post format slug + * @return string The translated post format name + */ +function get_post_format_string( $slug ) { + $strings = get_post_format_strings(); + if ( !$slug ) + return $strings['standard']; + else + return ( isset( $strings[$slug] ) ) ? $strings[$slug] : ''; +} + +/** + * Sets a post thumbnail. + * + * @since 3.1.0 + * + * @param int|object $post Post ID or object where thumbnail should be attached. + * @param int $thumbnail_id Thumbnail to attach. + * @return bool True on success, false on failure. + */ +function set_post_thumbnail( $post, $thumbnail_id ) { + $post = get_post( $post ); + $thumbnail_id = absint( $thumbnail_id ); + if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) { + if ( $thumbnail_html = wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) ) + return update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id ); + else + return delete_post_meta( $post->ID, '_thumbnail_id' ); + } + return false; +} + +/** + * Removes a post thumbnail. + * + * @since 3.3.0 + * + * @param int|object $post Post ID or object where thumbnail should be removed from. + * @return bool True on success, false on failure. + */ +function delete_post_thumbnail( $post ) { + $post = get_post( $post ); + if ( $post ) + return delete_post_meta( $post->ID, '_thumbnail_id' ); + return false; +} + +/** + * Returns a link to a post format index. + * + * @since 3.1.0 + * + * @param string $format Post format + * @return string Link + */ +function get_post_format_link( $format ) { + $term = get_term_by('slug', 'post-format-' . $format, 'post_format' ); + if ( ! $term || is_wp_error( $term ) ) + return false; + return get_term_link( $term ); +} + +/** + * Deletes auto-drafts for new posts that are > 7 days old + * + * @since 3.4.0 + */ +function wp_delete_auto_drafts() { + global $wpdb; + + // Cleanup old auto-drafts more than 7 days old + $old_posts = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_status = 'auto-draft' AND DATE_SUB( NOW(), INTERVAL 7 DAY ) > post_date" ); + foreach ( (array) $old_posts as $delete ) + wp_delete_post( $delete, true ); // Force delete +} + +/** + * Filters the request to allow for the format prefix. + * + * @access private + * @since 3.1.0 + */ +function _post_format_request( $qvs ) { + if ( ! isset( $qvs['post_format'] ) ) + return $qvs; + $slugs = get_post_format_slugs(); + if ( isset( $slugs[ $qvs['post_format'] ] ) ) + $qvs['post_format'] = 'post-format-' . $slugs[ $qvs['post_format'] ]; + $tax = get_taxonomy( 'post_format' ); + if ( ! is_admin() ) + $qvs['post_type'] = $tax->object_type; + return $qvs; +} +add_filter( 'request', '_post_format_request' ); + +/** + * Filters the post format term link to remove the format prefix. + * + * @access private + * @since 3.1.0 + */ +function _post_format_link( $link, $term, $taxonomy ) { + global $wp_rewrite; + if ( 'post_format' != $taxonomy ) + return $link; + if ( $wp_rewrite->get_extra_permastruct( $taxonomy ) ) { + return str_replace( "/{$term->slug}", '/' . str_replace( 'post-format-', '', $term->slug ), $link ); + } else { + $link = remove_query_arg( 'post_format', $link ); + return add_query_arg( 'post_format', str_replace( 'post-format-', '', $term->slug ), $link ); + } +} +add_filter( 'term_link', '_post_format_link', 10, 3 ); + +/** + * Remove the post format prefix from the name property of the term object created by get_term(). + * + * @access private + * @since 3.1.0 + */ +function _post_format_get_term( $term ) { + if ( isset( $term->slug ) ) { + $term->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) ); + } + return $term; +} +add_filter( 'get_post_format', '_post_format_get_term' ); + +/** + * Remove the post format prefix from the name property of the term objects created by get_terms(). + * + * @access private + * @since 3.1.0 + */ +function _post_format_get_terms( $terms, $taxonomies, $args ) { + if ( in_array( 'post_format', (array) $taxonomies ) ) { + if ( isset( $args['fields'] ) && 'names' == $args['fields'] ) { + foreach( $terms as $order => $name ) { + $terms[$order] = get_post_format_string( str_replace( 'post-format-', '', $name ) ); + } + } else { + foreach ( (array) $terms as $order => $term ) { + if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) { + $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) ); + } + } + } + } + return $terms; +} +add_filter( 'get_terms', '_post_format_get_terms', 10, 3 ); + +/** + * Remove the post format prefix from the name property of the term objects created by wp_get_object_terms(). + * + * @access private + * @since 3.1.0 + */ +function _post_format_wp_get_object_terms( $terms ) { + foreach ( (array) $terms as $order => $term ) { + if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) { + $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) ); + } + } + return $terms; +} +add_filter( 'wp_get_object_terms', '_post_format_wp_get_object_terms' ); + +/** + * Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts. + * + * @access private + * @param string $new_status + * @param string $old_status + * @param object $post + * @since 3.3.0 + */ +function _update_term_count_on_transition_post_status( $new_status, $old_status, $post ) { + // Update counts for the post's terms. + foreach ( (array) get_object_taxonomies( $post->post_type ) as $taxonomy ) { + $tt_ids = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'tt_ids' ) ); + wp_update_term_count( $tt_ids, $taxonomy ); + } +} + +/** + * Adds any posts from the given ids to the cache that do not already exist in cache + * + * @since 3.4.0 + * + * @access private + * + * @param array $post_ids ID list + * @param bool $update_term_cache Whether to update the term cache. Default is true. + * @param bool $update_meta_cache Whether to update the meta cache. Default is true. + */ +function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) { + global $wpdb; + + $non_cached_ids = _get_non_cached_ids( $ids, 'posts' ); + if ( !empty( $non_cached_ids ) ) { + $fresh_posts = $wpdb->get_results( sprintf( "SELECT $wpdb->posts.* FROM $wpdb->posts WHERE ID IN (%s)", join( ",", $non_cached_ids ) ) ); + + update_post_caches( $fresh_posts, 'any', $update_term_cache, $update_meta_cache ); + } +}