X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/4feeb71a9d812a9ae371c28a3d8b442a4394ded7..607b7e02d77e7326161e8ec15639052d2040f745:/wp-includes/post.php diff --git a/wp-includes/post.php b/wp-includes/post.php index ccb11de7..d0331727 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -13,6 +13,8 @@ /** * Creates the initial post types when 'init' action is fired. * + * See {@see 'init'}. + * * @since 2.9.0 */ function create_initial_post_types() { @@ -197,7 +199,7 @@ function get_attached_file( $attachment_id, $unfiltered = false ) { } /** - * Filter the attached file based on the given ID. + * Filters the attached file based on the given ID. * * @since 2.1.0 * @@ -224,7 +226,7 @@ function update_attached_file( $attachment_id, $file ) { return false; /** - * Filter the path to the attached file to update. + * Filters the path to the attached file to update. * * @since 2.1.0 * @@ -259,7 +261,7 @@ function _wp_relative_upload_path( $path ) { } /** - * Filter the relative path to an uploaded file. + * Filters the relative path to an uploaded file. * * @since 2.9.0 * @@ -286,11 +288,10 @@ function _wp_relative_upload_path( $path ) { * example of what is possible. * * The arguments listed as defaults are for this function and also of the - * {@link get_posts()} function. The arguments are combined with the - * get_children defaults and are then passed to the {@link get_posts()} - * function, which accepts additional arguments. You can replace the defaults in - * this function, listed below and the additional arguments listed in the - * {@link get_posts()} function. + * get_posts() function. The arguments are combined with the get_children defaults + * and are then passed to the get_posts() function, which accepts additional arguments. + * You can replace the defaults in this function, listed below and the additional + * arguments listed in the get_posts() function. * * The 'post_parent' is the most important argument and important attention * needs to be paid to the $args parameter. If you pass either an object or an @@ -412,8 +413,8 @@ function get_extended( $post ) { /** * Retrieves post data given a post ID or post object. * - * See {@link sanitize_post()} for optional $filter values. Also, the parameter - * $post, must be given as a variable, since it is passed by reference. + * See sanitize_post() for optional $filter values. Also, the parameter + * `$post`, must be given as a variable, since it is passed by reference. * * @since 1.5.1 * @@ -578,7 +579,7 @@ function get_post_status( $ID = '' ) { } /** - * Filter the post status. + * Filters the post status. * * @since 4.4.0 * @@ -818,7 +819,7 @@ function post_type_exists( $post_type ) { } /** - * Retrieve the post type of the current post or of a given post. + * Retrieves the post type of the current post or of a given post. * * @since 2.1.0 * @@ -833,16 +834,17 @@ function get_post_type( $post = null ) { } /** - * Retrieve a post type object by name. + * Retrieves a post type object by name. * * @since 3.0.0 + * @since 4.6.0 Object returned is now an instance of WP_Post_Type. * * @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. + * @return WP_Post_Type|null WP_Post_Type object if it exists, null otherwise. */ function get_post_type_object( $post_type ) { global $wp_post_types; @@ -881,21 +883,30 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) } /** - * Register a post type. Do not use before init. + * Registers a post type. * - * A function for creating or modifying a post type based on the - * parameters given. The function will accept an array (second optional - * parameter), along with a string for the post type name. + * Note: Post type registrations should not be hooked before the + * {@see 'init'} action. Also, any taxonomy connections should be + * registered via the `$taxonomies` argument to ensure consistency + * when hooks such as {@see 'parse_query'} or {@see 'pre_get_posts'} + * are used. + * + * Post types can support any number of built-in core features such + * as meta boxes, custom fields, post thumbnails, post statuses, + * comments, and more. See the `$supports` argument for a complete + * list of supported features. * * @since 2.9.0 * @since 3.0.0 The `show_ui` argument is now enforced on the new post screen. - * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing screen and post editing screen. + * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing + * screen and post editing screen. + * @since 4.6.0 Post type object returned is now an instance of WP_Post_Type. * - * @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. + * @global array $wp_post_types List of post types. * - * @param string $post_type Post type key, must not exceed 20 characters. + * @param string $post_type Post type key. Must not exceed 20 characters and may + * only contain lowercase alphanumeric characters, dashes, + * and underscores. See sanitize_key(). * @param array|string $args { * Array or string of arguments for registering a post type. * @@ -903,7 +914,8 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * 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()}. + * labels for hierarchical ones. See get_post_type_labels() for a full + * list of supported 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 @@ -916,7 +928,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * @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: + * as part of parse_request(). Endpoints would include: * * ?post_type={post_type_key} * * ?{post_type_key}={single_post_slug} * * ?{post_type_query_var}={single_post_slug} @@ -947,17 +959,23 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * 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()}. + * 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 array $supports Core feature(s) the post type supports. Serves as an alias for calling + * add_post_type_support() directly. Core 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. Defaults is an array + * containing 'title' and 'editor'. * @type callable $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()}. + * post type. Taxonomies can be registered later with register_taxonomy() + * or 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 @@ -993,10 +1011,10 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * @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. + * @return WP_Post_Type|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; + global $wp_post_types; if ( ! is_array( $wp_post_types ) ) { $wp_post_types = array(); @@ -1004,191 +1022,34 @@ function register_post_type( $post_type, $args = array() ) { // Sanitize post type name $post_type = sanitize_key( $post_type ); - $args = wp_parse_args( $args ); - - /** - * Filter the arguments for registering a post type. - * - * @since 4.4.0 - * - * @param array $args Array of arguments for registering a post type. - * @param string $post_type Post type key. - */ - $args = apply_filters( 'register_post_type_args', $args, $post_type ); - - $has_edit_link = ! empty( $args['_edit_link'] ); - - // Args prefixed with an underscore are reserved for internal use. - $defaults = array( - '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 = array_merge( $defaults, $args ); - $args = (object) $args; - - $args->name = $post_type; 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' ); + _doing_it_wrong( __FUNCTION__, __( 'Post type names must be between 1 and 20 characters in length.' ), '4.2.0' ); 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 ) - $args->publicly_queryable = $args->public; - - // If not set, default to the setting for public. - if ( null === $args->show_ui ) - $args->show_ui = $args->public; - - // If not set, default to the setting for show_ui. - if ( null === $args->show_in_menu || ! $args->show_ui ) - $args->show_in_menu = $args->show_ui; - - // If not set, default to the whether the full UI is shown. - if ( null === $args->show_in_admin_bar ) - $args->show_in_admin_bar = (bool) $args->show_in_menu; - - // If not set, default to the setting for public. - if ( null === $args->show_in_nav_menus ) - $args->show_in_nav_menus = $args->public; - - // If not set, default to true if not public, false if public. - if ( null === $args->exclude_from_search ) - $args->exclude_from_search = !$args->public; - - // Back compat with quirky handling in version 3.0. #14122. - if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) ) - $args->map_meta_cap = true; - - // If not set, default to false. - if ( null === $args->map_meta_cap ) - $args->map_meta_cap = false; - - // If there's no specified edit link and no UI, remove the edit link. - if ( ! $args->show_ui && ! $has_edit_link ) { - $args->_edit_link = ''; - } - - $args->cap = get_post_type_capabilities( $args ); - unset( $args->capabilities ); + $post_type_object = new WP_Post_Type( $post_type, $args ); + $post_type_object->add_supports(); + $post_type_object->add_rewrite_rules(); + $post_type_object->register_meta_boxes(); - if ( is_array( $args->capability_type ) ) - $args->capability_type = $args->capability_type[0]; + $wp_post_types[ $post_type ] = $post_type_object; - if ( ! empty( $args->supports ) ) { - add_post_type_support( $post_type, $args->supports ); - unset( $args->supports ); - } elseif ( false !== $args->supports ) { - // Add default features - add_post_type_support( $post_type, array( 'title', 'editor' ) ); - } - - if ( false !== $args->query_var ) { - if ( true === $args->query_var ) - $args->query_var = $post_type; - else - $args->query_var = sanitize_title_with_dashes( $args->query_var ); - - if ( $wp && is_post_type_viewable( $args ) ) { - $wp->add_query_var( $args->query_var ); - } - } - - if ( false !== $args->rewrite && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) { - if ( ! is_array( $args->rewrite ) ) - $args->rewrite = array(); - if ( empty( $args->rewrite['slug'] ) ) - $args->rewrite['slug'] = $post_type; - if ( ! isset( $args->rewrite['with_front'] ) ) - $args->rewrite['with_front'] = true; - if ( ! isset( $args->rewrite['pages'] ) ) - $args->rewrite['pages'] = true; - if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive ) - $args->rewrite['feeds'] = (bool) $args->has_archive; - if ( ! isset( $args->rewrite['ep_mask'] ) ) { - if ( isset( $args->permalink_epmask ) ) - $args->rewrite['ep_mask'] = $args->permalink_epmask; - else - $args->rewrite['ep_mask'] = EP_PERMALINK; - } - - if ( $args->hierarchical ) - add_rewrite_tag( "%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&pagename=" ); - else - add_rewrite_tag( "%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=" ); - - if ( $args->has_archive ) { - $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive; - if ( $args->rewrite['with_front'] ) - $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug; - else - $archive_slug = $wp_rewrite->root . $archive_slug; - - add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' ); - if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) { - $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')'; - add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' ); - add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' ); - } - if ( $args->rewrite['pages'] ) - add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' ); - } - - $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 ); - - $args->labels = get_post_type_labels( $args ); - $args->label = $args->labels->name; - - $wp_post_types[ $post_type ] = $args; - - add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 ); - - foreach ( $args->taxonomies as $taxonomy ) { - register_taxonomy_for_object_type( $taxonomy, $post_type ); - } + $post_type_object->add_hooks(); + $post_type_object->register_taxonomies(); /** * Fires after a post type is registered. * * @since 3.3.0 + * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object. * - * @param string $post_type Post type. - * @param object $args Arguments used to register the post type. + * @param string $post_type Post type. + * @param WP_Post_Type $post_type_object Arguments used to register the post type. */ - do_action( 'registered_post_type', $post_type, $args ); + do_action( 'registered_post_type', $post_type, $post_type_object ); - return $args; + return $post_type_object; } /** @@ -1198,67 +1059,31 @@ function register_post_type( $post_type, $args = array() ) { * * @since 4.5.0 * - * @global WP_Rewrite $wp_rewrite WordPress rewrite component. - * @global WP $wp Current WordPress environment instance. - * @global array $_wp_post_type_features Used to remove post type features. - * @global array $post_type_meta_caps Used to remove meta capabilities. - * @global array $wp_post_types List of post types. + * @global array $wp_post_types List of post types. * * @param string $post_type Post type to unregister. * @return bool|WP_Error True on success, WP_Error on failure or if the post type doesn't exist. */ function unregister_post_type( $post_type ) { + global $wp_post_types; + if ( ! post_type_exists( $post_type ) ) { - return new WP_Error( 'invalid_post_type', __( 'Invalid post type' ) ); + return new WP_Error( 'invalid_post_type', __( 'Invalid post type.' ) ); } - $post_type_args = get_post_type_object( $post_type ); + $post_type_object = get_post_type_object( $post_type ); // Do not allow unregistering internal post types. - if ( $post_type_args->_builtin ) { + if ( $post_type_object->_builtin ) { return new WP_Error( 'invalid_post_type', __( 'Unregistering a built-in post type is not allowed' ) ); } - global $wp, $wp_rewrite, $_wp_post_type_features, $post_type_meta_caps, $wp_post_types; - - // Remove query var. - if ( false !== $post_type_args->query_var ) { - $wp->remove_query_var( $post_type_args->query_var ); - } + $post_type_object->remove_supports(); + $post_type_object->remove_rewrite_rules(); + $post_type_object->unregister_meta_boxes(); + $post_type_object->remove_hooks(); + $post_type_object->unregister_taxonomies(); - // Remove any rewrite rules, permastructs, and rules. - if ( false !== $post_type_args->rewrite ) { - remove_rewrite_tag( "%$post_type%" ); - remove_permastruct( $post_type ); - foreach ( $wp_rewrite->extra_rules_top as $regex => $query ) { - if ( false !== strpos( $query, "index.php?post_type=$post_type" ) ) { - unset( $wp_rewrite->extra_rules_top[ $regex ] ); - } - } - } - - // Remove registered custom meta capabilities. - foreach ( $post_type_args->cap as $cap ) { - unset( $post_type_meta_caps[ $cap ] ); - } - - // Remove all post type support. - unset( $_wp_post_type_features[ $post_type ] ); - - // Unregister the post type meta box if a custom callback was specified. - if ( $post_type_args->register_meta_box_cb ) { - remove_action( 'add_meta_boxes_' . $post_type, $post_type_args->register_meta_box_cb ); - } - - // Remove the post type from all taxonomies. - foreach ( get_object_taxonomies( $post_type ) as $taxonomy ) { - unregister_taxonomy_for_object_type( $taxonomy, $post_type ); - } - - // Remove the future post hook action. - remove_action( 'future_' . $post_type, '_future_post_hook', 5 ); - - // Remove the post type. unset( $wp_post_types[ $post_type ] ); /** @@ -1395,52 +1220,58 @@ function _post_type_meta_capabilities( $capabilities = null ) { } /** - * Build an object with all post type labels out of a post type object + * Builds an object with all post type labels out of a post type object. * * Accepted keys of the label array in the post type object: * - * - name - general name for the post type, usually plural. The same and overridden - * by $post_type_object->label. Default is Posts/Pages - * - singular_name - name for one object of this post type. Default is Post/Page - * - add_new - Default is Add New for both hierarchical and non-hierarchical types. - * When internationalizing this string, please use a 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. - * - archives - String for use with archives in nav menus. Default is Post Archives/Page Archives. - * - insert_into_item - String for the media frame button. Default is Insert into post/Insert into page. - * - uploaded_to_this_item - String for the media frame filter. Default is Uploaded to this post/Uploaded to this page. - * - 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`. - * - filter_items_list - String for the table views hidden heading. - * - items_list_navigation - String for the table pagination hidden heading. - * - items_list - String for the table hidden heading. + * - `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 https://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} + * matching your post type. Example: `_x( 'Add New', 'product', 'textdomain' );`. + * - `add_new_item` - Label for adding a new singular item. Default is 'Add New Post' / 'Add New Page'. + * - `edit_item` - Label for editing a singular item. Default is 'Edit Post' / 'Edit Page'. + * - `new_item` - Label for the new item page title. Default is 'New Post' / 'New Page'. + * - `view_item` - Label for viewing a singular item. Default is 'View Post' / 'View Page'. + * - `search_items` - Label for searching plural items. Default is 'Search Posts' / 'Search Pages'. + * - `not_found` - Label used when no items are found. Default is 'No posts found' / 'No pages found'. + * - `not_found_in_trash` - Label used when no items are in the trash. Default is 'No posts found in Trash' / + * 'No pages found in Trash'. + * - `parent_item_colon` - Label used to prefix parents of hierarchical items. Not used on non-hierarchical + * post types. Default is 'Parent Page:'. + * - `all_items` - Label to signify all items in a submenu link. Default is 'All Posts' / 'All Pages'. + * - `archives` - Label for archives in nav menus. Default is 'Post Archives' / 'Page Archives'. + * - `insert_into_item` - Label for the media frame button. Default is 'Insert into post' / 'Insert into page'. + * - `uploaded_to_this_item` - Label for the media frame filter. Default is 'Uploaded to this post' / + * 'Uploaded to this page'. + * - `featured_image` - Label for the Featured Image meta box title. Default is 'Featured Image'. + * - `set_featured_image` - Label for setting the featured image. Default is 'Set featured image'. + * - `remove_featured_image` - Label for removing the featured image. Default is 'Remove featured image'. + * - `use_featured_image` - Label in the media frame for using a featured image. Default is 'Use as featured image'. + * - `menu_name` - Label for the menu name. Default is the same as `name`. + * - `filter_items_list` - Label for the table views hidden heading. Default is 'Filter posts list' / + * 'Filter pages list'. + * - `items_list_navigation` - Label for the table pagination hidden heading. Default is 'Posts list navigation' / + * 'Pages list navigation'. + * - `items_list` - Label for the table hidden heading. Default is 'Posts list' / 'Pages list'. * * Above, the first default value is for non-hierarchical post types (like posts) * and the second one is for hierarchical post types (like pages). * + * Note: To set labels used in post type admin notices, see the {@see 'post_updated_messages'} filter. + * * @since 3.0.0 * @since 4.3.0 Added the `featured_image`, `set_featured_image`, `remove_featured_image`, * and `use_featured_image` labels. * @since 4.4.0 Added the `insert_into_item`, `uploaded_to_this_item`, `filter_items_list`, * `items_list_navigation`, and `items_list` labels. + * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object. * * @access private * - * @param object $post_type_object Post type object. - * @return object object with all the labels as member variables. + * @param object|WP_Post_Type $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( @@ -1476,7 +1307,7 @@ function get_post_type_labels( $post_type_object ) { $default_labels = clone $labels; /** - * Filter the labels of a specific post type. + * Filters the labels of a specific post type. * * The dynamic portion of the hook name, `$post_type`, refers to * the post type slug. @@ -1693,8 +1524,9 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) { * * @since 4.4.0 * @since 4.5.0 Added the ability to pass a post type name in addition to object. + * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object. * - * @param object $post_type Post type name or object. + * @param string|WP_Post_Type $post_type Post type name or object. * @return bool Whether the post type should be considered viewable. */ function is_post_type_viewable( $post_type ) { @@ -2039,7 +1871,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { if ( $prefixed ) { /** - * Filter the value of a specific post field to edit. + * Filters the value of a specific post field to edit. * * The dynamic portion of the hook name, `$field`, refers to the post * field name. @@ -2052,7 +1884,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { $value = apply_filters( "edit_{$field}", $value, $post_id ); /** - * Filter the value of a specific post field to edit. + * Filters 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. @@ -2079,7 +1911,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { if ( $prefixed ) { /** - * Filter the value of a specific post field before saving. + * Filters the value of a specific post field before saving. * * The dynamic portion of the hook name, `$field`, refers to the post * field name. @@ -2091,7 +1923,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { $value = apply_filters( "pre_{$field}", $value ); /** - * Filter the value of a specific field before saving. + * Filters the value of a specific field before saving. * * The dynamic portion of the hook name, `$field_no_prefix`, refers * to the post field name. @@ -2105,7 +1937,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { $value = apply_filters( "pre_post_{$field}", $value ); /** - * Filter the value of a specific post field before saving. + * Filters the value of a specific post field before saving. * * The dynamic portion of the hook name, `$field`, refers to the post * field name. @@ -2122,7 +1954,7 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { if ( $prefixed ) { /** - * Filter the value of a specific post field for display. + * Filters the value of a specific post field for display. * * The dynamic portion of the hook name, `$field`, refers to the post * field name. @@ -2139,12 +1971,13 @@ function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) { } else { $value = apply_filters( "post_{$field}", $value, $post_id, $context ); } - } - if ( 'attribute' == $context ) - $value = esc_attr($value); - elseif ( 'js' == $context ) - $value = esc_js($value); + if ( 'attribute' == $context ) { + $value = esc_attr( $value ); + } elseif ( 'js' == $context ) { + $value = esc_js( $value ); + } + } return $value; } @@ -2167,7 +2000,18 @@ function stick_post( $post_id ) { if ( ! in_array($post_id, $stickies) ) $stickies[] = $post_id; - update_option('sticky_posts', $stickies); + $updated = update_option( 'sticky_posts', $stickies ); + + if ( $updated ) { + /** + * Fires once a post has been added to the sticky list. + * + * @since 4.6.0 + * + * @param int $post_id ID of the post that was stuck. + */ + do_action( 'post_stuck', $post_id ); + } } /** @@ -2194,7 +2038,18 @@ function unstick_post( $post_id ) { array_splice($stickies, $offset, 1); - update_option('sticky_posts', $stickies); + $updated = update_option( 'sticky_posts', $stickies ); + + if ( $updated ) { + /** + * Fires once a post has been removed from the sticky list. + * + * @since 4.6.0 + * + * @param int $post_id ID of the post that was unstuck. + */ + do_action( 'post_unstuck', $post_id ); + } } /** @@ -2341,7 +2196,7 @@ function get_post_mime_types() { ); /** - * Filter the default list of post mime types. + * Filters the default list of post mime types. * * @since 2.5.0 * @@ -2486,7 +2341,7 @@ function wp_delete_post( $postid = 0, $force_delete = false ) { return wp_delete_attachment( $postid, $force_delete ); /** - * Filter whether a post deletion should take place. + * Filters whether a post deletion should take place. * * @since 4.4.0 * @@ -2851,8 +2706,10 @@ function wp_untrash_post_comments( $post = null ) { * * @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. + * @param array $args Optional. Category arguments. See wp_get_object_terms(). Default empty. + * @return array List of categories. If the `$fields` argument passed via `$args` is 'all' or + * 'all_with_object_id', an array of WP_Term objects will be returned. If `$fields` + * is 'ids', an array of category ids. If `$fields` is 'names', an array of category names. */ function wp_get_post_categories( $post_id = 0, $args = array() ) { $post_id = (int) $post_id; @@ -2869,7 +2726,7 @@ function wp_get_post_categories( $post_id = 0, $args = array() ) { * * There is only one default for this function, called 'fields' and by default * is set to 'all'. There are other defaults that can be overridden in - * {@link wp_get_object_terms()}. + * wp_get_object_terms(). * * @since 2.3.0 * @@ -2887,14 +2744,14 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) { * * There is only one default for this function, called 'fields' and by default * is set to 'all'. There are other defaults that can be overridden in - * {@link wp_get_object_terms()}. + * wp_get_object_terms(). * * @since 2.8.0 * * @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. + * @param array $args Optional. 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. */ @@ -2923,7 +2780,7 @@ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array( function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { if ( is_numeric( $args ) ) { - _deprecated_argument( __FUNCTION__, '3.1', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) ); + _deprecated_argument( __FUNCTION__, '3.1.0', __( 'Passing an integer number of posts is deprecated. Pass an array of arguments instead.' ) ); $args = array( 'numberposts' => absint( $args ) ); } @@ -3004,6 +2861,8 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { * @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. + * @type array $post_category Array of category names, slugs, or IDs. + * Defaults to value of the 'default_category' option. * @type array $tax_input Array of taxonomy terms keyed by their taxonomy name. Default empty. * @type array $meta_input Array of post meta values keyed by their post meta key. Default empty. * } @@ -3084,7 +2943,7 @@ function wp_insert_post( $postarr, $wp_error = false ) { && post_type_supports( $post_type, 'excerpt' ); /** - * Filter whether the post should be considered "empty". + * Filters 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 @@ -3252,7 +3111,7 @@ function wp_insert_post( $postarr, $wp_error = false ) { } /** - * Filter the post parent -- used to check for and prevent hierarchy loops. + * Filters the post parent -- used to check for and prevent hierarchy loops. * * @since 3.1.0 * @@ -3306,7 +3165,7 @@ function wp_insert_post( $postarr, $wp_error = false ) { if ( 'attachment' === $post_type ) { /** - * Filter attachment post data before it is updated in or added to the database. + * Filters attachment post data before it is updated in or added to the database. * * @since 3.9.0 * @@ -3316,7 +3175,7 @@ function wp_insert_post( $postarr, $wp_error = false ) { $data = apply_filters( 'wp_insert_attachment_data', $data, $postarr ); } else { /** - * Filter slashed post data just before it is inserted into the database. + * Filters slashed post data just before it is inserted into the database. * * @since 2.7.0 * @@ -3423,6 +3282,27 @@ function wp_insert_post( $postarr, $wp_error = false ) { } } + // Set or remove featured image. + if ( isset( $postarr['_thumbnail_id'] ) ) { + $thumbnail_support = current_theme_supports( 'post-thumbnails', $post_type ) && post_type_supports( $post_type, 'thumbnail' ) || 'revision' === $post_type; + if ( ! $thumbnail_support && 'attachment' === $post_type && $post_mime_type ) { + if ( wp_attachment_is( 'audio', $post_ID ) ) { + $thumbnail_support = post_type_supports( 'attachment:audio', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:audio' ); + } elseif ( wp_attachment_is( 'video', $post_ID ) ) { + $thumbnail_support = post_type_supports( 'attachment:video', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:video' ); + } + } + + if ( $thumbnail_support ) { + $thumbnail_id = intval( $postarr['_thumbnail_id'] ); + if ( -1 === $thumbnail_id ) { + delete_post_thumbnail( $post_ID ); + } else { + set_post_thumbnail( $post_ID, $thumbnail_id ); + } + } + } + clean_post_cache( $post_ID ); $post = get_post( $post_ID ); @@ -3669,7 +3549,7 @@ function check_and_publish_future_post( $post_id ) { return; } - // wp_publish_post(_ returns no meaningful value. + // wp_publish_post() returns no meaningful value. wp_publish_post( $post_id ); } @@ -3706,7 +3586,7 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p $post_name_check = $wpdb->get_var( $wpdb->prepare( $check_sql, $slug, $post_ID ) ); /** - * Filter whether the post slug would make a bad attachment slug. + * Filters whether the post slug would make a bad attachment slug. * * @since 3.1.0 * @@ -3734,7 +3614,7 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p $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. + * Filters whether the post slug would make a bad hierarchical post slug. * * @since 3.1.0 * @@ -3780,7 +3660,7 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p } /** - * Filter whether the post slug would be bad as a flat slug. + * Filters whether the post slug would be bad as a flat slug. * * @since 3.1.0 * @@ -3800,7 +3680,7 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p } /** - * Filter the unique post slug. + * Filters the unique post slug. * * @since 3.3.0 * @@ -3956,8 +3836,8 @@ function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $appe * 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 + * the generic {@see 'transition_post_status'} action, as well as the dynamic hooks + * {@see '$old_status_to_$new_status'} and {@see '$new_status_$post->post_type'}. Note * that the function does not transition the post object in the database. * * For instance: When publishing a post for the first time, the post status may transition @@ -4041,7 +3921,7 @@ function add_ping( $post_id, $uri ) { $new = implode("\n", $pung); /** - * Filter the new ping URL to add for the given post. + * Filters the new ping URL to add for the given post. * * @since 2.0.0 * @@ -4078,7 +3958,7 @@ function get_enclosed( $post_id ) { } /** - * Filter the list of enclosures already enclosed for the given post. + * Filters the list of enclosures already enclosed for the given post. * * @since 2.0.0 * @@ -4105,7 +3985,7 @@ function get_pung( $post_id ) { $pung = preg_split('/\s/', $pung); /** - * Filter the list of already-pinged URLs for the given post. + * Filters the list of already-pinged URLs for the given post. * * @since 2.0.0 * @@ -4131,7 +4011,7 @@ function get_to_ping( $post_id ) { $to_ping = preg_split('/\s/', $to_ping, -1, PREG_SPLIT_NO_EMPTY); /** - * Filter the list of URLs yet to ping for the given post. + * Filters the list of URLs yet to ping for the given post. * * @since 2.0.0 * @@ -4228,6 +4108,24 @@ function get_page( $page, $output = OBJECT, $filter = 'raw') { function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) { global $wpdb; + $last_changed = wp_cache_get( 'last_changed', 'posts' ); + if ( false === $last_changed ) { + $last_changed = microtime(); + wp_cache_set( 'last_changed', $last_changed, 'posts' ); + } + + $hash = md5( $page_path . serialize( $post_type ) ); + $cache_key = "get_page_by_path:$hash:$last_changed"; + $cached = wp_cache_get( $cache_key, 'posts' ); + if ( false !== $cached ) { + // Special case: '0' is a bad `$page_path`. + if ( '0' === $cached || 0 === $cached ) { + return; + } else { + return get_post( $cached, $output ); + } + } + $page_path = rawurlencode(urldecode($page_path)); $page_path = str_replace('%2F', '/', $page_path); $page_path = str_replace('%20', ' ', $page_path); @@ -4282,6 +4180,9 @@ function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) { } } + // We cache misses as well as hits. + wp_cache_set( $cache_key, $foundid, 'posts' ); + if ( $foundid ) { return get_post( $foundid, $output ); } @@ -4425,11 +4326,12 @@ function _page_traverse_name( $page_id, &$children, &$result ){ * Sub pages will be in the "directory" under the parent page post name. * * @since 1.5.0 + * @since 4.6.0 Converted the `$page` parameter to optional. * - * @param WP_Post|object|int $page Page object or page ID. + * @param WP_Post|object|int $page Optional. Page ID or WP_Post object. Default is global $post. * @return string|false Page URI, false on error. */ -function get_page_uri( $page ) { +function get_page_uri( $page = 0 ) { if ( ! $page instanceof WP_Post ) { $page = get_post( $page ); } @@ -4441,13 +4343,13 @@ function get_page_uri( $page ) { foreach ( $page->ancestors as $parent ) { $parent = get_post( $parent ); - if ( $parent ) { + if ( $parent && $parent->post_name ) { $uri = $parent->post_name . '/' . $uri; } } /** - * Filter the URI for a page. + * Filters the URI for a page. * * @since 4.4.0 * @@ -4742,7 +4644,7 @@ function get_pages( $args = array() ) { $pages = array_map( 'get_post', $pages ); /** - * Filter the retrieved list of pages. + * Filters the retrieved list of pages. * * @since 2.1.0 * @@ -4953,7 +4855,7 @@ function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) { return $data; /** - * Filter the attachment meta data. + * Filters the attachment meta data. * * @since 2.1.0 * @@ -4979,7 +4881,7 @@ function wp_update_attachment_metadata( $post_id, $data ) { return false; /** - * Filter the updated attachment meta data. + * Filters the updated attachment meta data. * * @since 2.1.0 * @@ -5043,7 +4945,7 @@ function wp_get_attachment_url( $post_id = 0 ) { } /** - * Filter the attachment URL. + * Filters the attachment URL. * * @since 2.1.0 * @@ -5058,6 +4960,37 @@ function wp_get_attachment_url( $post_id = 0 ) { return $url; } +/** + * Retrieves the caption for an attachment. + * + * @since 4.6.0 + * + * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`. + * @return string|false False on failure. Attachment caption on success. + */ +function wp_get_attachment_caption( $post_id = 0 ) { + $post_id = (int) $post_id; + if ( ! $post = get_post( $post_id ) ) { + return false; + } + + if ( 'attachment' !== $post->post_type ) { + return false; + } + + $caption = $post->post_excerpt; + + /** + * Filters the attachment caption. + * + * @since 4.6.0 + * + * @param string $caption Caption for the given attachment. + * @param int $post_id Attachment ID. + */ + return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID ); +} + /** * Retrieve thumbnail for an attachment. * @@ -5077,7 +5010,7 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) { if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) ) { /** - * Filter the attachment thumbnail file path. + * Filters the attachment thumbnail file path. * * @since 2.1.0 * @@ -5114,7 +5047,7 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) { $url = str_replace(basename($url), basename($thumb), $url); /** - * Filter the attachment thumbnail URL. + * Filters the attachment thumbnail URL. * * @since 2.1.0 * @@ -5129,12 +5062,12 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) { * * @since 4.2.0 * - * @param string $type Attachment type. Accepts 'image', 'audio', or 'video'. - * @param int|WP_Post $post_id Optional. Attachment ID. Default 0. + * @param string $type Attachment type. Accepts 'image', 'audio', or 'video'. + * @param int|WP_Post $post Optional. Attachment ID or object. Default is global $post. * @return bool True if one of the accepted types, false otherwise. */ -function wp_attachment_is( $type, $post_id = 0 ) { - if ( ! $post = get_post( $post_id ) ) { +function wp_attachment_is( $type, $post = null ) { + if ( ! $post = get_post( $post ) ) { return false; } @@ -5180,10 +5113,10 @@ function wp_attachment_is( $type, $post_id = 0 ) { * @since 4.2.0 Modified into wrapper for wp_attachment_is() and * allowed WP_Post object to be passed. * - * @param int|WP_Post $post Optional. Attachment ID. Default 0. + * @param int|WP_Post $post Optional. Attachment ID or object. Default is global $post. * @return bool Whether the attachment is an image. */ -function wp_attachment_is_image( $post = 0 ) { +function wp_attachment_is_image( $post = null ) { return wp_attachment_is( 'image', $post ); } @@ -5225,7 +5158,7 @@ function wp_mime_type_icon( $mime = 0 ) { if ( !is_array($icon_files) ) { /** - * Filter the icon directory path. + * Filters the icon directory path. * * @since 2.0.0 * @@ -5234,7 +5167,7 @@ function wp_mime_type_icon( $mime = 0 ) { $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' ); /** - * Filter the icon directory URI. + * Filters the icon directory URI. * * @since 2.0.0 * @@ -5243,7 +5176,7 @@ function wp_mime_type_icon( $mime = 0 ) { $icon_dir_uri = apply_filters( 'icon_dir_uri', includes_url( 'images/media' ) ); /** - * Filter the list of icon directory URIs. + * Filters the list of icon directory URIs. * * @since 2.5.0 * @@ -5303,7 +5236,7 @@ function wp_mime_type_icon( $mime = 0 ) { } /** - * Filter the mime type icon. + * Filters the mime type icon. * * @since 2.1.0 * @@ -5410,7 +5343,7 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, } /** - * Filter the capability to read private posts for a custom post type + * Filters the capability to read private posts for a custom post type * when generating SQL for getting posts by author. * * @since 2.2.0 @@ -5479,13 +5412,13 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, */ function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) { /** - * Filter the date the last post was published. + * Filters the date the last post was published. * * @since 2.3.0 * * @param string $date Date the last post was published. * @param string $timezone Location to use for getting the post published date. - * See {@see get_lastpostdate()} for accepted `$timezone` values. + * See get_lastpostdate() for accepted `$timezone` values. */ return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone ); } @@ -5500,7 +5433,7 @@ function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) { * @since 1.2.0 * @since 4.4.0 The `$post_type` argument was added. * - * @param string $timezone Optional. The timezone for the timestamp. See {@see get_lastpostdate()} + * @param string $timezone Optional. The timezone for the timestamp. See get_lastpostdate() * for information on accepted values. * Default 'server'. * @param string $post_type Optional. The post type to check. Default 'any'. @@ -5515,7 +5448,7 @@ function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) { * @param string $lastpostmodified Date the last post was modified. * Returning anything other than false will short-circuit the function. * @param string $timezone Location to use for getting the post modified date. - * See {@see get_lastpostdate()} for accepted `$timezone` values. + * See get_lastpostdate() for accepted `$timezone` values. * @param string $post_type The post type to check. */ $lastpostmodified = apply_filters( 'pre_get_lastpostmodified', false, $timezone, $post_type ); @@ -5531,13 +5464,13 @@ function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) { } /** - * Filter the date the last post was modified. + * Filters 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_lastpostdate()} for accepted `$timezone` values. + * See get_lastpostdate() for accepted `$timezone` values. */ return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone ); } @@ -5842,8 +5775,7 @@ function _transition_post_status( $new_status, $old_status, $post ) { * * @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()}. + * wp_transition_post_status() and the default filter for _future_post_hook(). * @param WP_Post $post Post object. */ function _future_post_hook( $deprecated, $post ) { @@ -5903,7 +5835,7 @@ function wp_get_post_parent_id( $post_ID ) { * Check the given subset of the post hierarchy for hierarchy loops. * * Prevents loops from forming and breaks those that it finds. Attached - * to the 'wp_insert_post_parent' filter. + * to the {@see 'wp_insert_post_parent'} filter. * * @since 3.1.0 * @@ -6109,7 +6041,7 @@ function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post } /** - * Adds a trashed suffix For a given post. + * Adds a trashed suffix for a given post. * * Store its desired (i.e. current) slug so it can try to reclaim it * if the post is untrashed. @@ -6120,6 +6052,7 @@ function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post * @access private * * @param WP_Post $post The post. + * @return string New slug for the post. */ function wp_add_trashed_suffix_to_post_name_for_post( $post ) { global $wpdb;