X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/53f4633144ed68c8b8fb5861f992b5489894a940..16e7b37c7914d753890c1a05a9335f3b43751eb8:/wp-includes/post.php
diff --git a/wp-includes/post.php b/wp-includes/post.php
index 912a03c8..c81f5c58 100644
--- a/wp-includes/post.php
+++ b/wp-includes/post.php
@@ -1,10 +1,9 @@
array(
- 'name_admin_bar' => _x( 'Post', 'add new on admin bar' ),
+ 'name_admin_bar' => _x( 'Post', 'add new from admin bar' ),
),
'public' => true,
'_builtin' => true, /* internal use only. don't use this when registering your own post type. */
'_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
'capability_type' => 'post',
'map_meta_cap' => true,
+ 'menu_position' => 5,
'hierarchical' => false,
'rewrite' => false,
'query_var' => false,
'delete_with_user' => true,
'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ),
+ 'show_in_rest' => true,
+ 'rest_base' => 'posts',
+ 'rest_controller_class' => 'WP_REST_Posts_Controller',
) );
register_post_type( 'page', array(
'labels' => array(
- 'name_admin_bar' => _x( 'Page', 'add new on admin bar' ),
+ 'name_admin_bar' => _x( 'Page', 'add new from admin bar' ),
),
'public' => true,
'publicly_queryable' => false,
@@ -43,11 +48,15 @@ function create_initial_post_types() {
'_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */
'capability_type' => 'page',
'map_meta_cap' => true,
+ 'menu_position' => 20,
'hierarchical' => true,
'rewrite' => false,
'query_var' => false,
'delete_with_user' => true,
'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ),
+ 'show_in_rest' => true,
+ 'rest_base' => 'pages',
+ 'rest_controller_class' => 'WP_REST_Posts_Controller',
) );
register_post_type( 'attachment', array(
@@ -57,6 +66,7 @@ function create_initial_post_types() {
'add_new' => _x( 'Add New', 'add new media' ),
'edit_item' => __( 'Edit Media' ),
'view_item' => __( 'View Attachment Page' ),
+ 'attributes' => __( 'Attachment Attributes' ),
),
'public' => true,
'show_ui' => true,
@@ -73,6 +83,9 @@ function create_initial_post_types() {
'show_in_nav_menus' => false,
'delete_with_user' => true,
'supports' => array( 'title', 'author', 'comments' ),
+ 'show_in_rest' => true,
+ 'rest_base' => 'media',
+ 'rest_controller_class' => 'WP_REST_Attachments_Controller',
) );
add_post_type_support( 'attachment:audio', 'thumbnail' );
add_post_type_support( 'attachment:video', 'thumbnail' );
@@ -108,43 +121,117 @@ function create_initial_post_types() {
'query_var' => false,
) );
+ register_post_type( 'custom_css', array(
+ 'labels' => array(
+ 'name' => __( 'Custom CSS' ),
+ 'singular_name' => __( 'Custom CSS' ),
+ ),
+ 'public' => false,
+ 'hierarchical' => false,
+ 'rewrite' => false,
+ 'query_var' => false,
+ 'delete_with_user' => false,
+ 'can_export' => true,
+ '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
+ 'supports' => array( 'title', 'revisions' ),
+ 'capabilities' => array(
+ 'delete_posts' => 'edit_theme_options',
+ 'delete_post' => 'edit_theme_options',
+ 'delete_published_posts' => 'edit_theme_options',
+ 'delete_private_posts' => 'edit_theme_options',
+ 'delete_others_posts' => 'edit_theme_options',
+ 'edit_post' => 'edit_css',
+ 'edit_posts' => 'edit_css',
+ 'edit_others_posts' => 'edit_css',
+ 'edit_published_posts' => 'edit_css',
+ 'read_post' => 'read',
+ 'read_private_posts' => 'read',
+ 'publish_posts' => 'edit_theme_options',
+ ),
+ ) );
+
+ register_post_type( 'customize_changeset', array(
+ 'labels' => array(
+ 'name' => _x( 'Changesets', 'post type general name' ),
+ 'singular_name' => _x( 'Changeset', 'post type singular name' ),
+ 'menu_name' => _x( 'Changesets', 'admin menu' ),
+ 'name_admin_bar' => _x( 'Changeset', 'add new on admin bar' ),
+ 'add_new' => _x( 'Add New', 'Customize Changeset' ),
+ 'add_new_item' => __( 'Add New Changeset' ),
+ 'new_item' => __( 'New Changeset' ),
+ 'edit_item' => __( 'Edit Changeset' ),
+ 'view_item' => __( 'View Changeset' ),
+ 'all_items' => __( 'All Changesets' ),
+ 'search_items' => __( 'Search Changesets' ),
+ 'not_found' => __( 'No changesets found.' ),
+ 'not_found_in_trash' => __( 'No changesets found in Trash.' ),
+ ),
+ 'public' => false,
+ '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
+ 'map_meta_cap' => true,
+ 'hierarchical' => false,
+ 'rewrite' => false,
+ 'query_var' => false,
+ 'can_export' => false,
+ 'delete_with_user' => false,
+ 'supports' => array( 'title', 'author' ),
+ 'capability_type' => 'customize_changeset',
+ 'capabilities' => array(
+ 'create_posts' => 'customize',
+ 'delete_others_posts' => 'customize',
+ 'delete_post' => 'customize',
+ 'delete_posts' => 'customize',
+ 'delete_private_posts' => 'customize',
+ 'delete_published_posts' => 'customize',
+ 'edit_others_posts' => 'customize',
+ 'edit_post' => 'customize',
+ 'edit_posts' => 'customize',
+ 'edit_private_posts' => 'customize',
+ 'edit_published_posts' => 'do_not_allow',
+ 'publish_posts' => 'customize',
+ 'read' => 'read',
+ 'read_post' => 'customize',
+ 'read_private_posts' => 'customize',
+ ),
+ ) );
+
register_post_status( 'publish', array(
- 'label' => _x( 'Published', 'post' ),
+ 'label' => _x( 'Published', 'post status' ),
'public' => true,
'_builtin' => true, /* internal use only. */
'label_count' => _n_noop( 'Published (%s)', 'Published (%s)' ),
) );
register_post_status( 'future', array(
- 'label' => _x( 'Scheduled', 'post' ),
+ 'label' => _x( 'Scheduled', 'post status' ),
'protected' => true,
'_builtin' => true, /* internal use only. */
'label_count' => _n_noop('Scheduled (%s)', 'Scheduled (%s)' ),
) );
register_post_status( 'draft', array(
- 'label' => _x( 'Draft', 'post' ),
+ 'label' => _x( 'Draft', 'post status' ),
'protected' => true,
'_builtin' => true, /* internal use only. */
'label_count' => _n_noop( 'Draft (%s)', 'Drafts (%s)' ),
) );
register_post_status( 'pending', array(
- 'label' => _x( 'Pending', 'post' ),
+ 'label' => _x( 'Pending', 'post status' ),
'protected' => true,
'_builtin' => true, /* internal use only. */
'label_count' => _n_noop( 'Pending (%s)', 'Pending (%s)' ),
) );
register_post_status( 'private', array(
- 'label' => _x( 'Private', 'post' ),
+ 'label' => _x( 'Private', 'post status' ),
'private' => true,
'_builtin' => true, /* internal use only. */
'label_count' => _n_noop( 'Private (%s)', 'Private (%s)' ),
) );
register_post_status( 'trash', array(
- 'label' => _x( 'Trash', 'post' ),
+ 'label' => _x( 'Trash', 'post status' ),
'internal' => true,
'_builtin' => true, /* internal use only. */
'label_count' => _n_noop( 'Trash (%s)', 'Trash (%s)' ),
@@ -185,14 +272,18 @@ function create_initial_post_types() {
*/
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 ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) )
+ if ( $file && 0 !== strpos( $file, '/' ) && ! preg_match( '|^.:\\\|', $file ) && ( ( $uploads = wp_get_upload_dir() ) && false === $uploads['error'] ) ) {
$file = $uploads['basedir'] . "/$file";
- if ( $unfiltered )
+ }
+
+ if ( $unfiltered ) {
return $file;
+ }
/**
- * Filter the attached file based on the given ID.
+ * Filters the attached file based on the given ID.
*
* @since 2.1.0
*
@@ -219,7 +310,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
*
@@ -247,14 +338,14 @@ function update_attached_file( $attachment_id, $file ) {
function _wp_relative_upload_path( $path ) {
$new_path = $path;
- $uploads = wp_upload_dir();
+ $uploads = wp_get_upload_dir();
if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) {
$new_path = str_replace( $uploads['basedir'], '', $new_path );
$new_path = ltrim( $new_path, '/' );
}
/**
- * Filter the relative path to an uploaded file.
+ * Filters the relative path to an uploaded file.
*
* @since 2.9.0
*
@@ -277,15 +368,14 @@ function _wp_relative_upload_path( $path ) {
* Attachments may also be made the child of a post, so if that is an accurate
* statement (which needs to be verified), it would then be possible to get
* all of the attachments for a post. Attachments have since changed since
- * version 2.5, so this is most likely unaccurate, but serves generally as an
+ * version 2.5, so this is most likely inaccurate, but serves generally as an
* 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
@@ -311,8 +401,8 @@ function _wp_relative_upload_path( $path ) {
* @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.
+ * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
* @return array Array of children, where the type of each element is determined by $output parameter.
* Empty array on failure.
*/
@@ -383,7 +473,7 @@ function get_children( $args = '', $output = OBJECT ) {
* @since 1.0.0
*
* @param string $post Post content.
- * @return array Post before ('main'), after ('extended'), and custom readmore ('more_text').
+ * @return array Post before ('main'), after ('extended'), and custom read more ('more_text').
*/
function get_extended( $post ) {
//Match the new style more links.
@@ -407,16 +497,16 @@ 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
*
* @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 $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Post object, an associative array, or a numeric array, respectively. 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.
@@ -454,338 +544,6 @@ function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
return $_post;
}
-/**
- * WordPress Post class.
- *
- * @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.
- *
- * 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.
- *
- * 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;
-
- $post_id = (int) $post_id;
- if ( ! $post_id )
- return false;
-
- $_post = wp_cache_get( $post_id, 'posts' );
-
- if ( ! $_post ) {
- $_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id ) );
-
- if ( ! $_post )
- return false;
-
- $_post = sanitize_post( $_post, 'raw' );
- wp_cache_add( $_post->ID, $_post, 'posts' );
- } elseif ( empty( $_post->filter ) ) {
- $_post = sanitize_post( $_post, 'raw' );
- }
-
- return new WP_Post( $_post );
- }
-
- /**
- * 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;
-
- if ( 'page_template' == $key )
- return ( 'page' == $this->post_type );
-
- if ( 'post_category' == $key )
- return true;
-
- if ( 'tags_input' == $key )
- return true;
-
- return metadata_exists( 'post', $this->ID, $key );
- }
-
- /**
- * 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 );
- }
-
- if ( 'post_category' == $key ) {
- if ( is_object_in_taxonomy( $this->post_type, 'category' ) )
- $terms = get_the_terms( $this, 'category' );
-
- if ( empty( $terms ) )
- return array();
-
- return wp_list_pluck( $terms, 'term_id' );
- }
-
- if ( 'tags_input' == $key ) {
- if ( is_object_in_taxonomy( $this->post_type, 'post_tag' ) )
- $terms = get_the_terms( $this, 'post_tag' );
-
- if ( empty( $terms ) )
- return array();
-
- return wp_list_pluck( $terms, 'name' );
- }
-
- // Rest of the values need filtering.
- if ( 'ancestors' == $key )
- $value = get_post_ancestors( $this );
- else
- $value = get_post_meta( $this->ID, $key, true );
-
- if ( $this->filter )
- $value = sanitize_post_field( $key, $value, $this->ID, $this->filter );
-
- return $value;
- }
-
- /**
- * {@Missing Summary}
- *
- * @param string $filter Filter.
- * @return self|array|bool|object|WP_Post
- */
- public function filter( $filter ) {
- if ( $this->filter == $filter )
- return $this;
-
- if ( $filter == 'raw' )
- return self::get_instance( $this->ID );
-
- return sanitize_post( $this, $filter );
- }
-
- /**
- * Convert object to array.
- *
- * @return array Object as array.
- */
- public function to_array() {
- $post = get_object_vars( $this );
-
- foreach ( array( 'ancestors', 'page_template', 'post_category', 'tags_input' ) as $key ) {
- if ( $this->__isset( $key ) )
- $post[ $key ] = $this->__get( $key );
- }
-
- return $post;
- }
-}
-
/**
* Retrieve ancestors of a post.
*
@@ -825,16 +583,17 @@ function get_post_ancestors( $post ) {
* supported values are found within those functions.
*
* @since 2.3.0
+ * @since 4.5.0 The `$post` parameter was made optional.
*
* @see sanitize_post_field()
*
* @param string $field Post field name.
- * @param int|WP_Post $post Post ID or post object.
+ * @param int|WP_Post $post Optional. Post ID or post object. Defaults to current post.
* @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' ) {
+function get_post_field( $field, $post = null, $context = 'display' ) {
$post = get_post( $post );
if ( !$post )
@@ -903,7 +662,15 @@ function get_post_status( $ID = '' ) {
}
- return $post->post_status;
+ /**
+ * Filters the post status.
+ *
+ * @since 4.4.0
+ *
+ * @param string $post_status The post status.
+ * @param WP_Post $post The post object.
+ */
+ return apply_filters( 'get_post_status', $post->post_status, $post );
}
/**
@@ -1136,7 +903,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
*
@@ -1151,24 +918,26 @@ 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;
- if ( empty($wp_post_types[$post_type]) )
+ if ( ! is_scalar( $post_type ) || empty( $wp_post_types[ $post_type ] ) ) {
return null;
+ }
- return $wp_post_types[$post_type];
+ return $wp_post_types[ $post_type ];
}
/**
@@ -1186,7 +955,7 @@ function get_post_type_object( $post_type ) {
* 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'.
+ * must match; 'not' means no elements may match. Default 'and'.
* @return array A list of post type names or objects.
*/
function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) {
@@ -1198,85 +967,108 @@ 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.6.0 Post type object returned is now an instance of WP_Post_Type.
+ * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
+ * arguments to register the post type in REST API.
*
- * @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.
*
- * @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 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() 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
+ * 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 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 and allow a 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 bool $show_in_rest Whether to add the post type route in the REST API 'wp/v2' namespace.
+ * @type string $rest_base To change the base url of REST API route. Default is $post_type.
+ * @type string $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'.
+ * @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 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 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
+ * $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
@@ -1292,194 +1084,107 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* 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'.
+ * @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.
+ * @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 ) )
+ 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' => '',
- '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 = (object) $args;
-
+ // Sanitize post type name
$post_type = sanitize_key( $post_type );
- $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;
+ $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 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;
+ $wp_post_types[ $post_type ] = $post_type_object;
- // If not set, default to the setting for public.
- if ( null === $args->show_in_nav_menus )
- $args->show_in_nav_menus = $args->public;
+ $post_type_object->add_hooks();
+ $post_type_object->register_taxonomies();
- // 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;
+ /**
+ * 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 WP_Post_Type $post_type_object Arguments used to register the post type.
+ */
+ do_action( 'registered_post_type', $post_type, $post_type_object );
- $args->cap = get_post_type_capabilities( $args );
- unset( $args->capabilities );
+ return $post_type_object;
+}
- if ( is_array( $args->capability_type ) )
- $args->capability_type = $args->capability_type[0];
+/**
+ * Unregisters a post type.
+ *
+ * Can not be used to unregister built-in post types.
+ *
+ * @since 4.5.0
+ *
+ * @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 ( ! 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 ( ! post_type_exists( $post_type ) ) {
+ return new WP_Error( 'invalid_post_type', __( 'Invalid post type.' ) );
}
- if ( false !== $args->query_var && ! empty( $wp ) ) {
- if ( true === $args->query_var )
- $args->query_var = $post_type;
- else
- $args->query_var = sanitize_title_with_dashes( $args->query_var );
- $wp->add_query_var( $args->query_var );
- }
-
- if ( false !== $args->rewrite && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
- if ( ! is_array( $args->rewrite ) )
- $args->rewrite = array();
- if ( empty( $args->rewrite['slug'] ) )
- $args->rewrite['slug'] = $post_type;
- if ( ! isset( $args->rewrite['with_front'] ) )
- $args->rewrite['with_front'] = true;
- if ( ! isset( $args->rewrite['pages'] ) )
- $args->rewrite['pages'] = true;
- if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive )
- $args->rewrite['feeds'] = (bool) $args->has_archive;
- if ( ! isset( $args->rewrite['ep_mask'] ) ) {
- if ( isset( $args->permalink_epmask ) )
- $args->rewrite['ep_mask'] = $args->permalink_epmask;
- else
- $args->rewrite['ep_mask'] = EP_PERMALINK;
- }
-
- if ( $args->hierarchical )
- add_rewrite_tag( "%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&pagename=" );
- else
- add_rewrite_tag( "%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=" );
+ $post_type_object = get_post_type_object( $post_type );
- 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 );
+ // Do not allow unregistering internal post types.
+ if ( $post_type_object->_builtin ) {
+ return new WP_Error( 'invalid_post_type', __( 'Unregistering a built-in post type is not allowed' ) );
}
- // 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 );
+ $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();
- $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 );
- }
+ unset( $wp_post_types[ $post_type ] );
/**
- * Fires after a post type is registered.
+ * Fires after a post type was unregistered.
*
- * @since 3.3.0
+ * @since 4.5.0
*
- * @param string $post_type Post type.
- * @param object $args Arguments used to register the post type.
+ * @param string $post_type Post type key.
*/
- do_action( 'registered_post_type', $post_type, $args );
+ do_action( 'unregistered_post_type', $post_type );
- return $args;
+ return true;
}
/**
@@ -1589,58 +1294,76 @@ function get_post_type_capabilities( $args ) {
* @since 3.1.0
* @access private
*
- * @staticvar array $meta_caps
+ * @global array $post_type_meta_caps Used to store meta capabilities.
*
- * @param array|void $capabilities Post type meta capabilities.
+ * @param array $capabilities Post type meta capabilities.
*/
function _post_type_meta_capabilities( $capabilities = null ) {
- static $meta_caps = array();
- if ( null === $capabilities )
- return $meta_caps;
+ global $post_type_meta_caps;
+
foreach ( $capabilities as $core => $custom ) {
- if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) )
- $meta_caps[ $custom ] = $core;
+ if ( in_array( $core, array( 'read_post', 'delete_post', 'edit_post' ) ) ) {
+ $post_type_meta_caps[ $custom ] = $core;
+ }
}
}
/**
- * 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.
- * - 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`.
+ * - `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'.
+ * - `view_items` - Label for viewing post type archives. Default is 'View Posts' / 'View Pages'.
+ * - `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'.
+ * - `attributes` - Label for the attributes meta box. Default is 'Post Attributes' / 'Page Attributes'.
+ * - `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.
+ * @since 4.7.0 Added the `view_items` and `attributes` labels.
+ *
* @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(
@@ -1651,15 +1374,23 @@ function get_post_type_labels( $post_type_object ) {
'edit_item' => array( __('Edit Post'), __('Edit Page') ),
'new_item' => array( __('New Post'), __('New Page') ),
'view_item' => array( __('View Post'), __('View Page') ),
+ 'view_items' => array( __('View Posts'), __('View Pages') ),
'search_items' => array( __('Search Posts'), __('Search Pages') ),
'not_found' => array( __('No posts found.'), __('No pages found.') ),
'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ),
'parent_item_colon' => array( null, __('Parent Page:') ),
'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) ),
+ 'archives' => array( __( 'Post Archives' ), __( 'Page Archives' ) ),
+ 'attributes' => array( __( 'Post Attributes' ), __( 'Page Attributes' ) ),
+ 'insert_into_item' => array( __( 'Insert into post' ), __( 'Insert into page' ) ),
+ 'uploaded_to_this_item' => array( __( 'Uploaded to this post' ), __( 'Uploaded to this page' ) ),
'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' ) ),
+ 'filter_items_list' => array( __( 'Filter posts list' ), __( 'Filter pages list' ) ),
+ 'items_list_navigation' => array( __( 'Posts list navigation' ), __( 'Pages list navigation' ) ),
+ 'items_list' => array( __( 'Posts list' ), __( 'Pages list' ) ),
);
$nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
@@ -1667,8 +1398,10 @@ function get_post_type_labels( $post_type_object ) {
$post_type = $post_type_object->name;
+ $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.
@@ -1679,7 +1412,12 @@ function get_post_type_labels( $post_type_object ) {
*
* @param object $labels Object with labels for the post type as member variables.
*/
- return apply_filters( "post_type_labels_{$post_type}", $labels );
+ $labels = apply_filters( "post_type_labels_{$post_type}", $labels );
+
+ // Ensure that the filtered labels contain all required default values.
+ $labels = (object) array_merge( (array) $default_labels, (array) $labels );
+
+ return $labels;
}
/**
@@ -1691,6 +1429,7 @@ function get_post_type_labels( $post_type_object ) {
*
* @param object $object A custom-something object.
* @param array $nohier_vs_hier_defaults Hierarchical vs non-hierarchical default labels.
+ * @return object Object containing labels for the given custom-something object.
*/
function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
$object->labels = (array) $object->labels;
@@ -1710,11 +1449,17 @@ 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'];
+ if ( !isset( $object->labels['archives'] ) && isset( $object->labels['all_items'] ) ) {
+ $object->labels['archives'] = $object->labels['all_items'];
+ }
+
$defaults = array();
foreach ( $nohier_vs_hier_defaults as $key => $value ) {
$defaults[$key] = $object->hierarchical ? $value[1] : $value[0];
}
$labels = array_merge( $defaults, $object->labels );
+ $object->labels = (object) $object->labels;
+
return (object) $labels;
}
@@ -1818,6 +1563,28 @@ function post_type_supports( $post_type, $feature ) {
return ( isset( $_wp_post_type_features[$post_type][$feature] ) );
}
+/**
+ * Retrieves a list of post type names that support a specific feature.
+ *
+ * @since 4.5.0
+ *
+ * @global array $_wp_post_type_features Post type features
+ *
+ * @param array|string $feature Single feature or an array of features the post types should support.
+ * @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; 'not' means no elements may
+ * match. Default 'and'.
+ * @return array A list of post type names.
+ */
+function get_post_types_by_support( $feature, $operator = 'and' ) {
+ global $_wp_post_type_features;
+
+ $features = array_fill_keys( (array) $feature, true );
+
+ return array_keys( wp_filter_object_list( $_wp_post_type_features, $features, $operator ) );
+}
+
/**
* Update the post type for the post ID.
*
@@ -1843,6 +1610,30 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) {
return $return;
}
+/**
+ * Determines whether a post type is considered "viewable".
+ *
+ * For built-in post types such as posts and pages, the 'public' value will be evaluated.
+ * For all others, the 'publicly_queryable' value will be used.
+ *
+ * @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 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 ) {
+ if ( is_scalar( $post_type ) ) {
+ $post_type = get_post_type_object( $post_type );
+ if ( ! $post_type ) {
+ return false;
+ }
+ }
+
+ return $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public );
+}
+
/**
* Retrieve list of latest posts or posts matching criteria.
*
@@ -1853,28 +1644,23 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) {
* @see WP_Query::parse_query()
*
* @param array $args {
- * Optional. Arguments to retrieve posts. {@see WP_Query::parse_query()} for more
+ * Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all
* 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.
+ * in WP_Query. Accepts -1 for all. Default 5.
* @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 ) {
$defaults = array(
- 'numberposts' => 5, 'offset' => 0,
+ 'numberposts' => 5,
'category' => 0, 'orderby' => 'date',
'order' => 'DESC', 'include' => array(),
'exclude' => array(), 'meta_key' => '',
@@ -2122,7 +1908,7 @@ function sanitize_post( $post, $context = 'display' ) {
foreach ( array_keys(get_object_vars($post)) as $field )
$post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context);
$post->filter = $context;
- } else {
+ } elseif ( is_array( $post ) ) {
// Check if post already filtered for this context.
if ( isset($post['filter']) && $context == $post['filter'] )
return $post;
@@ -2143,15 +1929,16 @@ function sanitize_post( $post, $context = 'display' ) {
* are treated like 'display' when calling filters.
*
* @since 2.3.0
+ * @since 4.4.0 Like `sanitize_post()`, `$context` defaults to 'display'.
*
* @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 $context Optional. How to sanitize post fields. Looks for 'raw', 'edit',
+ * 'db', 'display', 'attribute' and 'js'. Default 'display'.
* @return mixed Sanitized value.
*/
-function sanitize_post_field($field, $value, $post_id, $context) {
+function sanitize_post_field( $field, $value, $post_id, $context = 'display' ) {
$int_fields = array('ID', 'post_parent', 'menu_order');
if ( in_array($field, $int_fields) )
$value = (int) $value;
@@ -2178,7 +1965,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
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.
@@ -2191,7 +1978,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
$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.
@@ -2218,7 +2005,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
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.
@@ -2230,7 +2017,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
$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.
@@ -2244,7 +2031,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
$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.
@@ -2261,7 +2048,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
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.
@@ -2278,12 +2065,13 @@ function sanitize_post_field($field, $value, $post_id, $context) {
} 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;
}
@@ -2306,7 +2094,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 );
+ }
}
/**
@@ -2333,7 +2132,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 );
+ }
}
/**
@@ -2369,7 +2179,7 @@ function _count_posts_cache_key( $type = 'post', $perm = '' ) {
*
* @since 2.5.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $type Optional. Post type to retrieve count. Default 'post'.
* @param string $perm Optional. 'readable' or empty. Default empty.
@@ -2434,7 +2244,7 @@ function wp_count_posts( $type = 'post', $perm = '' ) {
*
* @since 2.5.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param string|array $mime_type Optional. Array or comma-separated list of
* MIME patterns. Default empty.
@@ -2447,7 +2257,7 @@ function wp_count_attachments( $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 );
$counts = array();
- foreach( (array) $count as $row ) {
+ foreach ( (array) $count as $row ) {
$counts[ $row['post_mime_type'] ] = $row['num_posts'];
}
$counts['trash'] = $wpdb->get_var( "SELECT COUNT( * ) FROM $wpdb->posts WHERE post_type = 'attachment' AND post_status = 'trash' $and");
@@ -2480,7 +2290,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
*
@@ -2624,6 +2434,20 @@ function wp_delete_post( $postid = 0, $force_delete = false ) {
if ( $post->post_type == 'attachment' )
return wp_delete_attachment( $postid, $force_delete );
+ /**
+ * Filters whether a post deletion should take place.
+ *
+ * @since 4.4.0
+ *
+ * @param bool $delete Whether to go forward with deletion.
+ * @param WP_Post $post Post object.
+ * @param bool $force_delete Whether to bypass the trash.
+ */
+ $check = apply_filters( 'pre_delete_post', null, $post, $force_delete );
+ if ( null !== $check ) {
+ return $check;
+ }
+
/**
* Fires before a post is deleted, at the start of wp_delete_post().
*
@@ -2647,8 +2471,9 @@ function wp_delete_post( $postid = 0, $force_delete = false ) {
// 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 ( $children ) {
+ $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) );
+ }
}
// Do raw query. wp_get_post_revisions() is filtered.
@@ -2660,9 +2485,14 @@ function wp_delete_post( $postid = 0, $force_delete = false ) {
// Point all attachments to this post up one level.
$wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
+ wp_defer_comment_counting( true );
+
$comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid ));
- foreach ( $comment_ids as $comment_id )
+ foreach ( $comment_ids as $comment_id ) {
wp_delete_comment( $comment_id, true );
+ }
+
+ wp_defer_comment_counting( false );
$post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $postid ));
foreach ( $post_meta_ids as $mid )
@@ -2778,7 +2608,7 @@ function wp_trash_post( $post_id = 0 ) {
add_post_meta($post_id,'_wp_trash_meta_time', time());
$post['post_status'] = 'trash';
- wp_insert_post($post);
+ wp_insert_post( wp_slash( $post ) );
wp_trash_post_comments($post_id);
@@ -2825,7 +2655,7 @@ function wp_untrash_post( $post_id = 0 ) {
delete_post_meta($post_id, '_wp_trash_meta_status');
delete_post_meta($post_id, '_wp_trash_meta_time');
- wp_insert_post($post);
+ wp_insert_post( wp_slash( $post ) );
wp_untrash_post_comments($post_id);
@@ -2902,7 +2732,7 @@ function wp_trash_post_comments( $post = null ) {
*
* @since 2.9.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
* @return true|void
@@ -2970,8 +2800,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;
@@ -2988,12 +2820,12 @@ 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
*
* @param int $post_id Optional. The Post ID. Does not default to the ID of the
- * global $post. Defualt 0.
+ * global $post. Default 0.
* @param array $args Optional. Overwrite the defaults
* @return array List of post tags.
*/
@@ -3006,14 +2838,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.
*/
@@ -3035,14 +2867,16 @@ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array(
*
* @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.
+ * @param array $args Optional. Arguments to retrieve posts. Default empty array.
+ * @param string $output Optional. The required return type. One of OBJECT or ARRAY_A, which correspond to
+ * a WP_Post object or an associative array, respectively. Default ARRAY_A.
+ * @return array|false Array of recent posts, where the type of each element is determined by $output parameter.
+ * Empty array on failure.
*/
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 ) );
}
@@ -3062,7 +2896,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
// Backward compatibility. Prior to 3.1 expected posts to be returned in array.
if ( ARRAY_A == $output ){
- foreach( $results as $key => $result ) {
+ foreach ( $results as $key => $result ) {
$results[$key] = get_object_vars( $result );
}
return $results ? $results : array();
@@ -3083,6 +2917,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
*
* @since 1.0.0
* @since 4.2.0 Support was added for encoding emoji in the post title, content, and excerpt.
+ * @since 4.4.0 A 'meta_input' array can now be passed to `$postarr` to add post meta data.
*
* @see sanitize_post()
* @global wpdb $wpdb WordPress database abstraction object.
@@ -3108,7 +2943,8 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
* @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 $post_name The post name. Default is the sanitized post title
+ * when creating a new post.
* @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
@@ -3121,8 +2957,12 @@ 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.
* }
- * @param bool $wp_error Optional. Whether to allow return of WP_Error on failure. Default false.
+ * @param bool $wp_error Optional. Whether to return a 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 ) {
@@ -3187,6 +3027,9 @@ function wp_insert_post( $postarr, $wp_error = false ) {
$post_excerpt = $postarr['post_excerpt'];
if ( isset( $postarr['post_name'] ) ) {
$post_name = $postarr['post_name'];
+ } elseif ( $update ) {
+ // For an update, don't modify the post_name if it wasn't supplied as an argument.
+ $post_name = $post_before->post_name;
}
$maybe_empty = 'attachment' !== $post_type
@@ -3196,7 +3039,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
@@ -3220,7 +3063,7 @@ function wp_insert_post( $postarr, $wp_error = false ) {
}
$post_status = empty( $postarr['post_status'] ) ? 'draft' : $postarr['post_status'];
- if ( 'attachment' === $post_type && ! in_array( $post_status, array( 'inherit', 'private', 'trash' ) ) ) {
+ if ( 'attachment' === $post_type && ! in_array( $post_status, array( 'inherit', 'private', 'trash', 'auto-draft' ), true ) ) {
$post_status = 'inherit';
}
@@ -3269,7 +3112,11 @@ function wp_insert_post( $postarr, $wp_error = false ) {
* 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' );
+ if ( empty( $postarr['post_date_gmt'] ) || '0000-00-00 00:00:00' == $postarr['post_date_gmt'] ) {
+ $post_date = current_time( 'mysql' );
+ } else {
+ $post_date = get_date_from_gmt( $postarr['post_date_gmt'] );
+ }
} else {
$post_date = $postarr['post_date'];
}
@@ -3281,7 +3128,7 @@ function wp_insert_post( $postarr, $wp_error = false ) {
$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.' ) );
+ return new WP_Error( 'invalid_date', __( 'Invalid date.' ) );
} else {
return 0;
}
@@ -3332,7 +3179,7 @@ function wp_insert_post( $postarr, $wp_error = false ) {
// 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'];
+ $post_author = isset( $postarr['post_author'] ) ? $postarr['post_author'] : $user_id;
$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'] : '';
@@ -3360,7 +3207,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
*
@@ -3371,6 +3218,28 @@ function wp_insert_post( $postarr, $wp_error = false ) {
*/
$post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr );
+ /*
+ * If the post is being untrashed and it has a desired slug stored in post meta,
+ * reassign it.
+ */
+ if ( 'trash' === $previous_status && 'trash' !== $post_status ) {
+ $desired_post_slug = get_post_meta( $post_ID, '_wp_desired_post_slug', true );
+ if ( $desired_post_slug ) {
+ delete_post_meta( $post_ID, '_wp_desired_post_slug' );
+ $post_name = $desired_post_slug;
+ }
+ }
+
+ // If a trashed post has the desired slug, change it and let this post have it.
+ if ( 'trash' !== $post_status && $post_name ) {
+ wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post_ID );
+ }
+
+ // When trashing an existing post, change its slug to allow non-trashed posts to use it.
+ if ( 'trash' === $post_status && 'trash' !== $previous_status && 'new' !== $previous_status ) {
+ $post_name = wp_add_trashed_suffix_to_post_name_for_post( $post_ID );
+ }
+
$post_name = wp_unique_post_slug( $post_name, $post_ID, $post_status, $post_type, $post_parent );
// Don't unslash.
@@ -3381,7 +3250,7 @@ function wp_insert_post( $postarr, $wp_error = false ) {
$emoji_fields = array( 'post_title', 'post_content', 'post_excerpt' );
- foreach( $emoji_fields as $emoji_field ) {
+ foreach ( $emoji_fields as $emoji_field ) {
if ( isset( $data[ $emoji_field ] ) ) {
$charset = $wpdb->get_col_charset( $wpdb->posts, $emoji_field );
if ( 'utf8' === $charset ) {
@@ -3392,7 +3261,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
*
@@ -3402,7 +3271,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
*
@@ -3470,6 +3339,12 @@ function wp_insert_post( $postarr, $wp_error = false ) {
if ( ! empty( $postarr['tax_input'] ) ) {
foreach ( $postarr['tax_input'] as $taxonomy => $tags ) {
$taxonomy_obj = get_taxonomy($taxonomy);
+ if ( ! $taxonomy_obj ) {
+ /* translators: %s: taxonomy name */
+ _doing_it_wrong( __FUNCTION__, sprintf( __( 'Invalid taxonomy: %s.' ), $taxonomy ), '4.4.0' );
+ continue;
+ }
+
// array = hierarchical, string = non-hierarchical.
if ( is_array( $tags ) ) {
$tags = array_filter($tags);
@@ -3480,6 +3355,12 @@ function wp_insert_post( $postarr, $wp_error = false ) {
}
}
+ if ( ! empty( $postarr['meta_input'] ) ) {
+ foreach ( $postarr['meta_input'] as $field => $value ) {
+ update_post_meta( $post_ID, $field, $value );
+ }
+ }
+
$current_guid = get_post_field( 'guid', $post_ID );
// Set GUID.
@@ -3497,16 +3378,37 @@ 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 );
- if ( ! empty( $postarr['page_template'] ) && 'page' == $data['post_type'] ) {
+ if ( ! empty( $postarr['page_template'] ) ) {
$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.'));
+ return new WP_Error( 'invalid_page_template', __( 'Invalid page template.' ) );
}
update_post_meta( $post_ID, '_wp_page_template', 'default' );
} else {
@@ -3526,6 +3428,18 @@ function wp_insert_post( $postarr, $wp_error = false ) {
* @param int $post_ID Attachment ID.
*/
do_action( 'edit_attachment', $post_ID );
+ $post_after = get_post( $post_ID );
+
+ /**
+ * Fires once an existing attachment has been updated.
+ *
+ * @since 4.4.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( 'attachment_updated', $post_ID, $post_after, $post_before );
} else {
/**
@@ -3731,7 +3645,7 @@ function check_and_publish_future_post( $post_id ) {
return;
}
- // wp_publish_post(_ returns no meaninful value
+ // wp_publish_post() returns no meaningful value.
wp_publish_post( $post_id );
}
@@ -3768,14 +3682,14 @@ 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
*
* @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 ) ) {
+ if ( $post_name_check || in_array( $slug, $feeds ) || 'embed' === $slug || apply_filters( 'wp_unique_post_slug_is_bad_attachment_slug', false, $slug ) ) {
$suffix = 2;
do {
$alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
@@ -3796,7 +3710,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
*
@@ -3805,7 +3719,7 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p
* @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 ) ) {
+ if ( $post_name_check || in_array( $slug, $feeds ) || 'embed' === $slug || 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 = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
@@ -3842,7 +3756,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
*
@@ -3850,7 +3764,7 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p
* @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 ) ) {
+ if ( $post_name_check || in_array( $slug, $feeds ) || 'embed' === $slug || $conflicts_with_date_archive || apply_filters( 'wp_unique_post_slug_is_bad_flat_slug', false, $slug, $post_type ) ) {
$suffix = 2;
do {
$alt_post_name = _truncate_post_slug( $slug, 200 - ( strlen( $suffix ) + 1 ) ) . "-$suffix";
@@ -3862,7 +3776,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
*
@@ -3907,10 +3821,10 @@ function _truncate_post_slug( $slug, $length = 200 ) {
*
* @since 2.3.0
*
- * @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.
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post.
+ * @param string|array $tags Optional. An array of tags to set for the post, or a string of tags
+ * separated by commas. Default empty.
+ * @return array|false|WP_Error Array of affected term IDs. WP_Error or false on failure.
*/
function wp_add_post_tags( $post_id = 0, $tags = '' ) {
return wp_set_post_tags($post_id, $tags, true);
@@ -3923,12 +3837,12 @@ function wp_add_post_tags( $post_id = 0, $tags = '' ) {
*
* @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.
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post.
+ * @param string|array $tags Optional. An array of tags to set for the post, or a string of tags
+ * 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 term taxonomy IDs of affected terms. 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);
@@ -3941,12 +3855,13 @@ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
*
* @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.
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post.
+ * @param string|array $tags Optional. An array of terms to set for the post, or a string of terms
+ * separated by commas. Default empty.
+ * @param string $taxonomy Optional. Taxonomy name. Default 'post_tag'.
+ * @param bool $append Optional. If true, don't delete existing terms, just add on. If false,
+ * replace the terms with the new terms. Default false.
+ * @return array|false|WP_Error Array of term taxonomy IDs of affected terms. 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;
@@ -3989,7 +3904,7 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a
* 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
+ * @return array|false|WP_Error Array of term taxonomy IDs of affected categories. WP_Error or false on failure.
*/
function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $append = false ) {
$post_ID = (int) $post_ID;
@@ -4017,8 +3932,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
@@ -4086,23 +4001,36 @@ function wp_transition_post_status( $new_status, $old_status, $post ) {
* Add a URL to those already pinged.
*
* @since 1.5.0
+ * @since 4.7.0 $post_id can be a WP_Post object.
+ * @since 4.7.0 $uri can be an array of URIs.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int $post_id Post ID.
- * @param string $uri Ping URI.
+ * @param int|WP_Post $post_id Post object or ID.
+ * @param string|array $uri Ping URI or array of URIs.
* @return int|false How many rows were updated.
*/
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;
+
+ $post = get_post( $post_id );
+ if ( ! $post ) {
+ return false;
+ }
+
+ $pung = trim( $post->pinged );
+ $pung = preg_split( '/\s/', $pung );
+
+ if ( is_array( $uri ) ) {
+ $pung = array_merge( $pung, $uri );
+ }
+ else {
+ $pung[] = $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
*
@@ -4110,9 +4038,9 @@ function add_ping( $post_id, $uri ) {
*/
$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 ) );
+ $return = $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post->ID ) );
+ clean_post_cache( $post->ID );
+ return $return;
}
/**
@@ -4132,14 +4060,14 @@ function get_enclosed( $post_id ) {
foreach ( $custom_fields as $key => $val ) {
if ( 'enclosure' != $key || !is_array( $val ) )
continue;
- foreach( $val as $enc ) {
+ foreach ( $val as $enc ) {
$enclosure = explode( "\n", $enc );
$pung[] = trim( $enclosure[ 0 ] );
}
}
/**
- * 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
*
@@ -4154,19 +4082,22 @@ function get_enclosed( $post_id ) {
*
* @since 1.5.0
*
- * @global wpdb $wpdb WordPress database abstraction object.
+ * @since 4.7.0 $post_id can be a WP_Post object.
*
- * @param int $post_id Post ID.
+ * @param int|WP_Post $post_id Post ID or object.
* @return array
*/
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);
+ $post = get_post( $post_id );
+ if ( ! $post ) {
+ return false;
+ }
+
+ $pung = trim( $post->pinged );
+ $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
*
@@ -4179,20 +4110,23 @@ function get_pung( $post_id ) {
* Retrieve URLs that need to be pinged.
*
* @since 1.5.0
+ * @since 4.7.0 $post_id can be a WP_Post object.
*
- * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @param int $post_id Post ID
+ * @param int|WP_Post $post_id Post Object or ID
* @return array
*/
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 );
+ $post = get_post( $post_id );
+
+ if ( ! $post ) {
+ return false;
+ }
+
+ $to_ping = sanitize_trackback_urls( $post->to_ping );
$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
*
@@ -4222,7 +4156,7 @@ function trackback_url_list( $tb_list, $post_id ) {
}
$trackback_urls = explode( ',', $tb_list );
- foreach( (array) $trackback_urls as $tb_url ) {
+ foreach ( (array) $trackback_urls as $tb_url ) {
$tb_url = trim( $tb_url );
trackback( $tb_url, wp_unslash( $postdata['post_title'] ), $excerpt, $post_id );
}
@@ -4263,11 +4197,11 @@ function get_all_page_ids() {
* @deprecated 3.5.0 Use get_post()
*
* @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 $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Post object, an associative array, or a numeric array, respectively. 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.
+ * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
*/
function get_page( $page, $output = OBJECT, $filter = 'raw') {
return get_post( $page, $output, $filter );
@@ -4281,14 +4215,28 @@ function get_page( $page, $output = OBJECT, $filter = 'raw') {
* @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 $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Post object, an associative array, or a numeric array, respectively. 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.
+ * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
*/
function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
global $wpdb;
+ $last_changed = wp_cache_get_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);
@@ -4322,6 +4270,11 @@ function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
if ( $page->post_name == $revparts[0] ) {
$count = 0;
$p = $page;
+
+ /*
+ * Loop through the given path parts from right to left,
+ * ensuring each matches the post ancestry.
+ */
while ( $p->post_parent != 0 && isset( $pages[ $p->post_parent ] ) ) {
$count++;
$parent = $pages[ $p->post_parent ];
@@ -4338,6 +4291,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 );
}
@@ -4351,10 +4307,10 @@ function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
* @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 $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Post object, an associative array, or a numeric array, respectively. 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
+ * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
*/
function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) {
global $wpdb;
@@ -4463,12 +4419,12 @@ function get_page_hierarchy( &$pages, $page_id = 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.
+ * @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 ] ) ){
- foreach( (array)$children[ $page_id ] as $child ) {
+ foreach ( (array)$children[ $page_id ] as $child ) {
$result[ $child->ID ] = $child->post_name;
_page_traverse_name( $child->ID, $children, $result );
}
@@ -4476,17 +4432,20 @@ function _page_traverse_name( $page_id, &$children, &$result ){
}
/**
- * Build URI for a page.
+ * Build the URI path for a page.
*
* 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 ) {
- $page = get_post( $page );
+function get_page_uri( $page = 0 ) {
+ if ( ! $page instanceof WP_Post ) {
+ $page = get_post( $page );
+ }
if ( ! $page )
return false;
@@ -4494,10 +4453,21 @@ function get_page_uri( $page ) {
$uri = $page->post_name;
foreach ( $page->ancestors as $parent ) {
- $uri = get_post( $parent )->post_name . '/' . $uri;
+ $parent = get_post( $parent );
+ if ( $parent && $parent->post_name ) {
+ $uri = $parent->post_name . '/' . $uri;
+ }
}
- return $uri;
+ /**
+ * Filters the URI for a page.
+ *
+ * @since 4.4.0
+ *
+ * @param string $uri Page URI.
+ * @param WP_Post $page Page object.
+ */
+ return apply_filters( 'get_page_uri', $uri, $page );
}
/**
@@ -4510,15 +4480,18 @@ function get_page_uri( $page ) {
* @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 int $child_of Page ID to return child and grandchild pages of. Note: The value
+ * of `$hierarchical` has no bearing on whether `$child_of` returns
+ * hierarchical results. 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 bool $hierarchical Whether to return pages hierarchically. If false in conjunction with
+ * `$child_of` also being false, both arguments will be disregarded.
+ * 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`.
@@ -4527,15 +4500,14 @@ function get_page_uri( $page ) {
* @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 int $parent Page ID to return direct children of. 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.
+ * @type string|array $post_status A comma-separated list or array of post statuses to include.
* Default 'publish'.
* }
* @return array|false List of pages matching defaults or `$args`.
@@ -4544,13 +4516,21 @@ function get_pages( $args = array() ) {
global $wpdb;
$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' => array(),
- 'number' => '', 'offset' => 0,
- 'post_type' => 'page', 'post_status' => 'publish',
+ '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' => array(),
+ 'number' => '',
+ 'offset' => 0,
+ 'post_type' => 'page',
+ 'post_status' => 'publish',
);
$r = wp_parse_args( $args, $defaults );
@@ -4585,11 +4565,7 @@ function get_pages( $args = array() ) {
// $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' );
- }
+ $last_changed = wp_cache_get_last_changed( 'posts' );
$cache_key = "get_pages:$key:$last_changed";
if ( $cache = wp_cache_get( $cache_key, 'posts' ) ) {
@@ -4757,7 +4733,7 @@ function get_pages( $args = array() ) {
if ( ! empty( $r['exclude_tree'] ) ) {
$exclude = wp_parse_id_list( $r['exclude_tree'] );
- foreach( $exclude as $id ) {
+ foreach ( $exclude as $id ) {
$children = get_page_children( $id, $pages );
foreach ( $children as $child ) {
$exclude[] = $child->ID;
@@ -4783,7 +4759,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
*
@@ -4833,15 +4809,17 @@ function is_local_attachment($url) {
* setting the value for the 'comment_status' key.
*
* @since 2.0.0
+ * @since 4.7.0 Added the `$wp_error` parameter to allow a WP_Error to be returned on failure.
*
* @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.
+ * @param string|array $args Arguments for inserting an attachment.
+ * @param string $file Optional. Filename.
+ * @param int $parent Optional. Parent post ID.
+ * @param bool $wp_error Optional. Whether to return a WP_Error on failure. Default false.
+ * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
*/
-function wp_insert_attachment( $args, $file = false, $parent = 0 ) {
+function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false ) {
$defaults = array(
'file' => $file,
'post_parent' => 0
@@ -4855,7 +4833,7 @@ function wp_insert_attachment( $args, $file = false, $parent = 0 ) {
$data['post_type'] = 'attachment';
- return wp_insert_post( $data );
+ return wp_insert_post( $data, $wp_error );
}
/**
@@ -4914,9 +4892,14 @@ function wp_delete_attachment( $post_id, $force_delete = false ) {
// Delete all for any posts.
delete_metadata( 'post', null, '_thumbnail_id', $post_id, true );
+ wp_defer_comment_counting( 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 )
+ foreach ( $comment_ids as $comment_id ) {
wp_delete_comment( $comment_id, true );
+ }
+
+ wp_defer_comment_counting( false );
$post_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d ", $post_id ));
foreach ( $post_meta_ids as $mid )
@@ -4931,7 +4914,7 @@ function wp_delete_attachment( $post_id, $force_delete = false ) {
/** This action is documented in wp-includes/post.php */
do_action( 'deleted_post', $post_id );
- $uploadpath = wp_upload_dir();
+ $uploadpath = wp_get_upload_dir();
if ( ! empty($meta['thumb']) ) {
// Don't delete the thumb if another attachment uses it.
@@ -4989,7 +4972,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
*
@@ -5015,7 +4998,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
*
@@ -5048,15 +5031,16 @@ function wp_get_attachment_url( $post_id = 0 ) {
$url = '';
// Get attached file.
- if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) {
+ if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true ) ) {
// Get upload directory.
- if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) {
+ if ( ( $uploads = wp_get_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 );
+ // Get the directory name relative to the basedir (back compat for pre-2.7 uploads)
+ $url = trailingslashit( $uploads['baseurl'] . '/' . _wp_get_attachment_relative_path( $file ) ) . basename( $file );
} else {
// It's a newly-uploaded file, therefore $file is relative to the basedir.
$url = $uploads['baseurl'] . "/$file";
@@ -5072,13 +5056,13 @@ function wp_get_attachment_url( $post_id = 0 ) {
$url = get_the_guid( $post->ID );
}
- // On SSL front-end, URLs should be HTTPS.
+ // 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.
+ * Filters the attachment URL.
*
* @since 2.1.0
*
@@ -5093,6 +5077,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.
*
@@ -5112,7 +5127,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
*
@@ -5149,7 +5164,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
*
@@ -5164,12 +5179,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;
}
@@ -5215,10 +5230,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 );
}
@@ -5241,7 +5256,8 @@ function wp_mime_type_icon( $mime = 0 ) {
$mime = (int) $mime;
if ( $post = get_post( $mime ) ) {
$post_id = (int) $post->ID;
- $ext = preg_replace('/^.+?\.([^.]+)$/', '$1', $post->guid);
+ $file = get_attached_file( $post_id );
+ $ext = preg_replace('/^.+?\.([^.]+)$/', '$1', $file);
if ( !empty($ext) ) {
$post_mimes[] = $ext;
if ( $ext_type = wp_ext2type( $ext ) )
@@ -5259,7 +5275,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
*
@@ -5268,7 +5284,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
*
@@ -5277,7 +5293,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
*
@@ -5322,17 +5338,22 @@ function wp_mime_type_icon( $mime = 0 ) {
$matches['default'] = array('default');
foreach ( $matches as $match => $wilds ) {
- if ( isset($types[$wilds[0]])) {
- $icon = $types[$wilds[0]];
- if ( !is_numeric($mime) )
- wp_cache_add("mime_type_icon_$mime", $icon);
- break;
+ foreach ( $wilds as $wild ) {
+ if ( ! isset( $types[ $wild ] ) ) {
+ continue;
+ }
+
+ $icon = $types[ $wild ];
+ if ( ! is_numeric( $mime ) ) {
+ wp_cache_add( "mime_type_icon_$mime", $icon );
+ }
+ break 2;
}
}
}
/**
- * Filter the mime type icon.
+ * Filters the mime type icon.
*
* @since 2.1.0
*
@@ -5364,23 +5385,27 @@ function wp_mime_type_icon( $mime = 0 ) {
* @param WP_Post $post_before The Previous Post Object
*/
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 )
+ // Don't bother if it hasn't changed.
+ if ( $post->post_name == $post_before->post_name ) {
return;
+ }
// We're only concerned with published, non-hierarchical objects.
- if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) )
+ if ( ! ( 'publish' === $post->post_status || ( 'attachment' === get_post_type( $post ) && 'inherit' === $post->post_status ) ) || is_post_type_hierarchical( $post->post_type ) ) {
return;
+ }
- $old_slugs = (array) get_post_meta($post_id, '_wp_old_slug');
+ $old_slugs = (array) get_post_meta( $post_id, '_wp_old_slug' );
// 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 ( ! empty( $post_before->post_name ) && ! in_array( $post_before->post_name, $old_slugs ) ) {
+ add_post_meta( $post_id, '_wp_old_slug', $post_before->post_name );
+ }
// If the new slug was used previously, delete it from the list.
- if ( in_array($post->post_name, $old_slugs) )
- delete_post_meta($post_id, '_wp_old_slug', $post->post_name);
+ if ( in_array( $post->post_name, $old_slugs ) ) {
+ delete_post_meta( $post_id, '_wp_old_slug', $post->post_name );
+ }
}
/**
@@ -5408,8 +5433,7 @@ function get_private_posts_cap_sql( $post_type ) {
* @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
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @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
@@ -5436,7 +5460,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
@@ -5493,22 +5517,27 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null,
* 'gmt' is when the last post was posted in GMT formatted date.
*
* @since 0.71
- *
- * @param string $timezone The location to get the time. Accepts 'gmt', 'blog',
- * or 'server'. Default 'server'.
+ * @since 4.4.0 The `$post_type` argument was added.
+ *
+ * @param string $timezone Optional. The timezone for the timestamp. Accepts 'server', 'blog', or 'gmt'.
+ * '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'.
+ * @param string $post_type Optional. The post type to check. Default 'any'.
* @return string The date of the last post.
*/
-function get_lastpostdate( $timezone = 'server' ) {
+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. Likely values are 'gmt',
- * 'blog', or 'server'.
+ * @param string $date Date the last post was published.
* @param string $timezone Location to use for getting the post published date.
+ * See get_lastpostdate() for accepted `$timezone` values.
*/
- return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date' ), $timezone );
+ return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone );
}
/**
@@ -5519,29 +5548,46 @@ function get_lastpostdate( $timezone = 'server' ) {
* 'gmt' is when the last post was modified in GMT time.
*
* @since 1.2.0
+ * @since 4.4.0 The `$post_type` argument was added.
*
- * @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'.
+ * @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'.
* @return string The timestamp.
*/
-function get_lastpostmodified( $timezone = 'server' ) {
- $lastpostmodified = _get_last_post_time( $timezone, 'modified' );
+function get_lastpostmodified( $timezone = 'server', $post_type = 'any' ) {
+ /**
+ * Pre-filter the return value of get_lastpostmodified() before the query is run.
+ *
+ * @since 4.4.0
+ *
+ * @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 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 );
+ if ( false !== $lastpostmodified ) {
+ return $lastpostmodified;
+ }
+
+ $lastpostmodified = _get_last_post_time( $timezone, 'modified', $post_type );
$lastpostdate = get_lastpostdate($timezone);
- if ( $lastpostdate > $lastpostmodified )
+ if ( $lastpostdate > $lastpostmodified ) {
$lastpostmodified = $lastpostdate;
+ }
/**
- * 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_lastpostmodified()} for accepted `$timezone` values.
+ * See get_lastpostdate() for accepted `$timezone` values.
*/
return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
}
@@ -5550,51 +5596,64 @@ function get_lastpostmodified( $timezone = 'server' ) {
* Get the timestamp of the last time any post was modified or published.
*
* @since 3.1.0
+ * @since 4.4.0 The `$post_type` argument was added.
* @access private
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @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'.
+ * @param string $timezone The timezone for the timestamp. See get_lastpostdate().
+ * for information on accepted values.
+ * @param string $field Post field to check. Accepts 'date' or 'modified'.
+ * @param string $post_type Optional. The post type to check. Default 'any'.
* @return string|false The timestamp.
*/
-function _get_last_post_time( $timezone, $field ) {
+function _get_last_post_time( $timezone, $field, $post_type = 'any' ) {
global $wpdb;
- if ( !in_array( $field, array( 'date', 'modified' ) ) )
+ if ( ! in_array( $field, array( 'date', 'modified' ) ) ) {
return false;
+ }
$timezone = strtolower( $timezone );
$key = "lastpost{$field}:$timezone";
+ if ( 'any' !== $post_type ) {
+ $key .= ':' . sanitize_key( $post_type );
+ }
$date = wp_cache_get( $key, 'timeinfo' );
+ if ( false !== $date ) {
+ return $date;
+ }
- if ( !$date ) {
- $add_seconds_server = date('Z');
-
+ if ( 'any' === $post_type ) {
$post_types = get_post_types( array( 'public' => true ) );
- array_walk( $post_types, array( &$wpdb, 'escape_by_ref' ) );
+ array_walk( $post_types, array( $wpdb, 'escape_by_ref' ) );
$post_types = "'" . implode( "', '", $post_types ) . "'";
+ } else {
+ $post_types = "'" . sanitize_key( $post_type ) . "'";
+ }
- switch ( $timezone ) {
- case 'gmt':
- $date = $wpdb->get_var("SELECT post_{$field}_gmt FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
- break;
- case 'blog':
- $date = $wpdb->get_var("SELECT post_{$field} FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
- break;
- case 'server':
- $date = $wpdb->get_var("SELECT DATE_ADD(post_{$field}_gmt, INTERVAL '$add_seconds_server' SECOND) FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
- break;
- }
+ switch ( $timezone ) {
+ case 'gmt':
+ $date = $wpdb->get_var("SELECT post_{$field}_gmt FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
+ break;
+ case 'blog':
+ $date = $wpdb->get_var("SELECT post_{$field} FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
+ break;
+ case 'server':
+ $add_seconds_server = date( 'Z' );
+ $date = $wpdb->get_var("SELECT DATE_ADD(post_{$field}_gmt, INTERVAL '$add_seconds_server' SECOND) FROM $wpdb->posts WHERE post_status = 'publish' AND post_type IN ({$post_types}) ORDER BY post_{$field}_gmt DESC LIMIT 1");
+ break;
+ }
+
+ if ( $date ) {
+ wp_cache_set( $key, $date, 'timeinfo' );
- if ( $date )
- wp_cache_set( $key, $date, 'timeinfo' );
+ return $date;
}
- return $date;
+ return false;
}
/**
@@ -5624,12 +5683,11 @@ function update_post_cache( &$posts ) {
* @since 2.0.0
*
* @global bool $_wp_suspend_cache_invalidation
- * @global wpdb $wpdb WordPress database abstraction object.
*
* @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;
+ global $_wp_suspend_cache_invalidation;
if ( ! empty( $_wp_suspend_cache_invalidation ) )
return;
@@ -5814,6 +5872,7 @@ function _transition_post_status( $new_status, $old_status, $post ) {
foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
wp_cache_delete( "lastpostmodified:$timezone", 'timeinfo' );
wp_cache_delete( "lastpostdate:$timezone", 'timeinfo' );
+ wp_cache_delete( "lastpostdate:$timezone:{$post->post_type}", 'timeinfo' );
}
}
@@ -5836,8 +5895,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 ) {
@@ -5897,7 +5955,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
*
@@ -5989,6 +6047,43 @@ function wp_delete_auto_drafts() {
}
}
+/**
+ * Queues posts for lazy-loading of term meta.
+ *
+ * @since 4.5.0
+ *
+ * @param array $posts Array of WP_Post objects.
+ */
+function wp_queue_posts_for_term_meta_lazyload( $posts ) {
+ $post_type_taxonomies = $term_ids = array();
+ foreach ( $posts as $post ) {
+ if ( ! ( $post instanceof WP_Post ) ) {
+ continue;
+ }
+
+ if ( ! isset( $post_type_taxonomies[ $post->post_type ] ) ) {
+ $post_type_taxonomies[ $post->post_type ] = get_object_taxonomies( $post->post_type );
+ }
+
+ foreach ( $post_type_taxonomies[ $post->post_type ] as $taxonomy ) {
+ // Term cache should already be primed by `update_post_term_cache()`.
+ $terms = get_object_term_cache( $post->ID, $taxonomy );
+ if ( false !== $terms ) {
+ foreach ( $terms as $term ) {
+ if ( ! isset( $term_ids[ $term->term_id ] ) ) {
+ $term_ids[] = $term->term_id;
+ }
+ }
+ }
+ }
+ }
+
+ if ( $term_ids ) {
+ $lazyloader = wp_metadata_lazyloader();
+ $lazyloader->queue_objects( 'term', $term_ids );
+ }
+}
+
/**
* Update the custom taxonomies' term counts when a post's status is changed.
*
@@ -6018,9 +6113,9 @@ function _update_term_count_on_transition_post_status( $new_status, $old_status,
*
* @see update_post_caches()
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param array $ids ID list
+ * @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.
*/
@@ -6034,3 +6129,62 @@ function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache
update_post_caches( $fresh_posts, 'any', $update_term_cache, $update_meta_cache );
}
}
+
+/**
+ * Adds a suffix if any trashed posts have a given slug.
+ *
+ * Store its desired (i.e. current) slug so it can try to reclaim it
+ * if the post is untrashed.
+ *
+ * For internal use.
+ *
+ * @since 4.5.0
+ * @access private
+ *
+ * @param string $post_name Slug.
+ * @param string $post_ID Optional. Post ID that should be ignored. Default 0.
+ */
+function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post_ID = 0 ) {
+ $trashed_posts_with_desired_slug = get_posts( array(
+ 'name' => $post_name,
+ 'post_status' => 'trash',
+ 'post_type' => 'any',
+ 'nopaging' => true,
+ 'post__not_in' => array( $post_ID )
+ ) );
+
+ if ( ! empty( $trashed_posts_with_desired_slug ) ) {
+ foreach ( $trashed_posts_with_desired_slug as $_post ) {
+ wp_add_trashed_suffix_to_post_name_for_post( $_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.
+ *
+ * For internal use.
+ *
+ * @since 4.5.0
+ * @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;
+
+ $post = get_post( $post );
+
+ if ( '__trashed' === substr( $post->post_name, -9 ) ) {
+ return $post->post_name;
+ }
+ add_post_meta( $post->ID, '_wp_desired_post_slug', $post->post_name );
+ $post_name = _truncate_post_slug( $post->post_name, 191 ) . '__trashed';
+ $wpdb->update( $wpdb->posts, array( 'post_name' => $post_name ), array( 'ID' => $post->ID ) );
+ clean_post_cache( $post->ID );
+ return $post_name;
+}