X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..76aea3697c6043c1613370f172395b4f65ee71f0:/wp-includes/post.php diff --git a/wp-includes/post.php b/wp-includes/post.php index c648adc3..32526400 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -1,9 +1,36 @@ post_parent; + $args = array('post_parent' => (int) $GLOBALS['post']->post_parent ); } else { return false; } } elseif ( is_object( $args ) ) { - $args = 'post_parent=' . (int) $args->post_parent; + $args = array('post_parent' => (int) $args->post_parent ); } elseif ( is_numeric( $args ) ) { - $args = 'post_parent=' . (int) $args; + $args = array('post_parent' => (int) $args); } $defaults = array( @@ -48,15 +132,13 @@ function &get_children($args = '', $output = OBJECT) { $r = wp_parse_args( $args, $defaults ); $children = get_posts( $r ); - - if ( $children ) { - foreach ( $children as $key => $child ) { - $post_cache[$blog_id][$child->ID] =& $children[$key]; - $kids[$child->ID] =& $children[$key]; - } - } else { + if ( !$children ) return false; - } + + update_post_cache($children); + + foreach ( $children as $key => $child ) + $kids[$child->ID] =& $children[$key]; if ( $output == OBJECT ) { return $kids; @@ -73,7 +155,18 @@ function &get_children($args = '', $output = OBJECT) { } } -// get extended entry info () +/** + * get_extended() - Get extended entry info () + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * + * @param string $post {@internal Missing Description}} + * @return array {@internal Missing Description}} + */ function get_extended($post) { //Match the new style more links if ( preg_match('//', $post, $matches) ) { @@ -90,53 +183,99 @@ function get_extended($post) { return array('main' => $main, 'extended' => $extended); } -// Retrieves post data given a post ID or post object. -// Handles post caching. +/** + * get_post() - Retrieves post data given a post ID or post object. + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5.1 + * @uses $wpdb + * @link http://codex.wordpress.org/Function_Reference/get_post + * + * @param int|object &$post post ID or post object + * @param string $output {@internal Missing Description}} + * @param string $filter {@internal Missing Description}} + * @return mixed {@internal Missing Description}} + */ function &get_post(&$post, $output = OBJECT, $filter = 'raw') { - global $post_cache, $wpdb, $blog_id; + global $wpdb; + $null = null; if ( empty($post) ) { if ( isset($GLOBALS['post']) ) $_post = & $GLOBALS['post']; else - $_post = null; + return $null; } elseif ( is_object($post) ) { - if ( 'page' == $post->post_type ) - return get_page($post, $output, $filter); - if ( !isset($post_cache[$blog_id][$post->ID]) ) - $post_cache[$blog_id][$post->ID] = &$post; - $_post = & $post_cache[$blog_id][$post->ID]; + _get_post_ancestors($post); + wp_cache_add($post->ID, $post, 'posts'); + $_post = &$post; } else { $post = (int) $post; - if ( isset($post_cache[$blog_id][$post]) ) - $_post = & $post_cache[$blog_id][$post]; - elseif ( $_post = wp_cache_get($post, 'pages') ) - return get_page($_post, $output, $filter); - else { - $query = "SELECT * FROM $wpdb->posts WHERE ID = '$post' LIMIT 1"; - $_post = & $wpdb->get_row($query); - if ( 'page' == $_post->post_type ) - return get_page($_post, $output, $filter); - $post_cache[$blog_id][$post] = & $_post; + if ( ! $_post = wp_cache_get($post, 'posts') ) { + $_post = & $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post)); + if ( ! $_post ) + return $null; + _get_post_ancestors($_post); + wp_cache_add($_post->ID, $_post, 'posts'); } } - if ( defined('WP_IMPORTING') ) - unset($post_cache[$blog_id]); - $_post = sanitize_post($_post, $filter); if ( $output == OBJECT ) { return $_post; } elseif ( $output == ARRAY_A ) { - return get_object_vars($_post); + $__post = get_object_vars($_post); + return $__post; } elseif ( $output == ARRAY_N ) { - return array_values(get_object_vars($_post)); + $__post = array_values(get_object_vars($_post)); + return $__post; } else { return $_post; } } +/** + * Retrieve ancestors of a post. + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * + * @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); + + if ( !empty($post->ancestors) ) + return $post->ancestors; + + return array(); +} + +/** + * Retrieve data from a post field based on Post ID. + * + * Examples of the post field will be, 'post_type', 'post_status', '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 + * supported values are found within those functions. + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * @uses sanitize_post_field() See for possible $context values. + * + * @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 + */ function get_post_field( $field, $post, $context = 'display' ) { $post = (int) $post; $post = get_post( $post ); @@ -153,7 +292,19 @@ function get_post_field( $field, $post, $context = 'display' ) { return sanitize_post_field($field, $post->$field, $post->ID, $context); } -// Takes a post ID, returns its mime type. +/** + * Retrieve the mime type of an attachment based on the ID. + * + * This function can be used with any post type, but it makes more sense with + * attachments. + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * + * @param int $ID Optional. Post ID. + * @return bool|string False on failure or returns the mime type + */ function get_post_mime_type($ID = '') { $post = & get_post($ID); @@ -163,6 +314,19 @@ function get_post_mime_type($ID = '') { return false; } +/** + * Retrieve the post status based on the Post ID. + * + * If the post ID is of an attachment, then the parent post status will be given + * instead. + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * + * @param int $ID Post ID + * @return string|bool Post status or false on failure. + */ function get_post_status($ID = '') { $post = get_post($ID); @@ -176,8 +340,68 @@ function get_post_status($ID = '') { return false; } +/** + * Retrieve all of the WordPress supported post statuses. + * + * Posts have a limited set of valid status values, this provides the + * post_status values and descriptions. + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * + * @return array List of post statuses. + */ +function get_post_statuses( ) { + $status = array( + 'draft' => __('Draft'), + 'pending' => __('Pending Review'), + 'private' => __('Private'), + 'publish' => __('Published') + ); + + return $status; +} + +/** + * Retrieve all of the WordPress support page statuses. + * + * Pages have a limited set of valid status values, this provides the + * post_status values and descriptions. + * + * @package WordPress + * @subpackage Page + * @since 2.5 + * + * @return array List of page statuses. + */ +function get_page_statuses( ) { + $status = array( + 'draft' => __('Draft'), + 'private' => __('Private'), + 'publish' => __('Published') + ); + + return $status; +} + +/** + * get_post_type() - Returns post type + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @uses $wpdb + * @uses $posts {@internal Missing Description}} + * + * @param mixed $post post object or post ID + * @return mixed post type or false + */ function get_post_type($post = false) { - global $wpdb, $posts; + global $posts; if ( false === $post ) $post = $posts[0]; @@ -190,226 +414,306 @@ function get_post_type($post = false) { return false; } -function get_posts($args) { +/** + * set_post_type() - Set post type + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * + * @uses $wpdb + * @uses $posts {@internal Missing Description}} + * + * @param mixed $post_id post ID + * @param mixed post type + * @return bool {@internal Missing Description}} + */ +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->query( $wpdb->prepare("UPDATE $wpdb->posts SET post_type = %s WHERE ID = %d", $post_type, $post_id) ); + + if ( 'page' == $post_type ) + clean_page_cache($post_id); + else + clean_post_cache($post_id); + + return $return; +} + +/** + * get_posts() - Returns a number of posts + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.2 + * @uses $wpdb + * @link http://codex.wordpress.org/Template_Tags/get_posts + * + * @param array $args {@internal Missing Description}} + * @return array {@internal Missing Description}} + */ +function get_posts($args = null) { $defaults = array( 'numberposts' => 5, 'offset' => 0, 'category' => 0, 'orderby' => 'post_date', 'order' => 'DESC', 'include' => '', 'exclude' => '', 'meta_key' => '', 'meta_value' =>'', 'post_type' => 'post', - 'post_status' => 'publish', 'post_parent' => 0 + 'post_parent' => 0, 'suppress_filters' => true ); $r = wp_parse_args( $args, $defaults ); - extract( $r, EXTR_SKIP ); - - $numberposts = (int) $numberposts; - $offset = (int) $offset; - $category = (int) $category; - $post_parent = (int) $post_parent; - - $inclusions = ''; - if ( !empty($include) ) { - $offset = 0; //ignore offset, category, exclude, meta_key, and meta_value, post_parent if using include - $category = 0; - $exclude = ''; - $meta_key = ''; - $meta_value = ''; - $post_parent = 0; - $incposts = preg_split('/[\s,]+/',$include); - $numberposts = count($incposts); // only the number of posts included - if ( count($incposts) ) { - foreach ( $incposts as $incpost ) { - if (empty($inclusions)) - $inclusions = ' AND ( ID = ' . intval($incpost) . ' '; - else - $inclusions .= ' OR ID = ' . intval($incpost) . ' '; - } - } - } - if (!empty($inclusions)) - $inclusions .= ')'; - - $exclusions = ''; - if ( !empty($exclude) ) { - $exposts = preg_split('/[\s,]+/',$exclude); - if ( count($exposts) ) { - foreach ( $exposts as $expost ) { - if (empty($exclusions)) - $exclusions = ' AND ( ID <> ' . intval($expost) . ' '; - else - $exclusions .= ' AND ID <> ' . intval($expost) . ' '; - } - } - } - if (!empty($exclusions)) - $exclusions .= ')'; - - $query = "SELECT DISTINCT * FROM $wpdb->posts "; - $query .= empty( $category ) ? '' : ", $wpdb->term_relationships, $wpdb->term_taxonomy "; - $query .= empty( $meta_key ) ? '' : ", $wpdb->postmeta "; - $query .= " WHERE 1=1 "; - $query .= empty( $post_type ) ? '' : "AND post_type = '$post_type' "; - $query .= empty( $post_status ) ? '' : "AND post_status = '$post_status' "; - $query .= "$exclusions $inclusions " ; - $query .= empty( $category ) ? '' : "AND ($wpdb->posts.ID = $wpdb->term_relationships.object_id AND $wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id AND $wpdb->term_taxonomy.term_id = " . $category. ") "; - $query .= empty( $post_parent ) ? '' : "AND $wpdb->posts.post_parent = '$post_parent' "; - $query .= empty( $meta_key ) | empty($meta_value) ? '' : " AND ($wpdb->posts.ID = $wpdb->postmeta.post_id AND $wpdb->postmeta.meta_key = '$meta_key' AND $wpdb->postmeta.meta_value = '$meta_value' )"; - $query .= " GROUP BY $wpdb->posts.ID ORDER BY " . $orderby . ' ' . $order; - if ( 0 < $numberposts ) - $query .= " LIMIT " . $offset . ',' . $numberposts; + if ( empty( $r['post_status'] ) ) + $r['post_status'] = ( 'attachment' == $r['post_type'] ) ? 'inherit' : 'publish'; + if ( ! empty($r['numberposts']) ) + $r['posts_per_page'] = $r['numberposts']; + if ( ! empty($r['category']) ) + $r['cat'] = $r['category']; + if ( ! empty($r['include']) ) { + $incposts = preg_split('/[\s,]+/',$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']); - $posts = $wpdb->get_results($query); + $get_posts = new WP_Query; + return $get_posts->query($r); - update_post_caches($posts); - - return $posts; } // // Post meta functions // -function add_post_meta($post_id, $key, $value, $unique = false) { - global $wpdb, $post_meta_cache, $blog_id; +/** + * add_post_meta() - adds metadata for post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * @link http://codex.wordpress.org/Function_Reference/add_post_meta + * + * @param int $post_id post ID + * @param string $key {@internal Missing Description}} + * @param mixed $value {@internal Missing Description}} + * @param bool $unique whether to check for a value with the same key + * @return bool {@internal Missing Description}} + */ +function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) { + global $wpdb; - $post_id = (int) $post_id; + // make sure meta is added to the post, not a revision + if ( $the_post = wp_is_post_revision($post_id) ) + $post_id = $the_post; - if ( $unique ) { - if ( $wpdb->get_var("SELECT meta_key FROM $wpdb->postmeta WHERE meta_key = '$key' AND post_id = '$post_id'") ) { - return false; - } - } + // expected_slashed ($meta_key) + $meta_key = stripslashes($meta_key); + + if ( $unique && $wpdb->get_var( $wpdb->prepare( "SELECT meta_key FROM $wpdb->postmeta WHERE meta_key = %s AND post_id = %d", $meta_key, $post_id ) ) ) + return false; - $post_meta_cache[$blog_id][$post_id][$key][] = $value; + $meta_value = maybe_serialize($meta_value); - $value = maybe_serialize($value); - $value = $wpdb->escape($value); + $wpdb->insert( $wpdb->postmeta, compact( 'post_id', 'meta_key', 'meta_value' ) ); - $wpdb->query("INSERT INTO $wpdb->postmeta (post_id,meta_key,meta_value) VALUES ('$post_id','$key','$value')"); + wp_cache_delete($post_id, 'post_meta'); return true; } +/** + * delete_post_meta() - delete post metadata + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * @link http://codex.wordpress.org/Function_Reference/delete_post_meta + * + * @param int $post_id post ID + * @param string $key {@internal Missing Description}} + * @param mixed $value {@internal Missing Description}} + * @return bool {@internal Missing Description}} + */ function delete_post_meta($post_id, $key, $value = '') { - global $wpdb, $post_meta_cache, $blog_id; + global $wpdb; - $post_id = (int) $post_id; + $post_id = absint( $post_id ); - if ( empty($value) ) { - $meta_id = $wpdb->get_var("SELECT meta_id FROM $wpdb->postmeta WHERE post_id = '$post_id' AND meta_key = '$key'"); - } else { - $meta_id = $wpdb->get_var("SELECT meta_id FROM $wpdb->postmeta WHERE post_id = '$post_id' AND meta_key = '$key' AND meta_value = '$value'"); - } + // expected_slashed ($key, $value) + $key = stripslashes( $key ); + $value = stripslashes( $value ); + + if ( empty( $value ) ) + $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s", $post_id, $key ) ); + else + $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s AND meta_value = %s", $post_id, $key, $value ) ); if ( !$meta_id ) return false; - if ( empty($value) ) { - $wpdb->query("DELETE FROM $wpdb->postmeta WHERE post_id = '$post_id' AND meta_key = '$key'"); - unset($post_meta_cache[$blog_id][$post_id][$key]); - } else { - $wpdb->query("DELETE FROM $wpdb->postmeta WHERE post_id = '$post_id' AND meta_key = '$key' AND meta_value = '$value'"); - $cache_key = $post_meta_cache[$blog_id][$post_id][$key]; - if ($cache_key) foreach ( $cache_key as $index => $data ) - if ( $data == $value ) - unset($post_meta_cache[$blog_id][$post_id][$key][$index]); - } + if ( empty( $value ) ) + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s", $post_id, $key ) ); + else + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = %s AND meta_value = %s", $post_id, $key, $value ) ); - unset($post_meta_cache[$blog_id][$post_id][$key]); + wp_cache_delete($post_id, 'post_meta'); return true; } +/** + * get_post_meta() - Get a post meta field + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * @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 bool $single Whether to return a single value + * @return mixed {@internal Missing Description}} + */ function get_post_meta($post_id, $key, $single = false) { - global $wpdb, $post_meta_cache, $blog_id; - $post_id = (int) $post_id; - if ( isset($post_meta_cache[$blog_id][$post_id][$key]) ) { + $meta_cache = wp_cache_get($post_id, 'post_meta'); + + if ( !$meta_cache ) { + update_postmeta_cache($post_id); + $meta_cache = wp_cache_get($post_id, 'post_meta'); + } + + if ( isset($meta_cache[$key]) ) { if ( $single ) { - return maybe_unserialize( $post_meta_cache[$blog_id][$post_id][$key][0] ); + return maybe_unserialize( $meta_cache[$key][0] ); } else { - return maybe_unserialize( $post_meta_cache[$blog_id][$post_id][$key] ); + return array_map('maybe_unserialize', $meta_cache[$key]); } } - if ( !isset($post_meta_cache[$blog_id][$post_id]) ) - update_postmeta_cache($post_id); - - if ( $single ) { - if ( isset($post_meta_cache[$blog_id][$post_id][$key][0]) ) - return maybe_unserialize($post_meta_cache[$blog_id][$post_id][$key][0]); - else - return ''; - } else { - return maybe_unserialize($post_meta_cache[$blog_id][$post_id][$key]); - } + return ''; } -function update_post_meta($post_id, $key, $value, $prev_value = '') { - global $wpdb, $post_meta_cache, $blog_id; +/** + * update_post_meta() - Update a post meta field + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * @link http://codex.wordpress.org/Function_Reference/update_post_meta + * + * @param int $post_id post ID + * @param string $key {@internal Missing Description}} + * @param mixed $value {@internal Missing Description}} + * @param mixed $prev_value previous value (for differentiating between meta fields with the same key and post ID) + * @return bool {@internal Missing Description}} + */ +function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') { + global $wpdb; - $post_id = (int) $post_id; + // expected_slashed ($meta_key) + $meta_key = stripslashes($meta_key); - $original_value = $value; - $value = maybe_serialize($value); - $value = $wpdb->escape($value); + if ( ! $wpdb->get_var( $wpdb->prepare( "SELECT meta_key FROM $wpdb->postmeta WHERE meta_key = %s AND post_id = %d", $meta_key, $post_id ) ) ) { + return add_post_meta($post_id, $meta_key, $meta_value); + } - $original_prev = $prev_value; - $prev_value = maybe_serialize($prev_value); - $prev_value = $wpdb->escape($prev_value); + $meta_value = maybe_serialize($meta_value); - if (! $wpdb->get_var("SELECT meta_key FROM $wpdb->postmeta WHERE meta_key = '$key' AND post_id = '$post_id'") ) { - return false; - } + $data = compact( 'meta_value' ); + $where = compact( 'meta_key', 'post_id' ); - if ( empty($prev_value) ) { - $wpdb->query("UPDATE $wpdb->postmeta SET meta_value = '$value' WHERE meta_key = '$key' AND post_id = '$post_id'"); - $cache_key = $post_meta_cache[$blog_id][$post_id][$key]; - if ( !empty($cache_key) ) - foreach ($cache_key as $index => $data) - $post_meta_cache[$blog_id][$post_id][$key][$index] = $original_value; - } else { - $wpdb->query("UPDATE $wpdb->postmeta SET meta_value = '$value' WHERE meta_key = '$key' AND post_id = '$post_id' AND meta_value = '$prev_value'"); - $cache_key = $post_meta_cache[$blog_id][$post_id][$key]; - if ( !empty($cache_key) ) - foreach ($cache_key as $index => $data) - if ( $data == $original_prev ) - $post_meta_cache[$blog_id][$post_id][$key][$index] = $original_value; + if ( !empty( $prev_value ) ) { + $prev_value = maybe_serialize($prev_value); + $where['meta_value'] = $prev_value; } + $wpdb->update( $wpdb->postmeta, $data, $where ); + wp_cache_delete($post_id, 'post_meta'); return true; } - +/** + * delete_post_meta_by_key() - Delete everything from post meta matching $post_meta_key + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * @uses $wpdb + * + * @param string $post_meta_key What to search for when deleting + * @return bool Whether the post meta key was deleted from the database + */ function delete_post_meta_by_key($post_meta_key) { - global $wpdb, $post_meta_cache, $blog_id; - $post_meta_key = $wpdb->escape($post_meta_key); - if ( $wpdb->query("DELETE FROM $wpdb->postmeta WHERE meta_key = '$post_meta_key'") ) { - unset($post_meta_cache[$blog_id]); // not worth doing the work to iterate through the cache + global $wpdb; + if ( $wpdb->query($wpdb->prepare("DELETE FROM $wpdb->postmeta WHERE meta_key = %s", $post_meta_key)) ) { + /** @todo Get post_ids and delete cache */ + // wp_cache_delete($post_id, 'post_meta'); return true; } return false; } - +/** + * get_post_custom() - Retrieve post custom fields + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.2 + * @link http://codex.wordpress.org/Function_Reference/get_post_custom + * + * @uses $id + * @uses $wpdb + * + * @param int $post_id post ID + * @return array {@internal Missing Description}} + */ function get_post_custom($post_id = 0) { - global $id, $post_meta_cache, $wpdb, $blog_id; + global $id; if ( !$post_id ) $post_id = (int) $id; $post_id = (int) $post_id; - if ( !isset($post_meta_cache[$blog_id][$post_id]) ) + if ( ! wp_cache_get($post_id, 'post_meta') ) update_postmeta_cache($post_id); - return $post_meta_cache[$blog_id][$post_id]; + return wp_cache_get($post_id, 'post_meta'); } +/** + * get_post_custom_keys() - Retrieve post custom field names + * + * @package WordPress + * @subpackage Post + * @since 1.2 + * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys + * + * @param int $post_id post ID + * @return array|null Either array of the keys, or null if keys would not be retrieved + */ function get_post_custom_keys( $post_id = 0 ) { $custom = get_post_custom( $post_id ); @@ -420,35 +724,65 @@ function get_post_custom_keys( $post_id = 0 ) { return $keys; } - +/** + * get_post_custom_values() - Retrieve values for a custom post field + * + * @package WordPress + * @subpackage Post + * @since 1.2 + * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values + * + * @param string $key field name + * @param int $post_id post ID + * @return mixed {@internal Missing Description}} + */ function get_post_custom_values( $key = '', $post_id = 0 ) { $custom = get_post_custom($post_id); return $custom[$key]; } +/** + * sanitize_post() - Sanitize every post field + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @param object|array $post The Post Object or Array + * @param string $context How to sanitize post fields + * @return object|array The now sanitized Post Object or Array (will be the same type as $post) + */ function sanitize_post($post, $context = 'display') { - if ( 'raw' == $context ) return $post; - - // TODO: Use array keys instead of hard coded list - $fields = array('post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_date', 'post_date_gmt', 'post_parent', 'menu_order', 'post_mime_type', 'post_category'); - - $do_object = false; - if ( is_object($post) ) - $do_object = true; - - foreach ( $fields as $field ) { - if ( $do_object ) + if ( is_object($post) ) { + foreach ( array_keys(get_object_vars($post)) as $field ) $post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context); - else + } else { + foreach ( array_keys($post) as $field ) $post[$field] = sanitize_post_field($field, $post[$field], $post['ID'], $context); } - return $post; } +/** + * sanitize_post_field() - Sanitize post field based on context + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @param string $field The Post Object field name + * @param string $value The Post Object value + * @param int $postid Post ID + * @param string $context How to sanitize post fields + * @return string Sanitized value + */ function sanitize_post_field($field, $value, $post_id, $context) { $int_fields = array('ID', 'post_parent', 'menu_order'); if ( in_array($field, $int_fields) ) @@ -506,35 +840,242 @@ function sanitize_post_field($field, $value, $post_id, $context) { return $value; } -function wp_delete_post($postid = 0) { - global $wpdb, $wp_rewrite; - $postid = (int) $postid; +/** + * Count number of posts of a post type and is user has permissions to view. + * + * This function provides an efficient method of finding the amount of post's + * type a blog has. Another method is to count the amount of items in + * get_posts(), but that method has a lot of overhead with doing so. Therefore, + * when developing for 2.5+, use this function instead. + * + * The $perm parameter checks for 'readable' value and if the user can read + * private posts, it will display that for the user that is signed in. + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * @link http://codex.wordpress.org/Template_Tags/wp_count_posts + * + * @param string $type Optional. Post type to retrieve count + * @param string $perm Optional. 'readable' or empty. + * @return object Number of posts for each status + */ +function wp_count_posts( $type = 'post', $perm = '' ) { + global $wpdb; - if ( !$post = $wpdb->get_row("SELECT * FROM $wpdb->posts WHERE ID = $postid") ) - return $post; + $user = wp_get_current_user(); - if ( 'attachment' == $post->post_type ) - return wp_delete_attachment($postid); + $cache_key = $type; - do_action('delete_post', $postid); + $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") ) { + $cache_key .= '_' . $perm . '_' . $user->ID; + $query .= " AND (post_status != 'private' OR ( post_author = '$user->ID' AND post_status = 'private' ))"; + } + } + $query .= ' GROUP BY post_status'; - // TODO delete for pluggable post taxonomies too - wp_delete_object_term_relationships($postid, array('category', 'post_tag')); + $count = wp_cache_get($cache_key, 'counts'); + if ( false !== $count ) + return $count; - if ( 'page' == $post->post_type ) - $wpdb->query("UPDATE $wpdb->posts SET post_parent = $post->post_parent WHERE post_parent = $postid AND post_type = 'page'"); + $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A ); - $wpdb->query("UPDATE $wpdb->posts SET post_parent = $post->post_parent WHERE post_parent = $postid AND post_type = 'attachment'"); + $stats = array( ); + foreach( (array) $count as $row_num => $row ) { + $stats[$row['post_status']] = $row['num_posts']; + } - $wpdb->query("DELETE FROM $wpdb->posts WHERE ID = $postid"); + $stats = (object) $stats; + wp_cache_set($cache_key, $stats, 'counts'); - $wpdb->query("DELETE FROM $wpdb->comments WHERE comment_post_ID = $postid"); + return $stats; +} + + +/** + * wp_count_attachments() - Count number of attachments + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * + * @param string|array $post_mime_type Array or comma-separated list of MIME patterns + * @return array Number of posts for each post_mime_type + */ + +function wp_count_attachments( $mime_type = '' ) { + global $wpdb; + + $and = wp_post_mime_type_where( $mime_type ); + $count = $wpdb->get_results( "SELECT post_mime_type, COUNT( * ) AS num_posts FROM $wpdb->posts WHERE post_type = 'attachment' $and GROUP BY post_mime_type", ARRAY_A ); + + $stats = array( ); + foreach( (array) $count as $row ) { + $stats[$row['post_mime_type']] = $row['num_posts']; + } + + return (object) $stats; +} + +/** + * wp_match_mime_type() - Check a MIME-Type against a list + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * + * @param string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or flash (same as *flash*) + * @param string|array $real_mime_types post_mime_type values + * @return array array(wildcard=>array(real types)) + */ +function wp_match_mime_types($wildcard_mime_types, $real_mime_types) { + $matches = array(); + if ( is_string($wildcard_mime_types) ) + $wildcard_mime_types = array_map('trim', explode(',', $wildcard_mime_types)); + if ( is_string($real_mime_types) ) + $real_mime_types = array_map('trim', explode(',', $real_mime_types)); + $wild = '[-._a-z0-9]*'; + foreach ( (array) $wildcard_mime_types as $type ) { + $type = str_replace('*', $wild, $type); + $patternses[1][$type] = "^$type$"; + if ( false === strpos($type, '/') ) { + $patternses[2][$type] = "^$type/"; + $patternses[3][$type] = $type; + } + } + asort($patternses); + foreach ( $patternses as $patterns ) + foreach ( $patterns as $type => $pattern ) + foreach ( (array) $real_mime_types as $real ) + if ( preg_match("#$pattern#", $real) && ( empty($matches[$type]) || false === array_search($real, $matches[$type]) ) ) + $matches[$type][] = $real; + return $matches; +} + +/** + * wp_get_post_mime_type_where() - Convert MIME types into SQL + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * + * @param string|array $mime_types MIME types + * @return string SQL AND clause + */ +function wp_post_mime_type_where($post_mime_types) { + $where = ''; + $wildcards = array('', '%', '%/%'); + if ( is_string($post_mime_types) ) + $post_mime_types = array_map('trim', explode(',', $post_mime_types)); + foreach ( (array) $post_mime_types as $mime_type ) { + $mime_type = preg_replace('/\s/', '', $mime_type); + $slashpos = strpos($mime_type, '/'); + if ( false !== $slashpos ) { + $mime_group = preg_replace('/[^-*.a-zA-Z0-9]/', '', substr($mime_type, 0, $slashpos)); + $mime_subgroup = preg_replace('/[^-*.a-zA-Z0-9]/', '', substr($mime_type, $slashpos + 1)); + if ( empty($mime_subgroup) ) + $mime_subgroup = '*'; + else + $mime_subgroup = str_replace('/', '', $mime_subgroup); + $mime_pattern = "$mime_group/$mime_subgroup"; + } else { + $mime_pattern = preg_replace('/[^-*.a-zA-Z0-9]/', '', $mime_type); + if ( false === strpos($mime_pattern, '*') ) + $mime_pattern .= '/*'; + } + + $mime_pattern = preg_replace('/\*+/', '%', $mime_pattern); + + if ( in_array( $mime_type, $wildcards ) ) + return ''; + + if ( false !== strpos($mime_pattern, '%') ) + $wheres[] = "post_mime_type LIKE '$mime_pattern'"; + else + $wheres[] = "post_mime_type = '$mime_pattern'"; + } + if ( !empty($wheres) ) + $where = ' AND (' . join(' OR ', $wheres) . ') '; + return $where; +} + +/** + * wp_delete_post() - Deletes a Post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * + * @param int $postid post ID + * @return mixed {@internal Missing Description}} + */ +function wp_delete_post($postid = 0) { + global $wpdb, $wp_rewrite; + + if ( !$post = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) ) + return $post; + + if ( 'attachment' == $post->post_type ) + return wp_delete_attachment($postid); + + do_action('delete_post', $postid); + + /** @todo delete for pluggable post taxonomies too */ + wp_delete_object_term_relationships($postid, array('category', 'post_tag')); + + $parent_data = array( 'post_parent' => $post->post_parent ); + $parent_where = array( 'post_parent' => $postid ); + + if ( 'page' == $post->post_type) { + // if the page is defined in option page_on_front or post_for_posts, + // adjust the corresponding options + if ( get_option('page_on_front') == $postid ) { + update_option('show_on_front', 'posts'); + delete_option('page_on_front'); + } + 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' ) ); + } + + // 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. + foreach ( $revision_ids as $revision_id ) + wp_delete_post_revision( $revision_id ); - $wpdb->query("DELETE FROM $wpdb->postmeta WHERE post_id = $postid"); + // Point all attachments to this post up one level + $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) ); + + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->posts WHERE ID = %d", $postid )); + + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->comments WHERE comment_post_ID = %d", $postid )); + + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE post_id = %d", $postid )); if ( 'page' == $post->post_type ) { clean_page_cache($postid); + + foreach ( (array) $children as $child ) + clean_page_cache($child->ID); + $wp_rewrite->flush_rules(); + } else { + clean_post_cache($postid); } do_action('deleted_post', $postid); @@ -542,6 +1083,22 @@ function wp_delete_post($postid = 0) { return $post; } +/** + * wp_get_post_categories() - Retrieve the list of categories for a post + * + * Compatibility layer for themes and plugins. Also an easy layer of abstraction + * away from the complexity of the taxonomy layer. + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here + * + * @param int $post_id Optional. The Post ID + * @param array $args Optional. Overwrite the defaults + * @return array {@internal Missing Description}} + */ function wp_get_post_categories( $post_id = 0, $args = array() ) { $post_id = (int) $post_id; @@ -552,6 +1109,19 @@ function wp_get_post_categories( $post_id = 0, $args = array() ) { return $cats; } +/** + * wp_get_post_tags() - Retrieve the post tags + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here + * + * @param int $post_id Optional. The Post ID + * @param array $args Optional. Overwrite the defaults + * @return mixed The tags the post has currently + */ function wp_get_post_tags( $post_id = 0, $args = array() ) { $post_id = (int) $post_id; @@ -563,6 +1133,18 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) { return $tags; } +/** + * wp_get_recent_posts() - Get the $num most recent posts + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * + * @param int $num number of posts to get + * @return array {@internal Missing Description}} + */ function wp_get_recent_posts($num = 10) { global $wpdb; @@ -578,9 +1160,21 @@ function wp_get_recent_posts($num = 10) { return $result?$result:array(); } +/** + * wp_get_single_post() - Get one post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * @uses $wpdb + * + * @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) { - global $wpdb; - $postid = (int) $postid; $post = get_post($postid, $mode); @@ -598,12 +1192,30 @@ function wp_get_single_post($postid = 0, $mode = OBJECT) { return $post; } -function wp_insert_post($postarr = array()) { - global $wpdb, $wp_rewrite, $allowedtags, $user_ID; +/** + * wp_insert_post() - Insert a post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * + * @uses $wpdb + * @uses $wp_rewrite + * @uses $user_ID + * @uses $allowedtags + * + * @param array $postarr post contents + * @return int post ID or 0 on error + */ +function wp_insert_post($postarr = array(), $wp_error = false) { + global $wpdb, $wp_rewrite, $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' => ''); + 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', + 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => ''); $postarr = wp_parse_args($postarr, $defaults); $postarr = sanitize_post($postarr, 'db'); @@ -620,8 +1232,12 @@ function wp_insert_post($postarr = array()) { $previous_status = 'new'; } - if ( ('' == $post_content) && ('' == $post_title) && ('' == $post_excerpt) ) - return 0; + if ( ('' == $post_content) && ('' == $post_title) && ('' == $post_excerpt) ) { + if ( $wp_error ) + return new WP_Error('empty_content', __('Content, title, and excerpt are empty.')); + else + return 0; + } // Make sure we set a valid category if (0 == count($post_category) || !is_array($post_category)) { @@ -637,9 +1253,11 @@ function wp_insert_post($postarr = array()) { if ( empty($post_type) ) $post_type = 'post'; - // Get the post ID. - if ( $update ) + // Get the post ID and GUID + if ( $update ) { $post_ID = (int) $ID; + $guid = get_post_field( 'guid', $post_ID ); + } // Create a valid post name. Drafts are allowed to have an empty // post name. @@ -651,14 +1269,26 @@ function wp_insert_post($postarr = array()) { } // If the post date is empty (due to having been new or a draft) and status is not 'draft', set date to now - if (empty($post_date)) { + if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date ) { if ( !in_array($post_status, array('draft', 'pending')) ) $post_date = current_time('mysql'); + else + $post_date = '0000-00-00 00:00:00'; } - if (empty($post_date_gmt)) { + if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) { if ( !in_array($post_status, array('draft', 'pending')) ) $post_date_gmt = get_gmt_from_date($post_date); + else + $post_date_gmt = '0000-00-00 00:00:00'; + } + + if ( $update || '0000-00-00 00:00:00' == $post_date ) { + $post_modified = current_time( 'mysql' ); + $post_modified_gmt = current_time( 'mysql', 1 ); + } else { + $post_modified = $post_date; + $post_modified_gmt = $post_date_gmt; } if ( 'publish' == $post_status ) { @@ -698,72 +1328,78 @@ function wp_insert_post($postarr = array()) { $post_password = ''; if ( 'draft' != $post_status ) { - $post_name_check = $wpdb->get_var("SELECT post_name FROM $wpdb->posts WHERE post_name = '$post_name' AND post_type = '$post_type' AND ID != '$post_ID' AND post_parent = '$post_parent' LIMIT 1"); + $post_name_check = $wpdb->get_var($wpdb->prepare("SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d AND post_parent = %d LIMIT 1", $post_name, $post_type, $post_ID, $post_parent)); if ($post_name_check || in_array($post_name, $wp_rewrite->feeds) ) { $suffix = 2; do { $alt_post_name = substr($post_name, 0, 200-(strlen($suffix)+1)). "-$suffix"; - $post_name_check = $wpdb->get_var("SELECT post_name FROM $wpdb->posts WHERE post_name = '$alt_post_name' AND post_type = '$post_type' AND ID != '$post_ID' AND post_parent = '$post_parent' LIMIT 1"); + $post_name_check = $wpdb->get_var($wpdb->prepare("SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d AND post_parent = %d LIMIT 1", $alt_post_name, $post_type, $post_ID, $post_parent)); $suffix++; } while ($post_name_check); $post_name = $alt_post_name; } } + // expected_slashed (everything!) + $data = compact( array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'guid' ) ); + $data = stripslashes_deep( $data ); + $where = array( 'ID' => $post_ID ); + if ($update) { - $wpdb->query( - "UPDATE IGNORE $wpdb->posts SET - post_author = '$post_author', - post_date = '$post_date', - post_date_gmt = '$post_date_gmt', - post_content = '$post_content', - post_content_filtered = '$post_content_filtered', - post_title = '$post_title', - post_excerpt = '$post_excerpt', - post_status = '$post_status', - post_type = '$post_type', - comment_status = '$comment_status', - ping_status = '$ping_status', - post_password = '$post_password', - post_name = '$post_name', - to_ping = '$to_ping', - pinged = '$pinged', - post_modified = '".current_time('mysql')."', - post_modified_gmt = '".current_time('mysql',1)."', - post_parent = '$post_parent', - menu_order = '$menu_order' - WHERE ID = $post_ID"); + do_action( 'pre_post_update', $post_ID ); + if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) { + if ( $wp_error ) + return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error); + else + return 0; + } } else { - $wpdb->query( - "INSERT IGNORE INTO $wpdb->posts - (post_author, post_date, post_date_gmt, post_content, post_content_filtered, post_title, post_excerpt, post_status, post_type, comment_status, ping_status, post_password, post_name, to_ping, pinged, post_modified, post_modified_gmt, post_parent, menu_order, post_mime_type) - VALUES - ('$post_author', '$post_date', '$post_date_gmt', '$post_content', '$post_content_filtered', '$post_title', '$post_excerpt', '$post_status', '$post_type', '$comment_status', '$ping_status', '$post_password', '$post_name', '$to_ping', '$pinged', '$post_date', '$post_date_gmt', '$post_parent', '$menu_order', '$post_mime_type')"); - $post_ID = (int) $wpdb->insert_id; + $data['post_mime_type'] = stripslashes( $post_mime_type ); // This isn't in the update + if ( false === $wpdb->insert( $wpdb->posts, $data ) ) { + if ( $wp_error ) + return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error); + else + return 0; + } + $post_ID = (int) $wpdb->insert_id; + + // use the newly generated $post_ID + $where = array( 'ID' => $post_ID ); } if ( empty($post_name) && 'draft' != $post_status ) { $post_name = sanitize_title($post_title, $post_ID); - $wpdb->query( "UPDATE $wpdb->posts SET post_name = '$post_name' WHERE ID = '$post_ID'" ); + $wpdb->update( $wpdb->posts, compact( 'post_name' ), $where ); } wp_set_post_categories( $post_ID, $post_category ); wp_set_post_tags( $post_ID, $tags_input ); - if ( 'page' == $post_type ) { + $current_guid = get_post_field( 'guid', $post_ID ); + + if ( 'page' == $post_type ) clean_page_cache($post_ID); - } else { + else clean_post_cache($post_ID); - } // Set GUID - if ( ! $update ) - $wpdb->query("UPDATE $wpdb->posts SET guid = '" . get_permalink($post_ID) . "' WHERE ID = '$post_ID'"); + if ( !$update && '' == $current_guid ) + $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where ); $post = get_post($post_ID); - if ( !empty($page_template) ) + + if ( !empty($page_template) && 'page' == $post_type ) { $post->page_template = $page_template; + $page_templates = get_page_templates(); + if ( 'default' != $page_template && !in_array($page_template, $page_templates) ) { + if ( $wp_error ) + return new WP_Error('invalid_page_template', __('The page template is invalid.')); + else + return 0; + } + update_post_meta($post_ID, '_wp_page_template', $page_template); + } wp_transition_post_status($post_status, $previous_status, $post); @@ -776,9 +1412,20 @@ function wp_insert_post($postarr = array()) { return $post_ID; } +/** + * wp_update_post() - Update a post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * @uses $wpdb + * + * @param array $postarr post data + * @return int {@internal Missing Description}} + */ function wp_update_post($postarr = array()) { - global $wpdb; - if ( is_object($postarr) ) $postarr = get_object_vars($postarr); @@ -816,6 +1463,19 @@ function wp_update_post($postarr = array()) { return wp_insert_post($postarr); } +/** + * wp_publish_post() - Mark a post as "published" + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * @uses $wpdb + * + * @param int $post_id Post ID + * @return int|null {@internal Missing Description}} + */ function wp_publish_post($post_id) { global $wpdb; @@ -827,24 +1487,84 @@ function wp_publish_post($post_id) { if ( 'publish' == $post->post_status ) return; - $wpdb->query( "UPDATE $wpdb->posts SET post_status = 'publish' WHERE ID = '$post_id'" ); + $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $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 ( get_object_taxonomies('post') as $taxonomy ) { + $terms = wp_get_object_terms($post_id, $taxonomy, 'fields=tt_ids'); + wp_update_term_count($terms, $taxonomy); + } + do_action('edit_post', $post_id, $post); do_action('save_post', $post_id, $post); do_action('wp_insert_post', $post_id, $post); } +/** + * check_and_publish_future_post() - check to make sure post has correct status before + * passing it on to be published. Invoked by cron 'publish_future_post' event + * This safeguard prevents cron from publishing drafts, etc. + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.5 + * @uses $wpdb + * + * @param int $post_id Post ID + * @return int|null {@internal Missing Description}} + */ +function check_and_publish_future_post($post_id) { + + $post = get_post($post_id); + + if ( empty($post) ) + return; + + if ( 'future' != $post->post_status ) + return; + + return wp_publish_post($post_id); +} + +/** + * wp_add_post_tags() - Adds the tags to a post + * + * @uses wp_set_post_tags() Same first two paraeters, but the last parameter is always set to true. + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @param int $post_id Optional. Post ID + * @param string $tags The tags to set for the post + * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise + */ function wp_add_post_tags($post_id = 0, $tags = '') { return wp_set_post_tags($post_id, $tags, true); } +/** + * wp_set_post_tags() - Set the tags for a post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * @uses $wpdb + * + * @param int $post_id post ID + * @param string $tags The tags to set for the post + * @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 + */ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { - /* $append - true = don't delete existing tags, just add on, false = replace the tags with the new tags */ - global $wpdb; $post_id = (int) $post_id; @@ -853,13 +1573,25 @@ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { if ( empty($tags) ) $tags = array(); - $tags = (is_array($tags)) ? $tags : explode( ',', $tags ); + $tags = (is_array($tags)) ? $tags : explode( ',', trim($tags, " \n\t\r\0\x0B,") ); wp_set_object_terms($post_id, $tags, 'post_tag', $append); } +/** + * wp_set_post_categories() - Set categories for a post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * @uses $wpdb + * + * @param int $post_ID post ID + * @param array $post_categories + * @return bool|mixed {@internal Missing Description}} + */ function wp_set_post_categories($post_ID = 0, $post_categories = array()) { - global $wpdb; - $post_ID = (int) $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)) @@ -873,6 +1605,19 @@ function wp_set_post_categories($post_ID = 0, $post_categories = array()) { return wp_set_object_terms($post_ID, $post_categories, 'category'); } // wp_set_post_categories() +/** + * wp_transition_post_status() - Change the post transition status + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @param string $new_status {@internal Missing Description}} + * @param string $old_status {@internal Missing Description}} + * @param int $post {@internal Missing Description}} + */ function wp_transition_post_status($new_status, $old_status, $post) { if ( $new_status != $old_status ) { do_action('transition_post_status', $new_status, $old_status, $post); @@ -885,19 +1630,47 @@ function wp_transition_post_status($new_status, $old_status, $post) { // Trackback and ping functions // -function add_ping($post_id, $uri) { // Add a URL to those already pung +/** + * add_ping() - Add a URL to those already pung + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * + * @param int $post_id post ID + * @param string $uri {@internal Missing Description}} + * @return mixed {@internal Missing Description}} + */ +function add_ping($post_id, $uri) { global $wpdb; - $pung = $wpdb->get_var("SELECT pinged FROM $wpdb->posts WHERE ID = $post_id"); + $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id )); $pung = trim($pung); $pung = preg_split('/\s/', $pung); $pung[] = $uri; $new = implode("\n", $pung); $new = apply_filters('add_ping', $new); - return $wpdb->query("UPDATE $wpdb->posts SET pinged = '$new' WHERE ID = $post_id"); + // expected_slashed ($new) + $new = stripslashes($new); + return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) ); } -function get_enclosed($post_id) { // Get enclosures already enclosed for a post - global $wpdb; +/** + * get_enclosed() - Get enclosures already enclosed for a post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * + * @param int $post_id post ID + * @return array {@internal Missing Description}} + */ +function get_enclosed($post_id) { $custom_fields = get_post_custom( $post_id ); $pung = array(); if ( !is_array( $custom_fields ) ) @@ -915,26 +1688,62 @@ function get_enclosed($post_id) { // Get enclosures already enclosed for a post return $pung; } -function get_pung($post_id) { // Get URLs already pung for a post +/** + * get_pung() - Get URLs already pinged for a post + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * + * @param int $post_id post ID + * @return array {@internal Missing Description}} + */ +function get_pung($post_id) { global $wpdb; - $pung = $wpdb->get_var("SELECT pinged FROM $wpdb->posts WHERE ID = $post_id"); + $pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id )); $pung = trim($pung); $pung = preg_split('/\s/', $pung); $pung = apply_filters('get_pung', $pung); return $pung; } -function get_to_ping($post_id) { // Get any URLs in the todo list +/** + * get_to_ping() - Get any URLs in the todo list + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * + * @param int $post_id post ID + * @return array {@internal Missing Description}} + */ +function get_to_ping($post_id) { global $wpdb; - $to_ping = $wpdb->get_var("SELECT to_ping FROM $wpdb->posts WHERE ID = $post_id"); + $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 = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY); $to_ping = apply_filters('get_to_ping', $to_ping); return $to_ping; } -// do trackbacks for a list of urls -// accepts a comma-separated list of trackback urls and a post id +/** + * trackback_url_list() - Do trackbacks for a list of urls + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.0.0 + * + * @param string $tb_list comma separated list of URLs + * @param int $post_id post ID + */ function trackback_url_list($tb_list, $post_id) { if (!empty($tb_list)) { // get post data @@ -962,74 +1771,68 @@ function trackback_url_list($tb_list, $post_id) { // Page functions // +/** + * get_all_page_ids() - Get a list of page IDs + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * @uses $wpdb + * + * @return array {@internal Missing Description}} + */ function get_all_page_ids() { global $wpdb; - if ( ! $page_ids = wp_cache_get('all_page_ids', 'pages') ) { + if ( ! $page_ids = wp_cache_get('all_page_ids', 'posts') ) { $page_ids = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE post_type = 'page'"); - wp_cache_add('all_page_ids', $page_ids, 'pages'); + wp_cache_add('all_page_ids', $page_ids, 'posts'); } return $page_ids; } - -// Retrieves page data given a page ID or page object. -// Handles page caching. +/** + * get_page() - Retrieves page data given a page ID or page object + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5.1 + * + * @param mixed &$page page object or page ID + * @param string $output what to output + * @param string $filter How the return value should be filtered. + * @return mixed {@internal Missing Description}} + */ function &get_page(&$page, $output = OBJECT, $filter = 'raw') { - global $wpdb, $blog_id; - if ( empty($page) ) { - if ( isset( $GLOBALS['page'] ) && isset( $GLOBALS['page']->ID ) ) { - $_page = & $GLOBALS['page']; - wp_cache_add($_page->ID, $_page, 'pages'); - } else { - // shouldn't we just return NULL at this point? ~ Mark - $_page = null; - } - } elseif ( is_object($page) ) { - if ( 'post' == $page->post_type ) - return get_post($page, $output, $filter); - wp_cache_add($page->ID, $page, 'pages'); - $_page = $page; - } else { - $page = (int) $page; - // first, check the cache - if ( ! ( $_page = wp_cache_get($page, 'pages') ) ) { - // not in the page cache? - if ( isset($GLOBALS['page']->ID) && ($page == $GLOBALS['page']->ID) ) { // for is_page() views - // I don't think this code ever gets executed ~ Mark - $_page = & $GLOBALS['page']; - wp_cache_add($_page->ID, $_page, 'pages'); - } elseif ( isset($GLOBALS['post_cache'][$blog_id][$page]) ) { // it's actually a page, and is cached - return get_post($page, $output, $filter); - } else { // it's not in any caches, so off to the DB we go - // Why are we using assignment for this query? - $_page = & $wpdb->get_row("SELECT * FROM $wpdb->posts WHERE ID= '$page' LIMIT 1"); - if ( 'post' == $_page->post_type ) - return get_post($_page, $output, $filter); - // Potential issue: we're not checking to see if the post_type = 'page' - // So all non-'post' posts will get cached as pages. - wp_cache_add($_page->ID, $_page, 'pages'); - } - } + if ( isset( $GLOBALS['page'] ) && isset( $GLOBALS['page']->ID ) ) + return get_post($GLOBALS['page'], $output, $filter); + else + return null; } - $_page = sanitize_post($_page, $filter); - - // at this point, one way or another, $_post contains the page object - - if ( $output == OBJECT ) { - return $_page; - } elseif ( $output == ARRAY_A ) { - return get_object_vars($_page); - } elseif ( $output == ARRAY_N ) { - return array_values(get_object_vars($_page)); - } else { - return $_page; - } + return get_post($page, $output, $filter); } +/** + * get_page_by_path() - Retrieves a page given its path + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * @uses $wpdb + * + * @param string $page_path page path + * @param string $output output type + * @return mixed {@internal Missing Description}} + */ function get_page_by_path($page_path, $output = OBJECT) { global $wpdb; $page_path = rawurlencode(urldecode($page_path)); @@ -1041,7 +1844,7 @@ function get_page_by_path($page_path, $output = OBJECT) { foreach($page_paths as $pathdir) $full_path .= ($pathdir!=''?'/':'') . sanitize_title($pathdir); - $pages = $wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_name = '$leaf_path' AND post_type='page'"); + $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 )); if ( empty($pages) ) return NULL; @@ -1050,7 +1853,7 @@ function get_page_by_path($page_path, $output = OBJECT) { $path = '/' . $leaf_path; $curpage = $page; while ($curpage->post_parent != 0) { - $curpage = $wpdb->get_row("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE ID = '$curpage->post_parent' and post_type='page'"); + $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; } @@ -1061,22 +1864,43 @@ function get_page_by_path($page_path, $output = OBJECT) { return NULL; } +/** + * get_page_by_title() - Retrieve a page given its title + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * @uses $wpdb + * + * @param string $page_title page title + * @param string $output output type + * @return mixed {@internal Missing Description}} + */ function get_page_by_title($page_title, $output = OBJECT) { global $wpdb; - $page_title = $wpdb->escape($page_title); - $page = $wpdb->get_var("SELECT ID FROM $wpdb->posts WHERE post_title = '$page_title' AND post_type='page'"); + $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type='page'", $page_title )); if ( $page ) return get_page($page, $output); return NULL; } +/** + * get_page_children() - Retrieve child pages + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5.1 + * + * @param int $page_id page ID + * @param array $pages list of pages + * @return array {@internal Missing Description}} + */ function &get_page_children($page_id, $pages) { - global $page_cache, $blog_id; - - if ( empty($pages) ) - $pages = &$page_cache[$blog_id]; - $page_list = array(); foreach ( $pages as $page ) { if ( $page->post_parent == $page_id ) { @@ -1088,8 +1912,20 @@ function &get_page_children($page_id, $pages) { return $page_list; } -//fetches the pages returned as a FLAT list, but arranged in order of their hierarchy, i.e., child parents -//immediately follow their parents +/** + * get_page_hierarchy() - {@internal Missing Short Description}} + * + * Fetches the pages returned as a FLAT list, but arranged in order of their hierarchy, + * i.e., child parents immediately follow their parents. + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * + * @param array $posts posts array + * @param int $parent parent page ID + * @return array {@internal Missing Description}} + */ function get_page_hierarchy($posts, $parent = 0) { $result = array ( ); if ($posts) { foreach ($posts as $post) { @@ -1102,9 +1938,21 @@ function get_page_hierarchy($posts, $parent = 0) { return $result; } +/** + * get_page_uri() - Builds a page URI + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * + * @param int $page_id page ID + * @return string {@internal Missing Description}} + */ function get_page_uri($page_id) { $page = get_page($page_id); - $uri = urldecode($page->post_name); + $uri = $page->post_name; // A page cannot be it's own parent. if ( $page->post_parent == $page->ID ) @@ -1112,16 +1960,29 @@ function get_page_uri($page_id) { while ($page->post_parent != 0) { $page = get_page($page->post_parent); - $uri = urldecode($page->post_name) . "/" . $uri; + $uri = $page->post_name . "/" . $uri; } return $uri; } -function &get_pages($args = '') { - global $wpdb; - - $defaults = array( +/** + * get_pages() - Retrieve a list of pages + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.5 + * @uses $wpdb + * + * @param mixed $args Optional. Array or string of options + * @return array List of pages matching defaults or $args + */ +function &get_pages($args = '') { + global $wpdb; + + $defaults = array( 'child_of' => 0, 'sort_order' => 'ASC', 'sort_column' => 'post_title', 'hierarchical' => 1, 'exclude' => '', 'include' => '', @@ -1133,7 +1994,7 @@ function &get_pages($args = '') { extract( $r, EXTR_SKIP ); $key = md5( serialize( $r ) ); - if ( $cache = wp_cache_get( 'get_pages', 'page' ) ) + if ( $cache = wp_cache_get( 'get_pages', 'posts' ) ) if ( isset( $cache[ $key ] ) ) return apply_filters('get_pages', $cache[ $key ], $r ); @@ -1148,9 +2009,9 @@ function &get_pages($args = '') { if ( count($incpages) ) { foreach ( $incpages as $incpage ) { if (empty($inclusions)) - $inclusions = ' AND ( ID = ' . intval($incpage) . ' '; + $inclusions = $wpdb->prepare(' AND ( ID = %d ', $incpage); else - $inclusions .= ' OR ID = ' . intval($incpage) . ' '; + $inclusions .= $wpdb->prepare(' OR ID = %d ', $incpage); } } } @@ -1163,9 +2024,9 @@ function &get_pages($args = '') { if ( count($expages) ) { foreach ( $expages as $expage ) { if (empty($exclusions)) - $exclusions = ' AND ( ID <> ' . intval($expage) . ' '; + $exclusions = $wpdb->prepare(' AND ( ID <> %d ', $expage); else - $exclusions .= ' AND ID <> ' . intval($expage) . ' '; + $exclusions .= $wpdb->prepare(' AND ID <> %d ', $expage); } } } @@ -1189,19 +2050,30 @@ function &get_pages($args = '') { } if ( '' == $author_query ) - $author_query = ' post_author = ' . intval($post_author) . ' '; + $author_query = $wpdb->prepare(' post_author = %d ', $post_author); else - $author_query .= ' OR post_author = ' . intval($post_author) . ' '; + $author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author); } if ( '' != $author_query ) $author_query = " AND ($author_query)"; } } - $query = "SELECT * FROM $wpdb->posts " ; - $query .= ( empty( $meta_key ) ? "" : ", $wpdb->postmeta " ) ; - $query .= " WHERE (post_type = 'page' AND post_status = 'publish') $exclusions $inclusions " ; - $query .= ( empty( $meta_key ) | empty($meta_value) ? "" : " AND ($wpdb->posts.ID = $wpdb->postmeta.post_id AND $wpdb->postmeta.meta_key = '$meta_key' AND $wpdb->postmeta.meta_value = '$meta_value' )" ) ; + $join = ''; + $where = "$exclusions $inclusions "; + if ( ! empty( $meta_key ) || ! empty( $meta_value ) ) { + $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )"; + + // meta_key and met_value might be slashed + $meta_key = stripslashes($meta_key); + $meta_value = stripslashes($meta_value); + if ( ! empty( $meta_key ) ) + $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key); + if ( ! empty( $meta_value ) ) + $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value); + + } + $query = "SELECT * FROM $wpdb->posts $join WHERE (post_type = 'page' AND post_status = 'publish') $where "; $query .= $author_query; $query .= " ORDER BY " . $sort_column . " " . $sort_order ; @@ -1217,55 +2089,29 @@ function &get_pages($args = '') { $pages = & get_page_children($child_of, $pages); $cache[ $key ] = $pages; - wp_cache_set( 'get_pages', $cache, 'page' ); + wp_cache_set( 'get_pages', $cache, 'posts' ); $pages = apply_filters('get_pages', $pages, $r); return $pages; } -function generate_page_uri_index() { - global $wpdb; - - //get pages in order of hierarchy, i.e. children after parents - $posts = get_page_hierarchy($wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'page'")); - //now reverse it, because we need parents after children for rewrite rules to work properly - $posts = array_reverse($posts, true); - - $page_uris = array(); - $page_attachment_uris = array(); - - if ($posts) { - - foreach ($posts as $id => $post) { - - // URL => page name - $uri = get_page_uri($id); - $attachments = $wpdb->get_results("SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'attachment' AND post_parent = '$id'"); - if ( $attachments ) { - foreach ( $attachments as $attachment ) { - $attach_uri = get_page_uri($attachment->ID); - $page_attachment_uris[$attach_uri] = $attachment->ID; - } - } - - $page_uris[$uri] = $id; - } - - delete_option('page_uris'); - update_option('page_uris', $page_uris); - - if ( $page_attachment_uris ) { - delete_option('page_attachment_uris'); - update_option('page_attachment_uris', $page_attachment_uris); - } - } -} - // // Attachment functions // +/** + * is_local_attachment() - Check if the attachment URI is local one and is really an attachment. + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * + * @param string $url URL to check + * @return bool {@internal Missing Description}} + */ function is_local_attachment($url) { if (strpos($url, get_bloginfo('url')) === false) return false; @@ -1279,12 +2125,30 @@ function is_local_attachment($url) { return false; } +/** + * wp_insert_attachment() - Insert an attachment + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * + * @uses $wpdb + * @uses $user_ID + * + * @param object $object attachment object + * @param string $file filename + * @param int $post_parent parent post ID + * @return int {@internal Missing Description}} + */ 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, 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0, - 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => ''); + 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', + 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => ''); $object = wp_parse_args($object, $defaults); if ( !empty($parent) ) @@ -1319,14 +2183,15 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { else $post_name = sanitize_title($post_name); - $post_name_check = - $wpdb->get_var("SELECT post_name FROM $wpdb->posts WHERE post_name = '$post_name' AND post_status = 'inherit' AND ID != '$post_ID' LIMIT 1"); + // expected_slashed ($post_name) + $post_name_check = $wpdb->get_var( $wpdb->prepare( "SELECT post_name FROM $wpdb->posts WHERE post_name = '$post_name' AND post_status = 'inherit' AND ID != %d LIMIT 1", $post_ID)); if ($post_name_check) { $suffix = 2; while ($post_name_check) { $alt_post_name = $post_name . "-$suffix"; - $post_name_check = $wpdb->get_var("SELECT post_name FROM $wpdb->posts WHERE post_name = '$alt_post_name' AND post_status = 'inherit' AND ID != '$post_ID' AND post_parent = '$post_parent' LIMIT 1"); + // expected_slashed ($alt_post_name, $post_name) + $post_name_check = $wpdb->get_var( $wpdb->prepare( "SELECT post_name FROM $wpdb->posts WHERE post_name = '$alt_post_name' AND post_status = 'inherit' AND ID != %d AND post_parent = %d LIMIT 1", $post_ID, $post_parent)); $suffix++; } $post_name = $alt_post_name; @@ -1337,6 +2202,11 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { if ( empty($post_date_gmt) ) $post_date_gmt = current_time('mysql', 1); + if ( empty($post_modified) ) + $post_modified = $post_date; + if ( empty($post_modified_gmt) ) + $post_modified_gmt = $post_date_gmt; + if ( empty($comment_status) ) { if ( $update ) $comment_status = 'closed'; @@ -1367,50 +2237,27 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { if ( ! isset($pinged) ) $pinged = ''; - if ($update) { - $wpdb->query( - "UPDATE $wpdb->posts SET - post_author = '$post_author', - post_date = '$post_date', - post_date_gmt = '$post_date_gmt', - post_content = '$post_content', - post_content_filtered = '$post_content_filtered', - post_title = '$post_title', - post_excerpt = '$post_excerpt', - post_status = '$post_status', - post_type = '$post_type', - comment_status = '$comment_status', - ping_status = '$ping_status', - post_password = '$post_password', - post_name = '$post_name', - to_ping = '$to_ping', - pinged = '$pinged', - post_modified = '".current_time('mysql')."', - post_modified_gmt = '".current_time('mysql',1)."', - post_parent = '$post_parent', - menu_order = '$menu_order', - post_mime_type = '$post_mime_type', - guid = '$guid' - WHERE ID = $post_ID"); + // expected_slashed (everything!) + $data = compact( array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'post_mime_type', 'guid' ) ); + $data = stripslashes_deep( $data ); + + if ( $update ) { + $wpdb->update( $wpdb->posts, $data, array( 'ID' => $post_ID ) ); } else { - $wpdb->query( - "INSERT INTO $wpdb->posts - (post_author, post_date, post_date_gmt, post_content, post_content_filtered, post_title, post_excerpt, post_status, post_type, comment_status, ping_status, post_password, post_name, to_ping, pinged, post_modified, post_modified_gmt, post_parent, menu_order, post_mime_type, guid) - VALUES - ('$post_author', '$post_date', '$post_date_gmt', '$post_content', '$post_content_filtered', '$post_title', '$post_excerpt', '$post_status', '$post_type', '$comment_status', '$ping_status', '$post_password', '$post_name', '$to_ping', '$pinged', '$post_date', '$post_date_gmt', '$post_parent', '$menu_order', '$post_mime_type', '$guid')"); - $post_ID = (int) $wpdb->insert_id; + $wpdb->insert( $wpdb->posts, $data ); + $post_ID = (int) $wpdb->insert_id; } if ( empty($post_name) ) { $post_name = sanitize_title($post_title, $post_ID); - $wpdb->query( "UPDATE $wpdb->posts SET post_name = '$post_name' WHERE ID = '$post_ID'" ); + $wpdb->update( $wpdb->posts, compact("post_name"), array( 'ID' => $post_ID ) ); } wp_set_post_categories($post_ID, $post_category); if ( $file ) update_attached_file( $post_ID, $file ); - + clean_post_cache($post_ID); if ( $update) { @@ -1422,11 +2269,23 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { return $post_ID; } +/** + * wp_delete_attachment() - Delete an attachment + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.0 + * @uses $wpdb + * + * @param int $postid attachment Id + * @return mixed {@internal Missing Description}} + */ function wp_delete_attachment($postid) { global $wpdb; - $postid = (int) $postid; - if ( !$post = $wpdb->get_row("SELECT * FROM $wpdb->posts WHERE ID = '$postid'") ) + if ( !$post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d", $postid)) ) return $post; if ( 'attachment' != $post->post_type ) @@ -1435,34 +2294,58 @@ function wp_delete_attachment($postid) { $meta = wp_get_attachment_metadata( $postid ); $file = get_attached_file( $postid ); - // TODO delete for pluggable post taxonomies too + /** @todo Delete for pluggable post taxonomies too */ wp_delete_object_term_relationships($postid, array('category', 'post_tag')); - $wpdb->query("DELETE FROM $wpdb->posts WHERE ID = '$postid'"); + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->posts WHERE ID = %d", $postid )); - $wpdb->query("DELETE FROM $wpdb->comments WHERE comment_post_ID = '$postid'"); + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->comments WHERE comment_post_ID = %d", $postid )); - $wpdb->query("DELETE FROM $wpdb->postmeta WHERE post_id = '$postid'"); + $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE post_id = %d ", $postid )); if ( ! empty($meta['thumb']) ) { // Don't delete the thumb if another attachment uses it - if (! $wpdb->get_row("SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE '%".$wpdb->escape($meta['thumb'])."%' AND post_id <> $postid")) { + if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%'.$meta['thumb'].'%', $postid)) ) { $thumbfile = str_replace(basename($file), $meta['thumb'], $file); $thumbfile = apply_filters('wp_delete_file', $thumbfile); @ unlink($thumbfile); } } + // remove intermediate images if there are any + $sizes = apply_filters('intermediate_image_sizes', array('thumbnail', 'medium')); + foreach ( $sizes as $size ) { + if ( $intermediate = image_get_intermediate_size($postid, $size) ) { + $intermediate_file = apply_filters('wp_delete_file', $intermediate['path']); + @ unlink($intermediate_file); + } + } + $file = apply_filters('wp_delete_file', $file); if ( ! empty($file) ) @ unlink($file); + clean_post_cache($postid); + do_action('delete_attachment', $postid); return $post; } +/** + * wp_get_attachment_metadata() - Retrieve metadata for an attachment + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id attachment ID + * @param bool $unfiltered Optional, default is false. If true, filters are not run + * @return array {@internal Missing Description}} + */ function wp_get_attachment_metadata( $post_id, $unfiltered = false ) { $post_id = (int) $post_id; if ( !$post =& get_post( $post_id ) ) @@ -1474,21 +2357,41 @@ function wp_get_attachment_metadata( $post_id, $unfiltered = false ) { return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID ); } +/** + * wp_update_attachment_metadata() - Update metadata for an attachment + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id attachment ID + * @param array $data attachment data + * @return int {@internal Missing Description}} + */ function wp_update_attachment_metadata( $post_id, $data ) { $post_id = (int) $post_id; if ( !$post =& get_post( $post_id ) ) return false; - $old_data = wp_get_attachment_metadata( $post->ID, true ); - $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ); - if ( $old_data ) - return update_post_meta( $post->ID, '_wp_attachment_metadata', $data, $old_data ); - else - return add_post_meta( $post->ID, '_wp_attachment_metadata', $data ); + return update_post_meta( $post->ID, '_wp_attachment_metadata', $data); } +/** + * wp_get_attachment_url() - Retrieve the URL for an attachment + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id attachment ID + * @return string {@internal Missing Description}} + */ function wp_get_attachment_url( $post_id = 0 ) { $post_id = (int) $post_id; if ( !$post =& get_post( $post_id ) ) @@ -1502,11 +2405,23 @@ function wp_get_attachment_url( $post_id = 0 ) { return apply_filters( 'wp_get_attachment_url', $url, $post->ID ); } +/** + * wp_get_attachment_thumb_file() - Retrieve thumbnail for an attachment + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id attachment ID + * @return mixed {@internal Missing Description}} + */ function wp_get_attachment_thumb_file( $post_id = 0 ) { $post_id = (int) $post_id; if ( !$post =& get_post( $post_id ) ) return false; - if ( !$imagedata = wp_get_attachment_metadata( $post->ID ) ) + if ( !is_array( $imagedata = wp_get_attachment_metadata( $post->ID ) ) ) return false; $file = get_attached_file( $post->ID ); @@ -1516,12 +2431,28 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) { return false; } +/** + * wp_get_attachment_thumb_url() - Retrieve URL for an attachment thumbnail + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id attachment ID + * @return string {@internal Missing Description}} + */ function wp_get_attachment_thumb_url( $post_id = 0 ) { $post_id = (int) $post_id; if ( !$post =& get_post( $post_id ) ) return false; if ( !$url = wp_get_attachment_url( $post->ID ) ) return false; + + $sized = image_downsize( $post_id, 'thumbnail' ); + if ( $sized ) + return $sized[0]; if ( !$thumb = wp_get_attachment_thumb_file( $post->ID ) ) return false; @@ -1531,6 +2462,18 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) { return apply_filters( 'wp_get_attachment_thumb_url', $url, $post->ID ); } +/** + * wp_attachment_is_image() - Check if the attachment is an image + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id attachment ID + * @return bool {@internal Missing Description}} + */ function wp_attachment_is_image( $post_id = 0 ) { $post_id = (int) $post_id; if ( !$post =& get_post( $post_id ) ) @@ -1548,47 +2491,110 @@ function wp_attachment_is_image( $post_id = 0 ) { return false; } +/** + * wp_mime_type_icon() - Retrieve the icon for a MIME type + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param string $mime MIME type + * @return string|bool {@internal Missing Description}} + */ function wp_mime_type_icon( $mime = 0 ) { - $post_id = 0; - if ( is_numeric($mime) ) { - $mime = (int) $mime; - if ( !$post =& get_post( $mime ) ) - return false; - $post_id = (int) $post->ID; - $mime = $post->post_mime_type; - } - - if ( empty($mime) ) - return false; + if ( !is_numeric($mime) ) + $icon = wp_cache_get("mime_type_icon_$mime"); + if ( empty($icon) ) { + $post_id = 0; + $post_mimes = array(); + if ( is_numeric($mime) ) { + $mime = (int) $mime; + if ( $post =& get_post( $mime ) ) { + $post_id = (int) $post->ID; + $ext = preg_replace('/^.+?\.([^.]+)$/', '$1', $post->guid); + if ( !empty($ext) ) { + $post_mimes[] = $ext; + if ( $ext_type = wp_ext2type( $ext ) ) + $post_mimes[] = $ext_type; + } + $mime = $post->post_mime_type; + } else { + $mime = 0; + } + } else { + $post_mimes[] = $mime; + } - $icon_dir = apply_filters( 'icon_dir', get_template_directory() . '/images' ); - $icon_dir_uri = apply_filters( 'icon_dir_uri', get_template_directory_uri() . '/images' ); + $icon_files = wp_cache_get('icon_files'); + + if ( !is_array($icon_files) ) { + $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' ); + $icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url('images/crystal') ); + $dirs = apply_filters( 'icon_dirs', array($icon_dir => $icon_dir_uri) ); + $icon_files = array(); + while ( $dirs ) { + $dir = array_shift($keys = array_keys($dirs)); + $uri = array_shift($dirs); + if ( $dh = opendir($dir) ) { + while ( false !== $file = readdir($dh) ) { + $file = basename($file); + if ( substr($file, 0, 1) == '.' ) + continue; + if ( !in_array(strtolower(substr($file, -4)), array('.png', '.gif', '.jpg') ) ) { + if ( is_dir("$dir/$file") ) + $dirs["$dir/$file"] = "$uri/$file"; + continue; + } + $icon_files["$dir/$file"] = "$uri/$file"; + } + closedir($dh); + } + } + wp_cache_set('icon_files', $icon_files, 600); + } - $types = array( - substr($mime, 0, strpos($mime, '/')), - substr($mime, strpos($mime, '/') + 1), - str_replace('/', '_', $mime) - ); + // Icon basename - extension = MIME wildcard + foreach ( $icon_files as $file => $uri ) + $types[ preg_replace('/^([^.]*).*$/', '$1', basename($file)) ] =& $icon_files[$file]; - $exts = array('jpg', 'gif', 'png'); + if ( ! empty($mime) ) { + $post_mimes[] = substr($mime, 0, strpos($mime, '/')); + $post_mimes[] = substr($mime, strpos($mime, '/') + 1); + $post_mimes[] = str_replace('/', '_', $mime); + } - $src = false; + $matches = wp_match_mime_types(array_keys($types), $post_mimes); + $matches['default'] = array('default'); - foreach ( $types as $type ) { - foreach ( $exts as $ext ) { - $src_file = "$icon_dir/$type.$ext"; - if ( file_exists($src_file) ) { - $src = "$icon_dir_uri/$type.$ext"; - break 2; + foreach ( $matches as $match => $wilds ) { + if ( isset($types[$wilds[0]])) { + $icon = $types[$wilds[0]]; + if ( !is_numeric($mime) ) + wp_cache_set("mime_type_icon_$mime", $icon); + break; } } } - return apply_filters( 'wp_mime_type_icon', $src, $mime, $post_id ); // Last arg is 0 if function pass mime type. + return apply_filters( 'wp_mime_type_icon', $icon, $mime, $post_id ); // Last arg is 0 if function pass mime type. } +/** + * wp_check_for_changed_slugs() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.1 + * + * @param int $post_id The Post ID + * @return int Same as $post_id + */ function wp_check_for_changed_slugs($post_id) { - if ( !strlen($_POST['wp-old-slug']) ) + if ( !isset($_POST['wp-old-slug']) || !strlen($_POST['wp-old-slug']) ) return $post_id; $post = &get_post($post_id); @@ -1615,12 +2621,21 @@ function wp_check_for_changed_slugs($post_id) { } /** + * get_private_posts_cap_sql() - {@internal Missing Short Description}} + * * 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 published posts, and all private posts to which the user * has access. * + * @package WordPress + * @subpackage Post + * @since 2.2 + * + * @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. */ @@ -1660,9 +2675,27 @@ function get_private_posts_cap_sql($post_type) { return $sql; } +/** + * get_lastpostdate() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @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, $pagenow, $wpdb, $blog_id; - $add_seconds_blog = get_option('gmt_offset') * 3600; + global $cache_lastpostdate, $wpdb, $blog_id; $add_seconds_server = date('Z'); if ( !isset($cache_lastpostdate[$blog_id][$timezone]) ) { switch(strtolower($timezone)) { @@ -1680,12 +2713,30 @@ function get_lastpostdate($timezone = 'server') { } else { $lastpostdate = $cache_lastpostdate[$blog_id][$timezone]; } - return apply_filters( 'get_lastpostdate', $lastpostdate ); + return apply_filters( 'get_lastpostdate', $lastpostdate, $timezone ); } +/** + * get_lastpostmodified() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 1.2 + * + * @uses $wpdb + * @uses $blog_id + * @uses apply_filters() Calls 'get_lastpostmodified' filter + * + * @global mixed $cache_lastpostmodified Stores the date the last post was modified + * @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 the post was last modified. + */ function get_lastpostmodified($timezone = 'server') { - global $cache_lastpostmodified, $pagenow, $wpdb, $blog_id; - $add_seconds_blog = get_option('gmt_offset') * 3600; + global $cache_lastpostmodified, $wpdb, $blog_id; $add_seconds_server = date('Z'); if ( !isset($cache_lastpostmodified[$blog_id][$timezone]) ) { switch(strtolower($timezone)) { @@ -1707,151 +2758,264 @@ function get_lastpostmodified($timezone = 'server') { } else { $lastpostmodified = $cache_lastpostmodified[$blog_id][$timezone]; } - return apply_filters( 'get_lastpostmodified', $lastpostmodified ); + return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone ); } -// -// Cache -// - +/** + * update_post_cache() - Updates posts in cache + * + * @usedby update_page_cache() 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) { - global $post_cache, $blog_id; - if ( !$posts ) return; - for ($i = 0; $i < count($posts); $i++) { - $post_cache[$blog_id][$posts[$i]->ID] = &$posts[$i]; - } + foreach ( $posts as $post ) + wp_cache_add($post->ID, $post, 'posts'); } +/** + * clean_post_cache() - Will clean the post in the cache + * + * Cleaning means delete from the cache of the post. Will call to clean + * the term object cache associated with the post ID. + * + * @package WordPress + * @subpackage Cache + * @since 2.0 + * + * @uses do_action() Will call the 'clean_post_cache' hook action. + * + * @param int $id The Post ID in the cache to clean + */ function clean_post_cache($id) { - global $post_cache, $post_meta_cache, $post_term_cache, $blog_id; - - if ( isset( $post_cache[$blog_id][$id] ) ) - unset( $post_cache[$blog_id][$id] ); + global $wpdb; + $id = (int) $id; - if ( isset ($post_meta_cache[$blog_id][$id] ) ) - unset( $post_meta_cache[$blog_id][$id] ); + wp_cache_delete($id, 'posts'); + wp_cache_delete($id, 'post_meta'); clean_object_term_cache($id, 'post'); -} -function update_page_cache(&$pages) { - global $page_cache, $blog_id; + wp_cache_delete( 'wp_get_archives', 'general' ); - if ( !$pages ) - return; + do_action('clean_post_cache', $id); - for ($i = 0; $i < count($pages); $i++) { - $page_cache[$blog_id][$pages[$i]->ID] = &$pages[$i]; - wp_cache_add($pages[$i]->ID, $pages[$i], 'pages'); + 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 ); } } +/** + * update_page_cache() - 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); +} + +/** + * clean_page_cache() - 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 + * + * @uses do_action() Will call the 'clean_page_cache' hook action. + * + * @param int $id Page ID to clean + */ function clean_page_cache($id) { - global $page_cache, $blog_id; + clean_post_cache($id); - if ( isset( $page_cache[$blog_id][$id] ) ) - unset( $page_cache[$blog_id][$id] ); + wp_cache_delete( 'all_page_ids', 'posts' ); + wp_cache_delete( 'get_pages', 'posts' ); - wp_cache_delete($id, 'pages'); - wp_cache_delete( 'all_page_ids', 'pages' ); - wp_cache_delete( 'get_pages', 'page' ); + do_action('clean_page_cache', $id); } +/** + * update_post_caches() - Call major cache updating functions for list of Post objects. + * + * @package WordPress + * @subpackage Cache + * @since 1.5 + * + * @uses $wpdb + * @uses update_post_cache() + * @uses update_object_term_cache() + * @uses update_postmeta_cache() + * + * @param array $posts Array of Post objects + */ function update_post_caches(&$posts) { - global $post_cache; - global $wpdb, $blog_id; - // No point in doing all this work if we didn't match any posts. if ( !$posts ) return; - // Get the categories for all the posts - for ($i = 0; $i < count($posts); $i++) { - $post_id_array[] = $posts[$i]->ID; - $post_cache[$blog_id][$posts[$i]->ID] = &$posts[$i]; - } + update_post_cache($posts); - $post_id_list = implode(',', $post_id_array); + $post_ids = array(); - update_object_term_cache($post_id_list, 'post'); + for ($i = 0; $i < count($posts); $i++) + $post_ids[] = $posts[$i]->ID; - update_postmeta_cache($post_id_list); -} + update_object_term_cache($post_ids, 'post'); -function update_postmeta_cache($post_id_list = '') { - global $wpdb, $post_meta_cache, $blog_id; + update_postmeta_cache($post_ids); +} - // We should validate this comma-separated list for the upcoming SQL query - $post_id_list = preg_replace('|[^0-9,]|', '', $post_id_list); +/** + * update_postmeta_cache() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Cache + * @since 2.1 + * + * @uses $wpdb + * + * @param array $post_ids {@internal Missing Description}} + * @return bool|array Returns false if there is nothing to update or an array of metadata + */ +function update_postmeta_cache($post_ids) { + global $wpdb; - if ( empty( $post_id_list ) ) + if ( empty( $post_ids ) ) return false; - // we're marking each post as having its meta cached (with no keys... empty array), to prevent posts with no meta keys from being queried again - // any posts that DO have keys will have this empty array overwritten with a proper array, down below - $post_id_array = (array) explode(',', $post_id_list); - $count = count( $post_id_array); - for ( $i = 0; $i < $count; $i++ ) { - $post_id = (int) $post_id_array[ $i ]; - if ( isset( $post_meta_cache[$blog_id][$post_id] ) ) { // If the meta is already cached - unset( $post_id_array[ $i ] ); - continue; - } - $post_meta_cache[$blog_id][$post_id] = array(); + if ( !is_array($post_ids) ) { + $post_ids = preg_replace('|[^0-9,]|', '', $post_ids); + $post_ids = explode(',', $post_ids); } - if ( count( $post_id_array ) == 0 ) - return; - $post_id_list = join( ',', $post_id_array ); // with already cached stuff removeds - // Get post-meta info - if ( $meta_list = $wpdb->get_results("SELECT post_id, meta_key, meta_value FROM $wpdb->postmeta WHERE post_id IN($post_id_list) ORDER BY post_id, meta_key", ARRAY_A) ) { - // Change from flat structure to hierarchical: - if ( !isset($post_meta_cache) ) - $post_meta_cache[$blog_id] = array(); + $post_ids = array_map('intval', $post_ids); + + $ids = array(); + foreach ( (array) $post_ids as $id ) { + if ( false === wp_cache_get($id, 'post_meta') ) + $ids[] = $id; + } + + if ( empty( $ids ) ) + return false; - foreach ($meta_list as $metarow) { + // Get post-meta info + $id_list = join(',', $ids); + $cache = array(); + if ( $meta_list = $wpdb->get_results("SELECT post_id, meta_key, meta_value FROM $wpdb->postmeta WHERE post_id IN ($id_list) ORDER BY post_id, meta_key", ARRAY_A) ) { + foreach ( (array) $meta_list as $metarow) { $mpid = (int) $metarow['post_id']; $mkey = $metarow['meta_key']; $mval = $metarow['meta_value']; // Force subkeys to be array type: - if ( !isset($post_meta_cache[$blog_id][$mpid]) || !is_array($post_meta_cache[$blog_id][$mpid]) ) - $post_meta_cache[$blog_id][$mpid] = array(); - if ( !isset($post_meta_cache[$blog_id][$mpid]["$mkey"]) || !is_array($post_meta_cache[$blog_id][$mpid]["$mkey"]) ) - $post_meta_cache[$blog_id][$mpid]["$mkey"] = array(); + if ( !isset($cache[$mpid]) || !is_array($cache[$mpid]) ) + $cache[$mpid] = array(); + if ( !isset($cache[$mpid][$mkey]) || !is_array($cache[$mpid][$mkey]) ) + $cache[$mpid][$mkey] = array(); // Add a value to the current pid/key: - $post_meta_cache[$blog_id][$mpid][$mkey][] = $mval; + $cache[$mpid][$mkey][] = $mval; } } + + foreach ( (array) $ids as $id ) { + if ( ! isset($cache[$id]) ) + $cache[$id] = array(); + } + + foreach ( array_keys($cache) as $post) + wp_cache_set($post, $cache[$post], 'post_meta'); + + return $cache; } // // Hooks // +/** + * _transition_post_status() - Hook {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @uses $wpdb + * + * @param string $new_status {@internal Missing Description}} + * @param string $old_status {@internal Missing Description}} + * @param object $post Object type containing the post information + */ function _transition_post_status($new_status, $old_status, $post) { global $wpdb; if ( $old_status != 'publish' && $new_status == 'publish' ) { - // Reset GUID if transitioning to publish. - $wpdb->query("UPDATE $wpdb->posts SET guid = '" . get_permalink($post->ID) . "' WHERE ID = '$post->ID'"); - do_action('private_to_published', $post->ID); // Deprecated, use private_to_publish + // Reset GUID if transitioning to publish and it is empty + if ( '' == get_the_guid($post->ID) ) + $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post->ID ) ), array( 'ID' => $post->ID ) ); + do_action('private_to_published', $post->ID); // Deprecated, use private_to_publish } // Always clears the hook in case the post status bounced from future to draft. wp_clear_scheduled_hook('publish_future_post', $post->ID); } -function _future_post_hook($post_id, $post) { - // Schedule publication. +/** + * _future_post_hook() - Hook used to schedule publication for a post marked for the future. + * + * The $post properties used and must exist are 'ID' and 'post_date_gmt'. + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @param int $post_id Not Used. Can be set to null. + * @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)); } +/** + * _publish_post_hook() - Hook {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @uses $wpdb + * @uses XMLRPC_REQUEST + * @uses APP_REQUEST + * @uses do_action Calls 'xmlprc_publish_post' action if XMLRPC_REQUEST is defined. Calls 'app_publish_post' + * action if APP_REQUEST is defined. + * + * @param int $post_id The ID in the database table of the post being published + */ function _publish_post_hook($post_id) { global $wpdb; @@ -1863,28 +3027,34 @@ function _publish_post_hook($post_id) { if ( defined('WP_IMPORTING') ) return; - $post = get_post($post_id); - + $data = array( 'post_id' => $post_id, 'meta_value' => '1' ); if ( get_option('default_pingback_flag') ) - $result = $wpdb->query(" - INSERT INTO $wpdb->postmeta - (post_id,meta_key,meta_value) - VALUES ('$post_id','_pingme','1') - "); - $result = $wpdb->query(" - INSERT INTO $wpdb->postmeta - (post_id,meta_key,meta_value) - VALUES ('$post_id','_encloseme','1') - "); + $wpdb->insert( $wpdb->postmeta, $data + array( 'meta_key' => '_pingme' ) ); + $wpdb->insert( $wpdb->postmeta, $data + array( 'meta_key' => '_encloseme' ) ); wp_schedule_single_event(time(), 'do_pings'); } +/** + * _save_post_hook() - 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. + * + * @package WordPress + * @subpackage Post + * @since 2.3 + * + * @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' ) { - if ( !empty($post->page_template) ) - if ( ! update_post_meta($post_id, '_wp_page_template', $post->page_template)) - add_post_meta($post_id, '_wp_page_template', $post->page_template, true); - clean_page_cache($post_id); global $wp_rewrite; $wp_rewrite->flush_rules(); @@ -1893,4 +3063,376 @@ function _save_post_hook($post_id, $post) { } } -?> \ No newline at end of file +// +// Private +// + +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; + } +} + +/* Post Revisions */ + +/** + * _wp_post_revision_fields() - 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 an array whose keys are the post fields to be saved for post revisions. + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @param array $post optional a post array to be processed for insertion as a post revision + * @param bool $autosave optional Is the revision an autosave? + * @return array post array ready to be inserted as a post revision or array of fields that can be versioned + */ +function _wp_post_revision_fields( $post = null, $autosave = false ) { + static $fields = false; + + if ( !$fields ) { + // Allow these to be versioned + $fields = array( + 'post_title' => __( 'Title' ), + 'post_content' => __( 'Content' ), + 'post_excerpt' => __( 'Excerpt' ), + ); + + // Runs only once + $fields = apply_filters( '_wp_post_revision_fields', $fields ); + + // WP uses these internally either in versioning or elsewhere - they cannot be versioned + foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) + unset( $fields[$protect] ); + } + + if ( !is_array($post) ) + return $fields; + + $return = array(); + foreach ( array_intersect( array_keys( $post ), array_keys( $fields ) ) as $field ) + $return[$field] = $post[$field]; + + $return['post_parent'] = $post['ID']; + $return['post_status'] = 'inherit'; + $return['post_type'] = 'revision'; + $return['post_name'] = $autosave ? "$post[ID]-autosave" : "$post[ID]-revision"; + $return['post_date'] = $post['post_modified']; + $return['post_date_gmt'] = $post['post_modified_gmt']; + + return $return; +} + +/** + * wp_save_post_revision() - Saves an already existing post as a post revision. Typically used immediately prior to post updates. + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @uses _wp_put_post_revision() + * + * @param int $post_id The ID of the post to save as a revision + * @return mixed null or 0 if error, new revision ID if success + */ +function wp_save_post_revision( $post_id ) { + // We do autosaves manually with wp_create_post_autosave() + if ( @constant( 'DOING_AUTOSAVE' ) ) + return; + + // WP_POST_REVISIONS = 0, false + if ( !constant('WP_POST_REVISIONS') ) + return; + + if ( !$post = get_post( $post_id, ARRAY_A ) ) + return; + + if ( !in_array( $post['post_type'], array( 'post', 'page' ) ) ) + return; + + $return = _wp_put_post_revision( $post ); + + // WP_POST_REVISIONS = true (default), -1 + if ( !is_numeric( WP_POST_REVISIONS ) || WP_POST_REVISIONS < 0 ) + return $return; + + // all revisions and (possibly) one autosave + $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) ); + + // WP_POST_REVISIONS = (int) (# of autasaves to save) + $delete = count($revisions) - WP_POST_REVISIONS; + + if ( $delete < 1 ) + return $return; + + $revisions = array_slice( $revisions, 0, $delete ); + + for ( $i = 0; isset($revisions[$i]); $i++ ) { + if ( false !== strpos( $revisions[$i]->post_name, 'autosave' ) ) + continue; + wp_delete_post_revision( $revisions[$i]->ID ); + } + + return $return; +} + +/** + * wp_get_post_autosave() - returns the autosaved data of the specified post. + * + * Returns a post object containing the information that was autosaved for the specified post. + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @param int $post_id The post ID + * @return object|bool the autosaved data or false on failure or when no autosave exists + */ +function wp_get_post_autosave( $post_id ) { + global $wpdb; + if ( !$post = get_post( $post_id ) ) + return false; + + $q = array( + 'name' => "{$post->ID}-autosave", + 'post_parent' => $post->ID, + 'post_type' => 'revision', + 'post_status' => 'inherit' + ); + + // Use WP_Query so that the result gets cached + $autosave_query = new WP_Query; + + add_action( 'parse_query', '_wp_get_post_autosave_hack' ); + $autosave = $autosave_query->query( $q ); + remove_action( 'parse_query', '_wp_get_post_autosave_hack' ); + + if ( $autosave && is_array($autosave) && is_object($autosave[0]) ) + return $autosave[0]; + + return false; +} + +// Internally used to hack WP_Query into submission +function _wp_get_post_autosave_hack( $query ) { + $query->is_single = false; +} + + +/** + * wp_is_post_revision() - Determines if the specified post is a revision. + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @param int|object $post post ID or post object + * @return bool|int false if not a revision, ID of revision's parent otherwise + */ +function wp_is_post_revision( $post ) { + if ( !$post = wp_get_post_revision( $post ) ) + return false; + return (int) $post->post_parent; +} + +/** + * wp_is_post_autosave() - Determines if the specified post is an autosave. + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @param int|object $post post ID or post object + * @return bool|int false if not a revision, ID of autosave's parent otherwise + */ +function wp_is_post_autosave( $post ) { + if ( !$post = wp_get_post_revision( $post ) ) + return false; + if ( "{$post->post_parent}-autosave" !== $post->post_name ) + return false; + return (int) $post->post_parent; +} + +/** + * _wp_put_post_revision() - Inserts post data into the posts table as a post revision + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @uses wp_insert_post() + * + * @param int|object|array $post post ID, post object OR post array + * @param bool $autosave optional Is the revision an autosave? + * @return mixed null or 0 if error, new revision ID if success + */ +function _wp_put_post_revision( $post = null, $autosave = false ) { + if ( is_object($post) ) + $post = get_object_vars( $post ); + elseif ( !is_array($post) ) + $post = get_post($post, ARRAY_A); + if ( !$post || empty($post['ID']) ) + return; + + if ( isset($post['post_type']) && 'revision' == $post['post_type'] ) + return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) ); + + $post = _wp_post_revision_fields( $post, $autosave ); + + $revision_id = wp_insert_post( $post ); + if ( is_wp_error($revision_id) ) + return $revision_id; + + if ( $revision_id ) + do_action( '_wp_put_post_revision', $revision_id ); + return $revision_id; +} + +/** + * wp_get_post_revision() - Gets a post revision + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @uses get_post() + * + * @param int|object $post post ID or post object + * @param $output optional OBJECT, ARRAY_A, or ARRAY_N + * @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') { + $null = null; + if ( !$revision = get_post( $post, OBJECT, $filter ) ) + return $revision; + if ( 'revision' !== $revision->post_type ) + return $null; + + if ( $output == OBJECT ) { + return $revision; + } elseif ( $output == ARRAY_A ) { + $_revision = get_object_vars($revision); + return $_revision; + } elseif ( $output == ARRAY_N ) { + $_revision = array_values(get_object_vars($revision)); + return $_revision; + } + + return $revision; +} + +/** + * wp_restore_post_revision() - Restores a post to the specified revision + * + * Can restore a past using all fields of the post revision, or only selected fields. + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @uses wp_get_post_revision() + * @uses wp_update_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 + */ +function wp_restore_post_revision( $revision_id, $fields = null ) { + if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) ) + return $revision; + + if ( !is_array( $fields ) ) + $fields = array_keys( _wp_post_revision_fields() ); + + $update = array(); + foreach( array_intersect( array_keys( $revision ), $fields ) as $field ) + $update[$field] = $revision[$field]; + + if ( !$update ) + return false; + + $update['ID'] = $revision['post_parent']; + + $post_id = wp_update_post( $update ); + if ( is_wp_error( $post_id ) ) + return $post_id; + + if ( $post_id ) + do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] ); + + return $post_id; +} + +/** + * wp_delete_post_revision() - Deletes a revision. + * + * Deletes the row from the posts table corresponding to the specified revision + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @uses wp_get_post_revision() + * @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 + */ +function wp_delete_post_revision( $revision_id ) { + if ( !$revision = wp_get_post_revision( $revision_id ) ) + return $revision; + + $delete = wp_delete_post( $revision->ID ); + if ( is_wp_error( $delete ) ) + return $delete; + + if ( $delete ) + do_action( 'wp_delete_post_revision', $revision->ID, $revision ); + + return $delete; +} + +/** + * wp_get_post_revisions() - Returns all revisions of specified post + * + * @package WordPress + * @subpackage Post Revisions + * @since 2.6 + * + * @uses get_children() + * + * @param int|object $post_id post ID or post object + * @return array empty if no revisions + */ +function wp_get_post_revisions( $post_id = 0, $args = null ) { + if ( !constant('WP_POST_REVISIONS') ) + return array(); + if ( ( !$post = get_post( $post_id ) ) || empty( $post->ID ) ) + return array(); + + $defaults = array( 'order' => 'DESC', 'orderby' => 'date' ); + $args = wp_parse_args( $args, $defaults ); + $args = array_merge( $args, array( 'post_parent' => $post->ID, 'post_type' => 'revision', 'post_status' => 'inherit' ) ); + + if ( !$revisions = get_children( $args ) ) + return array(); + return $revisions; +}