X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/6c8f14c09105d0afa4c1574215c59b5021040e76..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/post.php diff --git a/wp-includes/post.php b/wp-includes/post.php index 54f17f41..912a03c8 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -74,6 +74,8 @@ function create_initial_post_types() { 'delete_with_user' => true, 'supports' => array( 'title', 'author', 'comments' ), ) ); + add_post_type_support( 'attachment:audio', 'thumbnail' ); + add_post_type_support( 'attachment:video', 'thumbnail' ); register_post_type( 'revision', array( 'labels' => array( @@ -162,13 +164,13 @@ function create_initial_post_types() { 'exclude_from_search' => false, ) ); } -add_action( 'init', 'create_initial_post_types', 0 ); // highest priority /** * Retrieve attached file path based on attachment ID. * - * You can optionally send it through the 'get_attached_file' filter, but by - * default it will just return the file path unfiltered. + * By default the path will go through the 'get_attached_file' filter, but + * passing a true to the $unfiltered argument of get_attached_file() will + * return the file path unfiltered. * * The function works by getting the single post meta name, named * '_wp_attached_file' and returning it. This is a convenience function to @@ -176,19 +178,27 @@ add_action( 'init', 'create_initial_post_types', 0 ); // highest priority * attached filename through a filter. * * @since 2.0.0 - * @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID. * - * @param int $attachment_id Attachment ID. - * @param bool $unfiltered Whether to apply filters. - * @return string|bool The file path to the attached file, or false if the attachment does not exist. + * @param int $attachment_id Attachment ID. + * @param bool $unfiltered Optional. Whether to apply filters. Default false. + * @return string|false The file path to where the attached file should be, false otherwise. */ function get_attached_file( $attachment_id, $unfiltered = false ) { $file = get_post_meta( $attachment_id, '_wp_attached_file', true ); - // If the file is relative, prepend upload dir + // If the file is relative, prepend upload dir. if ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) ) $file = $uploads['basedir'] . "/$file"; if ( $unfiltered ) return $file; + + /** + * Filter the attached file based on the given ID. + * + * @since 2.1.0 + * + * @param string $file Path to attached file. + * @param int $attachment_id Attachment ID. + */ return apply_filters( 'get_attached_file', $file, $attachment_id ); } @@ -199,17 +209,25 @@ function get_attached_file( $attachment_id, $unfiltered = false ) { * '_wp_attached_file' to store the path of the attachment. * * @since 2.1.0 - * @uses apply_filters() Calls 'update_attached_file' on file path and attachment ID. * - * @param int $attachment_id Attachment ID - * @param string $file File path for the attachment - * @return bool False on failure, true on success. + * @param int $attachment_id Attachment ID. + * @param string $file File path for the attachment. + * @return bool True on success, false on failure. */ function update_attached_file( $attachment_id, $file ) { if ( !get_post( $attachment_id ) ) return false; + /** + * Filter the path to the attached file to update. + * + * @since 2.1.0 + * + * @param string $file Path to the attached file to update. + * @param int $attachment_id Attachment ID. + */ $file = apply_filters( 'update_attached_file', $file, $attachment_id ); + if ( $file = _wp_relative_upload_path( $file ) ) return update_post_meta( $attachment_id, '_wp_attached_file', $file ); else @@ -222,10 +240,9 @@ function update_attached_file( $attachment_id, $file ) { * The path is relative to the current upload dir. * * @since 2.9.0 - * @uses apply_filters() Calls '_wp_relative_upload_path' on file path. * - * @param string $path Full path to the file - * @return string relative path on success, unchanged path on failure. + * @param string $path Full path to the file. + * @return string Relative path on success, unchanged path on failure. */ function _wp_relative_upload_path( $path ) { $new_path = $path; @@ -236,6 +253,14 @@ function _wp_relative_upload_path( $path ) { $new_path = ltrim( $new_path, '/' ); } + /** + * Filter the relative path to an uploaded file. + * + * @since 2.9.0 + * + * @param string $new_path Relative path to the file. + * @param string $path Full path to the file. + */ return apply_filters( '_wp_relative_upload_path', $new_path, $path ); } @@ -278,16 +303,20 @@ function _wp_relative_upload_path( $path ) { * post types are 'post', 'pages', and 'attachments'. The 'post_status' * argument will accept any post status within the write administration panels. * - * @see get_posts() Has additional arguments that can be replaced. - * @internal Claims made in the long description might be inaccurate. - * * @since 2.0.0 * - * @param mixed $args Optional. User defined arguments for replacing the defaults. - * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N. - * @return array|bool False on failure and the type will be determined by $output parameter. + * @see get_posts() + * @todo Check validity of description. + * + * @global WP_Post $post + * + * @param mixed $args Optional. User defined arguments for replacing the defaults. Default empty. + * @param string $output Optional. Constant for return type. Accepts OBJECT, ARRAY_A, ARRAY_N. + * Default OBJECt. + * @return array Array of children, where the type of each element is determined by $output parameter. + * Empty array on failure. */ -function get_children($args = '', $output = OBJECT) { +function get_children( $args = '', $output = OBJECT ) { $kids = array(); if ( empty( $args ) ) { if ( isset( $GLOBALS['post'] ) ) { @@ -310,9 +339,12 @@ function get_children($args = '', $output = OBJECT) { $children = get_posts( $r ); - if ( !$children ) + if ( ! $children ) return $kids; + if ( ! empty( $r['fields'] ) ) + return $children; + update_post_cache($children); foreach ( $children as $key => $child ) @@ -321,12 +353,16 @@ function get_children($args = '', $output = OBJECT) { if ( $output == OBJECT ) { return $kids; } elseif ( $output == ARRAY_A ) { - foreach ( (array) $kids as $kid ) + $weeuns = array(); + foreach ( (array) $kids as $kid ) { $weeuns[$kid->ID] = get_object_vars($kids[$kid->ID]); + } return $weeuns; } elseif ( $output == ARRAY_N ) { - foreach ( (array) $kids as $kid ) + $babes = array(); + foreach ( (array) $kids as $kid ) { $babes[$kid->ID] = array_values(get_object_vars($kids[$kid->ID])); + } return $babes; } else { return $kids; @@ -341,16 +377,16 @@ function get_children($args = '', $output = OBJECT) { * referenced. * * The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before - * the . The 'extended' key has the content after the - * comment. The 'more_text' key has the custom "Read More" text. + * the ``. The 'extended' key has the content after the + * `` comment. The 'more_text' key has the custom "Read More" text. * * @since 1.0.0 * * @param string $post Post content. * @return array Post before ('main'), after ('extended'), and custom readmore ('more_text'). */ -function get_extended($post) { - //Match the new style more links +function get_extended( $post ) { + //Match the new style more links. if ( preg_match('//', $post, $matches) ) { list($main, $extended) = explode($matches[0], $post, 2); $more_text = $matches[1]; @@ -360,7 +396,7 @@ function get_extended($post) { $more_text = ''; } - // Strip leading and trailing whitespace + // leading and trailing whitespace. $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main); $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended); $more_text = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $more_text); @@ -375,19 +411,22 @@ function get_extended($post) { * $post, must be given as a variable, since it is passed by reference. * * @since 1.5.1 - * @uses $wpdb - * @link http://codex.wordpress.org/Function_Reference/get_post * - * @param int|object $post Post ID or post object. Optional, default is the current post from the loop. - * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N. - * @param string $filter Optional, default is raw. - * @return WP_Post|null WP_Post on success or null on failure + * @global WP_Post $post + * + * @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post. + * @param string $output Optional, default is Object. Accepts OBJECT, ARRAY_A, or ARRAY_N. + * Default OBJECT. + * @param string $filter Optional. Type of filter to apply. Accepts 'raw', 'edit', 'db', + * or 'display'. Default 'raw'. + * @return WP_Post|array|null Type corresponding to $output on success or null on failure. + * When $output is OBJECT, a `WP_Post` instance is returned. */ function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) { if ( empty( $post ) && isset( $GLOBALS['post'] ) ) $post = $GLOBALS['post']; - if ( is_a( $post, 'WP_Post' ) ) { + if ( $post instanceof WP_Post ) { $_post = $post; } elseif ( is_object( $post ) ) { if ( empty( $post->filter ) ) { @@ -420,153 +459,201 @@ function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) { * * @since 3.5.0 * + * @property string $page_template + * + * @property-read array $ancestors + * @property-read int $post_category + * @property-read string $tag_input + * */ final class WP_Post { /** + * Post ID. * * @var int */ public $ID; /** + * ID of post author. * - * @var int + * A numeric string, for compatibility reasons. + * + * @var string */ public $post_author = 0; /** + * The post's local publication time. * * @var string */ public $post_date = '0000-00-00 00:00:00'; /** + * The post's GMT publication time. * * @var string */ public $post_date_gmt = '0000-00-00 00:00:00'; /** + * The post's content. * * @var string */ public $post_content = ''; /** + * The post's title. * * @var string */ public $post_title = ''; /** + * The post's excerpt. * * @var string */ public $post_excerpt = ''; /** + * The post's status. * * @var string */ public $post_status = 'publish'; /** + * Whether comments are allowed. * * @var string */ public $comment_status = 'open'; /** + * Whether pings are allowed. * * @var string */ public $ping_status = 'open'; /** + * The post's password in plain text. * * @var string */ public $post_password = ''; /** + * The post's slug. * * @var string */ public $post_name = ''; /** + * URLs queued to be pinged. * * @var string */ public $to_ping = ''; /** + * URLs that have been pinged. * * @var string */ public $pinged = ''; /** + * The post's local modified time. * * @var string */ public $post_modified = '0000-00-00 00:00:00'; /** + * The post's GMT modified time. * * @var string */ public $post_modified_gmt = '0000-00-00 00:00:00'; /** + * A utility DB field for post content. + * * * @var string */ public $post_content_filtered = ''; /** + * ID of a post's parent post. * * @var int */ public $post_parent = 0; /** + * The unique identifier for a post, not necessarily a URL, used as the feed GUID. * * @var string */ public $guid = ''; /** + * A field used for ordering posts. * * @var int */ public $menu_order = 0; /** + * The post's type, like post or page. * * @var string */ public $post_type = 'post'; /** + * An attachment's mime type. * * @var string */ public $post_mime_type = ''; /** + * Cached comment count. * - * @var int + * A numeric string, for compatibility reasons. + * + * @var string */ public $comment_count = 0; /** + * Stores the post object's sanitization level. + * + * Does not correspond to a DB field. * * @var string */ public $filter; + /** + * Retrieve WP_Post instance. + * + * @static + * @access public + * + * @global wpdb $wpdb + * + * @param int $post_id Post ID. + * @return WP_Post|false Post object, false otherwise. + */ public static function get_instance( $post_id ) { global $wpdb; @@ -591,11 +678,22 @@ final class WP_Post { return new WP_Post( $_post ); } + /** + * Constructor. + * + * @param WP_Post|object $post Post object. + */ public function __construct( $post ) { foreach ( get_object_vars( $post ) as $key => $value ) $this->$key = $value; } + /** + * Isset-er. + * + * @param string $key Property to check if set. + * @return bool + */ public function __isset( $key ) { if ( 'ancestors' == $key ) return true; @@ -612,6 +710,12 @@ final class WP_Post { return metadata_exists( 'post', $this->ID, $key ); } + /** + * Getter. + * + * @param string $key Key to get. + * @return mixed + */ public function __get( $key ) { if ( 'page_template' == $key && $this->__isset( $key ) ) { return get_post_meta( $this->ID, '_wp_page_template', true ); @@ -637,8 +741,7 @@ final class WP_Post { return wp_list_pluck( $terms, 'name' ); } - // Rest of the values need filtering - + // Rest of the values need filtering. if ( 'ancestors' == $key ) $value = get_post_ancestors( $this ); else @@ -650,6 +753,12 @@ final class WP_Post { return $value; } + /** + * {@Missing Summary} + * + * @param string $filter Filter. + * @return self|array|bool|object|WP_Post + */ public function filter( $filter ) { if ( $this->filter == $filter ) return $this; @@ -660,6 +769,11 @@ final class WP_Post { return sanitize_post( $this, $filter ); } + /** + * Convert object to array. + * + * @return array Object as array. + */ public function to_array() { $post = get_object_vars( $this ); @@ -677,16 +791,13 @@ final class WP_Post { * * @since 2.5.0 * - * @param int|object $post Post ID or post object + * @param int|WP_Post $post Post ID or post object. * @return array Ancestor IDs or empty array if none are found. */ function get_post_ancestors( $post ) { - if ( ! $post ) - return false; - $post = get_post( $post ); - if ( empty( $post->post_parent ) || $post->post_parent == $post->ID ) + if ( ! $post || empty( $post->post_parent ) || $post->post_parent == $post->ID ) return array(); $ancestors = array(); @@ -714,12 +825,14 @@ function get_post_ancestors( $post ) { * supported values are found within those functions. * * @since 2.3.0 - * @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 bool|string False on failure or returns the value in post field + * @see sanitize_post_field() + * + * @param string $field Post field name. + * @param int|WP_Post $post Post ID or post object. + * @param string $context Optional. How to filter the field. Accepts 'raw', 'edit', 'db', + * or 'display'. Default 'display'. + * @return string The value of the post field on success, empty string on failure. */ function get_post_field( $field, $post, $context = 'display' ) { $post = get_post( $post ); @@ -741,10 +854,10 @@ function get_post_field( $field, $post, $context = 'display' ) { * * @since 2.0.0 * - * @param int $ID Optional. Post ID. - * @return bool|string False on failure or returns the mime type + * @param int|WP_Post $ID Optional. Post ID or post object. Default empty. + * @return string|false The mime type on success, false on failure. */ -function get_post_mime_type($ID = '') { +function get_post_mime_type( $ID = '' ) { $post = get_post($ID); if ( is_object($post) ) @@ -753,71 +866,6 @@ function get_post_mime_type($ID = '') { return false; } -/** - * Retrieve the format slug for a post - * - * @since 3.1.0 - * - * @param int|object $post A post - * - * @return mixed The format if successful. False if no format is set. WP_Error if errors. - */ -function get_post_format( $post = null ) { - $post = get_post($post); - - if ( ! post_type_supports( $post->post_type, 'post-formats' ) ) - return false; - - $_format = get_the_terms( $post->ID, 'post_format' ); - - if ( empty( $_format ) ) - return false; - - $format = array_shift( $_format ); - - return ( str_replace('post-format-', '', $format->slug ) ); -} - -/** - * Check if a post has a particular format - * - * @since 3.1.0 - * @uses has_term() - * - * @param string $format The format to check for - * @param object|id $post The post to check. If not supplied, defaults to the current post if used in the loop. - * @return bool True if the post has the format, false otherwise. - */ -function has_post_format( $format, $post = null ) { - return has_term('post-format-' . sanitize_key($format), 'post_format', $post); -} - -/** - * Assign a format to a post - * - * @since 3.1.0 - * - * @param int|object $post The post for which to assign a format - * @param string $format A format to assign. Use an empty string or array to remove all formats from the post. - * @return mixed WP_Error on error. Array of affected term IDs on success. - */ -function set_post_format( $post, $format ) { - $post = get_post($post); - - if ( empty($post) ) - return new WP_Error('invalid_post', __('Invalid post')); - - if ( !empty($format) ) { - $format = sanitize_key($format); - if ( 'standard' == $format || !in_array( $format, array_keys( get_post_format_slugs() ) ) ) - $format = ''; - else - $format = 'post-format-' . $format; - } - - return wp_set_post_terms($post->ID, $format, 'post_format'); -} - /** * Retrieve the post status based on the Post ID. * @@ -826,10 +874,10 @@ function set_post_format( $post, $format ) { * * @since 2.0.0 * - * @param int $ID Post ID - * @return string|bool Post status or false on failure. + * @param int|WP_Post $ID Optional. Post ID or post object. Default empty. + * @return string|false Post status on success, false on failure. */ -function get_post_status($ID = '') { +function get_post_status( $ID = '' ) { $post = get_post($ID); if ( !is_object($post) ) @@ -839,13 +887,20 @@ function get_post_status($ID = '') { if ( 'private' == $post->post_status ) return 'private'; - // Unattached attachments are assumed to be published + // Unattached attachments are assumed to be published. if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) ) return 'publish'; - // Inherit status from the parent - if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) - return get_post_status($post->post_parent); + // Inherit status from the parent. + if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) { + $parent_post_status = get_post_status( $post->post_parent ); + if ( 'trash' == $parent_post_status ) { + return get_post_meta( $post->post_parent, '_wp_trash_meta_status', true ); + } else { + return $parent_post_status; + } + } + } return $post->post_status; @@ -861,12 +916,12 @@ function get_post_status($ID = '') { * * @return array List of post statuses. */ -function get_post_statuses( ) { +function get_post_statuses() { $status = array( - 'draft' => __('Draft'), - 'pending' => __('Pending Review'), - 'private' => __('Private'), - 'publish' => __('Published') + 'draft' => __( 'Draft' ), + 'pending' => __( 'Pending Review' ), + 'private' => __( 'Private' ), + 'publish' => __( 'Published' ) ); return $status; @@ -882,11 +937,11 @@ function get_post_statuses( ) { * * @return array List of page statuses. */ -function get_page_statuses( ) { +function get_page_statuses() { $status = array( - 'draft' => __('Draft'), - 'private' => __('Private'), - 'publish' => __('Published') + 'draft' => __( 'Draft' ), + 'private' => __( 'Private' ), + 'publish' => __( 'Published' ) ); return $status; @@ -899,27 +954,43 @@ function get_page_statuses( ) { * parameters given. The function will accept an array (second optional * parameter), along with a string for the post status name. * - * - * Optional $args contents: - * - * label - A descriptive name for the post status marked for translation. Defaults to $post_status. - * public - Whether posts of this status should be shown in the front end of the site. Defaults to true. - * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to false. - * show_in_admin_all_list - Whether to include posts in the edit listing for their post type - * show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit - * listings, e.g. All (12) | Published (9) | My Custom Status (2) ... - * * Arguments prefixed with an _underscore shouldn't be used by plugins and themes. * - * @package WordPress - * @subpackage Post * @since 3.0.0 - * @uses $wp_post_statuses Inserts new post status object into the list + * @global array $wp_post_statuses Inserts new post status object into the list * * @param string $post_status Name of the post status. - * @param array|string $args See above description. - */ -function register_post_status($post_status, $args = array()) { + * @param array|string $args { + * Optional. Array or string of post status arguments. + * + * @type bool|string $label A descriptive name for the post status marked + * for translation. Defaults to value of $post_status. + * @type bool|array $label_count Descriptive text to use for nooped plurals. + * Default array of $label, twice + * @type bool $exclude_from_search Whether to exclude posts with this post status + * from search results. Default is value of $internal. + * @type bool $_builtin Whether the status is built-in. Core-use only. + * Default false. + * @type bool $public Whether posts of this status should be shown + * in the front end of the site. Default false. + * @type bool $internal Whether the status is for internal use only. + * Default false. + * @type bool $protected Whether posts with this status should be protected. + * Default false. + * @type bool $private Whether posts with this status should be private. + * Default false. + * @type bool $publicly_queryable Whether posts with this status should be publicly- + * queryable. Default is value of $public. + * @type bool $show_in_admin_all_list Whether to include posts in the edit listing for + * their post type. Default is value of $internal. + * @type bool $show_in_admin_status_list Show in the list of statuses with post counts at + * the top of the edit listings, + * e.g. All (12) | Published (9) | My Custom Status (2) + * Default is value of $internal. + * } + * @return object + */ +function register_post_status( $post_status, $args = array() ) { global $wp_post_statuses; if (!is_array($wp_post_statuses)) @@ -945,6 +1016,7 @@ function register_post_status($post_status, $args = array()) { $post_status = sanitize_key($post_status); $args->name = $post_status; + // Set various defaults. if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private ) $args->internal = true; @@ -984,17 +1056,16 @@ function register_post_status($post_status, $args = array()) { } /** - * Retrieve a post status object by name + * Retrieve a post status object by name. * - * @package WordPress - * @subpackage Post * @since 3.0.0 - * @uses $wp_post_statuses - * @see register_post_status - * @see get_post_statuses * - * @param string $post_status The name of a registered post status - * @return object A post status object + * @global array $wp_post_statuses List of post statuses. + * + * @see register_post_status() + * + * @param string $post_status The name of a registered post status. + * @return object|null A post status object. */ function get_post_status_object( $post_status ) { global $wp_post_statuses; @@ -1006,20 +1077,21 @@ function get_post_status_object( $post_status ) { } /** - * Get a list of all registered post status objects. + * Get a list of post statuses. * - * @package WordPress - * @subpackage Post * @since 3.0.0 - * @uses $wp_post_statuses - * @see register_post_status - * @see get_post_status_object - * - * @param array|string $args An array of key => value arguments to match against the post status objects. - * @param string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default. - * @param string $operator The logical operation to perform. 'or' means only one element - * from the array needs to match; 'and' means all elements must match. The default is 'and'. - * @return array A list of post status names or objects + * + * @global array $wp_post_statuses List of post statuses. + * + * @see register_post_status() + * + * @param array|string $args Optional. Array or string of post status arguments to compare against + * properties of the global `$wp_post_statuses objects`. Default empty array. + * @param string $output Optional. The type of output to return, either 'names' or 'objects'. Default 'names'. + * @param string $operator Optional. The logical operation to perform. 'or' means only one element + * from the array needs to match; 'and' means all elements must match. + * Default 'and'. + * @return array A list of post status names or objects. */ function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) { global $wp_post_statuses; @@ -1035,7 +1107,8 @@ function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) * A false return value might also mean that the post type does not exist. * * @since 3.0.0 - * @see get_post_type_object + * + * @see get_post_type_object() * * @param string $post_type Post type name * @return bool Whether post type is hierarchical. @@ -1049,12 +1122,13 @@ function is_post_type_hierarchical( $post_type ) { } /** - * Checks if a post type is registered. + * Check if a post type is registered. * * @since 3.0.0 - * @uses get_post_type_object() * - * @param string $post_type Post type name + * @see get_post_type_object() + * + * @param string $post_type Post type name. * @return bool Whether post type is registered. */ function post_type_exists( $post_type ) { @@ -1066,10 +1140,8 @@ function post_type_exists( $post_type ) { * * @since 2.1.0 * - * @uses $post The Loop current post global - * - * @param mixed $post Optional. Post object or post ID. - * @return bool|string post type or false on failure. + * @param int|WP_Post|null $post Optional. Post ID or post object. Default is global $post. + * @return string|false Post type on success, false on failure. */ function get_post_type( $post = null ) { if ( $post = get_post( $post ) ) @@ -1079,17 +1151,16 @@ function get_post_type( $post = null ) { } /** - * Retrieve a post type object by name + * Retrieve a post type object by name. * - * @package WordPress - * @subpackage Post * @since 3.0.0 - * @uses $wp_post_types - * @see register_post_type - * @see get_post_types * - * @param string $post_type The name of a registered post type - * @return object A post type object + * @global array $wp_post_types List of post types. + * + * @see register_post_type() + * + * @param string $post_type The name of a registered post type. + * @return object|null A post type object. */ function get_post_type_object( $post_type ) { global $wp_post_types; @@ -1103,17 +1174,20 @@ function get_post_type_object( $post_type ) { /** * Get a list of all registered post type objects. * - * @package WordPress - * @subpackage Post * @since 2.9.0 - * @uses $wp_post_types - * @see register_post_type - * - * @param array|string $args An array of key => value arguments to match against the post type objects. - * @param string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default. - * @param string $operator The logical operation to perform. 'or' means only one element - * from the array needs to match; 'and' means all elements must match. The default is 'and'. - * @return array A list of post type names or objects + * + * @global array $wp_post_types List of post types. + * + * @see register_post_type() for accepted arguments. + * + * @param array|string $args Optional. An array of key => value arguments to match against + * the post type objects. Default empty array. + * @param string $output Optional. The type of output to return. Accepts post type 'names' + * or 'objects'. Default 'names'. + * @param string $operator Optional. The logical operation to perform. 'or' means only one + * element from the array needs to match; 'and' means all elements + * must match. Accepts 'or' or 'and'. Default 'and'. + * @return array A list of post type names or objects. */ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) { global $wp_post_types; @@ -1130,112 +1204,156 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * parameters given. The function will accept an array (second optional * parameter), along with a string for the post type name. * - * Optional $args contents: - * - * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used. - * - labels - An array of labels for this post type. - * * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones. - * * You can see accepted values in {@link get_post_type_labels()}. - * - description - A short descriptive summary of what the post type is. Defaults to blank. - * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users. - * * Defaults to false. - * * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are - * inherited from public, each does not rely on this relationship and controls a very specific intention. - * - exclude_from_search - Whether to exclude posts with this post type from front end search results. - * * If not set, the the opposite of public's current value is used. - * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request(). - * * ?post_type={post_type_key} - * * ?{post_type_key}={single_post_slug} - * * ?{post_type_query_var}={single_post_slug} - * * If not set, the default is inherited from public. - * - show_ui - Whether to generate a default UI for managing this post type in the admin. - * * If not set, the default is inherited from public. - * - show_in_nav_menus - Makes this post type available for selection in navigation menus. - * * If not set, the default is inherited from public. - * - show_in_menu - Where to show the post type in the admin menu. - * * If true, the post type is shown in its own top level menu. - * * If false, no menu is shown - * * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will - * be placed as a sub menu of that. - * * show_ui must be true. - * * If not set, the default is inherited from show_ui - * - show_in_admin_bar - Makes this post type available via the admin bar. - * * If not set, the default is inherited from show_in_menu - * - menu_position - The position in the menu order the post type should appear. - * * show_in_menu must be true - * * Defaults to null, which places it at the bottom of its area. - * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon. - * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'. - * * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the - * capabilities, e.g. array('story', 'stories'). - * - capabilities - Array of capabilities for this post type. - * * By default the capability_type is used as a base to construct capabilities. - * * You can see accepted values in {@link get_post_type_capabilities()}. - * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false. - * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false. - * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor. - * * See {@link add_post_type_support()} for documentation. - * - register_meta_box_cb - Provide a callback function that will be called when setting up the - * meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback. - * - taxonomies - An array of taxonomy identifiers that will be registered for the post type. - * * Default is no taxonomies. - * * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type(). - * - has_archive - True to enable post type archives. Default is false. - * * Will generate the proper rewrite rules if rewrite is enabled. - * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug. - * * To prevent rewrite, set to false. - * * To specify rewrite rules, an array can be passed with any of these keys - * * 'slug' => string Customize the permastruct slug. Defaults to $post_type key - * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true. - * * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive. - * * 'pages' => bool Should the permastruct provide for pagination. Defaults to true. - * * 'ep_mask' => const Assign an endpoint mask. - * * If not specified and permalink_epmask is set, inherits from permalink_epmask. - * * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK - * - query_var - Sets the query_var key for this post type. Defaults to $post_type key - * * If false, a post type cannot be loaded at ?{query_var}={post_slug} - * * If specified as a string, the query ?{query_var_string}={post_slug} will be valid. - * - can_export - Allows this post type to be exported. Defaults to true. - * - delete_with_user - Whether to delete posts of this type when deleting a user. - * * If true, posts of this type belonging to the user will be moved to trash when then user is deleted. - * * If false, posts of this type belonging to the user will *not* be trashed or deleted. - * * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted. - * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY! - * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY! - * * @since 2.9.0 - * @uses $wp_post_types Inserts new post type object into the list * - * @param string $post_type Post type key, must not exceed 20 characters - * @param array|string $args See optional args description above. - * @return object|WP_Error the registered post type object, or an error object + * @global array $wp_post_types List of post types. + * @global WP_Rewrite $wp_rewrite Used for default feeds. + * @global WP $wp Used to add query vars. + * + * @param string $post_type Post type key, must not exceed 20 characters. + * @param array|string $args { + * Array or string of arguments for registering a post type. + * + * @type string $label Name of the post type shown in the menu. Usually plural. + * Default is value of $labels['name']. + * @type array $labels An array of labels for this post type. If not set, post + * labels are inherited for non-hierarchical types and page + * labels for hierarchical ones. {@see get_post_type_labels()}. + * @type string $description A short descriptive summary of what the post type is. + * Default empty. + * @type bool $public Whether a post type is intended for use publicly either via + * the admin interface or by front-end users. While the default + * settings of $exclude_from_search, $publicly_queryable, $show_ui, + * and $show_in_nav_menus are inherited from public, each does not + * rely on this relationship and controls a very specific intention. + * Default false. + * @type bool $hierarchical Whether the post type is hierarchical (e.g. page). Default false. + * @type bool $exclude_from_search Whether to exclude posts with this post type from front end search + * results. Default is the opposite value of $public. + * @type bool $publicly_queryable Whether queries can be performed on the front end for the post type + * as part of {@see parse_request()}. Endpoints would include: + * * ?post_type={post_type_key} + * * ?{post_type_key}={single_post_slug} + * * ?{post_type_query_var}={single_post_slug} + * If not set, the default is inherited from $public. + * @type bool $show_ui Whether to generate a default UI for managing this post type in the + * admin. Default is value of $public. + * @type bool $show_in_menu Where to show the post type in the admin menu. To work, $show_ui + * must be true. If true, the post type is shown in its own top level + * menu. If false, no menu is shown. If a string of an existing top + * level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post + * type will be placed as a sub-menu of that. + * Default is value of $show_ui. + * @type bool $show_in_nav_menus Makes this post type available for selection in navigation menus. + * Default is value $public. + * @type bool $show_in_admin_bar Makes this post type available via the admin bar. Default is value + * of $show_in_menu. + * @type int $menu_position The position in the menu order the post type should appear. To work, + * $show_in_menu must be true. Default null (at the bottom). + * @type string $menu_icon The url to the icon to be used for this menu. Pass a base64-encoded + * SVG using a data URI, which will be colored to match the color scheme + * -- this should begin with 'data:image/svg+xml;base64,'. Pass the name + * of a Dashicons helper class to use a font icon, e.g. + * 'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty + * so an icon can be added via CSS. Defaults to use the posts icon. + * @type string $capability_type The string to use to build the read, edit, and delete capabilities. + * May be passed as an array to allow for alternative plurals when using + * this argument as a base to construct the capabilities, e.g. + * array('story', 'stories'). Default 'post'. + * @type array $capabilities Array of capabilities for this post type. $capability_type is used + * as a base to construct capabilities by default. + * {@see get_post_type_capabilities()}. + * @type bool $map_meta_cap Whether to use the internal default meta capability handling. + * Default false. + * @type array $supports An alias for calling {@see add_post_type_support()} directly. + * Defaults to array containing 'title' & 'editor'. + * @type callback $register_meta_box_cb Provide a callback function that sets up the meta boxes for the + * edit form. Do remove_meta_box() and add_meta_box() calls in the + * callback. Default null. + * @type array $taxonomies An array of taxonomy identifiers that will be registered for the + * post type. Taxonomies can be registered later with + * {@see register_taxonomy()} or {@see register_taxonomy_for_object_type()}. + * Default empty array. + * @type bool|string $has_archive Whether there should be post type archives, or if a string, the + * archive slug to use. Will generate the proper rewrite rules if + * $rewrite is enabled. Default false. + * @type bool|array $rewrite { + * Triggers the handling of rewrites for this post type. To prevent rewrite, set to false. + * Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be + * passed with any of these keys: + * + * @type string $slug Customize the permastruct slug. Defaults to $post_type key. + * @type bool $with_front Whether the permastruct should be prepended with WP_Rewrite::$front. + * Default true. + * @type bool $feeds Whether the feed permastruct should be built for this post type. + * Default is value of $has_archive. + * @type bool $pages Whether the permastruct should provide for pagination. Default true. + * @type const $ep_mask Endpoint mask to assign. If not specified and permalink_epmask is set, + * inherits from $permalink_epmask. If not specified and permalink_epmask + * is not set, defaults to EP_PERMALINK. + * } + * @type string|bool $query_var Sets the query_var key for this post type. Defaults to $post_type + * key. If false, a post type cannot be loaded at + * ?{query_var}={post_slug}. If specified as a string, the query + * ?{query_var_string}={post_slug} will be valid. + * @type bool $can_export Whether to allow this post type to be exported. Default true. + * @type bool $delete_with_user Whether to delete posts of this type when deleting a user. If true, + * posts of this type belonging to the user will be moved to trash + * when then user is deleted. If false, posts of this type belonging + * to the user will *not* be trashed or deleted. If not set (the default), + * posts are trashed if post_type_supports('author'). Otherwise posts + * are not trashed or deleted. Default null. + * @type bool $_builtin FOR INTERNAL USE ONLY! True if this post type is a native or + * "built-in" post_type. Default false. + * @type string $_edit_link FOR INTERNAL USE ONLY! URL segment to use for edit link of + * this post type. Default 'post.php?post=%d'. + * } + * @return object|WP_Error The registered post type object, or an error object. */ function register_post_type( $post_type, $args = array() ) { global $wp_post_types, $wp_rewrite, $wp; - if ( !is_array($wp_post_types) ) + if ( ! is_array( $wp_post_types ) ) $wp_post_types = array(); // Args prefixed with an underscore are reserved for internal use. $defaults = array( - 'labels' => array(), 'description' => '', 'publicly_queryable' => null, 'exclude_from_search' => null, - 'capability_type' => 'post', 'capabilities' => array(), 'map_meta_cap' => null, - '_builtin' => false, '_edit_link' => 'post.php?post=%d', 'hierarchical' => false, - 'public' => false, 'rewrite' => true, 'has_archive' => false, 'query_var' => true, - 'supports' => array(), 'register_meta_box_cb' => null, - 'taxonomies' => array(), 'show_ui' => null, 'menu_position' => null, 'menu_icon' => null, - 'can_export' => true, - 'show_in_nav_menus' => null, 'show_in_menu' => null, 'show_in_admin_bar' => null, - 'delete_with_user' => null, + 'labels' => array(), + 'description' => '', + 'public' => false, + 'hierarchical' => false, + 'exclude_from_search' => null, + 'publicly_queryable' => null, + 'show_ui' => null, + 'show_in_menu' => null, + 'show_in_nav_menus' => null, + 'show_in_admin_bar' => null, + 'menu_position' => null, + 'menu_icon' => null, + 'capability_type' => 'post', + 'capabilities' => array(), + 'map_meta_cap' => null, + 'supports' => array(), + 'register_meta_box_cb' => null, + 'taxonomies' => array(), + 'has_archive' => false, + 'rewrite' => true, + 'query_var' => true, + 'can_export' => true, + 'delete_with_user' => null, + '_builtin' => false, + '_edit_link' => 'post.php?post=%d', ); - $args = wp_parse_args($args, $defaults); + $args = wp_parse_args( $args, $defaults ); $args = (object) $args; - $post_type = sanitize_key($post_type); + $post_type = sanitize_key( $post_type ); $args->name = $post_type; - if ( strlen( $post_type ) > 20 ) - return new WP_Error( 'post_type_too_long', __( 'Post types cannot exceed 20 characters in length' ) ); + if ( empty( $post_type ) || strlen( $post_type ) > 20 ) { + _doing_it_wrong( __FUNCTION__, __( 'Post type names must be between 1 and 20 characters in length.' ), '4.2' ); + return new WP_Error( 'post_type_length_invalid', __( 'Post type names must be between 1 and 20 characters in length.' ) ); + } // If not set, default to the setting for public. if ( null === $args->publicly_queryable ) @@ -1251,9 +1369,9 @@ function register_post_type( $post_type, $args = array() ) { // If not set, default to the whether the full UI is shown. if ( null === $args->show_in_admin_bar ) - $args->show_in_admin_bar = true === $args->show_in_menu; + $args->show_in_admin_bar = (bool) $args->show_in_menu; - // Whether to show this type in nav-menus.php. Defaults to the setting for public. + // If not set, default to the setting for public. if ( null === $args->show_in_nav_menus ) $args->show_in_nav_menus = $args->public; @@ -1261,36 +1379,37 @@ function register_post_type( $post_type, $args = array() ) { if ( null === $args->exclude_from_search ) $args->exclude_from_search = !$args->public; - // Back compat with quirky handling in version 3.0. #14122 + // Back compat with quirky handling in version 3.0. #14122. if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) ) $args->map_meta_cap = true; + // If not set, default to false. if ( null === $args->map_meta_cap ) $args->map_meta_cap = false; $args->cap = get_post_type_capabilities( $args ); - unset($args->capabilities); + unset( $args->capabilities ); if ( is_array( $args->capability_type ) ) $args->capability_type = $args->capability_type[0]; - if ( ! empty($args->supports) ) { - add_post_type_support($post_type, $args->supports); - unset($args->supports); + if ( ! empty( $args->supports ) ) { + add_post_type_support( $post_type, $args->supports ); + unset( $args->supports ); } elseif ( false !== $args->supports ) { // Add default features - add_post_type_support($post_type, array('title', 'editor')); + add_post_type_support( $post_type, array( 'title', 'editor' ) ); } - if ( false !== $args->query_var && !empty($wp) ) { + if ( false !== $args->query_var && ! empty( $wp ) ) { if ( true === $args->query_var ) $args->query_var = $post_type; else - $args->query_var = sanitize_title_with_dashes($args->query_var); - $wp->add_query_var($args->query_var); + $args->query_var = sanitize_title_with_dashes( $args->query_var ); + $wp->add_query_var( $args->query_var ); } - if ( false !== $args->rewrite && ( is_admin() || '' != get_option('permalink_structure') ) ) { + if ( false !== $args->rewrite && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) { if ( ! is_array( $args->rewrite ) ) $args->rewrite = array(); if ( empty( $args->rewrite['slug'] ) ) @@ -1309,9 +1428,9 @@ function register_post_type( $post_type, $args = array() ) { } if ( $args->hierarchical ) - add_rewrite_tag("%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name="); + add_rewrite_tag( "%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&pagename=" ); else - add_rewrite_tag("%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name="); + add_rewrite_tag( "%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=" ); if ( $args->has_archive ) { $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive; @@ -1330,16 +1449,19 @@ function register_post_type( $post_type, $args = array() ) { add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' ); } - add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $args->rewrite ); + $permastruct_args = $args->rewrite; + $permastruct_args['feed'] = $permastruct_args['feeds']; + add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $permastruct_args ); } + // Register the post type meta box if a custom callback was specified. if ( $args->register_meta_box_cb ) - add_action('add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1); + add_action( 'add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1 ); $args->labels = get_post_type_labels( $args ); $args->label = $args->labels->name; - $wp_post_types[$post_type] = $args; + $wp_post_types[ $post_type ] = $args; add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 ); @@ -1347,13 +1469,21 @@ function register_post_type( $post_type, $args = array() ) { register_taxonomy_for_object_type( $taxonomy, $post_type ); } + /** + * Fires after a post type is registered. + * + * @since 3.3.0 + * + * @param string $post_type Post type. + * @param object $args Arguments used to register the post type. + */ do_action( 'registered_post_type', $post_type, $args ); return $args; } /** - * Builds an object with all post type capabilities out of a post type object + * Build an object with all post type capabilities out of a post type object * * Post type capabilities use the 'capability_type' argument as a base, if the * capability is not set in the 'capabilities' argument array or if the @@ -1399,11 +1529,13 @@ function register_post_type( $post_type, $args = array() ) { * only assigned by default if the post type is registered with the 'map_meta_cap' * argument set to true (default is false). * - * @see map_meta_cap() * @since 3.0.0 * - * @param object $args Post type registration arguments - * @return object object with all the capabilities as member variables + * @see register_post_type() + * @see map_meta_cap() + * + * @param object $args Post type registration arguments. + * @return object object with all the capabilities as member variables. */ function get_post_type_capabilities( $args ) { if ( ! is_array( $args->capability_type ) ) @@ -1452,10 +1584,14 @@ function get_post_type_capabilities( $args ) { } /** - * Stores or returns a list of post type meta caps for map_meta_cap(). + * Store or return a list of post type meta caps for map_meta_cap(). * * @since 3.1.0 * @access private + * + * @staticvar array $meta_caps + * + * @param array|void $capabilities Post type meta capabilities. */ function _post_type_meta_capabilities( $capabilities = null ) { static $meta_caps = array(); @@ -1468,28 +1604,43 @@ function _post_type_meta_capabilities( $capabilities = null ) { } /** - * Builds an object with all post type labels out of a post type object + * Build an object with all post type labels out of a post type object * * Accepted keys of the label array in the post type object: - * - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages + * + * - name - general name for the post type, usually plural. The same and overridden + * by $post_type_object->label. Default is Posts/Pages * - singular_name - name for one object of this post type. Default is Post/Page - * - add_new - Default is Add New for both hierarchical and non-hierarchical types. When internationalizing this string, please use a {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} matching your post type. Example: _x('Add New', 'product'); - * - add_new_item - Default is Add New Post/Add New Page - * - edit_item - Default is Edit Post/Edit Page - * - new_item - Default is New Post/New Page - * - view_item - Default is View Post/View Page - * - search_items - Default is Search Posts/Search Pages - * - not_found - Default is No posts found/No pages found - * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash - * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page: - * - all_items - String for the submenu. Default is All Posts/All Pages - * - menu_name - Default is the same as name - * - * Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages). + * - add_new - Default is Add New for both hierarchical and non-hierarchical types. + * When internationalizing this string, please use a gettext context + * {@link https://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context} + * matching your post type. Example: `_x( 'Add New', 'product' );`. + * - add_new_item - Default is Add New Post/Add New Page. + * - edit_item - Default is Edit Post/Edit Page. + * - new_item - Default is New Post/New Page. + * - view_item - Default is View Post/View Page. + * - search_items - Default is Search Posts/Search Pages. + * - not_found - Default is No posts found/No pages found. + * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash. + * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical + * ones the default is 'Parent Page:'. + * - all_items - String for the submenu. Default is All Posts/All Pages. + * - featured_image - Default is Featured Image. + * - set_featured_image - Default is Set featured image. + * - remove_featured_image - Default is Remove featured image. + * - use_featured_image - Default is Use as featured image. + * - menu_name - Default is the same as `name`. + * + * Above, the first default value is for non-hierarchical post types (like posts) + * and the second one is for hierarchical post types (like pages). * * @since 3.0.0 - * @param object $post_type_object - * @return object object with all the labels as member variables + * @since 4.3.0 Added the `featured_image`, `set_featured_image`, `remove_featured_image`, + * and `use_featured_image` labels. + * @access private + * + * @param object $post_type_object Post type object. + * @return object object with all the labels as member variables. */ function get_post_type_labels( $post_type_object ) { $nohier_vs_hier_defaults = array( @@ -1504,23 +1655,45 @@ function get_post_type_labels( $post_type_object ) { 'not_found' => array( __('No posts found.'), __('No pages found.') ), 'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ), 'parent_item_colon' => array( null, __('Parent Page:') ), - 'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) ) + 'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) ), + 'featured_image' => array( __( 'Featured Image' ), __( 'Featured Image' ) ), + 'set_featured_image' => array( __( 'Set featured image' ), __( 'Set featured image' ) ), + 'remove_featured_image' => array( __( 'Remove featured image' ), __( 'Remove featured image' ) ), + 'use_featured_image' => array( __( 'Use as featured image' ), __( 'Use as featured image' ) ), ); $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name']; $labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults ); $post_type = $post_type_object->name; + + /** + * Filter the labels of a specific post type. + * + * The dynamic portion of the hook name, `$post_type`, refers to + * the post type slug. + * + * @since 3.5.0 + * + * @see get_post_type_labels() for the full list of labels. + * + * @param object $labels Object with labels for the post type as member variables. + */ return apply_filters( "post_type_labels_{$post_type}", $labels ); } /** - * Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object + * Build an object with custom-something object (post type, taxonomy) labels + * out of a custom-something object * - * @access private * @since 3.0.0 + * @access private + * + * @param object $object A custom-something object. + * @param array $nohier_vs_hier_defaults Hierarchical vs non-hierarchical default labels. */ function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) { + $object->labels = (array) $object->labels; if ( isset( $object->label ) && empty( $object->labels['name'] ) ) $object->labels['name'] = $object->label; @@ -1537,15 +1710,16 @@ function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) { if ( !isset( $object->labels['all_items'] ) && isset( $object->labels['menu_name'] ) ) $object->labels['all_items'] = $object->labels['menu_name']; - foreach ( $nohier_vs_hier_defaults as $key => $value ) - $defaults[$key] = $object->hierarchical ? $value[1] : $value[0]; - + $defaults = array(); + foreach ( $nohier_vs_hier_defaults as $key => $value ) { + $defaults[$key] = $object->hierarchical ? $value[1] : $value[0]; + } $labels = array_merge( $defaults, $object->labels ); - return (object)$labels; + return (object) $labels; } /** - * Adds submenus for post types. + * Add submenus for post types. * * @access private * @since 3.1.0 @@ -1553,27 +1727,32 @@ function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) { function _add_post_type_submenus() { foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) { $ptype_obj = get_post_type_object( $ptype ); - // Submenus only. + // Sub-menus only. if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true ) continue; add_submenu_page( $ptype_obj->show_in_menu, $ptype_obj->labels->name, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, "edit.php?post_type=$ptype" ); } } -add_action( 'admin_menu', '_add_post_type_submenus' ); /** * Register support of certain features for a post type. * - * All features are directly associated with a functional area of the edit screen, such as the - * editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author', - * 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'. + * All core features are directly associated with a functional area of the edit + * screen, such as the editor or a meta box. Features include: 'title', 'editor', + * 'comments', 'revisions', 'trackbacks', 'author', 'excerpt', 'page-attributes', + * 'thumbnail', 'custom-fields', and 'post-formats'. * - * Additionally, the 'revisions' feature dictates whether the post type will store revisions, - * and the 'comments' feature dictates whether the comments count will show on the edit screen. + * Additionally, the 'revisions' feature dictates whether the post type will + * store revisions, and the 'comments' feature dictates whether the comments + * count will show on the edit screen. * * @since 3.0.0 - * @param string $post_type The post type for which to add the feature - * @param string|array $feature the feature being added, can be an array of feature strings or a single string + * + * @global array $_wp_post_type_features + * + * @param string $post_type The post type for which to add the feature. + * @param string|array $feature The feature being added, accepts an array of + * feature strings or a single string. */ function add_post_type_support( $post_type, $feature ) { global $_wp_post_type_features; @@ -1591,27 +1770,28 @@ function add_post_type_support( $post_type, $feature ) { * Remove support for a feature from a post type. * * @since 3.0.0 - * @param string $post_type The post type for which to remove the feature - * @param string $feature The feature being removed + * + * @global array $_wp_post_type_features + * + * @param string $post_type The post type for which to remove the feature. + * @param string $feature The feature being removed. */ function remove_post_type_support( $post_type, $feature ) { global $_wp_post_type_features; - if ( !isset($_wp_post_type_features[$post_type]) ) - return; - - if ( isset($_wp_post_type_features[$post_type][$feature]) ) - unset($_wp_post_type_features[$post_type][$feature]); + unset( $_wp_post_type_features[ $post_type ][ $feature ] ); } /** * Get all the post type features * * @since 3.4.0 - * @param string $post_type The post type - * @return array + * + * @global array $_wp_post_type_features + * + * @param string $post_type The post type. + * @return array Post type supports list. */ - function get_all_post_type_supports( $post_type ) { global $_wp_post_type_features; @@ -1622,43 +1802,35 @@ function get_all_post_type_supports( $post_type ) { } /** - * Checks a post type's support for a given feature + * Check a post type's support for a given feature. * * @since 3.0.0 - * @param string $post_type The post type being checked - * @param string $feature the feature being checked - * @return boolean + * + * @global array $_wp_post_type_features + * + * @param string $post_type The post type being checked. + * @param string $feature The feature being checked. + * @return bool Whether the post type supports the given feature. */ - function post_type_supports( $post_type, $feature ) { global $_wp_post_type_features; - if ( !isset( $_wp_post_type_features[$post_type][$feature] ) ) - return false; - - // If no args passed then no extra checks need be performed - if ( func_num_args() <= 2 ) - return true; - - // @todo Allow pluggable arg checking - //$args = array_slice( func_get_args(), 2 ); - - return true; + return ( isset( $_wp_post_type_features[$post_type][$feature] ) ); } /** - * Updates the post type for the post ID. + * Update the post type for the post ID. * * The page or post cache will be cleaned for the post ID. * * @since 2.5.0 * - * @uses $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * - * @param int $post_id Post ID to change post type. Not actually optional. - * @param string $post_type Optional, default is post. Supported values are 'post' or 'page' to - * name a few. - * @return int Amount of rows changed. Should be 1 for success and 0 for failure. + * @param int $post_id Optional. Post ID to change post type. Default 0. + * @param string $post_type Optional. Post type. Accepts 'post' or 'page' to + * name a few. Default 'post'. + * @return int|false Amount of rows changed. Should be 1 for success and 0 for failure. */ function set_post_type( $post_id = 0, $post_type = 'post' ) { global $wpdb; @@ -1675,31 +1847,35 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) { * Retrieve list of latest posts or posts matching criteria. * * The defaults are as follows: - * 'numberposts' - Default is 5. Total number of posts to retrieve. - * 'offset' - Default is 0. See {@link WP_Query::query()} for more. - * 'category' - What category to pull the posts from. - * 'orderby' - Default is 'post_date'. How to order the posts. - * 'order' - Default is 'DESC'. The order to retrieve the posts. - * 'include' - See {@link WP_Query::query()} for more. - * 'exclude' - See {@link WP_Query::query()} for more. - * 'meta_key' - See {@link WP_Query::query()} for more. - * 'meta_value' - See {@link WP_Query::query()} for more. - * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few. - * 'post_parent' - The parent of the post or post type. - * 'post_status' - Default is 'publish'. Post status to retrieve. * * @since 1.2.0 - * @uses $wpdb - * @uses WP_Query::query() See for more default arguments and information. - * @link http://codex.wordpress.org/Template_Tags/get_posts * - * @param array $args Optional. Overrides defaults. + * @see WP_Query::parse_query() + * + * @param array $args { + * Optional. Arguments to retrieve posts. {@see WP_Query::parse_query()} for more + * available arguments. + * + * @type int $numberposts Total number of posts to retrieve. Is an alias of $posts_per_page + * in WP_Query. Accepts 1+ and -1 for all. Default 5. + * @type int $offset The number of posts to offset before retrieval. Default 0. + * @type int|string $category Category ID or comma-separated list of IDs (this or any children). + * Is an alias of $cat in WP_Query. Default 0. + * @type string $orderby Which field to order posts by. Accepts post fields. Default 'date'. + * @type array $include An array of post IDs to retrieve, sticky posts will be included. + * Is an alias of $post__in in WP_Query. Default empty array. + * @type array $exclude An array of post IDs not to retrieve. Default empty array. + * @type string $meta_key Custom field key. Default empty. + * @type mixed $meta_value Custom field value. Default empty string. + * @type string $post_type Post type. Default 'post'. + * @type bool $suppress_filters Whether to suppress filters. Default true. + * } * @return array List of posts. */ -function get_posts($args = null) { +function get_posts( $args = null ) { $defaults = array( 'numberposts' => 5, 'offset' => 0, - 'category' => 0, 'orderby' => 'post_date', + 'category' => 0, 'orderby' => 'date', 'order' => 'DESC', 'include' => array(), 'exclude' => array(), 'meta_key' => '', 'meta_value' =>'', 'post_type' => 'post', @@ -1738,17 +1914,16 @@ function get_posts($args = null) { * Post meta data is called "Custom Fields" on the Administration Screen. * * @since 1.5.0 - * @uses $wpdb - * @link http://codex.wordpress.org/Function_Reference/add_post_meta * - * @param int $post_id Post ID. - * @param string $meta_key Metadata name. - * @param mixed $meta_value Metadata value. - * @param bool $unique Optional, default is false. Whether the same key should not be added. - * @return bool False for failure. True for success. + * @param int $post_id Post ID. + * @param string $meta_key Metadata name. + * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. + * @param bool $unique Optional. Whether the same key should not be added. + * Default false. + * @return int|false Meta ID on success, false on failure. */ -function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) { - // make sure meta is added to the post, not a revision +function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) { + // Make sure meta is added to the post, not a revision. if ( $the_post = wp_is_post_revision($post_id) ) $post_id = $the_post; @@ -1763,16 +1938,15 @@ function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) { * allows removing all metadata matching key, if needed. * * @since 1.5.0 - * @uses $wpdb - * @link http://codex.wordpress.org/Function_Reference/delete_post_meta * - * @param int $post_id post ID - * @param string $meta_key Metadata name. - * @param mixed $meta_value Optional. Metadata value. - * @return bool False for failure. True for success. + * @param int $post_id Post ID. + * @param string $meta_key Metadata name. + * @param mixed $meta_value Optional. Metadata value. Must be serializable if + * non-scalar. Default empty. + * @return bool True on success, false on failure. */ -function delete_post_meta($post_id, $meta_key, $meta_value = '') { - // make sure meta is added to the post, not a revision +function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) { + // Make sure meta is added to the post, not a revision. if ( $the_post = wp_is_post_revision($post_id) ) $post_id = $the_post; @@ -1783,16 +1957,15 @@ function delete_post_meta($post_id, $meta_key, $meta_value = '') { * Retrieve post meta field for a post. * * @since 1.5.0 - * @uses $wpdb - * @link http://codex.wordpress.org/Function_Reference/get_post_meta * - * @param int $post_id Post ID. - * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys. - * @param bool $single Whether to return a single value. - * @return mixed Will be an array if $single is false. Will be value of meta data field if $single - * is true. + * @param int $post_id Post ID. + * @param string $key Optional. The meta key to retrieve. By default, returns + * data for all keys. Default empty. + * @param bool $single Optional. Whether to return a single value. Default false. + * @return mixed Will be an array if $single is false. Will be value of meta data + * field if $single is true. */ -function get_post_meta($post_id, $key = '', $single = false) { +function get_post_meta( $post_id, $key = '', $single = false ) { return get_metadata('post', $post_id, $key, $single); } @@ -1805,17 +1978,17 @@ function get_post_meta($post_id, $key = '', $single = false) { * If the meta field for the post does not exist, it will be added. * * @since 1.5.0 - * @uses $wpdb - * @link http://codex.wordpress.org/Function_Reference/update_post_meta * - * @param int $post_id Post ID. - * @param string $meta_key Metadata key. - * @param mixed $meta_value Metadata value. - * @param mixed $prev_value Optional. Previous value to check before removing. - * @return bool False on failure, true if success. + * @param int $post_id Post ID. + * @param string $meta_key Metadata key. + * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. + * @param mixed $prev_value Optional. Previous value to check before removing. + * Default empty. + * @return int|bool Meta ID if the key didn't exist, true on successful update, + * false on failure. */ -function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') { - // make sure meta is added to the post, not a revision +function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) { + // Make sure meta is added to the post, not a revision. if ( $the_post = wp_is_post_revision($post_id) ) $post_id = $the_post; @@ -1826,12 +1999,11 @@ function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') { * Delete everything from post meta matching meta key. * * @since 2.3.0 - * @uses $wpdb * * @param string $post_meta_key Key to search for when deleting. - * @return bool Whether the post meta key was deleted from the database + * @return bool Whether the post meta key was deleted from the database. */ -function delete_post_meta_by_key($post_meta_key) { +function delete_post_meta_by_key( $post_meta_key ) { return delete_metadata( 'post', null, $post_meta_key, '', true ); } @@ -1842,10 +2014,9 @@ function delete_post_meta_by_key($post_meta_key) { * so the function is optimized to be called more than once. * * @since 1.2.0 - * @link http://codex.wordpress.org/Function_Reference/get_post_custom * - * @param int $post_id Post ID. - * @return array + * @param int $post_id Optional. Post ID. Default is ID of the global $post. + * @return array Post meta for the given post. */ function get_post_custom( $post_id = 0 ) { $post_id = absint( $post_id ); @@ -1861,10 +2032,9 @@ function get_post_custom( $post_id = 0 ) { * If there are no meta fields, then nothing (null) will be returned. * * @since 1.2.0 - * @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 could not be retrieved. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. + * @return array|void Array of the keys, if retrieved. */ function get_post_custom_keys( $post_id = 0 ) { $custom = get_post_custom( $post_id ); @@ -1883,11 +2053,10 @@ function get_post_custom_keys( $post_id = 0 ) { * will be retrieved and only the meta field key values returned. * * @since 1.2.0 - * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values * - * @param string $key Meta field key. - * @param int $post_id Post ID - * @return array Meta field values. + * @param string $key Optional. Meta field key. Default empty. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. + * @return array|null Meta field values. */ function get_post_custom_values( $key = '', $post_id = 0 ) { if ( !$key ) @@ -1906,7 +2075,7 @@ function get_post_custom_values( $key = '', $post_id = 0 ) { * * @since 2.7.0 * - * @param int $post_id Optional. Post ID. + * @param int $post_id Optional. Post ID. Default is ID of the global $post. * @return bool Whether post is sticky. */ function is_sticky( $post_id = 0 ) { @@ -1929,18 +2098,23 @@ function is_sticky( $post_id = 0 ) { /** * Sanitize every post field. * - * If the context is 'raw', then the post object or array will get minimal santization of the int fields. + * If the context is 'raw', then the post object or array will get minimal + * sanitization of the integer fields. * * @since 2.3.0 - * @uses sanitize_post_field() Used to sanitize the fields. * - * @param object|WP_Post|array $post The Post Object or Array - * @param string $context Optional, default is 'display'. How to sanitize post fields. - * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post) + * @see sanitize_post_field() + * + * @param object|WP_Post|array $post The Post Object or Array + * @param string $context Optional. How to sanitize post fields. + * Accepts 'raw', 'edit', 'db', or 'display'. + * Default 'display'. + * @return object|WP_Post|array The now sanitized Post Object or Array (will be the + * same type as $post). */ -function sanitize_post($post, $context = 'display') { +function sanitize_post( $post, $context = 'display' ) { if ( is_object($post) ) { - // Check if post already filtered for this context + // Check if post already filtered for this context. if ( isset($post->filter) && $context == $post->filter ) return $post; if ( !isset($post->ID) ) @@ -1949,7 +2123,7 @@ function sanitize_post($post, $context = 'display') { $post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context); $post->filter = $context; } else { - // Check if post already filtered for this context + // Check if post already filtered for this context. if ( isset($post['filter']) && $context == $post['filter'] ) return $post; if ( !isset($post['ID']) ) @@ -1964,28 +2138,17 @@ function sanitize_post($post, $context = 'display') { /** * Sanitize post field based on context. * - * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The - * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display' - * when calling filters. + * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and + * 'js'. The 'display' context is used by default. 'attribute' and 'js' contexts + * are treated like 'display' when calling filters. * * @since 2.3.0 - * @uses apply_filters() Calls 'edit_$field' and '{$field_no_prefix}_edit_pre' passing $value and - * $post_id if $context == 'edit' and field name prefix == 'post_'. - * - * @uses apply_filters() Calls 'edit_post_$field' passing $value and $post_id if $context == 'db'. - * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db' and field name prefix == 'post_'. - * @uses apply_filters() Calls '{$field}_pre' passing $value if $context == 'db' and field name prefix != 'post_'. * - * @uses apply_filters() Calls '$field' passing $value, $post_id and $context if $context == anything - * other than 'raw', 'edit' and 'db' and field name prefix == 'post_'. - * @uses apply_filters() Calls 'post_$field' passing $value if $context == anything other than 'raw', - * 'edit' and 'db' and field name prefix != 'post_'. - * - * @param string $field The Post Object field name. - * @param mixed $value The Post Object value. - * @param int $post_id Post ID. - * @param string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display', - * 'attribute' and 'js'. + * @param string $field The Post Object field name. + * @param mixed $value The Post Object value. + * @param int $post_id Post ID. + * @param string $context How to sanitize post fields. Looks for 'raw', 'edit', + * 'db', 'display', 'attribute' and 'js'. * @return mixed Sanitized value. */ function sanitize_post_field($field, $value, $post_id, $context) { @@ -1993,7 +2156,7 @@ function sanitize_post_field($field, $value, $post_id, $context) { if ( in_array($field, $int_fields) ) $value = (int) $value; - // Fields which contain arrays of ints. + // Fields which contain arrays of integers. $array_int_fields = array( 'ancestors' ); if ( in_array($field, $array_int_fields) ) { $value = array_map( 'absint', $value); @@ -2013,11 +2176,34 @@ function sanitize_post_field($field, $value, $post_id, $context) { $format_to_edit = array('post_content', 'post_excerpt', 'post_title', 'post_password'); if ( $prefixed ) { - $value = apply_filters("edit_{$field}", $value, $post_id); - // Old school - $value = apply_filters("{$field_no_prefix}_edit_pre", $value, $post_id); + + /** + * Filter the value of a specific post field to edit. + * + * The dynamic portion of the hook name, `$field`, refers to the post + * field name. + * + * @since 2.3.0 + * + * @param mixed $value Value of the post field. + * @param int $post_id Post ID. + */ + $value = apply_filters( "edit_{$field}", $value, $post_id ); + + /** + * Filter the value of a specific post field to edit. + * + * The dynamic portion of the hook name, `$field_no_prefix`, refers to + * the post field name. + * + * @since 2.3.0 + * + * @param mixed $value Value of the post field. + * @param int $post_id Post ID. + */ + $value = apply_filters( "{$field_no_prefix}_edit_pre", $value, $post_id ); } else { - $value = apply_filters("edit_post_{$field}", $value, $post_id); + $value = apply_filters( "edit_post_{$field}", $value, $post_id ); } if ( in_array($field, $format_to_edit) ) { @@ -2028,25 +2214,75 @@ function sanitize_post_field($field, $value, $post_id, $context) { } else { $value = esc_attr($value); } - } else if ( 'db' == $context ) { + } elseif ( 'db' == $context ) { if ( $prefixed ) { - $value = apply_filters("pre_{$field}", $value); - $value = apply_filters("{$field_no_prefix}_save_pre", $value); + + /** + * Filter the value of a specific post field before saving. + * + * The dynamic portion of the hook name, `$field`, refers to the post + * field name. + * + * @since 2.3.0 + * + * @param mixed $value Value of the post field. + */ + $value = apply_filters( "pre_{$field}", $value ); + + /** + * Filter the value of a specific field before saving. + * + * The dynamic portion of the hook name, `$field_no_prefix`, refers + * to the post field name. + * + * @since 2.3.0 + * + * @param mixed $value Value of the post field. + */ + $value = apply_filters( "{$field_no_prefix}_save_pre", $value ); } else { - $value = apply_filters("pre_post_{$field}", $value); - $value = apply_filters("{$field}_pre", $value); + $value = apply_filters( "pre_post_{$field}", $value ); + + /** + * Filter the value of a specific post field before saving. + * + * The dynamic portion of the hook name, `$field`, refers to the post + * field name. + * + * @since 2.3.0 + * + * @param mixed $value Value of the post field. + */ + $value = apply_filters( "{$field}_pre", $value ); } } else { + // Use display filters by default. - if ( $prefixed ) - $value = apply_filters($field, $value, $post_id, $context); - else - $value = apply_filters("post_{$field}", $value, $post_id, $context); + if ( $prefixed ) { + + /** + * Filter the value of a specific post field for display. + * + * The dynamic portion of the hook name, `$field`, refers to the post + * field name. + * + * @since 2.3.0 + * + * @param mixed $value Value of the prefixed post field. + * @param int $post_id Post ID. + * @param string $context Context for how to sanitize the field. Possible + * values include 'raw', 'edit', 'db', 'display', + * 'attribute' and 'js'. + */ + $value = apply_filters( $field, $value, $post_id, $context ); + } else { + $value = apply_filters( "post_{$field}", $value, $post_id, $context ); + } } if ( 'attribute' == $context ) $value = esc_attr($value); - else if ( 'js' == $context ) + elseif ( 'js' == $context ) $value = esc_js($value); return $value; @@ -2061,7 +2297,7 @@ function sanitize_post_field($field, $value, $post_id, $context) { * * @param int $post_id Post ID. */ -function stick_post($post_id) { +function stick_post( $post_id ) { $stickies = get_option('sticky_posts'); if ( !is_array($stickies) ) @@ -2074,7 +2310,7 @@ function stick_post($post_id) { } /** - * Unstick a post. + * Un-stick a post. * * Sticky posts should be displayed at the top of the front page. * @@ -2082,7 +2318,7 @@ function stick_post($post_id) { * * @param int $post_id Post ID. */ -function unstick_post($post_id) { +function unstick_post( $post_id ) { $stickies = get_option('sticky_posts'); if ( !is_array($stickies) ) @@ -2101,7 +2337,27 @@ function unstick_post($post_id) { } /** - * Count number of posts of a post type and is user has permissions to view. + * Return the cache key for wp_count_posts() based on the passed arguments. + * + * @since 3.9.0 + * + * @param string $type Optional. Post type to retrieve count Default 'post'. + * @param string $perm Optional. 'readable' or empty. Default empty. + * @return string The cache key. + */ +function _count_posts_cache_key( $type = 'post', $perm = '' ) { + $cache_key = 'posts-' . $type; + if ( 'readable' == $perm && is_user_logged_in() ) { + $post_type_object = get_post_type_object( $type ); + if ( $post_type_object && ! current_user_can( $post_type_object->cap->read_private_posts ) ) { + $cache_key .= '_' . $perm . '_' . get_current_user_id(); + } + } + return $cache_key; +} + +/** + * Count number of posts of a post type and if 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 @@ -2112,46 +2368,60 @@ function unstick_post($post_id) { * private posts, it will display that for the user that is signed in. * * @since 2.5.0 - * @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 + * @global wpdb $wpdb + * + * @param string $type Optional. Post type to retrieve count. Default 'post'. + * @param string $perm Optional. 'readable' or empty. Default empty. + * @return object Number of posts for each status. */ function wp_count_posts( $type = 'post', $perm = '' ) { global $wpdb; - $user = wp_get_current_user(); + if ( ! post_type_exists( $type ) ) + return new stdClass; + + $cache_key = _count_posts_cache_key( $type, $perm ); - $cache_key = $type; + $counts = wp_cache_get( $cache_key, 'counts' ); + if ( false !== $counts ) { + /** This filter is documented in wp-includes/post.php */ + return apply_filters( 'wp_count_posts', $counts, $type, $perm ); + } $query = "SELECT post_status, COUNT( * ) AS num_posts FROM {$wpdb->posts} WHERE post_type = %s"; if ( 'readable' == $perm && is_user_logged_in() ) { $post_type_object = get_post_type_object($type); - if ( !current_user_can( $post_type_object->cap->read_private_posts ) ) { - $cache_key .= '_' . $perm . '_' . $user->ID; - $query .= " AND (post_status != 'private' OR ( post_author = '$user->ID' AND post_status = 'private' ))"; + if ( ! current_user_can( $post_type_object->cap->read_private_posts ) ) { + $query .= $wpdb->prepare( " AND (post_status != 'private' OR ( post_author = %d AND post_status = 'private' ))", + get_current_user_id() + ); } } $query .= ' GROUP BY post_status'; - $count = wp_cache_get($cache_key, 'counts'); - if ( false !== $count ) - return $count; - - $count = $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A ); + $results = (array) $wpdb->get_results( $wpdb->prepare( $query, $type ), ARRAY_A ); + $counts = array_fill_keys( get_post_stati(), 0 ); - $stats = array(); - foreach ( get_post_stati() as $state ) - $stats[$state] = 0; - - foreach ( (array) $count as $row ) - $stats[$row['post_status']] = $row['num_posts']; + foreach ( $results as $row ) { + $counts[ $row['post_status'] ] = $row['num_posts']; + } - $stats = (object) $stats; - wp_cache_set($cache_key, $stats, 'counts'); + $counts = (object) $counts; + wp_cache_set( $cache_key, $counts, 'counts' ); - return $stats; + /** + * Modify returned post counts by status for the current post type. + * + * @since 3.7.0 + * + * @param object $counts An object containing the current post_type's post + * counts by status. + * @param string $type Post type. + * @param string $perm The permission to determine if the posts are 'readable' + * by the current user. + */ + return apply_filters( 'wp_count_posts', $counts, $type, $perm ); } /** @@ -2164,8 +2434,11 @@ function wp_count_posts( $type = 'post', $perm = '' ) { * * @since 2.5.0 * - * @param string|array $mime_type Optional. Array or comma-separated list of MIME patterns. - * @return array Number of posts for each mime type. + * @global wpdb $wpdb + * + * @param string|array $mime_type Optional. Array or comma-separated list of + * MIME patterns. Default empty. + * @return object An object containing the attachment counts by mime type. */ function wp_count_attachments( $mime_type = '' ) { global $wpdb; @@ -2173,21 +2446,31 @@ function wp_count_attachments( $mime_type = '' ) { $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 post_status != 'trash' $and GROUP BY post_mime_type", ARRAY_A ); - $stats = array( ); + $counts = array(); foreach( (array) $count as $row ) { - $stats[$row['post_mime_type']] = $row['num_posts']; + $counts[ $row['post_mime_type'] ] = $row['num_posts']; } - $stats['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and"); + $counts['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and"); - return (object) $stats; + /** + * Modify returned attachment counts by mime type. + * + * @since 3.7.0 + * + * @param object $counts An object containing the attachment counts by + * mime type. + * @param string $mime_type The mime type pattern used to filter the attachments + * counted. + */ + return apply_filters( 'wp_count_attachments', (object) $counts, $mime_type ); } /** - * Get default post mime types + * Get default post mime types. * * @since 2.9.0 * - * @return array + * @return array List of post mime types. */ function get_post_mime_types() { $post_mime_types = array( // array( adj, noun ) @@ -2196,7 +2479,14 @@ function get_post_mime_types() { 'video' => array(__('Video'), __('Manage Video'), _n_noop('Video (%s)', 'Video (%s)')), ); - return apply_filters('post_mime_types', $post_mime_types); + /** + * Filter the default list of post mime types. + * + * @since 2.5.0 + * + * @param array $post_mime_types Default list of post mime types. + */ + return apply_filters( 'post_mime_types', $post_mime_types ); } /** @@ -2208,32 +2498,45 @@ function get_post_mime_types() { * * @since 2.5.0 * - * @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)) + * @param string|array $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*) + * or flash (same as *flash*). + * @param string|array $real_mime_types Real post mime type values. + * @return array array(wildcard=>array(real types)). */ -function wp_match_mime_types($wildcard_mime_types, $real_mime_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)); + 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 ) ); + } + + $patternses = array(); $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; + $mimes = array_map( 'trim', explode( ',', $type ) ); + foreach ( $mimes as $mime ) { + $regex = str_replace( '__wildcard__', $wild, preg_quote( str_replace( '*', '__wildcard__', $mime ) ) ); + $patternses[][$type] = "^$regex$"; + if ( false === strpos( $mime, '/' ) ) { + $patternses[][$type] = "^$regex/"; + $patternses[][$type] = $regex; + } } } - 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]) ) ) + 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; } @@ -2242,15 +2545,20 @@ function wp_match_mime_types($wildcard_mime_types, $real_mime_types) { * * @since 2.5.0 * - * @param string|array $post_mime_types List of mime types or comma separated string of mime types. - * @param string $table_alias Optional. Specify a table alias, if needed. + * @param string|array $post_mime_types List of mime types or comma separated string + * of mime types. + * @param string $table_alias Optional. Specify a table alias, if needed. + * Default empty. * @return string The SQL AND clause for mime searching. */ -function wp_post_mime_type_where($post_mime_types, $table_alias = '') { +function wp_post_mime_type_where( $post_mime_types, $table_alias = '' ) { $where = ''; $wildcards = array('', '%', '%/%'); if ( is_string($post_mime_types) ) $post_mime_types = array_map('trim', explode(',', $post_mime_types)); + + $wheres = array(); + foreach ( (array) $post_mime_types as $mime_type ) { $mime_type = preg_replace('/\s/', '', $mime_type); $slashpos = strpos($mime_type, '/'); @@ -2284,23 +2592,25 @@ function wp_post_mime_type_where($post_mime_types, $table_alias = '') { } /** - * Trashes or deletes a post or page. + * Trash or delete a post or page. * - * When the post and page is permanently deleted, everything that is tied to it is deleted also. - * This includes comments, post meta fields, and terms associated with the post. + * When the post and page is permanently deleted, everything that is tied to + * it is deleted also. This includes comments, post meta fields, and terms + * associated with the post. * - * The post or page is moved to trash instead of permanently deleted unless trash is - * disabled, item is already in the trash, or $force_delete is true. + * The post or page is moved to trash instead of permanently deleted unless + * trash is disabled, item is already in the trash, or $force_delete is true. * * @since 1.0.0 - * @uses do_action() on 'delete_post' before deletion unless post type is 'attachment'. - * @uses do_action() on 'deleted_post' after deletion unless post type is 'attachment'. - * @uses wp_delete_attachment() if post type is 'attachment'. - * @uses wp_trash_post() if item should be trashed. - * - * @param int $postid Post ID. - * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false. - * @return mixed False on failure + * + * @global wpdb $wpdb WordPress database abstraction object. + * @see wp_delete_attachment() + * @see wp_trash_post() + * + * @param int $postid Optional. Post ID. Default 0. + * @param bool $force_delete Optional. Whether to bypass trash and force deletion. + * Default false. + * @return array|false|WP_Post False on failure. */ function wp_delete_post( $postid = 0, $force_delete = false ) { global $wpdb; @@ -2309,12 +2619,21 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { return $post; if ( !$force_delete && ( $post->post_type == 'post' || $post->post_type == 'page') && get_post_status( $postid ) != 'trash' && EMPTY_TRASH_DAYS ) - return wp_trash_post($postid); + return wp_trash_post( $postid ); if ( $post->post_type == 'attachment' ) return wp_delete_attachment( $postid, $force_delete ); - do_action('before_delete_post', $postid); + /** + * Fires before a post is deleted, at the start of wp_delete_post(). + * + * @since 3.2.0 + * + * @see wp_delete_post() + * + * @param int $postid Post ID. + */ + do_action( 'before_delete_post', $postid ); delete_post_meta($postid,'_wp_trash_meta_status'); delete_post_meta($postid,'_wp_trash_meta_time'); @@ -2325,34 +2644,20 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { $parent_where = array( 'post_parent' => $postid ); if ( is_post_type_hierarchical( $post->post_type ) ) { - // Point children of this page to its parent, also clean the cache of affected children + // Point children of this page to its parent, also clean the cache of affected children. $children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type ); $children = $wpdb->get_results( $children_query ); $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) ); } - if ( 'page' == $post->post_type) { - // if the page is defined in option page_on_front or post_for_posts, - // adjust the corresponding options - 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'); - } - } else { - unstick_post($postid); - } - - // Do raw query. wp_get_post_revisions() is filtered + // Do raw query. wp_get_post_revisions() is filtered. $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) ); // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up. foreach ( $revision_ids as $revision_id ) wp_delete_post_revision( $revision_id ); - // Point all attachments to this post up one level + // Point all attachments to this post up one level. $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) ); $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid )); @@ -2363,11 +2668,29 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { foreach ( $post_meta_ids as $mid ) delete_metadata_by_mid( 'post', $mid ); + /** + * Fires immediately before a post is deleted from the database. + * + * @since 1.2.0 + * + * @param int $postid Post ID. + */ do_action( 'delete_post', $postid ); - $wpdb->delete( $wpdb->posts, array( 'ID' => $postid ) ); - do_action( 'deleted_post', $postid ); - - clean_post_cache( $post ); + $result = $wpdb->delete( $wpdb->posts, array( 'ID' => $postid ) ); + if ( ! $result ) { + return false; + } + + /** + * Fires immediately after a post is deleted from the database. + * + * @since 2.2.0 + * + * @param int $postid Post ID. + */ + do_action( 'deleted_post', $postid ); + + clean_post_cache( $post ); if ( is_post_type_hierarchical( $post->post_type ) && $children ) { foreach ( $children as $child ) @@ -2376,25 +2699,63 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { wp_clear_scheduled_hook('publish_future_post', array( $postid ) ); - do_action('after_delete_post', $postid); + /** + * Fires after a post is deleted, at the conclusion of wp_delete_post(). + * + * @since 3.2.0 + * + * @see wp_delete_post() + * + * @param int $postid Post ID. + */ + do_action( 'after_delete_post', $postid ); return $post; } /** - * Moves a post or page to the Trash + * Reset the page_on_front, show_on_front, and page_for_post settings when + * a linked page is deleted or trashed. + * + * Also ensures the post is no longer sticky. + * + * @since 3.7.0 + * @access private + * + * @param int $post_id Post ID. + */ +function _reset_front_page_settings_for_post( $post_id ) { + $post = get_post( $post_id ); + 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' ) == $post->ID ) { + update_option( 'show_on_front', 'posts' ); + update_option( 'page_on_front', 0 ); + } + if ( get_option( 'page_for_posts' ) == $post->ID ) { + delete_option( 'page_for_posts', 0 ); + } + } + unstick_post( $post->ID ); +} + +/** + * Move a post or page to the Trash * * If trash is disabled, the post or page is permanently deleted. * * @since 2.9.0 - * @uses do_action() on 'trash_post' before trashing - * @uses do_action() on 'trashed_post' after trashing - * @uses wp_delete_post() if trash is disabled * - * @param int $post_id Post ID. - * @return mixed False on failure + * @see wp_delete_post() + * + * @param int $post_id Optional. Post ID. Default is ID of the global $post + * if EMPTY_TRASH_DAYS equals true. + * @return false|array|WP_Post|null Post data array, otherwise false. */ -function wp_trash_post($post_id = 0) { +function wp_trash_post( $post_id = 0 ) { if ( !EMPTY_TRASH_DAYS ) return wp_delete_post($post_id, true); @@ -2404,7 +2765,14 @@ function wp_trash_post($post_id = 0) { if ( $post['post_status'] == 'trash' ) return false; - do_action('wp_trash_post', $post_id); + /** + * Fires before a post is sent to the trash. + * + * @since 3.3.0 + * + * @param int $post_id Post ID. + */ + do_action( 'wp_trash_post', $post_id ); add_post_meta($post_id,'_wp_trash_meta_status', $post['post_status']); add_post_meta($post_id,'_wp_trash_meta_time', time()); @@ -2414,29 +2782,41 @@ function wp_trash_post($post_id = 0) { wp_trash_post_comments($post_id); - do_action('trashed_post', $post_id); + /** + * Fires after a post is sent to the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + */ + do_action( 'trashed_post', $post_id ); return $post; } /** - * Restores a post or page from the Trash + * Restore a post or page from the Trash. * * @since 2.9.0 - * @uses do_action() on 'untrash_post' before undeletion - * @uses do_action() on 'untrashed_post' after undeletion * - * @param int $post_id Post ID. - * @return mixed False on failure + * @param int $post_id Optional. Post ID. Default is ID of the global $post. + * @return WP_Post|false WP_Post object. False on failure. */ -function wp_untrash_post($post_id = 0) { +function wp_untrash_post( $post_id = 0 ) { if ( !$post = get_post($post_id, ARRAY_A) ) return $post; if ( $post['post_status'] != 'trash' ) return false; - do_action('untrash_post', $post_id); + /** + * Fires before a post is restored from the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + */ + do_action( 'untrash_post', $post_id ); $post_status = get_post_meta($post_id, '_wp_trash_meta_status', true); @@ -2449,22 +2829,29 @@ function wp_untrash_post($post_id = 0) { wp_untrash_post_comments($post_id); - do_action('untrashed_post', $post_id); + /** + * Fires after a post is restored from the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + */ + do_action( 'untrashed_post', $post_id ); return $post; } /** - * Moves comments for a post to the trash + * Moves comments for a post to the trash. * * @since 2.9.0 - * @uses do_action() on 'trash_post_comments' before trashing - * @uses do_action() on 'trashed_post_comments' after trashing * - * @param int $post Post ID or object. - * @return mixed False on failure + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post. + * @return mixed|void False on failure. */ -function wp_trash_post_comments($post = null) { +function wp_trash_post_comments( $post = null ) { global $wpdb; $post = get_post($post); @@ -2473,39 +2860,54 @@ function wp_trash_post_comments($post = null) { $post_id = $post->ID; - do_action('trash_post_comments', $post_id); + /** + * Fires before comments are sent to the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + */ + do_action( 'trash_post_comments', $post_id ); $comments = $wpdb->get_results( $wpdb->prepare("SELECT comment_ID, comment_approved FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id) ); if ( empty($comments) ) return; - // Cache current status for each comment + // Cache current status for each comment. $statuses = array(); foreach ( $comments as $comment ) $statuses[$comment->comment_ID] = $comment->comment_approved; add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses); - // Set status for all comments to post-trashed + // Set status for all comments to post-trashed. $result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id)); clean_comment_cache( array_keys($statuses) ); - do_action('trashed_post_comments', $post_id, $statuses); + /** + * Fires after comments are sent to the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + * @param array $statuses Array of comment statuses. + */ + do_action( 'trashed_post_comments', $post_id, $statuses ); return $result; } /** - * Restore comments for a post from the trash + * Restore comments for a post from the trash. * * @since 2.9.0 - * @uses do_action() on 'untrash_post_comments' before trashing - * @uses do_action() on 'untrashed_post_comments' after trashing * - * @param int $post Post ID or object. - * @return mixed False on failure + * @global wpdb $wpdb + * + * @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post. + * @return true|void */ -function wp_untrash_post_comments($post = null) { +function wp_untrash_post_comments( $post = null ) { global $wpdb; $post = get_post($post); @@ -2519,26 +2921,41 @@ function wp_untrash_post_comments($post = null) { if ( empty($statuses) ) return true; - do_action('untrash_post_comments', $post_id); + /** + * Fires before comments are restored for a post from the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + */ + do_action( 'untrash_post_comments', $post_id ); - // Restore each comment to its original status + // Restore each comment to its original status. $group_by_status = array(); foreach ( $statuses as $comment_id => $comment_status ) $group_by_status[$comment_status][] = $comment_id; foreach ( $group_by_status as $status => $comments ) { // Sanity check. This shouldn't happen. - if ( 'post-trashed' == $status ) + if ( 'post-trashed' == $status ) { $status = '0'; - $comments_in = implode( "', '", $comments ); - $wpdb->query( "UPDATE $wpdb->comments SET comment_approved = '$status' WHERE comment_ID IN ('" . $comments_in . "')" ); + } + $comments_in = implode( ', ', array_map( 'intval', $comments ) ); + $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->comments SET comment_approved = %s WHERE comment_ID IN ($comments_in)", $status ) ); } clean_comment_cache( array_keys($statuses) ); delete_post_meta($post_id, '_wp_trash_meta_comments_status'); - do_action('untrashed_post_comments', $post_id); + /** + * Fires after comments are restored for a post from the trash. + * + * @since 2.9.0 + * + * @param int $post_id Post ID. + */ + do_action( 'untrashed_post_comments', $post_id ); } /** @@ -2549,11 +2966,12 @@ function wp_untrash_post_comments($post = null) { * * @since 2.1.0 * - * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here. + * @see wp_get_object_terms() * - * @param int $post_id Optional. The Post ID. - * @param array $args Optional. Overwrite the defaults. - * @return array + * @param int $post_id Optional. The Post ID. Does not default to the ID of the + * global $post. Default 0. + * @param array $args Optional. Category arguments. Default empty. + * @return array List of categories. */ function wp_get_post_categories( $post_id = 0, $args = array() ) { $post_id = (int) $post_id; @@ -2572,13 +2990,10 @@ function wp_get_post_categories( $post_id = 0, $args = array() ) { * is set to 'all'. There are other defaults that can be overridden in * {@link wp_get_object_terms()}. * - * @package WordPress - * @subpackage Post * @since 2.3.0 * - * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here - * - * @param int $post_id Optional. The Post ID + * @param int $post_id Optional. The Post ID. Does not default to the ID of the + * global $post. Defualt 0. * @param array $args Optional. Overwrite the defaults * @return array List of post tags. */ @@ -2593,16 +3008,14 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) { * is set to 'all'. There are other defaults that can be overridden in * {@link wp_get_object_terms()}. * - * @package WordPress - * @subpackage Post * @since 2.8.0 * - * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here - * - * @param int $post_id Optional. The Post ID - * @param string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag. - * @param array $args Optional. Overwrite the defaults - * @return array List of post tags. + * @param int $post_id Optional. The Post ID. Does not default to the ID of the + * global $post. Default 0. + * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'. + * @param array $args Optional. {@link wp_get_object_terms()} arguments. Default empty array. + * @return array|WP_Error List of post terms or empty array if no terms were found. WP_Error object + * if `$taxonomy` doesn't exist. */ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) { $post_id = (int) $post_id; @@ -2616,16 +3029,15 @@ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array( } /** - * Retrieve number of recent posts. + * Retrieve a number of recent posts. * * @since 1.0.0 - * @uses wp_parse_args() - * @uses get_posts() * - * @param string $deprecated Deprecated. - * @param array $args Optional. Overrides defaults. - * @param string $output Optional. - * @return unknown. + * @see get_posts() + * + * @param array $args Optional. Arguments to retrieve posts. Default empty array. + * @param string $output Optional. Type of output. Accepts ARRAY_A or ''. Default ARRAY_A. + * @return array|false Associative array if $output equals ARRAY_A, array or false if no results. */ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { @@ -2634,7 +3046,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { $args = array( 'numberposts' => absint( $args ) ); } - // Set default arguments + // Set default arguments. $defaults = array( 'numberposts' => 10, 'offset' => 0, 'category' => 0, 'orderby' => 'post_date', @@ -2648,7 +3060,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { $results = get_posts( $r ); - // Backward compatibility. Prior to 3.1 expected posts to be returned in array + // Backward compatibility. Prior to 3.1 expected posts to be returned in array. if ( ARRAY_A == $output ){ foreach( $results as $key => $result ) { $results[$key] = get_object_vars( $result ); @@ -2661,50 +3073,82 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { } /** - * Insert a post. + * Insert or update a post. * * If the $postarr parameter has 'ID' set to a value, then post will be updated. * - * You can set the post date manually, but setting the values for 'post_date' + * You can set the post date manually, by setting the values for 'post_date' * and 'post_date_gmt' keys. You can close the comments or open the comments by * setting the value for 'comment_status' key. * - * The defaults for the parameter $postarr are: - * 'post_status' - Default is 'draft'. - * 'post_type' - Default is 'post'. - * 'post_author' - Default is current user ID ($user_ID). The ID of the user who added the post. - * 'ping_status' - Default is the value in 'default_ping_status' option. - * Whether the attachment can accept pings. - * 'post_parent' - Default is 0. Set this for the post it belongs to, if any. - * 'menu_order' - Default is 0. The order it is displayed. - * 'to_ping' - Whether to ping. - * 'pinged' - Default is empty string. - * 'post_password' - Default is empty string. The password to access the attachment. - * 'guid' - Global Unique ID for referencing the attachment. - * 'post_content_filtered' - Post content filtered. - * 'post_excerpt' - Post excerpt. - * * @since 1.0.0 - * @uses $wpdb - * @uses $user_ID - * @uses do_action() Calls 'pre_post_update' on post ID if this is an update. - * @uses do_action() Calls 'edit_post' action on post ID and post data if this is an update. - * @uses do_action() Calls 'save_post' and 'wp_insert_post' on post id and post data just before returning. - * @uses apply_filters() Calls 'wp_insert_post_data' passing $data, $postarr prior to database update or insert. - * @uses wp_transition_post_status() - * - * @param array $postarr Elements that make up post to insert. - * @param bool $wp_error Optional. Allow return of WP_Error on failure. - * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success. - */ -function wp_insert_post($postarr, $wp_error = false) { - global $wpdb, $user_ID; + * @since 4.2.0 Support was added for encoding emoji in the post title, content, and excerpt. + * + * @see sanitize_post() + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param array $postarr { + * An array of elements that make up a post to update or insert. + * + * @type int $ID The post ID. If equal to something other than 0, + * the post with that ID will be updated. Default 0. + * @type int $post_author The ID of the user who added the post. Default is + * the current user ID. + * @type string $post_date The date of the post. Default is the current time. + * @type string $post_date_gmt The date of the post in the GMT timezone. Default is + * the value of `$post_date`. + * @type mixed $post_content The post content. Default empty. + * @type string $post_content_filtered The filtered post content. Default empty. + * @type string $post_title The post title. Default empty. + * @type string $post_excerpt The post excerpt. Default empty. + * @type string $post_status The post status. Default 'draft'. + * @type string $post_type The post type. Default 'post'. + * @type string $comment_status Whether the post can accept comments. Accepts 'open' or 'closed'. + * Default is the value of 'default_comment_status' option. + * @type string $ping_status Whether the post can accept pings. Accepts 'open' or 'closed'. + * Default is the value of 'default_ping_status' option. + * @type string $post_password The password to access the post. Default empty. + * @type string $post_name The post name. Default is the sanitized post title. + * @type string $to_ping Space or carriage return-separated list of URLs to ping. + * Default empty. + * @type string $pinged Space or carriage return-separated list of URLs that have + * been pinged. Default empty. + * @type string $post_modified The date when the post was last modified. Default is + * the current time. + * @type string $post_modified_gmt The date when the post was last modified in the GMT + * timezone. Default is the current time. + * @type int $post_parent Set this for the post it belongs to, if any. Default 0. + * @type int $menu_order The order the post should be displayed in. Default 0. + * @type string $post_mime_type The mime type of the post. Default empty. + * @type string $guid Global Unique ID for referencing the post. Default empty. + * } + * @param bool $wp_error Optional. Whether to allow return of WP_Error on failure. Default false. + * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure. + */ +function wp_insert_post( $postarr, $wp_error = false ) { + global $wpdb; + + $user_id = get_current_user_id(); - $defaults = array('post_status' => 'draft', 'post_type' => 'post', 'post_author' => $user_ID, - 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0, - 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', - 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0, - 'post_content' => '', 'post_title' => ''); + $defaults = array( + 'post_author' => $user_id, + 'post_content' => '', + 'post_content_filtered' => '', + 'post_title' => '', + 'post_excerpt' => '', + 'post_status' => 'draft', + 'post_type' => 'post', + 'comment_status' => '', + 'ping_status' => '', + 'post_password' => '', + 'to_ping' => '', + 'pinged' => '', + 'post_parent' => 0, + 'menu_order' => 0, + 'guid' => '', + 'import_id' => 0, + 'context' => '', + ); $postarr = wp_parse_args($postarr, $defaults); @@ -2712,98 +3156,145 @@ function wp_insert_post($postarr, $wp_error = false) { $postarr = sanitize_post($postarr, 'db'); - // export array as variables - extract($postarr, EXTR_SKIP); - // Are we updating or creating? + $post_ID = 0; $update = false; - if ( !empty($ID) ) { + $guid = $postarr['guid']; + + if ( ! empty( $postarr['ID'] ) ) { $update = true; - $previous_status = get_post_field('post_status', $ID); + + // Get the post ID and GUID. + $post_ID = $postarr['ID']; + $post_before = get_post( $post_ID ); + if ( is_null( $post_before ) ) { + if ( $wp_error ) { + return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) ); + } + return 0; + } + + $guid = get_post_field( 'guid', $post_ID ); + $previous_status = get_post_field('post_status', $post_ID ); } else { $previous_status = 'new'; } - $maybe_empty = ! $post_content && ! $post_title && ! $post_excerpt && post_type_supports( $post_type, 'editor' ) - && post_type_supports( $post_type, 'title' ) && post_type_supports( $post_type, 'excerpt' ); + $post_type = empty( $postarr['post_type'] ) ? 'post' : $postarr['post_type']; + + $post_title = $postarr['post_title']; + $post_content = $postarr['post_content']; + $post_excerpt = $postarr['post_excerpt']; + if ( isset( $postarr['post_name'] ) ) { + $post_name = $postarr['post_name']; + } + + $maybe_empty = 'attachment' !== $post_type + && ! $post_content && ! $post_title && ! $post_excerpt + && post_type_supports( $post_type, 'editor' ) + && post_type_supports( $post_type, 'title' ) + && post_type_supports( $post_type, 'excerpt' ); + + /** + * Filter whether the post should be considered "empty". + * + * The post is considered "empty" if both: + * 1. The post type supports the title, editor, and excerpt fields + * 2. The title, editor, and excerpt fields are all empty + * + * Returning a truthy value to the filter will effectively short-circuit + * the new post being inserted, returning 0. If $wp_error is true, a WP_Error + * will be returned instead. + * + * @since 3.3.0 + * + * @param bool $maybe_empty Whether the post should be considered "empty". + * @param array $postarr Array of post data. + */ if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) { - if ( $wp_error ) + if ( $wp_error ) { return new WP_Error( 'empty_content', __( 'Content, title, and excerpt are empty.' ) ); - else + } else { return 0; + } } - if ( empty($post_type) ) - $post_type = 'post'; - - if ( empty($post_status) ) - $post_status = 'draft'; + $post_status = empty( $postarr['post_status'] ) ? 'draft' : $postarr['post_status']; + if ( 'attachment' === $post_type && ! in_array( $post_status, array( 'inherit', 'private', 'trash' ) ) ) { + $post_status = 'inherit'; + } - if ( !empty($post_category) ) - $post_category = array_filter($post_category); // Filter out empty terms + if ( ! empty( $postarr['post_category'] ) ) { + // Filter out empty terms. + $post_category = array_filter( $postarr['post_category'] ); + } // Make sure we set a valid category. - if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) { + if ( empty( $post_category ) || 0 == count( $post_category ) || ! is_array( $post_category ) ) { // 'post' requires at least one category. - if ( 'post' == $post_type && 'auto-draft' != $post_status ) + if ( 'post' == $post_type && 'auto-draft' != $post_status ) { $post_category = array( get_option('default_category') ); - else + } else { $post_category = array(); + } } - if ( empty($post_author) ) - $post_author = $user_ID; - - $post_ID = 0; - - // Get the post ID and GUID - if ( $update ) { - $post_ID = (int) $ID; - $guid = get_post_field( 'guid', $post_ID ); - $post_before = get_post($post_ID); - } - - // Don't allow contributors to set the post slug for pending review posts - if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) ) + // Don't allow contributors to set the post slug for pending review posts. + if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) ) { $post_name = ''; + } - // Create a valid post name. Drafts and pending posts are allowed to have an empty - // post name. + /* + * Create a valid post name. Drafts and pending posts are allowed to have + * an empty post name. + */ if ( empty($post_name) ) { - if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) + if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) { $post_name = sanitize_title($post_title); - else + } else { $post_name = ''; + } } else { // On updates, we need to check to see if it's using the old, fixed sanitization context. $check_name = sanitize_title( $post_name, '', 'old-save' ); - if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $ID ) == $check_name ) + if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $post_ID ) == $check_name ) { $post_name = $check_name; - else // new post, or slug has changed. + } else { // new post, or slug has changed. $post_name = sanitize_title($post_name); + } } - // If the post date is empty (due to having been new or a draft) and status is not 'draft' or 'pending', set date to now - if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date ) - $post_date = current_time('mysql'); + /* + * If the post date is empty (due to having been new or a draft) and status + * is not 'draft' or 'pending', set date to now. + */ + if ( empty( $postarr['post_date'] ) || '0000-00-00 00:00:00' == $postarr['post_date'] ) { + $post_date = current_time( 'mysql' ); + } else { + $post_date = $postarr['post_date']; + } - // validate the date - $mm = substr( $post_date, 5, 2 ); - $jj = substr( $post_date, 8, 2 ); - $aa = substr( $post_date, 0, 4 ); - $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date ); - if ( !$valid_date ) { - if ( $wp_error ) - return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) ); - else - return 0; + // Validate the date. + $mm = substr( $post_date, 5, 2 ); + $jj = substr( $post_date, 8, 2 ); + $aa = substr( $post_date, 0, 4 ); + $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date ); + if ( ! $valid_date ) { + if ( $wp_error ) { + return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) ); + } else { + return 0; } + } - if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) { - if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) - $post_date_gmt = get_gmt_from_date($post_date); - else + if ( empty( $postarr['post_date_gmt'] ) || '0000-00-00 00:00:00' == $postarr['post_date_gmt'] ) { + if ( ! in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) { + $post_date_gmt = get_gmt_from_date( $post_date ); + } else { $post_date_gmt = '0000-00-00 00:00:00'; + } + } else { + $post_date_gmt = $postarr['post_date_gmt']; } if ( $update || '0000-00-00 00:00:00' == $post_date ) { @@ -2814,141 +3305,301 @@ function wp_insert_post($postarr, $wp_error = false) { $post_modified_gmt = $post_date_gmt; } - if ( 'publish' == $post_status ) { - $now = gmdate('Y-m-d H:i:59'); - if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) ) - $post_status = 'future'; - } elseif( 'future' == $post_status ) { - $now = gmdate('Y-m-d H:i:59'); - if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) ) - $post_status = 'publish'; + if ( 'attachment' !== $post_type ) { + if ( 'publish' == $post_status ) { + $now = gmdate('Y-m-d H:i:59'); + if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) ) { + $post_status = 'future'; + } + } elseif ( 'future' == $post_status ) { + $now = gmdate('Y-m-d H:i:59'); + if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) ) { + $post_status = 'publish'; + } + } } - if ( empty($comment_status) ) { - if ( $update ) + // Comment status. + if ( empty( $postarr['comment_status'] ) ) { + if ( $update ) { $comment_status = 'closed'; - else - $comment_status = get_option('default_comment_status'); + } else { + $comment_status = get_default_comment_status( $post_type ); + } + } else { + $comment_status = $postarr['comment_status']; } - if ( empty($ping_status) ) - $ping_status = get_option('default_ping_status'); - if ( isset($to_ping) ) - $to_ping = sanitize_trackback_urls( $to_ping ); - else - $to_ping = ''; + // These variables are needed by compact() later. + $post_content_filtered = $postarr['post_content_filtered']; + $post_author = empty( $postarr['post_author'] ) ? $user_id : $postarr['post_author']; + $ping_status = empty( $postarr['ping_status'] ) ? get_default_comment_status( $post_type, 'pingback' ) : $postarr['ping_status']; + $to_ping = isset( $postarr['to_ping'] ) ? sanitize_trackback_urls( $postarr['to_ping'] ) : ''; + $pinged = isset( $postarr['pinged'] ) ? $postarr['pinged'] : ''; + $import_id = isset( $postarr['import_id'] ) ? $postarr['import_id'] : 0; + + /* + * The 'wp_insert_post_parent' filter expects all variables to be present. + * Previously, these variables would have already been extracted + */ + if ( isset( $postarr['menu_order'] ) ) { + $menu_order = (int) $postarr['menu_order']; + } else { + $menu_order = 0; + } - if ( ! isset($pinged) ) - $pinged = ''; + $post_password = isset( $postarr['post_password'] ) ? $postarr['post_password'] : ''; + if ( 'private' == $post_status ) { + $post_password = ''; + } - if ( isset($post_parent) ) - $post_parent = (int) $post_parent; - else + if ( isset( $postarr['post_parent'] ) ) { + $post_parent = (int) $postarr['post_parent']; + } else { $post_parent = 0; + } - // Check the post_parent to see if it will cause a hierarchy loop + /** + * Filter the post parent -- used to check for and prevent hierarchy loops. + * + * @since 3.1.0 + * + * @param int $post_parent Post parent ID. + * @param int $post_ID Post ID. + * @param array $new_postarr Array of parsed post data. + * @param array $postarr Array of sanitized, but otherwise unmodified post data. + */ $post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr ); - if ( isset($menu_order) ) - $menu_order = (int) $menu_order; - else - $menu_order = 0; + $post_name = wp_unique_post_slug( $post_name, $post_ID, $post_status, $post_type, $post_parent ); - if ( !isset($post_password) || 'private' == $post_status ) - $post_password = ''; + // Don't unslash. + $post_mime_type = isset( $postarr['post_mime_type'] ) ? $postarr['post_mime_type'] : ''; + + // Expected_slashed (everything!). + $data = compact( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'post_mime_type', 'guid' ); - $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent); + $emoji_fields = array( 'post_title', 'post_content', 'post_excerpt' ); + + foreach( $emoji_fields as $emoji_field ) { + if ( isset( $data[ $emoji_field ] ) ) { + $charset = $wpdb->get_col_charset( $wpdb->posts, $emoji_field ); + if ( 'utf8' === $charset ) { + $data[ $emoji_field ] = wp_encode_emoji( $data[ $emoji_field ] ); + } + } + } - // 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 = apply_filters('wp_insert_post_data', $data, $postarr); - $data = stripslashes_deep( $data ); + if ( 'attachment' === $post_type ) { + /** + * Filter attachment post data before it is updated in or added to the database. + * + * @since 3.9.0 + * + * @param array $data An array of sanitized attachment post data. + * @param array $postarr An array of unsanitized attachment post data. + */ + $data = apply_filters( 'wp_insert_attachment_data', $data, $postarr ); + } else { + /** + * Filter slashed post data just before it is inserted into the database. + * + * @since 2.7.0 + * + * @param array $data An array of slashed post data. + * @param array $postarr An array of sanitized, but otherwise unmodified post data. + */ + $data = apply_filters( 'wp_insert_post_data', $data, $postarr ); + } + $data = wp_unslash( $data ); $where = array( 'ID' => $post_ID ); if ( $update ) { - do_action( 'pre_post_update', $post_ID ); + /** + * Fires immediately before an existing post is updated in the database. + * + * @since 2.5.0 + * + * @param int $post_ID Post ID. + * @param array $data Array of unslashed post data. + */ + do_action( 'pre_post_update', $post_ID, $data ); if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) { - if ( $wp_error ) + if ( $wp_error ) { return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error); - else + } else { return 0; + } } } else { - if ( isset($post_mime_type) ) - $data['post_mime_type'] = stripslashes( $post_mime_type ); // This isn't in the update - // If there is a suggested ID, use it if not already present - if ( !empty($import_id) ) { + // If there is a suggested ID, use it if not already present. + if ( ! empty( $import_id ) ) { $import_id = (int) $import_id; if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) { $data['ID'] = $import_id; } } if ( false === $wpdb->insert( $wpdb->posts, $data ) ) { - if ( $wp_error ) + if ( $wp_error ) { return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error); - else + } else { return 0; + } } $post_ID = (int) $wpdb->insert_id; - // use the newly generated $post_ID + // Use the newly generated $post_ID. $where = array( 'ID' => $post_ID ); } - if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) { - $data['post_name'] = sanitize_title($data['post_title'], $post_ID); + if ( empty( $data['post_name'] ) && ! in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) { + $data['post_name'] = wp_unique_post_slug( sanitize_title( $data['post_title'], $post_ID ), $post_ID, $data['post_status'], $post_type, $post_parent ); $wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where ); + clean_post_cache( $post_ID ); } - if ( is_object_in_taxonomy($post_type, 'category') ) + if ( is_object_in_taxonomy( $post_type, 'category' ) ) { wp_set_post_categories( $post_ID, $post_category ); + } - if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') ) - wp_set_post_tags( $post_ID, $tags_input ); + if ( isset( $postarr['tags_input'] ) && is_object_in_taxonomy( $post_type, 'post_tag' ) ) { + wp_set_post_tags( $post_ID, $postarr['tags_input'] ); + } - // new-style support for all custom taxonomies - if ( !empty($tax_input) ) { - foreach ( $tax_input as $taxonomy => $tags ) { + // New-style support for all custom taxonomies. + if ( ! empty( $postarr['tax_input'] ) ) { + foreach ( $postarr['tax_input'] as $taxonomy => $tags ) { $taxonomy_obj = get_taxonomy($taxonomy); - if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical. + // array = hierarchical, string = non-hierarchical. + if ( is_array( $tags ) ) { $tags = array_filter($tags); - if ( current_user_can($taxonomy_obj->cap->assign_terms) ) + } + if ( current_user_can( $taxonomy_obj->cap->assign_terms ) ) { wp_set_post_terms( $post_ID, $tags, $taxonomy ); + } } } $current_guid = get_post_field( 'guid', $post_ID ); - // Set GUID - if ( !$update && '' == $current_guid ) + // Set GUID. + if ( ! $update && '' == $current_guid ) { $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where ); + } + + if ( 'attachment' === $postarr['post_type'] ) { + if ( ! empty( $postarr['file'] ) ) { + update_attached_file( $post_ID, $postarr['file'] ); + } + + if ( ! empty( $postarr['context'] ) ) { + add_post_meta( $post_ID, '_wp_attachment_context', $postarr['context'], true ); + } + } clean_post_cache( $post_ID ); - $post = get_post($post_ID); + $post = get_post( $post_ID ); - if ( !empty($page_template) && 'page' == $data['post_type'] ) { - $post->page_template = $page_template; - $page_templates = wp_get_theme()->get_page_templates(); - if ( 'default' != $page_template && ! isset( $page_templates[ $page_template ] ) ) { - if ( $wp_error ) + if ( ! empty( $postarr['page_template'] ) && 'page' == $data['post_type'] ) { + $post->page_template = $postarr['page_template']; + $page_templates = wp_get_theme()->get_page_templates( $post ); + if ( 'default' != $postarr['page_template'] && ! isset( $page_templates[ $postarr['page_template'] ] ) ) { + 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', 'default' ); + } else { + update_post_meta( $post_ID, '_wp_page_template', $postarr['page_template'] ); } - update_post_meta($post_ID, '_wp_page_template', $page_template); } - wp_transition_post_status($data['post_status'], $previous_status, $post); + if ( 'attachment' !== $postarr['post_type'] ) { + wp_transition_post_status( $data['post_status'], $previous_status, $post ); + } else { + if ( $update ) { + /** + * Fires once an existing attachment has been updated. + * + * @since 2.0.0 + * + * @param int $post_ID Attachment ID. + */ + do_action( 'edit_attachment', $post_ID ); + } else { + + /** + * Fires once an attachment has been added. + * + * @since 2.0.0 + * + * @param int $post_ID Attachment ID. + */ + do_action( 'add_attachment', $post_ID ); + } + + return $post_ID; + } if ( $update ) { - do_action('edit_post', $post_ID, $post); + /** + * Fires once an existing post has been updated. + * + * @since 1.2.0 + * + * @param int $post_ID Post ID. + * @param WP_Post $post Post object. + */ + do_action( 'edit_post', $post_ID, $post ); $post_after = get_post($post_ID); + + /** + * Fires once an existing post has been updated. + * + * @since 3.0.0 + * + * @param int $post_ID Post ID. + * @param WP_Post $post_after Post object following the update. + * @param WP_Post $post_before Post object before the update. + */ do_action( 'post_updated', $post_ID, $post_after, $post_before); } - do_action('save_post', $post_ID, $post); - do_action('wp_insert_post', $post_ID, $post); + /** + * Fires once a post has been saved. + * + * The dynamic portion of the hook name, `$post->post_type`, refers to + * the post type slug. + * + * @since 3.7.0 + * + * @param int $post_ID Post ID. + * @param WP_Post $post Post object. + * @param bool $update Whether this is an existing post being updated or not. + */ + do_action( "save_post_{$post->post_type}", $post_ID, $post, $update ); + + /** + * Fires once a post has been saved. + * + * @since 1.5.0 + * + * @param int $post_ID Post ID. + * @param WP_Post $post Post object. + * @param bool $update Whether this is an existing post being updated or not. + */ + do_action( 'save_post', $post_ID, $post, $update ); + + /** + * Fires once a post has been saved. + * + * @since 2.0.0 + * + * @param int $post_ID Post ID. + * @param WP_Post $post Post object. + * @param bool $update Whether this is an existing post being updated or not. + */ + do_action( 'wp_insert_post', $post_ID, $post, $update ); return $post_ID; } @@ -2961,22 +3612,29 @@ function wp_insert_post($postarr, $wp_error = false) { * * @since 1.0.0 * - * @param array|object $postarr Post data. Arrays are expected to be escaped, objects are not. - * @param bool $wp_error Optional. Allow return of WP_Error on failure. + * @param array|object $postarr Optional. Post data. Arrays are expected to be escaped, + * objects are not. Default array. + * @param bool $wp_error Optional. Allow return of WP_Error on failure. Default false. * @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success. */ function wp_update_post( $postarr = array(), $wp_error = false ) { if ( is_object($postarr) ) { - // non-escaped post was passed + // Non-escaped post was passed. $postarr = get_object_vars($postarr); - $postarr = add_magic_quotes($postarr); + $postarr = wp_slash($postarr); } - // First, get all of the original fields + // First, get all of the original fields. $post = get_post($postarr['ID'], ARRAY_A); + if ( is_null( $post ) ) { + if ( $wp_error ) + return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) ); + return 0; + } + // Escape data pulled from DB. - $post = add_magic_quotes($post); + $post = wp_slash($post); // Passed post category list overwrites existing category list if not empty. if ( isset($postarr['post_category']) && is_array($postarr['post_category']) @@ -2985,7 +3643,7 @@ function wp_update_post( $postarr = array(), $wp_error = false ) { else $post_cats = $post['post_category']; - // Drafts shouldn't be assigned a date unless explicitly done so by the user + // Drafts shouldn't be assigned a date unless explicitly done so by the user. if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) && ('0000-00-00 00:00:00' == $post['post_date_gmt']) ) $clear_date = true; @@ -3010,18 +3668,39 @@ function wp_update_post( $postarr = array(), $wp_error = false ) { * Publish a post by transitioning the post status. * * @since 2.1.0 - * @uses wp_update_post() * - * @param mixed $post Post ID or object. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param int|WP_Post $post Post ID or post object. */ function wp_publish_post( $post ) { + global $wpdb; + if ( ! $post = get_post( $post ) ) return; + if ( 'publish' == $post->post_status ) return; + $wpdb->update( $wpdb->posts, array( 'post_status' => 'publish' ), array( 'ID' => $post->ID ) ); + + clean_post_cache( $post->ID ); + + $old_status = $post->post_status; $post->post_status = 'publish'; - wp_update_post( $post ); + wp_transition_post_status( 'publish', $old_status, $post ); + + /** This action is documented in wp-includes/post.php */ + do_action( 'edit_post', $post->ID, $post ); + + /** This action is documented in wp-includes/post.php */ + do_action( "save_post_{$post->post_type}", $post->ID, $post, true ); + + /** This action is documented in wp-includes/post.php */ + do_action( 'save_post', $post->ID, $post, true ); + + /** This action is documented in wp-includes/post.php */ + do_action( 'wp_insert_post', $post->ID, $post, true ); } /** @@ -3032,11 +3711,9 @@ function wp_publish_post( $post ) { * * @since 2.5.0 * - * @param int $post_id Post ID. - * @return null Nothing is returned. Which can mean that no action is required or post was published. + * @param int|WP_Post $post_id Post ID or post object. */ -function check_and_publish_future_post($post_id) { - +function check_and_publish_future_post( $post_id ) { $post = get_post($post_id); if ( empty($post) ) @@ -3047,13 +3724,15 @@ function check_and_publish_future_post($post_id) { $time = strtotime( $post->post_date_gmt . ' GMT' ); - if ( $time > time() ) { // Uh oh, someone jumped the gun! + // Uh oh, someone jumped the gun! + if ( $time > time() ) { wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) ); return; } - return wp_publish_post($post_id); + // wp_publish_post(_ returns no meaninful value + wp_publish_post( $post_id ); } /** @@ -3061,17 +3740,18 @@ function check_and_publish_future_post($post_id) { * * @since 2.8.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. * @global WP_Rewrite $wp_rewrite - * @param string $slug the desired slug (post_name) - * @param integer $post_ID - * @param string $post_status no uniqueness checks are made if the post is still draft or pending - * @param string $post_type - * @param integer $post_parent - * @return string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix) + * + * @param string $slug The desired slug (post_name). + * @param int $post_ID Post ID. + * @param string $post_status No uniqueness checks are made if the post is still draft or pending. + * @param string $post_type Post type. + * @param int $post_parent Post parent ID. + * @return string Unique slug for the post, based on $post_name (with a -1, -2, etc. suffix) */ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) { - if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) + if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) || ( 'inherit' == $post_status && 'revision' == $post_type ) ) return $slug; global $wpdb, $wp_rewrite; @@ -3082,34 +3762,54 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p if ( ! is_array( $feeds ) ) $feeds = array(); - $hierarchical_post_types = get_post_types( array('hierarchical' => true) ); if ( 'attachment' == $post_type ) { // Attachment slugs must be unique across all types. $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND ID != %d LIMIT 1"; $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) ); + /** + * Filter whether the post slug would make a bad attachment slug. + * + * @since 3.1.0 + * + * @param bool $bad_slug Whether the slug would be bad as an attachment slug. + * @param string $slug The post slug. + */ if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) { $suffix = 2; do { - $alt_post_name = substr ($slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; - $post_name_check = $wpdb->get_var( $wpdb->prepare($check_sql, $alt_post_name, $post_ID ) ); + $alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID ) ); $suffix++; } while ( $post_name_check ); $slug = $alt_post_name; } - } elseif ( in_array( $post_type, $hierarchical_post_types ) ) { + } elseif ( is_post_type_hierarchical( $post_type ) ) { if ( 'nav_menu_item' == $post_type ) return $slug; - // Page slugs must be unique within their own trees. Pages are in a separate - // namespace than posts so page slugs are allowed to overlap post slugs. - $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type IN ( '" . implode( "', '", esc_sql( $hierarchical_post_types ) ) . "' ) AND ID != %d AND post_parent = %d LIMIT 1"; - $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID, $post_parent ) ); + /* + * Page slugs must be unique within their own trees. Pages are in a separate + * namespace than posts so page slugs are allowed to overlap post slugs. + */ + $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type IN ( %s, 'attachment' ) AND ID != %d AND post_parent = %d LIMIT 1"; + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID, $post_parent ) ); + + /** + * Filter whether the post slug would make a bad hierarchical post slug. + * + * @since 3.1.0 + * + * @param bool $bad_slug Whether the post slug would be bad in a hierarchical post context. + * @param string $slug The post slug. + * @param string $post_type Post type. + * @param int $post_parent Post parent ID. + */ if ( $post_name_check || in_array( $slug, $feeds ) || preg_match( "@^($wp_rewrite->pagination_base)?\d+$@", $slug ) || apply_filters( 'wp_unique_post_slug_is_bad_hierarchical_slug', false, $slug, $post_type, $post_parent ) ) { $suffix = 2; do { - $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; - $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_ID, $post_parent ) ); + $alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; + $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID, $post_parent ) ); $suffix++; } while ( $post_name_check ); $slug = $alt_post_name; @@ -3119,10 +3819,41 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p $check_sql = "SELECT post_name FROM $wpdb->posts WHERE post_name = %s AND post_type = %s AND ID != %d LIMIT 1"; $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_type, $post_ID ) ); - if ( $post_name_check || in_array( $slug, $feeds ) || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) { + // Prevent new post slugs that could result in URLs that conflict with date archives. + $post = get_post( $post_ID ); + $conflicts_with_date_archive = false; + if ( 'post' === $post_type && ( ! $post || $post->post_name !== $slug ) && preg_match( '/^[0-9]+$/', $slug ) && $slug_num = intval( $slug ) ) { + $permastructs = array_values( array_filter( explode( '/', get_option( 'permalink_structure' ) ) ) ); + $postname_index = array_search( '%postname%', $permastructs ); + + /* + * Potential date clashes are as follows: + * + * - Any integer in the first permastruct position could be a year. + * - An integer between 1 and 12 that follows 'year' conflicts with 'monthnum'. + * - An integer between 1 and 31 that follows 'monthnum' conflicts with 'day'. + */ + if ( 0 === $postname_index || + ( $postname_index && '%year%' === $permastructs[ $postname_index - 1 ] && 13 > $slug_num ) || + ( $postname_index && '%monthnum%' === $permastructs[ $postname_index - 1 ] && 32 > $slug_num ) + ) { + $conflicts_with_date_archive = true; + } + } + + /** + * Filter whether the post slug would be bad as a flat slug. + * + * @since 3.1.0 + * + * @param bool $bad_slug Whether the post slug would be bad as a flat slug. + * @param string $slug The post slug. + * @param string $post_type Post type. + */ + if ( $post_name_check || in_array( $slug, $feeds ) || $conflicts_with_date_archive || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) { $suffix = 2; do { - $alt_post_name = substr( $slug, 0, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; + $alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix"; $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $alt_post_name, $post_type, $post_ID ) ); $suffix++; } while ( $post_name_check ); @@ -3130,23 +3861,58 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p } } + /** + * Filter the unique post slug. + * + * @since 3.3.0 + * + * @param string $slug The post slug. + * @param int $post_ID Post ID. + * @param string $post_status The post status. + * @param string $post_type Post type. + * @param int $post_parent Post parent ID + * @param string $original_slug The original post slug. + */ return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug ); } /** - * Adds tags to a post. + * Truncate a post slug. * - * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true. + * @since 3.6.0 + * @access private + * + * @see utf8_uri_encode() + * + * @param string $slug The slug to truncate. + * @param int $length Optional. Max length of the slug. Default 200 (characters). + * @return string The truncated slug. + */ +function _truncate_post_slug( $slug, $length = 200 ) { + if ( strlen( $slug ) > $length ) { + $decoded_slug = urldecode( $slug ); + if ( $decoded_slug === $slug ) + $slug = substr( $slug, 0, $length ); + else + $slug = utf8_uri_encode( $decoded_slug, $length ); + } + + return rtrim( $slug, '-' ); +} + +/** + * Add tags to a post. + * + * @see wp_set_post_tags() * - * @package WordPress - * @subpackage Post * @since 2.3.0 * - * @param int $post_id Post ID - * @param string $tags The tags to set for the post, separated by commas. - * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. + * Default 0. + * @param string $tags Optional. The tags to set for the post, separated by commas. Default empty. + * @return array|false|WP_Error Will return false if $post_id is not an integer or is 0. */ -function wp_add_post_tags($post_id = 0, $tags = '') { +function wp_add_post_tags( $post_id = 0, $tags = '' ) { return wp_set_post_tags($post_id, $tags, true); } @@ -3154,12 +3920,15 @@ function wp_add_post_tags($post_id = 0, $tags = '') { * Set the tags for a post. * * @since 2.3.0 - * @uses wp_set_object_terms() Sets the tags for the post. * - * @param int $post_id Post ID. - * @param string $tags The tags to set for the post, separated by commas. - * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. - * @return mixed Array of affected term IDs. WP_Error or false on failure. + * @see wp_set_object_terms() + * + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. + * @param string $tags Optional. The tags to set for the post, separated by commas. + * Default empty. + * @param bool $append Optional. If true, don't delete existing tags, just add on. If false, + * replace the tags with the new tags. Default false. + * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure. */ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { return wp_set_post_terms( $post_id, $tags, 'post_tag', $append); @@ -3169,13 +3938,15 @@ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) { * Set the terms for a post. * * @since 2.8.0 - * @uses wp_set_object_terms() Sets the tags for the post. * - * @param int $post_id Post ID. - * @param string $tags The tags to set for the post, separated by commas. - * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'. - * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. - * @return mixed Array of affected term IDs. WP_Error or false on failure. + * @see wp_set_object_terms() + * + * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post. + * @param string $tags Optional. The tags to set for the post, separated by commas. Default empty. + * @param string $taxonomy Optional. Taxonomy name. Default 'post_tag'. + * @param bool $append Optional. If true, don't delete existing tags, just add on. If false, + * replace the tags with the new tags. Default false. + * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure. */ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) { $post_id = (int) $post_id; @@ -3193,8 +3964,10 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a $tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) ); } - // Hierarchical taxonomies must always pass IDs rather than names so that children with the same - // names but different parents aren't confused. + /* + * Hierarchical taxonomies must always pass IDs rather than names so that + * children with the same names but different parents aren't confused. + */ if ( is_taxonomy_hierarchical( $taxonomy ) ) { $tags = array_unique( array_map( 'intval', $tags ) ); } @@ -3210,83 +3983,135 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a * * @since 2.1.0 * - * @param int $post_ID Post ID. - * @param array $post_categories Optional. List of categories. - * @return bool|mixed + * @param int $post_ID Optional. The Post ID. Does not default to the ID + * of the global $post. Default 0. + * @param array|int $post_categories Optional. List of categories or ID of category. + * Default empty array. + * @param bool $append If true, don't delete existing categories, just add on. + * If false, replace the categories with the new categories. + * @return array|bool|WP_Error */ -function wp_set_post_categories($post_ID = 0, $post_categories = array()) { +function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $append = false ) { $post_ID = (int) $post_ID; $post_type = get_post_type( $post_ID ); $post_status = get_post_status( $post_ID ); // If $post_categories isn't already an array, make it one: - if ( !is_array($post_categories) || empty($post_categories) ) { - if ( 'post' == $post_type && 'auto-draft' != $post_status ) + $post_categories = (array) $post_categories; + if ( empty( $post_categories ) ) { + if ( 'post' == $post_type && 'auto-draft' != $post_status ) { $post_categories = array( get_option('default_category') ); - else + $append = false; + } else { $post_categories = array(); - } else if ( 1 == count($post_categories) && '' == reset($post_categories) ) { + } + } elseif ( 1 == count( $post_categories ) && '' == reset( $post_categories ) ) { return true; } - return wp_set_post_terms($post_ID, $post_categories, 'category'); + return wp_set_post_terms( $post_ID, $post_categories, 'category', $append ); } /** - * Transition the post status of a post. - * - * Calls hooks to transition post status. - * - * The first is 'transition_post_status' with new status, old status, and post data. + * Fires actions related to the transitioning of a post's status. * - * The next action called is 'OLDSTATUS_to_NEWSTATUS' the 'NEWSTATUS' is the - * $new_status parameter and the 'OLDSTATUS' is $old_status parameter; it has the - * post data. + * When a post is saved, the post status is "transitioned" from one status to another, + * though this does not always mean the status has actually changed before and after + * the save. This function fires a number of action hooks related to that transition: + * the generic 'transition_post_status' action, as well as the dynamic hooks + * `"{$old_status}_to_{$new_status}"` and `"{$new_status}_{$post->post_type}"`. Note + * that the function does not transition the post object in the database. * - * The final action is named 'NEWSTATUS_POSTTYPE', 'NEWSTATUS' is from the $new_status - * parameter and POSTTYPE is post_type post data. + * For instance: When publishing a post for the first time, the post status may transition + * from 'draft' – or some other status – to 'publish'. However, if a post is already + * published and is simply being updated, the "old" and "new" statuses may both be 'publish' + * before and after the transition. * * @since 2.3.0 - * @link http://codex.wordpress.org/Post_Status_Transitions * - * @uses do_action() Calls 'transition_post_status' on $new_status, $old_status and - * $post if there is a status change. - * @uses do_action() Calls '{$old_status}_to_{$new_status}' on $post if there is a status change. - * @uses do_action() Calls '{$new_status}_{$post->post_type}' on post ID and $post. - * - * @param string $new_status Transition to this post status. - * @param string $old_status Previous post status. - * @param object $post Post data. + * @param string $new_status Transition to this post status. + * @param string $old_status Previous post status. + * @param WP_Post $post Post data. */ -function wp_transition_post_status($new_status, $old_status, $post) { - do_action('transition_post_status', $new_status, $old_status, $post); - do_action("{$old_status}_to_{$new_status}", $post); - do_action("{$new_status}_{$post->post_type}", $post->ID, $post); +function wp_transition_post_status( $new_status, $old_status, $post ) { + /** + * Fires when a post is transitioned from one status to another. + * + * @since 2.3.0 + * + * @param string $new_status New post status. + * @param string $old_status Old post status. + * @param WP_Post $post Post object. + */ + do_action( 'transition_post_status', $new_status, $old_status, $post ); + + /** + * Fires when a post is transitioned from one status to another. + * + * The dynamic portions of the hook name, `$new_status` and `$old status`, + * refer to the old and new post statuses, respectively. + * + * @since 2.3.0 + * + * @param WP_Post $post Post object. + */ + do_action( "{$old_status}_to_{$new_status}", $post ); + + /** + * Fires when a post is transitioned from one status to another. + * + * The dynamic portions of the hook name, `$new_status` and `$post->post_type`, + * refer to the new post status and post type, respectively. + * + * Please note: When this action is hooked using a particular post status (like + * 'publish', as `publish_{$post->post_type}`), it will fire both when a post is + * first transitioned to that status from something else, as well as upon + * subsequent post updates (old and new status are both the same). + * + * Therefore, if you are looking to only fire a callback when a post is first + * transitioned to a status, use the {@see 'transition_post_status'} hook instead. + * + * @since 2.3.0 + * + * @param int $post_id Post ID. + * @param WP_Post $post Post object. + */ + do_action( "{$new_status}_{$post->post_type}", $post->ID, $post ); } // -// Trackback and ping functions +// Comment, trackback, and pingback functions. // /** - * Add a URL to those already pung. + * Add a URL to those already pinged. * * @since 1.5.0 - * @uses $wpdb * - * @param int $post_id Post ID. - * @param string $uri Ping URI. - * @return int How many rows were updated. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param int $post_id Post ID. + * @param string $uri Ping URI. + * @return int|false How many rows were updated. */ -function add_ping($post_id, $uri) { +function add_ping( $post_id, $uri ) { global $wpdb; $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); - // expected_slashed ($new) - $new = stripslashes($new); + + /** + * Filter the new ping URL to add for the given post. + * + * @since 2.0.0 + * + * @param string $new New ping URL to add. + */ + $new = apply_filters( 'add_ping', $new ); + + // expected_slashed ($new). + $new = wp_unslash($new); return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) ); } @@ -3294,12 +4119,11 @@ function add_ping($post_id, $uri) { * Retrieve enclosures already enclosed for a post. * * @since 1.5.0 - * @uses $wpdb * * @param int $post_id Post ID. - * @return array List of enclosures + * @return array List of enclosures. */ -function get_enclosed($post_id) { +function get_enclosed( $post_id ) { $custom_fields = get_post_custom( $post_id ); $pung = array(); if ( !is_array( $custom_fields ) ) @@ -3313,44 +4137,68 @@ function get_enclosed($post_id) { $pung[] = trim( $enclosure[ 0 ] ); } } - $pung = apply_filters('get_enclosed', $pung, $post_id); - return $pung; + + /** + * Filter the list of enclosures already enclosed for the given post. + * + * @since 2.0.0 + * + * @param array $pung Array of enclosures for the given post. + * @param int $post_id Post ID. + */ + return apply_filters( 'get_enclosed', $pung, $post_id ); } /** * Retrieve URLs already pinged for a post. * * @since 1.5.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $post_id Post ID. * @return array */ -function get_pung($post_id) { +function get_pung( $post_id ) { global $wpdb; $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; + + /** + * Filter the list of already-pinged URLs for the given post. + * + * @since 2.0.0 + * + * @param array $pung Array of URLs already pinged for the given post. + */ + return apply_filters( 'get_pung', $pung ); } /** * Retrieve URLs that need to be pinged. * * @since 1.5.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $post_id Post ID * @return array */ -function get_to_ping($post_id) { +function get_to_ping( $post_id ) { global $wpdb; $to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id )); $to_ping = sanitize_trackback_urls( $to_ping ); $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY); - $to_ping = apply_filters('get_to_ping', $to_ping); - return $to_ping; + + /** + * Filter the list of URLs yet to ping for the given post. + * + * @since 2.0.0 + * + * @param array $to_ping List of URLs yet to ping. + */ + return apply_filters( 'get_to_ping', $to_ping ); } /** @@ -3358,28 +4206,25 @@ function get_to_ping($post_id) { * * @since 1.0.0 * - * @param string $tb_list Comma separated list of URLs - * @param int $post_id Post ID + * @param string $tb_list Comma separated list of URLs. + * @param int $post_id Post ID. */ -function trackback_url_list($tb_list, $post_id) { +function trackback_url_list( $tb_list, $post_id ) { if ( ! empty( $tb_list ) ) { - // get post data - $postdata = get_post($post_id, ARRAY_A); - - // import postdata as variables - extract($postdata, EXTR_SKIP); + // Get post data. + $postdata = get_post( $post_id, ARRAY_A ); - // form an excerpt - $excerpt = strip_tags($post_excerpt ? $post_excerpt : $post_content); + // Form an excerpt. + $excerpt = strip_tags( $postdata['post_excerpt'] ? $postdata['post_excerpt'] : $postdata['post_content'] ); - if (strlen($excerpt) > 255) { - $excerpt = substr($excerpt,0,252) . '...'; + if ( strlen( $excerpt ) > 255 ) { + $excerpt = substr( $excerpt, 0, 252 ) . '…'; } - $trackback_urls = explode(',', $tb_list); - foreach( (array) $trackback_urls as $tb_url) { - $tb_url = trim($tb_url); - trackback($tb_url, stripslashes($post_title), $excerpt, $post_id); + $trackback_urls = explode( ',', $tb_list ); + foreach( (array) $trackback_urls as $tb_url ) { + $tb_url = trim( $tb_url ); + trackback( $tb_url, wp_unslash( $postdata['post_title'] ), $excerpt, $post_id ); } } } @@ -3392,7 +4237,8 @@ function trackback_url_list($tb_list, $post_id) { * Get a list of page IDs. * * @since 2.0.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @return array List of page IDs. */ @@ -3414,12 +4260,14 @@ function get_all_page_ids() { * Use get_post() instead of get_page(). * * @since 1.5.1 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use get_post() * - * @param mixed $page Page object or page ID. Passed by reference. - * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N. - * @param string $filter How the return value should be filtered. - * @return WP_Post|null WP_Post on success or null on failure + * @param mixed $page Page object or page ID. Passed by reference. + * @param string $output Optional. What to output. Accepts OBJECT, ARRAY_A, or ARRAY_N. + * Default OBJECT. + * @param string $filter Optional. How the return value should be filtered. Accepts 'raw', + * 'edit', 'db', 'display'. Default 'raw'. + * @return WP_Post|array|null WP_Post on success or null on failure. */ function get_page( $page, $output = OBJECT, $filter = 'raw') { return get_post( $page, $output, $filter ); @@ -3429,27 +4277,43 @@ function get_page( $page, $output = OBJECT, $filter = 'raw') { * Retrieves a page given its path. * * @since 2.1.0 - * @uses $wpdb * - * @param string $page_path Page path - * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT. - * @param string $post_type Optional. Post type. Default page. - * @return WP_Post|null WP_Post on success or null on failure + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string $page_path Page path. + * @param string $output Optional. Output type. Accepts OBJECT, ARRAY_N, or ARRAY_A. + * Default OBJECT. + * @param string|array $post_type Optional. Post type or array of post types. Default 'page'. + * @return WP_Post|array|void WP_Post on success. */ -function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') { +function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) { global $wpdb; $page_path = rawurlencode(urldecode($page_path)); $page_path = str_replace('%2F', '/', $page_path); $page_path = str_replace('%20', ' ', $page_path); $parts = explode( '/', trim( $page_path, '/' ) ); - $parts = array_map( 'esc_sql', $parts ); + $parts = esc_sql( $parts ); $parts = array_map( 'sanitize_title_for_query', $parts ); - $in_string = "'". implode( "','", $parts ) . "'"; - $post_type_sql = $post_type; - $wpdb->escape_by_ref( $post_type_sql ); - $pages = $wpdb->get_results( "SELECT ID, post_name, post_parent, post_type FROM $wpdb->posts WHERE post_name IN ($in_string) AND (post_type = '$post_type_sql' OR post_type = 'attachment')", OBJECT_K ); + $in_string = "'" . implode( "','", $parts ) . "'"; + + if ( is_array( $post_type ) ) { + $post_types = $post_type; + } else { + $post_types = array( $post_type, 'attachment' ); + } + + $post_types = esc_sql( $post_types ); + $post_type_in_string = "'" . implode( "','", $post_types ) . "'"; + $sql = " + SELECT ID, post_name, post_parent, post_type + FROM $wpdb->posts + WHERE post_name IN ($in_string) + AND post_type IN ($post_type_in_string) + "; + + $pages = $wpdb->get_results( $sql, OBJECT_K ); $revparts = array_reverse( $parts ); @@ -3474,54 +4338,89 @@ function get_page_by_path($page_path, $output = OBJECT, $post_type = 'page') { } } - if ( $foundid ) + if ( $foundid ) { return get_post( $foundid, $output ); - - return null; + } } /** * Retrieve a page given its title. * * @since 2.1.0 - * @uses $wpdb * - * @param string $page_title Page title - * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT. - * @param string $post_type Optional. Post type. Default page. - * @return WP_Post|null WP_Post on success or null on failure + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string $page_title Page title + * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. + * Default OBJECT. + * @param string|array $post_type Optional. Post type or array of post types. Default 'page'. + * @return WP_Post|array|void WP_Post on success or null on failure */ -function get_page_by_title($page_title, $output = OBJECT, $post_type = 'page' ) { +function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) { global $wpdb; - $page = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type= %s", $page_title, $post_type ) ); - if ( $page ) - return get_post( $page, $output ); - return null; + if ( is_array( $post_type ) ) { + $post_type = esc_sql( $post_type ); + $post_type_in_string = "'" . implode( "','", $post_type ) . "'"; + $sql = $wpdb->prepare( " + SELECT ID + FROM $wpdb->posts + WHERE post_title = %s + AND post_type IN ($post_type_in_string) + ", $page_title ); + } else { + $sql = $wpdb->prepare( " + SELECT ID + FROM $wpdb->posts + WHERE post_title = %s + AND post_type = %s + ", $page_title, $post_type ); + } + + $page = $wpdb->get_var( $sql ); + + if ( $page ) { + return get_post( $page, $output ); + } } /** - * Retrieve child pages from list of pages matching page ID. + * Identify descendants of a given page ID in a list of page objects. * - * Matches against the pages parameter against the page ID. Also matches all - * children for the same to retrieve all children of a page. Does not make any - * SQL queries to get the children. + * Descendants are identified from the `$pages` array passed to the function. No database queries are performed. * * @since 1.5.1 * - * @param int $page_id Page ID. - * @param array $pages List of pages' objects. - * @return array + * @param int $page_id Page ID. + * @param array $pages List of page objects from which descendants should be identified. + * @return array List of page children. */ -function get_page_children($page_id, $pages) { - $page_list = array(); +function get_page_children( $page_id, $pages ) { + // Build a hash of ID -> children. + $children = array(); foreach ( (array) $pages as $page ) { - if ( $page->post_parent == $page_id ) { - $page_list[] = $page; - if ( $children = get_page_children($page->ID, $pages) ) - $page_list = array_merge($page_list, $children); + $children[ intval( $page->post_parent ) ][] = $page; + } + + $page_list = array(); + + // Start the search by looking at immediate children. + if ( isset( $children[ $page_id ] ) ) { + // Always start at the end of the stack in order to preserve original `$pages` order. + $to_look = array_reverse( $children[ $page_id ] ); + + while ( $to_look ) { + $p = array_pop( $to_look ); + $page_list[] = $p; + if ( isset( $children[ $p->ID ] ) ) { + foreach ( array_reverse( $children[ $p->ID ] ) as $child ) { + // Append to the `$to_look` stack to descend the tree. + $to_look[] = $child; + } + } } } + return $page_list; } @@ -3533,14 +4432,13 @@ function get_page_children($page_id, $pages) { * * @since 2.0.0 * - * @param array $pages Posts array. - * @param int $page_id Parent page ID. + * @param array $pages Posts array, passed by reference. + * @param int $page_id Optional. Parent page ID. Default 0. * @return array A list arranged by hierarchy. Children immediately follow their parents. */ function get_page_hierarchy( &$pages, $page_id = 0 ) { if ( empty( $pages ) ) { - $result = array(); - return $result; + return array(); } $children = array(); @@ -3556,10 +4454,17 @@ function get_page_hierarchy( &$pages, $page_id = 0 ) { } /** - * function to traverse and return all the nested children post names of a root page. + * Traverse and return all the nested children post names of a root page. + * * $children contains parent-children relations * * @since 2.9.0 + * + * @see _page_traverse_name() + * + * @param int $page_id Page ID. + * @param array &$children Parent-children relations, passed by reference. + * @param array &$result Result, passed by reference. */ function _page_traverse_name( $page_id, &$children, &$result ){ if ( isset( $children[ $page_id ] ) ){ @@ -3571,22 +4476,25 @@ function _page_traverse_name( $page_id, &$children, &$result ){ } /** - * Builds URI for a page. + * Build URI for a page. * * Sub pages will be in the "directory" under the parent page post name. * * @since 1.5.0 * - * @param mixed $page Page object or page ID. - * @return string Page URI. + * @param WP_Post|object|int $page Page object or page ID. + * @return string|false Page URI, false on error. */ -function get_page_uri($page) { - if ( ! is_object($page) ) - $page = get_post( $page ); +function get_page_uri( $page ) { + $page = get_post( $page ); + + if ( ! $page ) + return false; + $uri = $page->post_name; foreach ( $page->ancestors as $parent ) { - $uri = get_post( $parent )->post_name . "/" . $uri; + $uri = get_post( $parent )->post_name . '/' . $uri; } return $uri; @@ -3595,156 +4503,198 @@ function get_page_uri($page) { /** * Retrieve a list of pages. * - * The defaults that can be overridden are the following: 'child_of', - * 'sort_order', 'sort_column', 'post_title', 'hierarchical', 'exclude', - * 'include', 'meta_key', 'meta_value','authors', 'number', and 'offset'. + * @global wpdb $wpdb WordPress database abstraction object. * * @since 1.5.0 - * @uses $wpdb * - * @param mixed $args Optional. Array or string of options that overrides defaults. - * @return array List of pages matching defaults or $args - */ -function get_pages($args = '') { + * @param array|string $args { + * Optional. Array or string of arguments to retrieve pages. + * + * @type int $child_of Page ID to return child and grandchild pages of. + * Default 0, or no restriction. + * @type string $sort_order How to sort retrieved pages. Accepts 'ASC', 'DESC'. Default 'ASC'. + * @type string $sort_column What columns to sort pages by, comma-separated. Accepts 'post_author', + * 'post_date', 'post_title', 'post_name', 'post_modified', 'menu_order', + * 'post_modified_gmt', 'post_parent', 'ID', 'rand', 'comment_count'. + * 'post_' can be omitted for any values that start with it. + * Default 'post_title'. + * @type bool $hierarchical Whether to return pages hierarchically. Default true. + * @type array $exclude Array of page IDs to exclude. Default empty array. + * @type array $include Array of page IDs to include. Cannot be used with `$child_of`, + * `$parent`, `$exclude`, `$meta_key`, `$meta_value`, or `$hierarchical`. + * Default empty array. + * @type string $meta_key Only include pages with this meta key. Default empty. + * @type string $meta_value Only include pages with this meta value. Requires `$meta_key`. + * Default empty. + * @type string $authors A comma-separated list of author IDs. Default empty. + * @type int $parent Page ID to return direct children of. `$hierarchical` must be false. + * Default -1, or no restriction. + * @type string|array $exclude_tree Comma-separated string or array of page IDs to exclude. + * Default empty array. + * @type int $number The number of pages to return. Default 0, or all pages. + * @type int $offset The number of pages to skip before returning. Requires `$number`. + * Default 0. + * @type string $post_type The post type to query. Default 'page'. + * @type string $post_status A comma-separated list of post status types to include. + * Default 'publish'. + * } + * @return array|false List of pages matching defaults or `$args`. + */ +function get_pages( $args = array() ) { global $wpdb; - $pages = false; - $defaults = array( 'child_of' => 0, 'sort_order' => 'ASC', 'sort_column' => 'post_title', 'hierarchical' => 1, 'exclude' => array(), 'include' => array(), 'meta_key' => '', 'meta_value' => '', - 'authors' => '', 'parent' => -1, 'exclude_tree' => '', + 'authors' => '', 'parent' => -1, 'exclude_tree' => array(), 'number' => '', 'offset' => 0, 'post_type' => 'page', 'post_status' => 'publish', ); $r = wp_parse_args( $args, $defaults ); - extract( $r, EXTR_SKIP ); - $number = (int) $number; - $offset = (int) $offset; - // Make sure the post type is hierarchical + $number = (int) $r['number']; + $offset = (int) $r['offset']; + $child_of = (int) $r['child_of']; + $hierarchical = $r['hierarchical']; + $exclude = $r['exclude']; + $meta_key = $r['meta_key']; + $meta_value = $r['meta_value']; + $parent = $r['parent']; + $post_status = $r['post_status']; + + // Make sure the post type is hierarchical. $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) ); - if ( !in_array( $post_type, $hierarchical_post_types ) ) - return $pages; + if ( ! in_array( $r['post_type'], $hierarchical_post_types ) ) { + return false; + } + + if ( $parent > 0 && ! $child_of ) { + $hierarchical = false; + } - // Make sure we have a valid post status - if ( !is_array( $post_status ) ) + // Make sure we have a valid post status. + if ( ! is_array( $post_status ) ) { $post_status = explode( ',', $post_status ); - if ( array_diff( $post_status, get_post_stati() ) ) - return $pages; + } + if ( array_diff( $post_status, get_post_stati() ) ) { + return false; + } - $cache = array(); - $key = md5( serialize( compact(array_keys($defaults)) ) ); - if ( $cache = wp_cache_get( 'get_pages', 'posts' ) ) { - if ( is_array($cache) && isset( $cache[ $key ] ) && is_array( $cache[ $key ] ) ) { - // Convert to WP_Post instances - $pages = array_map( 'get_post', $cache[ $key ] ); - $pages = apply_filters( 'get_pages', $pages, $r ); - return $pages; - } + // $args can be whatever, only use the args defined in defaults to compute the key. + $key = md5( serialize( wp_array_slice_assoc( $r, array_keys( $defaults ) ) ) ); + $last_changed = wp_cache_get( 'last_changed', 'posts' ); + if ( ! $last_changed ) { + $last_changed = microtime(); + wp_cache_set( 'last_changed', $last_changed, 'posts' ); } - if ( !is_array($cache) ) - $cache = array(); + $cache_key = "get_pages:$key:$last_changed"; + if ( $cache = wp_cache_get( $cache_key, 'posts' ) ) { + // Convert to WP_Post instances. + $pages = array_map( 'get_post', $cache ); + /** This filter is documented in wp-includes/post.php */ + $pages = apply_filters( 'get_pages', $pages, $r ); + return $pages; + } $inclusions = ''; - if ( !empty($include) ) { + if ( ! empty( $r['include'] ) ) { $child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include $parent = -1; $exclude = ''; $meta_key = ''; $meta_value = ''; $hierarchical = false; - $incpages = wp_parse_id_list( $include ); + $incpages = wp_parse_id_list( $r['include'] ); if ( ! empty( $incpages ) ) { - foreach ( $incpages as $incpage ) { - if (empty($inclusions)) - $inclusions = $wpdb->prepare(' AND ( ID = %d ', $incpage); - else - $inclusions .= $wpdb->prepare(' OR ID = %d ', $incpage); - } + $inclusions = ' AND ID IN (' . implode( ',', $incpages ) . ')'; } } - if (!empty($inclusions)) - $inclusions .= ')'; $exclusions = ''; - if ( !empty($exclude) ) { + if ( ! empty( $exclude ) ) { $expages = wp_parse_id_list( $exclude ); if ( ! empty( $expages ) ) { - foreach ( $expages as $expage ) { - if (empty($exclusions)) - $exclusions = $wpdb->prepare(' AND ( ID <> %d ', $expage); - else - $exclusions .= $wpdb->prepare(' AND ID <> %d ', $expage); - } + $exclusions = ' AND ID NOT IN (' . implode( ',', $expages ) . ')'; } } - if (!empty($exclusions)) - $exclusions .= ')'; $author_query = ''; - if (!empty($authors)) { - $post_authors = preg_split('/[\s,]+/',$authors); + if ( ! empty( $r['authors'] ) ) { + $post_authors = preg_split( '/[\s,]+/', $r['authors'] ); if ( ! empty( $post_authors ) ) { foreach ( $post_authors as $post_author ) { //Do we have an author id or an author login? if ( 0 == intval($post_author) ) { $post_author = get_user_by('login', $post_author); - if ( empty($post_author) ) + if ( empty( $post_author ) ) { continue; - if ( empty($post_author->ID) ) + } + if ( empty( $post_author->ID ) ) { continue; + } $post_author = $post_author->ID; } - if ( '' == $author_query ) + if ( '' == $author_query ) { $author_query = $wpdb->prepare(' post_author = %d ', $post_author); - else + } else { $author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author); + } } - if ( '' != $author_query ) + if ( '' != $author_query ) { $author_query = " AND ($author_query)"; + } } } $join = ''; $where = "$exclusions $inclusions "; - if ( ! empty( $meta_key ) || ! empty( $meta_value ) ) { + if ( '' !== $meta_key || '' !== $meta_value ) { $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )"; // meta_key and meta_value might be slashed - $meta_key = stripslashes($meta_key); - $meta_value = stripslashes($meta_value); - if ( ! empty( $meta_key ) ) + $meta_key = wp_unslash($meta_key); + $meta_value = wp_unslash($meta_value); + if ( '' !== $meta_key ) { $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key); - if ( ! empty( $meta_value ) ) + } + if ( '' !== $meta_value ) { $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value); + } } - if ( $parent >= 0 ) + if ( is_array( $parent ) ) { + $post_parent__in = implode( ',', array_map( 'absint', (array) $parent ) ); + if ( ! empty( $post_parent__in ) ) { + $where .= " AND post_parent IN ($post_parent__in)"; + } + } elseif ( $parent >= 0 ) { $where .= $wpdb->prepare(' AND post_parent = %d ', $parent); + } if ( 1 == count( $post_status ) ) { - $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $post_type, array_shift( $post_status ) ); + $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $r['post_type'], reset( $post_status ) ); } else { $post_status = implode( "', '", $post_status ); - $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $post_type ); + $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $r['post_type'] ); } $orderby_array = array(); - $allowed_keys = array('author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified', - 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent', - 'ID', 'rand', 'comment_count'); - foreach ( explode( ',', $sort_column ) as $orderby ) { + $allowed_keys = array( 'author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified', + 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent', + 'ID', 'rand', 'comment_count' ); + + foreach ( explode( ',', $r['sort_column'] ) as $orderby ) { $orderby = trim( $orderby ); - if ( !in_array( $orderby, $allowed_keys ) ) + if ( ! in_array( $orderby, $allowed_keys ) ) { continue; + } switch ( $orderby ) { case 'menu_order': @@ -3759,10 +4709,11 @@ function get_pages($args = '') { $orderby = "$wpdb->posts.comment_count"; break; default: - if ( 0 === strpos( $orderby, 'post_' ) ) + if ( 0 === strpos( $orderby, 'post_' ) ) { $orderby = "$wpdb->posts." . $orderby; - else + } else { $orderby = "$wpdb->posts.post_" . $orderby; + } } $orderby_array[] = $orderby; @@ -3770,25 +4721,28 @@ function get_pages($args = '') { } $sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title"; - $sort_order = strtoupper( $sort_order ); - if ( '' !== $sort_order && !in_array( $sort_order, array( 'ASC', 'DESC' ) ) ) + $sort_order = strtoupper( $r['sort_order'] ); + if ( '' !== $sort_order && ! in_array( $sort_order, array( 'ASC', 'DESC' ) ) ) { $sort_order = 'ASC'; + } $query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where "; $query .= $author_query; $query .= " ORDER BY " . $sort_column . " " . $sort_order ; - if ( !empty($number) ) + if ( ! empty( $number ) ) { $query .= ' LIMIT ' . $offset . ',' . $number; + } $pages = $wpdb->get_results($query); if ( empty($pages) ) { - $pages = apply_filters('get_pages', array(), $r); + /** This filter is documented in wp-includes/post.php */ + $pages = apply_filters( 'get_pages', array(), $r ); return $pages; } - // Sanitize before caching so it'll only get done once + // Sanitize before caching so it'll only get done once. $num_pages = count($pages); for ($i = 0; $i < $num_pages; $i++) { $pages[$i] = sanitize_post($pages[$i], 'raw'); @@ -3797,32 +4751,46 @@ function get_pages($args = '') { // Update cache. update_post_cache( $pages ); - if ( $child_of || $hierarchical ) + if ( $child_of || $hierarchical ) { $pages = get_page_children($child_of, $pages); + } - if ( !empty($exclude_tree) ) { - $exclude = (int) $exclude_tree; - $children = get_page_children($exclude, $pages); - $excludes = array(); - foreach ( $children as $child ) - $excludes[] = $child->ID; - $excludes[] = $exclude; - $num_pages = count($pages); + if ( ! empty( $r['exclude_tree'] ) ) { + $exclude = wp_parse_id_list( $r['exclude_tree'] ); + foreach( $exclude as $id ) { + $children = get_page_children( $id, $pages ); + foreach ( $children as $child ) { + $exclude[] = $child->ID; + } + } + + $num_pages = count( $pages ); for ( $i = 0; $i < $num_pages; $i++ ) { - if ( in_array($pages[$i]->ID, $excludes) ) - unset($pages[$i]); + if ( in_array( $pages[$i]->ID, $exclude ) ) { + unset( $pages[$i] ); + } } } - $cache[ $key ] = $pages; - wp_cache_set( 'get_pages', $cache, 'posts' ); + $page_structure = array(); + foreach ( $pages as $page ) { + $page_structure[] = $page->ID; + } + + wp_cache_set( $cache_key, $page_structure, 'posts' ); // Convert to WP_Post instances $pages = array_map( 'get_post', $pages ); - $pages = apply_filters('get_pages', $pages, $r); - - return $pages; + /** + * Filter the retrieved list of pages. + * + * @since 2.1.0 + * + * @param array $pages List of pages to retrieve. + * @param array $r Array of get_pages() arguments. + */ + return apply_filters( 'get_pages', $pages, $r ); } // @@ -3853,7 +4821,7 @@ function is_local_attachment($url) { /** * Insert an attachment. * - * If you set the 'ID' in the $object parameter, it will mean that you are + * If you set the 'ID' in the $args parameter, it will mean that you are * updating and attempt to update the attachment. You can also set the * attachment name or title by setting the key 'post_name' or 'post_title'. * @@ -3864,186 +4832,34 @@ function is_local_attachment($url) { * comments are allowed. You can close them manually or keep them open by * setting the value for the 'comment_status' key. * - * The $object parameter can have the following: - * 'post_status' - Default is 'draft'. Can not be overridden, set the same as parent post. - * 'post_type' - Default is 'post', will be set to attachment. Can not override. - * 'post_author' - Default is current user ID. The ID of the user, who added the attachment. - * 'ping_status' - Default is the value in default ping status option. Whether the attachment - * can accept pings. - * 'post_parent' - Default is 0. Can use $parent parameter or set this for the post it belongs - * to, if any. - * 'menu_order' - Default is 0. The order it is displayed. - * 'to_ping' - Whether to ping. - * 'pinged' - Default is empty string. - * 'post_password' - Default is empty string. The password to access the attachment. - * 'guid' - Global Unique ID for referencing the attachment. - * 'post_content_filtered' - Attachment post content filtered. - * 'post_excerpt' - Attachment excerpt. - * * @since 2.0.0 - * @uses $wpdb - * @uses $user_ID - * @uses do_action() Calls 'edit_attachment' on $post_ID if this is an update. - * @uses do_action() Calls 'add_attachment' on $post_ID if this is not an update. - * - * @param string|array $object Arguments to override defaults. - * @param string $file Optional filename. - * @param int $parent Parent post ID. + * + * @see wp_insert_post() + * + * @param string|array $args Arguments for inserting an attachment. + * @param string $file Optional. Filename. + * @param int $parent Optional. Parent post ID. * @return int Attachment ID. */ -function wp_insert_attachment($object, $file = false, $parent = 0) { - global $wpdb, $user_ID; - - $defaults = array('post_status' => 'inherit', 'post_type' => 'post', 'post_author' => $user_ID, - 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0, - 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', - 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0, 'context' => ''); - - $object = wp_parse_args($object, $defaults); - if ( !empty($parent) ) - $object['post_parent'] = $parent; - - unset( $object[ 'filter' ] ); - - $object = sanitize_post($object, 'db'); - - // export array as variables - extract($object, EXTR_SKIP); - - if ( empty($post_author) ) - $post_author = $user_ID; - - $post_type = 'attachment'; - - if ( ! in_array( $post_status, array( 'inherit', 'private' ) ) ) - $post_status = 'inherit'; - - if ( !empty($post_category) ) - $post_category = array_filter($post_category); // Filter out empty terms - - // Make sure we set a valid category. - if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) { - $post_category = array(); - } - - // Are we updating or creating? - if ( !empty($ID) ) { - $update = true; - $post_ID = (int) $ID; - } else { - $update = false; - $post_ID = 0; - } - - // Create a valid post name. - if ( empty($post_name) ) - $post_name = sanitize_title($post_title); - else - $post_name = sanitize_title($post_name); - - // expected_slashed ($post_name) - $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent); - - if ( empty($post_date) ) - $post_date = current_time('mysql'); - 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'; - else - $comment_status = get_option('default_comment_status'); - } - if ( empty($ping_status) ) - $ping_status = get_option('default_ping_status'); - - if ( isset($to_ping) ) - $to_ping = preg_replace('|\s+|', "\n", $to_ping); - else - $to_ping = ''; - - if ( isset($post_parent) ) - $post_parent = (int) $post_parent; - else - $post_parent = 0; - - if ( isset($menu_order) ) - $menu_order = (int) $menu_order; - else - $menu_order = 0; - - if ( !isset($post_password) ) - $post_password = ''; - - if ( ! isset($pinged) ) - $pinged = ''; - - // 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 { - // If there is a suggested ID, use it if not already present - if ( !empty($import_id) ) { - $import_id = (int) $import_id; - if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) { - $data['ID'] = $import_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->update( $wpdb->posts, compact("post_name"), array( 'ID' => $post_ID ) ); - } - - if ( is_object_in_taxonomy($post_type, 'category') ) - wp_set_post_categories( $post_ID, $post_category ); +function wp_insert_attachment( $args, $file = false, $parent = 0 ) { + $defaults = array( + 'file' => $file, + 'post_parent' => 0 + ); - if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') ) - wp_set_post_tags( $post_ID, $tags_input ); + $data = wp_parse_args( $args, $defaults ); - // support for all custom taxonomies - if ( !empty($tax_input) ) { - foreach ( $tax_input as $taxonomy => $tags ) { - $taxonomy_obj = get_taxonomy($taxonomy); - if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical. - $tags = array_filter($tags); - if ( current_user_can($taxonomy_obj->cap->assign_terms) ) - wp_set_post_terms( $post_ID, $tags, $taxonomy ); - } + if ( ! empty( $parent ) ) { + $data['post_parent'] = $parent; } - if ( $file ) - update_attached_file( $post_ID, $file ); + $data['post_type'] = 'attachment'; - clean_post_cache( $post_ID ); - - if ( ! empty( $context ) ) - add_post_meta( $post_ID, '_wp_attachment_context', $context, true ); - - if ( $update) { - do_action('edit_attachment', $post_ID); - } else { - do_action('add_attachment', $post_ID); - } - - return $post_ID; + return wp_insert_post( $data ); } /** - * Trashes or deletes an attachment. + * Trash or delete an attachment. * * When an attachment is permanently deleted, the file will also be removed. * Deletion removes all post meta fields, taxonomy, comments, etc. associated @@ -4053,11 +4869,12 @@ function wp_insert_attachment($object, $file = false, $parent = 0) { * for media is disabled, item is already in the trash, or $force_delete is true. * * @since 2.0.0 - * @uses $wpdb - * @uses do_action() Calls 'delete_attachment' hook on Attachment ID. * - * @param int $post_id Attachment ID. - * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param int $post_id Attachment ID. + * @param bool $force_delete Optional. Whether to bypass trash and force deletion. + * Default false. * @return mixed False on failure. Post data on success. */ function wp_delete_attachment( $post_id, $force_delete = false ) { @@ -4079,21 +4896,23 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { $backup_sizes = get_post_meta( $post->ID, '_wp_attachment_backup_sizes', true ); $file = get_attached_file( $post_id ); - $intermediate_sizes = array(); - foreach ( get_intermediate_image_sizes() as $size ) { - if ( $intermediate = image_get_intermediate_size( $post_id, $size ) ) - $intermediate_sizes[] = $intermediate; - } - if ( is_multisite() ) delete_transient( 'dirsize_cache' ); - do_action('delete_attachment', $post_id); + /** + * Fires before an attachment is deleted, at the start of wp_delete_attachment(). + * + * @since 2.0.0 + * + * @param int $post_id Attachment ID. + */ + do_action( 'delete_attachment', $post_id ); wp_delete_object_term_relationships($post_id, array('category', 'post_tag')); wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type)); - delete_metadata( 'post', null, '_thumbnail_id', $post_id, true ); // delete all for any posts. + // Delete all for any posts. + delete_metadata( 'post', null, '_thumbnail_id', $post_id, true ); $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id )); foreach ( $comment_ids as $comment_id ) @@ -4103,39 +4922,47 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { foreach ( $post_meta_ids as $mid ) delete_metadata_by_mid( 'post', $mid ); + /** This action is documented in wp-includes/post.php */ do_action( 'delete_post', $post_id ); - $wpdb->delete( $wpdb->posts, array( 'ID' => $post_id ) ); + $result = $wpdb->delete( $wpdb->posts, array( 'ID' => $post_id ) ); + if ( ! $result ) { + return false; + } + /** This action is documented in wp-includes/post.php */ do_action( 'deleted_post', $post_id ); $uploadpath = wp_upload_dir(); if ( ! empty($meta['thumb']) ) { - // Don't delete the thumb if another attachment uses it - if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $meta['thumb'] . '%', $post_id)) ) { + // Don't delete the thumb if another attachment uses it. + 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", '%' . $wpdb->esc_like( $meta['thumb'] ) . '%', $post_id)) ) { $thumbfile = str_replace(basename($file), $meta['thumb'], $file); - $thumbfile = apply_filters('wp_delete_file', $thumbfile); + /** This filter is documented in wp-includes/functions.php */ + $thumbfile = apply_filters( 'wp_delete_file', $thumbfile ); @ unlink( path_join($uploadpath['basedir'], $thumbfile) ); } } - // remove intermediate and backup images if there are any - foreach ( $intermediate_sizes as $intermediate ) { - $intermediate_file = apply_filters( 'wp_delete_file', $intermediate['path'] ); - @ unlink( path_join($uploadpath['basedir'], $intermediate_file) ); + // Remove intermediate and backup images if there are any. + if ( isset( $meta['sizes'] ) && is_array( $meta['sizes'] ) ) { + foreach ( $meta['sizes'] as $size => $sizeinfo ) { + $intermediate_file = str_replace( basename( $file ), $sizeinfo['file'], $file ); + /** This filter is documented in wp-includes/functions.php */ + $intermediate_file = apply_filters( 'wp_delete_file', $intermediate_file ); + @ unlink( path_join( $uploadpath['basedir'], $intermediate_file ) ); + } } if ( is_array($backup_sizes) ) { foreach ( $backup_sizes as $size ) { $del_file = path_join( dirname($meta['file']), $size['file'] ); - $del_file = apply_filters('wp_delete_file', $del_file); + /** This filter is documented in wp-includes/functions.php */ + $del_file = apply_filters( 'wp_delete_file', $del_file ); @ unlink( path_join($uploadpath['basedir'], $del_file) ); } } - $file = apply_filters('wp_delete_file', $file); - - if ( ! empty($file) ) - @ unlink($file); + wp_delete_file( $file ); clean_post_cache( $post ); @@ -4147,9 +4974,9 @@ function wp_delete_attachment( $post_id, $force_delete = false ) { * * @since 2.1.0 * - * @param int $post_id Attachment ID - * @param bool $unfiltered Optional, default is false. If true, filters are not run. - * @return string|bool Attachment meta field. False on failure. + * @param int $post_id Attachment ID. Default 0. + * @param bool $unfiltered Optional. If true, filters are not run. Default false. + * @return mixed Attachment meta field. False on failure. */ function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) { $post_id = (int) $post_id; @@ -4161,6 +4988,15 @@ function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) { if ( $unfiltered ) return $data; + /** + * Filter the attachment meta data. + * + * @since 2.1.0 + * + * @param array|bool $data Array of meta data for the given attachment, or false + * if the object does not exist. + * @param int $post_id Attachment ID. + */ return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID ); } @@ -4169,15 +5005,23 @@ function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) { * * @since 2.1.0 * - * @param int $post_id Attachment ID. - * @param array $data Attachment data. - * @return int + * @param int $post_id Attachment ID. + * @param array $data Attachment data. + * @return int|bool False if $post is invalid. */ function wp_update_attachment_metadata( $post_id, $data ) { $post_id = (int) $post_id; if ( !$post = get_post( $post_id ) ) return false; + /** + * Filter the updated attachment meta data. + * + * @since 2.1.0 + * + * @param array $data Array of updated attachment meta data. + * @param int $post_id Attachment ID. + */ if ( $data = apply_filters( 'wp_update_attachment_metadata', $data, $post->ID ) ) return update_post_meta( $post->ID, '_wp_attachment_metadata', $data ); else @@ -4189,8 +5033,10 @@ function wp_update_attachment_metadata( $post_id, $data ) { * * @since 2.1.0 * - * @param int $post_id Attachment ID. - * @return string + * @global string $pagenow + * + * @param int $post_id Optional. Attachment ID. Default 0. + * @return string|false Attachment URL, otherwise false. */ function wp_get_attachment_url( $post_id = 0 ) { $post_id = (int) $post_id; @@ -4201,20 +5047,44 @@ function wp_get_attachment_url( $post_id = 0 ) { return false; $url = ''; - if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) { //Get attached file - if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { //Get upload directory - if ( 0 === strpos($file, $uploads['basedir']) ) //Check that the upload base exists in the file location - $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file); //replace file location with url location - elseif ( false !== strpos($file, 'wp-content/uploads') ) + // Get attached file. + if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) { + // Get upload directory. + if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { + // Check that the upload base exists in the file location. + if ( 0 === strpos( $file, $uploads['basedir'] ) ) { + // Replace file location with url location. + $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file); + } elseif ( false !== strpos($file, 'wp-content/uploads') ) { $url = $uploads['baseurl'] . substr( $file, strpos($file, 'wp-content/uploads') + 18 ); - else - $url = $uploads['baseurl'] . "/$file"; //Its a newly uploaded file, therefor $file is relative to the basedir. + } else { + // It's a newly-uploaded file, therefore $file is relative to the basedir. + $url = $uploads['baseurl'] . "/$file"; + } } } - if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recommended to rely upon this. + /* + * If any of the above options failed, Fallback on the GUID as used pre-2.7, + * not recommended to rely upon this. + */ + if ( empty($url) ) { $url = get_the_guid( $post->ID ); + } + // On SSL front-end, URLs should be HTTPS. + if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] ) { + $url = set_url_scheme( $url ); + } + + /** + * Filter the attachment URL. + * + * @since 2.1.0 + * + * @param string $url URL for the given attachment. + * @param int $post_id Attachment ID. + */ $url = apply_filters( 'wp_get_attachment_url', $url, $post->ID ); if ( empty( $url ) ) @@ -4228,8 +5098,8 @@ function wp_get_attachment_url( $post_id = 0 ) { * * @since 2.1.0 * - * @param int $post_id Attachment ID. - * @return mixed False on failure. Thumbnail file path on success. + * @param int $post_id Optional. Attachment ID. Default 0. + * @return string|false False on failure. Thumbnail file path on success. */ function wp_get_attachment_thumb_file( $post_id = 0 ) { $post_id = (int) $post_id; @@ -4240,8 +5110,17 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) { $file = get_attached_file( $post->ID ); - if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) ) + if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) ) { + /** + * Filter the attachment thumbnail file path. + * + * @since 2.1.0 + * + * @param string $thumbfile File path to the attachment thumbnail. + * @param int $post_id Attachment ID. + */ return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID ); + } return false; } @@ -4250,8 +5129,8 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) { * * @since 2.1.0 * - * @param int $post_id Attachment ID - * @return string|bool False on failure. Thumbnail URL on success. + * @param int $post_id Optional. Attachment ID. Default 0. + * @return string|false False on failure. Thumbnail URL on success. */ function wp_get_attachment_thumb_url( $post_id = 0 ) { $post_id = (int) $post_id; @@ -4269,43 +5148,89 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) { $url = str_replace(basename($url), basename($thumb), $url); + /** + * Filter the attachment thumbnail URL. + * + * @since 2.1.0 + * + * @param string $url URL for the attachment thumbnail. + * @param int $post_id Attachment ID. + */ return apply_filters( 'wp_get_attachment_thumb_url', $url, $post->ID ); } /** - * Check if the attachment is an image. + * Verifies an attachment is of a given type. * - * @since 2.1.0 + * @since 4.2.0 * - * @param int $post_id Attachment ID - * @return bool + * @param string $type Attachment type. Accepts 'image', 'audio', or 'video'. + * @param int|WP_Post $post_id Optional. Attachment ID. Default 0. + * @return bool True if one of the accepted types, false otherwise. */ -function wp_attachment_is_image( $post_id = 0 ) { - $post_id = (int) $post_id; - if ( !$post = get_post( $post_id ) ) +function wp_attachment_is( $type, $post_id = 0 ) { + if ( ! $post = get_post( $post_id ) ) { + return false; + } + + if ( ! $file = get_attached_file( $post->ID ) ) { return false; + } + + if ( 0 === strpos( $post->post_mime_type, $type . '/' ) ) { + return true; + } - if ( !$file = get_attached_file( $post->ID ) ) + $check = wp_check_filetype( $file ); + if ( empty( $check['ext'] ) ) { return false; + } - $ext = preg_match('/\.([^.]+)$/', $file, $matches) ? strtolower($matches[1]) : false; + $ext = $check['ext']; - $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' ); + if ( 'import' !== $post->post_mime_type ) { + return $type === $ext; + } - if ( 'image/' == substr($post->post_mime_type, 0, 6) || $ext && 'import' == $post->post_mime_type && in_array($ext, $image_exts) ) - return true; - return false; + switch ( $type ) { + case 'image': + $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' ); + return in_array( $ext, $image_exts ); + + case 'audio': + return in_array( $ext, wp_get_audio_extensions() ); + + case 'video': + return in_array( $ext, wp_get_video_extensions() ); + + default: + return $type === $ext; + } } /** - * Retrieve the icon for a MIME type. + * Checks if the attachment is an image. * * @since 2.1.0 + * @since 4.2.0 Modified into wrapper for wp_attachment_is() and + * allowed WP_Post object to be passed. * - * @param string|int $mime MIME type or attachment ID. - * @return string|bool + * @param int|WP_Post $post Optional. Attachment ID. Default 0. + * @return bool Whether the attachment is an image. */ -function wp_mime_type_icon( $mime = 0 ) { +function wp_attachment_is_image( $post = 0 ) { + return wp_attachment_is( 'image', $post ); +} + +/** + * Retrieve the icon for a MIME type. + * + * @since 2.1.0 + * + * @param string|int $mime MIME type or attachment ID. + * @return string|false Icon, false otherwise. + */ +function wp_mime_type_icon( $mime = 0 ) { if ( !is_numeric($mime) ) $icon = wp_cache_get("mime_type_icon_$mime"); @@ -4333,9 +5258,32 @@ function wp_mime_type_icon( $mime = 0 ) { $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) ); + /** + * Filter the icon directory path. + * + * @since 2.0.0 + * + * @param string $path Icon directory absolute path. + */ + $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' ); + + /** + * Filter the icon directory URI. + * + * @since 2.0.0 + * + * @param string $uri Icon directory URI. + */ + $icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url( 'images/media' ) ); + + /** + * Filter the list of icon directory URIs. + * + * @since 2.5.0 + * + * @param array $uris List of icon directory URIs. + */ + $dirs = apply_filters( 'icon_dirs', array( $icon_dir => $icon_dir_uri ) ); $icon_files = array(); while ( $dirs ) { $keys = array_keys( $dirs ); @@ -4359,7 +5307,8 @@ function wp_mime_type_icon( $mime = 0 ) { wp_cache_add( 'icon_files', $icon_files, 'default', 600 ); } - // Icon basename - extension = MIME wildcard + $types = array(); + // Icon basename - extension = MIME wildcard. foreach ( $icon_files as $file => $uri ) $types[ preg_replace('/^([^.]*).*$/', '$1', basename($file)) ] =& $icon_files[$file]; @@ -4382,11 +5331,21 @@ function wp_mime_type_icon( $mime = 0 ) { } } - return apply_filters( 'wp_mime_type_icon', $icon, $mime, $post_id ); // Last arg is 0 if function pass mime type. + /** + * Filter the mime type icon. + * + * @since 2.1.0 + * + * @param string $icon Path to the mime type icon. + * @param string $mime Mime type. + * @param int $post_id Attachment ID. Will equal 0 if the function passed + * the mime type. + */ + return apply_filters( 'wp_mime_type_icon', $icon, $mime, $post_id ); } /** - * Checked for changed slugs for published post objects and save the old slug. + * Check for changed slugs for published post objects and save the old slug. * * The function is used when a post object of any type is updated, * by comparing the current and previous post objects. @@ -4400,27 +5359,26 @@ function wp_mime_type_icon( $mime = 0 ) { * * @since 2.1.0 * - * @param int $post_id Post ID. - * @param object $post The Post Object - * @param object $post_before The Previous Post Object - * @return int Same as $post_id + * @param int $post_id Post ID. + * @param WP_Post $post The Post Object + * @param WP_Post $post_before The Previous Post Object */ -function wp_check_for_changed_slugs($post_id, $post, $post_before) { - // dont bother if it hasnt changed +function wp_check_for_changed_slugs( $post_id, $post, $post_before ) { + // Don't bother if it hasnt changed. if ( $post->post_name == $post_before->post_name ) return; - // we're only concerned with published, non-hierarchical objects + // We're only concerned with published, non-hierarchical objects. if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) ) return; $old_slugs = (array) get_post_meta($post_id, '_wp_old_slug'); - // if we haven't added this old slug before, add it now + // If we haven't added this old slug before, add it now. if ( !empty( $post_before->post_name ) && !in_array($post_before->post_name, $old_slugs) ) add_post_meta($post_id, '_wp_old_slug', $post_before->post_name); - // if the new slug was used previously, delete it from the list + // If the new slug was used previously, delete it from the list. if ( in_array($post->post_name, $old_slugs) ) delete_post_meta($post_id, '_wp_old_slug', $post->post_name); } @@ -4434,10 +5392,9 @@ function wp_check_for_changed_slugs($post_id, $post, $post_before) { * published posts, and all private posts to which the user has access. * * @since 2.2.0 + * @since 4.3.0 Added the ability to pass an array to `$post_type`. * - * @uses $user_ID - * - * @param string $post_type currently only supports 'post' or 'page'. + * @param string|array $post_type Single post type or an array of post types. Currently only supports 'post' or 'page'. * @return string SQL code that can be added to a where clause. */ function get_private_posts_cap_sql( $post_type ) { @@ -4447,56 +5404,83 @@ function get_private_posts_cap_sql( $post_type ) { /** * Retrieve the post SQL based on capability, author, and type. * - * @see get_private_posts_cap_sql() for full description. - * * @since 3.0.0 - * @param string $post_type Post type. - * @param bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term. - * @param int $post_author Optional. Query posts having a single author ID. - * @param bool $public_only Optional. Only return public posts. Skips cap checks for $current_user. Default is false. + * @since 4.3.0 Introduced the ability to pass an array of post types to `$post_type`. + * + * @see get_private_posts_cap_sql() + * + * @global wpdb $wpdb + * + * @param array|string $post_type Single post type or an array of post types. + * @param bool $full Optional. Returns a full WHERE statement instead of just + * an 'andalso' term. Default true. + * @param int $post_author Optional. Query posts having a single author ID. Default null. + * @param bool $public_only Optional. Only return public posts. Skips cap checks for + * $current_user. Default false. * @return string SQL WHERE code that can be added to a query. */ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) { - global $user_ID, $wpdb; + global $wpdb; - // Private posts - $post_type_obj = get_post_type_object( $post_type ); - if ( ! $post_type_obj ) - return $full ? 'WHERE 1 = 0' : ' 1 = 0 '; + if ( is_array( $post_type ) ) { + $post_types = $post_type; + } else { + $post_types = array( $post_type ); + } - // This hook is deprecated. Why you'd want to use it, I dunno. - if ( ! $cap = apply_filters( 'pub_priv_sql_capability', '' ) ) - $cap = $post_type_obj->cap->read_private_posts; + $post_type_clauses = array(); + foreach ( $post_types as $post_type ) { + $post_type_obj = get_post_type_object( $post_type ); + if ( ! $post_type_obj ) { + continue; + } - if ( $full ) { - if ( null === $post_author ) { - $sql = $wpdb->prepare( 'WHERE post_type = %s AND ', $post_type ); - } else { - $sql = $wpdb->prepare( 'WHERE post_author = %d AND post_type = %s AND ', $post_author, $post_type ); + /** + * Filter the capability to read private posts for a custom post type + * when generating SQL for getting posts by author. + * + * @since 2.2.0 + * @deprecated 3.2.0 The hook transitioned from "somewhat useless" to "totally useless". + * + * @param string $cap Capability. + */ + if ( ! $cap = apply_filters( 'pub_priv_sql_capability', '' ) ) { + $cap = current_user_can( $post_type_obj->cap->read_private_posts ); } - } else { - $sql = ''; - } - - $sql .= "(post_status = 'publish'"; - - // Only need to check the cap if $public_only is false - if ( false === $public_only ) { - if ( current_user_can( $cap ) ) { - // Does the user have the capability to view private posts? Guess so. - $sql .= " OR post_status = 'private'"; - } elseif ( is_user_logged_in() ) { - // Users can view their own private posts. - $id = (int) $user_ID; - if ( null === $post_author || ! $full ) { - $sql .= " OR post_status = 'private' AND post_author = $id"; - } elseif ( $id == (int) $post_author ) { - $sql .= " OR post_status = 'private'"; + + // Only need to check the cap if $public_only is false. + $post_status_sql = "post_status = 'publish'"; + if ( false === $public_only ) { + if ( $cap ) { + // Does the user have the capability to view private posts? Guess so. + $post_status_sql .= " OR post_status = 'private'"; + } elseif ( is_user_logged_in() ) { + // Users can view their own private posts. + $id = get_current_user_id(); + if ( null === $post_author || ! $full ) { + $post_status_sql .= " OR post_status = 'private' AND post_author = $id"; + } elseif ( $id == (int) $post_author ) { + $post_status_sql .= " OR post_status = 'private'"; + } // else none } // else none - } // else none + } + + $post_type_clauses[] = "( post_type = '" . $post_type . "' AND ( $post_status_sql ) )"; + } + + if ( empty( $post_type_clauses ) ) { + return $full ? 'WHERE 1 = 0' : '1 = 0'; + } + + $sql = '( '. implode( ' OR ', $post_type_clauses ) . ' )'; + + if ( null !== $post_author ) { + $sql .= $wpdb->prepare( ' AND post_author = %d', $post_author ); } - $sql .= ')'; + if ( $full ) { + $sql = 'WHERE ' . $sql; + } return $sql; } @@ -4510,47 +5494,70 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, * * @since 0.71 * - * @uses apply_filters() Calls 'get_lastpostdate' filter - * - * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. + * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', + * or 'server'. Default 'server'. * @return string The date of the last post. */ -function get_lastpostdate($timezone = 'server') { +function get_lastpostdate( $timezone = 'server' ) { + /** + * Filter the date the last post was published. + * + * @since 2.3.0 + * + * @param string $date Date the last post was published. Likely values are 'gmt', + * 'blog', or 'server'. + * @param string $timezone Location to use for getting the post published date. + */ return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date' ), $timezone ); } /** - * Retrieve last post modified date depending on timezone. + * Get the timestamp of the last time any post was modified. * * The server timezone is the default and is the difference between GMT and * server time. The 'blog' value is just when the last post was modified. The * 'gmt' is when the last post was modified in GMT time. * * @since 1.2.0 - * @uses apply_filters() Calls 'get_lastpostmodified' filter * - * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. - * @return string The date the post was last modified. + * @param string $timezone Optional. The timezone for the timestamp. Uses the server's internal timezone. + * Accepts 'server', 'blog', 'gmt'. or 'server'. 'server' uses the server's + * internal timezone. 'blog' uses the `post_modified` field, which proxies + * to the timezone set for the site. 'gmt' uses the `post_modified_gmt` field. + * Default 'server'. + * @return string The timestamp. */ -function get_lastpostmodified($timezone = 'server') { +function get_lastpostmodified( $timezone = 'server' ) { $lastpostmodified = _get_last_post_time( $timezone, 'modified' ); $lastpostdate = get_lastpostdate($timezone); if ( $lastpostdate > $lastpostmodified ) $lastpostmodified = $lastpostdate; + /** + * Filter the date the last post was modified. + * + * @since 2.3.0 + * + * @param string $lastpostmodified Date the last post was modified. + * @param string $timezone Location to use for getting the post modified date. + * See {@see get_lastpostmodified()} for accepted `$timezone` values. + */ return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone ); } /** - * Retrieve latest post date data based on timezone. + * Get the timestamp of the last time any post was modified or published. * - * @access private * @since 3.1.0 + * @access private * - * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'. - * @param string $field Field to check. Can be 'date' or 'modified'. - * @return string The date. + * @global wpdb $wpdb + * + * @param string $timezone The timezone for the timestamp. See {@see get_lastpostmodified()} + * for information on accepted values. + * @param string $field Post field to check. Accepts 'date' or 'modified'. + * @return string|false The timestamp. */ function _get_last_post_time( $timezone, $field ) { global $wpdb; @@ -4593,11 +5600,9 @@ function _get_last_post_time( $timezone, $field ) { /** * Updates posts in cache. * - * @package WordPress - * @subpackage Cache * @since 1.5.1 * - * @param array $posts Array of post objects + * @param array $posts Array of post objects, passed by reference. */ function update_post_cache( &$posts ) { if ( ! $posts ) @@ -4616,13 +5621,12 @@ function update_post_cache( &$posts ) { * This function not run if $_wp_suspend_cache_invalidation is not empty. See * wp_suspend_cache_invalidation(). * - * @package WordPress - * @subpackage Cache * @since 2.0.0 * - * @uses do_action() Calls 'clean_post_cache' on $id before adding children (if any). + * @global bool $_wp_suspend_cache_invalidation + * @global wpdb $wpdb WordPress database abstraction object. * - * @param object|int $post The post object or ID to remove from the cache + * @param int|WP_Post $post Post ID or post object to remove from the cache. */ function clean_post_cache( $post ) { global $_wp_suspend_cache_invalidation, $wpdb; @@ -4641,35 +5645,43 @@ function clean_post_cache( $post ) { wp_cache_delete( 'wp_get_archives', 'general' ); + /** + * Fires immediately after the given post's cache is cleaned. + * + * @since 2.5.0 + * + * @param int $post_id Post ID. + * @param WP_Post $post Post object. + */ do_action( 'clean_post_cache', $post->ID, $post ); - if ( is_post_type_hierarchical( $post->post_type ) ) - wp_cache_delete( 'get_pages', 'posts' ); - if ( 'page' == $post->post_type ) { wp_cache_delete( 'all_page_ids', 'posts' ); + + /** + * Fires immediately after the given page's cache is cleaned. + * + * @since 2.5.0 + * + * @param int $post_id Post ID. + */ do_action( 'clean_page_cache', $post->ID ); } + + wp_cache_set( 'last_changed', microtime(), 'posts' ); } /** * Call major cache updating functions for list of Post objects. * - * @package WordPress - * @subpackage Cache * @since 1.5.0 * - * @uses $wpdb - * @uses update_post_cache() - * @uses update_object_term_cache() - * @uses update_postmeta_cache() - * - * @param array $posts Array of Post objects - * @param string $post_type The post type of the posts in $posts. Default is 'post'. - * @param bool $update_term_cache Whether to update the term cache. Default is true. - * @param bool $update_meta_cache Whether to update the meta cache. Default is true. + * @param array $posts Array of Post objects + * @param string $post_type Optional. Post type. Default 'post'. + * @param bool $update_term_cache Optional. Whether to update the term cache. Default true. + * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true. */ -function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) { +function update_post_caches( &$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true ) { // No point in doing all this work if we didn't match any posts. if ( !$posts ) return; @@ -4687,9 +5699,11 @@ function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = t if ( is_array($post_type) ) { $ptypes = $post_type; } elseif ( 'any' == $post_type ) { + $ptypes = array(); // Just use the post_types in the supplied posts. - foreach ( $posts as $post ) + foreach ( $posts as $post ) { $ptypes[] = $post->post_type; + } $ptypes = array_unique($ptypes); } else { $ptypes = array($post_type); @@ -4710,16 +5724,13 @@ function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = t * metadata cache for the posts. Therefore, the functions, which call this * function, do not need to perform SQL queries on their own. * - * @package WordPress - * @subpackage Cache * @since 2.1.0 * - * @uses $wpdb - * * @param array $post_ids List of post IDs. - * @return bool|array Returns false if there is nothing to update or an array of metadata. + * @return array|false Returns false if there is nothing to update or an array + * of metadata. */ -function update_postmeta_cache($post_ids) { +function update_postmeta_cache( $post_ids ) { return update_meta_cache('post', $post_ids); } @@ -4729,19 +5740,16 @@ function update_postmeta_cache($post_ids) { * Cleaning means delete from the cache. Optionally will clean the term * object cache associated with the attachment ID. * - * This function will not run if $_wp_suspend_cache_invalidation is not empty. See - * wp_suspend_cache_invalidation(). + * This function will not run if $_wp_suspend_cache_invalidation is not empty. * - * @package WordPress - * @subpackage Cache * @since 3.0.0 * - * @uses do_action() Calls 'clean_attachment_cache' on $id. + * @global bool $_wp_suspend_cache_invalidation * - * @param int $id The attachment ID in the cache to clean - * @param bool $clean_terms optional. Whether to clean terms cache + * @param int $id The attachment ID in the cache to clean. + * @param bool $clean_terms Optional. Whether to clean terms cache. Default false. */ -function clean_attachment_cache($id, $clean_terms = false) { +function clean_attachment_cache( $id, $clean_terms = false ) { global $_wp_suspend_cache_invalidation; if ( !empty($_wp_suspend_cache_invalidation) ) @@ -4755,7 +5763,14 @@ function clean_attachment_cache($id, $clean_terms = false) { if ( $clean_terms ) clean_object_term_cache($id, 'attachment'); - do_action('clean_attachment_cache', $id); + /** + * Fires after the given attachment's cache is cleaned. + * + * @since 3.0.0 + * + * @param int $id Attachment ID. + */ + do_action( 'clean_attachment_cache', $id ); } // @@ -4767,25 +5782,34 @@ function clean_attachment_cache($id, $clean_terms = false) { * * @since 2.3.0 * @access private - * @uses $wpdb - * @uses do_action() Calls 'private_to_published' on post ID if this is a 'private_to_published' call. - * @uses wp_clear_scheduled_hook() with 'publish_future_post' and post ID. * - * @param string $new_status New post status - * @param string $old_status Previous post status - * @param object $post Object type containing the post information + * @see wp_clear_scheduled_hook() + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string $new_status New post status. + * @param string $old_status Previous post status. + * @param WP_Post $post Post object. */ -function _transition_post_status($new_status, $old_status, $post) { +function _transition_post_status( $new_status, $old_status, $post ) { global $wpdb; if ( $old_status != 'publish' && $new_status == 'publish' ) { - // Reset GUID if transitioning to publish and it is empty + // 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 + + /** + * Fires when a post's status is transitioned from private to published. + * + * @since 1.5.0 + * @deprecated 2.3.0 Use 'private_to_publish' instead. + * + * @param int $post_id Post ID. + */ + do_action('private_to_published', $post->ID); } - // If published posts changed clear the lastpostmodified cache + // If published posts changed clear the lastpostmodified cache. if ( 'publish' == $new_status || 'publish' == $old_status) { foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) { wp_cache_delete( "lastpostmodified:$timezone", 'timeinfo' ); @@ -4793,6 +5817,11 @@ function _transition_post_status($new_status, $old_status, $post) { } } + if ( $new_status !== $old_status ) { + wp_cache_delete( _count_posts_cache_key( $post->post_type ), 'counts' ); + wp_cache_delete( _count_posts_cache_key( $post->post_type, 'readable' ), 'counts' ); + } + // Always clears the hook in case the post status bounced from future to draft. wp_clear_scheduled_hook('publish_future_post', array( $post->ID ) ); } @@ -4805,12 +5834,13 @@ function _transition_post_status($new_status, $old_status, $post) { * @since 2.3.0 * @access private * - * @param int $deprecated Not used. Can be set to null. Never implemented. - * Not marked as deprecated with _deprecated_argument() as it conflicts with - * wp_transition_post_status() and the default filter for _future_post_hook(). - * @param object $post Object type containing the post information + * @param int $deprecated Not used. Can be set to null. Never implemented. Not marked + * as deprecated with _deprecated_argument() as it conflicts with + * wp_transition_post_status() and the default filter for + * {@see _future_post_hook()}. + * @param WP_Post $post Post object. */ -function _future_post_hook( $deprecated = '', $post ) { +function _future_post_hook( $deprecated, $post ) { wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) ); wp_schedule_single_event( strtotime( get_gmt_from_date( $post->post_date ) . ' GMT') , 'publish_future_post', array( $post->ID ) ); } @@ -4818,19 +5848,24 @@ function _future_post_hook( $deprecated = '', $post ) { /** * Hook to schedule pings and enclosures when a post is published. * + * Uses XMLRPC_REQUEST and WP_IMPORTING constants. + * * @since 2.3.0 * @access private - * @uses $wpdb - * @uses XMLRPC_REQUEST constant. - * @uses do_action() Calls 'xmlprc_publish_post' on post ID if XMLRPC_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; - - if ( defined('XMLRPC_REQUEST') ) - do_action('xmlrpc_publish_post', $post_id); + * @param int $post_id The ID in the database table of the post being published. + */ +function _publish_post_hook( $post_id ) { + if ( defined( 'XMLRPC_REQUEST' ) ) { + /** + * Fires when _publish_post_hook() is called during an XML-RPC request. + * + * @since 2.1.0 + * + * @param int $post_id Post ID. + */ + do_action( 'xmlrpc_publish_post', $post_id ); + } if ( defined('WP_IMPORTING') ) return; @@ -4843,412 +5878,13 @@ function _publish_post_hook($post_id) { } /** - * 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 inserted into the posts table as a post revision. Otherwise, returns - * an array whose keys are the post fields to be saved for post revisions. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * @access private - * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields. - * - * @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'] = isset($post['post_modified']) ? $post['post_modified'] : ''; - $return['post_date_gmt'] = isset($post['post_modified_gmt']) ? $post['post_modified_gmt'] : ''; - - return $return; -} - -/** - * Saves an already existing post as a post revision. - * - * Typically used immediately prior to post updates. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @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 ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) - return; - - // WP_POST_REVISIONS = 0, false - if ( ! WP_POST_REVISIONS ) - return; - - if ( !$post = get_post( $post_id, ARRAY_A ) ) - return; - - if ( 'auto-draft' == $post['post_status'] ) - return; - - if ( !post_type_supports($post['post_type'], 'revisions') ) - 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 autosaves 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; -} - -/** - * Retrieve 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.0 - * - * @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 ) { - - 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. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @param object $query WP_Query object - */ -function _wp_get_post_autosave_hack( $query ) { - $query->is_single = false; -} - -/** - * Determines if the specified post is a revision. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @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; -} - -/** - * Determines if the specified post is an autosave. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @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; -} - -/** - * Inserts post data into the posts table as a post revision. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @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 ); - $post = add_magic_quotes($post); //since data is from db - - $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; -} - -/** - * Gets a post revision. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @uses get_post() - * - * @param int|object $post Post ID or post object - * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. - * @param string $filter Optional sanitation filter. @see sanitize_post() - * @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; -} - -/** - * Restores a post to the specified revision. - * - * Can restore a past revision using all fields of the post revision, or only selected fields. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @uses wp_get_post_revision() - * @uses wp_update_post() - * @uses do_action() Calls 'wp_restore_post_revision' on post ID and revision ID if wp_update_post() - * is successful. - * - * @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']; - - $update = add_magic_quotes( $update ); //since data is from db - - $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; -} - -/** - * Deletes a revision. - * - * Deletes the row from the posts table corresponding to the specified revision. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @uses wp_get_post_revision() - * @uses wp_delete_post() - * - * @param int|object $revision_id Revision ID or revision object. - * @return mixed Null or WP_Error if error, deleted post if success. - */ -function wp_delete_post_revision( $revision_id ) { - if ( !$revision = wp_get_post_revision( $revision_id ) ) - 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; -} - -/** - * Returns all revisions of specified post. - * - * @package WordPress - * @subpackage Post_Revisions - * @since 2.6.0 - * - * @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 ( ! 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; -} - -function _set_preview($post) { - - if ( ! is_object($post) ) - return $post; - - $preview = wp_get_post_autosave($post->ID); - - if ( ! is_object($preview) ) - return $post; - - $preview = sanitize_post($preview); - - $post->post_content = $preview->post_content; - $post->post_title = $preview->post_title; - $post->post_excerpt = $preview->post_excerpt; - - return $post; -} - -function _show_post_preview() { - - if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) { - $id = (int) $_GET['preview_id']; - - if ( false == wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) ) - wp_die( __('You do not have permission to preview drafts.') ); - - add_filter('the_preview', '_set_preview'); - } -} - -/** - * Returns the post's parent's post_ID + * Return the post's parent's post_ID * * @since 3.1.0 * - * @param int $post_id + * @param int $post_ID * - * @return int|bool false on error + * @return int|false Post parent ID, otherwise false. */ function wp_get_post_parent_id( $post_ID ) { $post = get_post( $post_ID ); @@ -5258,38 +5894,37 @@ function wp_get_post_parent_id( $post_ID ) { } /** - * Checks the given subset of the post hierarchy for hierarchy loops. - * Prevents loops from forming and breaks those that it finds. + * Check the given subset of the post hierarchy for hierarchy loops. * - * Attached to the wp_insert_post_parent filter. + * Prevents loops from forming and breaks those that it finds. Attached + * to the 'wp_insert_post_parent' filter. * * @since 3.1.0 - * @uses wp_find_hierarchy_loop() * - * @param int $post_parent ID of the parent for the post we're checking. - * @param int $post_ID ID of the post we're checking. + * @see wp_find_hierarchy_loop() * - * @return int The new post_parent for the post. + * @param int $post_parent ID of the parent for the post we're checking. + * @param int $post_ID ID of the post we're checking. + * @return int The new post_parent for the post, 0 otherwise. */ function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) { - // Nothing fancy here - bail + // Nothing fancy here - bail. if ( !$post_parent ) return 0; - // New post can't cause a loop + // New post can't cause a loop. if ( empty( $post_ID ) ) return $post_parent; - // Can't be its own parent + // Can't be its own parent. if ( $post_parent == $post_ID ) return 0; - // Now look for larger loops - + // Now look for larger loops. if ( !$loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent ) ) return $post_parent; // No loop - // Setting $post_parent to the given value causes a loop + // Setting $post_parent to the given value causes a loop. if ( isset( $loop[$post_ID] ) ) return 0; @@ -5301,70 +5936,19 @@ function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) { } /** - * Returns an array of post format slugs to their translated and pretty display versions - * - * @since 3.1.0 - * - * @return array The array of translations - */ -function get_post_format_strings() { - $strings = array( - 'standard' => _x( 'Standard', 'Post format' ), // Special case. any value that evals to false will be considered standard - 'aside' => _x( 'Aside', 'Post format' ), - 'chat' => _x( 'Chat', 'Post format' ), - 'gallery' => _x( 'Gallery', 'Post format' ), - 'link' => _x( 'Link', 'Post format' ), - 'image' => _x( 'Image', 'Post format' ), - 'quote' => _x( 'Quote', 'Post format' ), - 'status' => _x( 'Status', 'Post format' ), - 'video' => _x( 'Video', 'Post format' ), - 'audio' => _x( 'Audio', 'Post format' ), - ); - return $strings; -} - -/** - * Retrieves an array of post format slugs. + * Set a post thumbnail. * * @since 3.1.0 * - * @return array The array of post format slugs. - */ -function get_post_format_slugs() { - $slugs = array_keys( get_post_format_strings() ); - return array_combine( $slugs, $slugs ); -} - -/** - * Returns a pretty, translated version of a post format slug - * - * @since 3.1.0 - * - * @param string $slug A post format slug - * @return string The translated post format name - */ -function get_post_format_string( $slug ) { - $strings = get_post_format_strings(); - if ( !$slug ) - return $strings['standard']; - else - return ( isset( $strings[$slug] ) ) ? $strings[$slug] : ''; -} - -/** - * Sets a post thumbnail. - * - * @since 3.1.0 - * - * @param int|object $post Post ID or object where thumbnail should be attached. - * @param int $thumbnail_id Thumbnail to attach. - * @return bool True on success, false on failure. + * @param int|WP_Post $post Post ID or post object where thumbnail should be attached. + * @param int $thumbnail_id Thumbnail to attach. + * @return int|bool True on success, false on failure. */ function set_post_thumbnail( $post, $thumbnail_id ) { $post = get_post( $post ); $thumbnail_id = absint( $thumbnail_id ); if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) { - if ( $thumbnail_html = wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) ) + if ( wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) ) return update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id ); else return delete_post_meta( $post->ID, '_thumbnail_id' ); @@ -5373,11 +5957,11 @@ function set_post_thumbnail( $post, $thumbnail_id ) { } /** - * Removes a post thumbnail. + * Remove a post thumbnail. * * @since 3.3.0 * - * @param int|object $post Post ID or object where thumbnail should be removed from. + * @param int|WP_Post $post Post ID or post object where thumbnail should be removed from. * @return bool True on success, false on failure. */ function delete_post_thumbnail( $post ) { @@ -5388,134 +5972,35 @@ function delete_post_thumbnail( $post ) { } /** - * Returns a link to a post format index. - * - * @since 3.1.0 - * - * @param string $format Post format - * @return string Link - */ -function get_post_format_link( $format ) { - $term = get_term_by('slug', 'post-format-' . $format, 'post_format' ); - if ( ! $term || is_wp_error( $term ) ) - return false; - return get_term_link( $term ); -} - -/** - * Deletes auto-drafts for new posts that are > 7 days old + * Delete auto-drafts for new posts that are > 7 days old. * * @since 3.4.0 + * + * @global wpdb $wpdb WordPress database abstraction object. */ function wp_delete_auto_drafts() { global $wpdb; - // Cleanup old auto-drafts more than 7 days old + // Cleanup old auto-drafts more than 7 days old. $old_posts = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_status = 'auto-draft' AND DATE_SUB( NOW(), INTERVAL 7 DAY ) > post_date" ); - foreach ( (array) $old_posts as $delete ) - wp_delete_post( $delete, true ); // Force delete -} - -/** - * Filters the request to allow for the format prefix. - * - * @access private - * @since 3.1.0 - */ -function _post_format_request( $qvs ) { - if ( ! isset( $qvs['post_format'] ) ) - return $qvs; - $slugs = get_post_format_slugs(); - if ( isset( $slugs[ $qvs['post_format'] ] ) ) - $qvs['post_format'] = 'post-format-' . $slugs[ $qvs['post_format'] ]; - $tax = get_taxonomy( 'post_format' ); - if ( ! is_admin() ) - $qvs['post_type'] = $tax->object_type; - return $qvs; -} -add_filter( 'request', '_post_format_request' ); - -/** - * Filters the post format term link to remove the format prefix. - * - * @access private - * @since 3.1.0 - */ -function _post_format_link( $link, $term, $taxonomy ) { - global $wp_rewrite; - if ( 'post_format' != $taxonomy ) - return $link; - if ( $wp_rewrite->get_extra_permastruct( $taxonomy ) ) { - return str_replace( "/{$term->slug}", '/' . str_replace( 'post-format-', '', $term->slug ), $link ); - } else { - $link = remove_query_arg( 'post_format', $link ); - return add_query_arg( 'post_format', str_replace( 'post-format-', '', $term->slug ), $link ); + foreach ( (array) $old_posts as $delete ) { + // Force delete. + wp_delete_post( $delete, true ); } } -add_filter( 'term_link', '_post_format_link', 10, 3 ); /** - * Remove the post format prefix from the name property of the term object created by get_term(). + * Update the custom taxonomies' term counts when a post's status is changed. * - * @access private - * @since 3.1.0 - */ -function _post_format_get_term( $term ) { - if ( isset( $term->slug ) ) { - $term->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) ); - } - return $term; -} -add_filter( 'get_post_format', '_post_format_get_term' ); - -/** - * Remove the post format prefix from the name property of the term objects created by get_terms(). - * - * @access private - * @since 3.1.0 - */ -function _post_format_get_terms( $terms, $taxonomies, $args ) { - if ( in_array( 'post_format', (array) $taxonomies ) ) { - if ( isset( $args['fields'] ) && 'names' == $args['fields'] ) { - foreach( $terms as $order => $name ) { - $terms[$order] = get_post_format_string( str_replace( 'post-format-', '', $name ) ); - } - } else { - foreach ( (array) $terms as $order => $term ) { - if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) { - $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) ); - } - } - } - } - return $terms; -} -add_filter( 'get_terms', '_post_format_get_terms', 10, 3 ); - -/** - * Remove the post format prefix from the name property of the term objects created by wp_get_object_terms(). + * For example, default posts term counts (for custom taxonomies) don't include + * private / draft posts. * + * @since 3.3.0 * @access private - * @since 3.1.0 - */ -function _post_format_wp_get_object_terms( $terms ) { - foreach ( (array) $terms as $order => $term ) { - if ( isset( $term->taxonomy ) && 'post_format' == $term->taxonomy ) { - $terms[$order]->name = get_post_format_string( str_replace( 'post-format-', '', $term->slug ) ); - } - } - return $terms; -} -add_filter( 'wp_get_object_terms', '_post_format_wp_get_object_terms' ); - -/** - * Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts. * - * @access private - * @param string $new_status - * @param string $old_status - * @param object $post - * @since 3.3.0 + * @param string $new_status New post status. + * @param string $old_status Old post status. + * @param WP_Post $post Post object. */ function _update_term_count_on_transition_post_status( $new_status, $old_status, $post ) { // Update counts for the post's terms. @@ -5529,12 +6014,15 @@ function _update_term_count_on_transition_post_status( $new_status, $old_status, * Adds any posts from the given ids to the cache that do not already exist in cache * * @since 3.4.0 - * * @access private * - * @param array $post_ids ID list - * @param bool $update_term_cache Whether to update the term cache. Default is true. - * @param bool $update_meta_cache Whether to update the meta cache. Default is true. + * @see update_post_caches() + * + * @global wpdb $wpdb + * + * @param array $ids ID list + * @param bool $update_term_cache Optional. Whether to update the term cache. Default true. + * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true. */ function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) { global $wpdb;