/**
* Creates the initial post types when 'init' action is fired.
*
+ * See {@see 'init'}.
+ *
* @since 2.9.0
*/
function create_initial_post_types() {
register_post_type( 'post', array(
'labels' => 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. */
'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,
'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(
'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,
'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' );
'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 status' ),
'public' => true,
}
/**
- * Filter the attached file based on the given ID.
+ * Filters the attached file based on the given ID.
*
* @since 2.1.0
*
return false;
/**
- * Filter the path to the attached file to update.
+ * Filters the path to the attached file to update.
*
* @since 2.1.0
*
}
/**
- * Filter the relative path to an uploaded file.
+ * Filters the relative path to an uploaded file.
*
* @since 2.9.0
*
* 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
* @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.
*/
/**
* 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.
}
/**
- * Filter the post status.
+ * Filters the post status.
*
* @since 4.4.0
*
}
/**
- * 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
*
}
/**
- * 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;
}
/**
- * Register a post type. Do not use before init.
+ * Registers a post type.
*
- * A function for creating or modifying a post type based on the
- * parameters given. The function will accept an array (second optional
- * parameter), along with a string for the post type name.
+ * Note: Post type registrations should not be hooked before the
+ * {@see 'init'} action. Also, any taxonomy connections should be
+ * registered via the `$taxonomies` argument to ensure consistency
+ * when hooks such as {@see 'parse_query'} or {@see 'pre_get_posts'}
+ * are used.
+ *
+ * Post types can support any number of built-in core features such
+ * as meta boxes, custom fields, post thumbnails, post statuses,
+ * comments, and more. See the `$supports` argument for a complete
+ * list of supported features.
*
* @since 2.9.0
* @since 3.0.0 The `show_ui` argument is now enforced on the new post screen.
- * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing screen and post editing screen.
+ * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
+ * screen and post editing screen.
+ * @since 4.6.0 Post type object returned is now an instance of WP_Post_Type.
+ * @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 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 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 callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
- * edit form. Do remove_meta_box() and add_meta_box() calls in the
- * callback. Default null.
- * @type array $taxonomies An array of taxonomy identifiers that will be registered for the
- * post type. Taxonomies can be registered later with
- * {@see register_taxonomy()} or {@see register_taxonomy_for_object_type()}.
- * 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
* 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 ) ) {
$wp_post_types = array();
// Sanitize post type name
$post_type = sanitize_key( $post_type );
- $args = wp_parse_args( $args );
-
- /**
- * Filter the arguments for registering a post type.
- *
- * @since 4.4.0
- *
- * @param array $args Array of arguments for registering a post type.
- * @param string $post_type Post type key.
- */
- $args = apply_filters( 'register_post_type_args', $args, $post_type );
-
- $has_edit_link = ! empty( $args['_edit_link'] );
-
- // Args prefixed with an underscore are reserved for internal use.
- $defaults = array(
- 'labels' => array(),
- 'description' => '',
- 'public' => false,
- 'hierarchical' => false,
- 'exclude_from_search' => null,
- 'publicly_queryable' => null,
- 'show_ui' => null,
- 'show_in_menu' => null,
- 'show_in_nav_menus' => null,
- 'show_in_admin_bar' => null,
- 'menu_position' => null,
- 'menu_icon' => null,
- 'capability_type' => 'post',
- 'capabilities' => array(),
- 'map_meta_cap' => null,
- 'supports' => array(),
- 'register_meta_box_cb' => null,
- 'taxonomies' => array(),
- 'has_archive' => false,
- 'rewrite' => true,
- 'query_var' => true,
- 'can_export' => true,
- 'delete_with_user' => null,
- '_builtin' => false,
- '_edit_link' => 'post.php?post=%d',
- );
- $args = array_merge( $defaults, $args );
- $args = (object) $args;
-
- $args->name = $post_type;
if ( empty( $post_type ) || strlen( $post_type ) > 20 ) {
- _doing_it_wrong( __FUNCTION__, __( 'Post type names must be between 1 and 20 characters in length.' ), '4.2' );
+ _doing_it_wrong( __FUNCTION__, __( 'Post type names must be between 1 and 20 characters in length.' ), '4.2.0' );
return new WP_Error( 'post_type_length_invalid', __( 'Post type names must be between 1 and 20 characters in length.' ) );
}
- // If not set, default to the setting for public.
- if ( null === $args->publicly_queryable )
- $args->publicly_queryable = $args->public;
-
- // If not set, default to the setting for public.
- if ( null === $args->show_ui )
- $args->show_ui = $args->public;
-
- // If not set, default to the setting for show_ui.
- if ( null === $args->show_in_menu || ! $args->show_ui )
- $args->show_in_menu = $args->show_ui;
-
- // If not set, default to the whether the full UI is shown.
- if ( null === $args->show_in_admin_bar )
- $args->show_in_admin_bar = (bool) $args->show_in_menu;
-
- // If not set, default to the setting for public.
- if ( null === $args->show_in_nav_menus )
- $args->show_in_nav_menus = $args->public;
-
- // If not set, default to true if not public, false if public.
- if ( null === $args->exclude_from_search )
- $args->exclude_from_search = !$args->public;
-
- // Back compat with quirky handling in version 3.0. #14122.
- if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
- $args->map_meta_cap = true;
-
- // If not set, default to false.
- if ( null === $args->map_meta_cap )
- $args->map_meta_cap = false;
-
- // If there's no specified edit link and no UI, remove the edit link.
- if ( ! $args->show_ui && ! $has_edit_link ) {
- $args->_edit_link = '';
- }
+ $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();
- $args->cap = get_post_type_capabilities( $args );
- unset( $args->capabilities );
+ $wp_post_types[ $post_type ] = $post_type_object;
- if ( is_array( $args->capability_type ) )
- $args->capability_type = $args->capability_type[0];
-
- if ( ! empty( $args->supports ) ) {
- add_post_type_support( $post_type, $args->supports );
- unset( $args->supports );
- } elseif ( false !== $args->supports ) {
- // Add default features
- add_post_type_support( $post_type, array( 'title', 'editor' ) );
- }
-
- if ( false !== $args->query_var ) {
- if ( true === $args->query_var )
- $args->query_var = $post_type;
- else
- $args->query_var = sanitize_title_with_dashes( $args->query_var );
-
- if ( $wp && is_post_type_viewable( $args ) ) {
- $wp->add_query_var( $args->query_var );
- }
- }
-
- if ( false !== $args->rewrite && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
- if ( ! is_array( $args->rewrite ) )
- $args->rewrite = array();
- if ( empty( $args->rewrite['slug'] ) )
- $args->rewrite['slug'] = $post_type;
- if ( ! isset( $args->rewrite['with_front'] ) )
- $args->rewrite['with_front'] = true;
- if ( ! isset( $args->rewrite['pages'] ) )
- $args->rewrite['pages'] = true;
- if ( ! isset( $args->rewrite['feeds'] ) || ! $args->has_archive )
- $args->rewrite['feeds'] = (bool) $args->has_archive;
- if ( ! isset( $args->rewrite['ep_mask'] ) ) {
- if ( isset( $args->permalink_epmask ) )
- $args->rewrite['ep_mask'] = $args->permalink_epmask;
- else
- $args->rewrite['ep_mask'] = EP_PERMALINK;
- }
-
- if ( $args->hierarchical )
- add_rewrite_tag( "%$post_type%", '(.+?)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&pagename=" );
- else
- add_rewrite_tag( "%$post_type%", '([^/]+)', $args->query_var ? "{$args->query_var}=" : "post_type=$post_type&name=" );
-
- if ( $args->has_archive ) {
- $archive_slug = $args->has_archive === true ? $args->rewrite['slug'] : $args->has_archive;
- if ( $args->rewrite['with_front'] )
- $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug;
- else
- $archive_slug = $wp_rewrite->root . $archive_slug;
-
- add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$post_type", 'top' );
- if ( $args->rewrite['feeds'] && $wp_rewrite->feeds ) {
- $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';
- add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
- add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$post_type" . '&feed=$matches[1]', 'top' );
- }
- if ( $args->rewrite['pages'] )
- add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$post_type" . '&paged=$matches[1]', 'top' );
- }
-
- $permastruct_args = $args->rewrite;
- $permastruct_args['feed'] = $permastruct_args['feeds'];
- add_permastruct( $post_type, "{$args->rewrite['slug']}/%$post_type%", $permastruct_args );
- }
-
- // Register the post type meta box if a custom callback was specified.
- if ( $args->register_meta_box_cb )
- add_action( 'add_meta_boxes_' . $post_type, $args->register_meta_box_cb, 10, 1 );
-
- $args->labels = get_post_type_labels( $args );
- $args->label = $args->labels->name;
-
- $wp_post_types[ $post_type ] = $args;
-
- add_action( 'future_' . $post_type, '_future_post_hook', 5, 2 );
-
- foreach ( $args->taxonomies as $taxonomy ) {
- register_taxonomy_for_object_type( $taxonomy, $post_type );
- }
+ $post_type_object->add_hooks();
+ $post_type_object->register_taxonomies();
/**
* Fires after a post type is registered.
*
* @since 3.3.0
+ * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
*
- * @param string $post_type Post type.
- * @param object $args Arguments used to register the post type.
+ * @param string $post_type Post type.
+ * @param WP_Post_Type $post_type_object Arguments used to register the post type.
*/
- do_action( 'registered_post_type', $post_type, $args );
+ do_action( 'registered_post_type', $post_type, $post_type_object );
- return $args;
+ return $post_type_object;
}
/**
*
* @since 4.5.0
*
- * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
- * @global WP $wp Current WordPress environment instance.
- * @global array $_wp_post_type_features Used to remove post type features.
- * @global array $post_type_meta_caps Used to remove meta capabilities.
- * @global array $wp_post_types List of post types.
+ * @global array $wp_post_types List of post types.
*
* @param string $post_type Post type to unregister.
* @return bool|WP_Error True on success, WP_Error on failure or if the post type doesn't exist.
*/
function unregister_post_type( $post_type ) {
+ global $wp_post_types;
+
if ( ! post_type_exists( $post_type ) ) {
- return new WP_Error( 'invalid_post_type', __( 'Invalid post type' ) );
+ return new WP_Error( 'invalid_post_type', __( 'Invalid post type.' ) );
}
- $post_type_args = get_post_type_object( $post_type );
+ $post_type_object = get_post_type_object( $post_type );
// Do not allow unregistering internal post types.
- if ( $post_type_args->_builtin ) {
+ if ( $post_type_object->_builtin ) {
return new WP_Error( 'invalid_post_type', __( 'Unregistering a built-in post type is not allowed' ) );
}
- global $wp, $wp_rewrite, $_wp_post_type_features, $post_type_meta_caps, $wp_post_types;
-
- // Remove query var.
- if ( false !== $post_type_args->query_var ) {
- $wp->remove_query_var( $post_type_args->query_var );
- }
-
- // Remove any rewrite rules, permastructs, and rules.
- if ( false !== $post_type_args->rewrite ) {
- remove_rewrite_tag( "%$post_type%" );
- remove_permastruct( $post_type );
- foreach ( $wp_rewrite->extra_rules_top as $regex => $query ) {
- if ( false !== strpos( $query, "index.php?post_type=$post_type" ) ) {
- unset( $wp_rewrite->extra_rules_top[ $regex ] );
- }
- }
- }
-
- // Remove registered custom meta capabilities.
- foreach ( $post_type_args->cap as $cap ) {
- unset( $post_type_meta_caps[ $cap ] );
- }
-
- // Remove all post type support.
- unset( $_wp_post_type_features[ $post_type ] );
+ $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();
- // Unregister the post type meta box if a custom callback was specified.
- if ( $post_type_args->register_meta_box_cb ) {
- remove_action( 'add_meta_boxes_' . $post_type, $post_type_args->register_meta_box_cb );
- }
-
- // Remove the post type from all taxonomies.
- foreach ( get_object_taxonomies( $post_type ) as $taxonomy ) {
- unregister_taxonomy_for_object_type( $taxonomy, $post_type );
- }
-
- // Remove the future post hook action.
- remove_action( 'future_' . $post_type, '_future_post_hook', 5 );
-
- // Remove the post type.
unset( $wp_post_types[ $post_type ] );
/**
}
/**
- * Build an object with all post type labels out of a post type object
+ * Builds an object with all post type labels out of a post type object.
*
* Accepted keys of the label array in the post type object:
*
- * - name - general name for the post type, usually plural. The same and overridden
- * by $post_type_object->label. Default is Posts/Pages
- * - singular_name - name for one object of this post type. Default is Post/Page
- * - add_new - Default is Add New for both hierarchical and non-hierarchical types.
- * When internationalizing this string, please use a gettext context
- * {@link https://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context}
- * matching your post type. Example: `_x( 'Add New', 'product' );`.
- * - add_new_item - Default is Add New Post/Add New Page.
- * - edit_item - Default is Edit Post/Edit Page.
- * - new_item - Default is New Post/New Page.
- * - view_item - Default is View Post/View Page.
- * - search_items - Default is Search Posts/Search Pages.
- * - not_found - Default is No posts found/No pages found.
- * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash.
- * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical
- * ones the default is 'Parent Page:'.
- * - all_items - String for the submenu. Default is All Posts/All Pages.
- * - archives - String for use with archives in nav menus. Default is Post Archives/Page Archives.
- * - insert_into_item - String for the media frame button. Default is Insert into post/Insert into page.
- * - uploaded_to_this_item - String for the media frame filter. Default is Uploaded to this post/Uploaded to this page.
- * - featured_image - Default is Featured Image.
- * - set_featured_image - Default is Set featured image.
- * - remove_featured_image - Default is Remove featured image.
- * - use_featured_image - Default is Use as featured image.
- * - menu_name - Default is the same as `name`.
- * - filter_items_list - String for the table views hidden heading.
- * - items_list_navigation - String for the table pagination hidden heading.
- * - items_list - String for the table hidden heading.
+ * - `name` - General name for the post type, usually plural. The same and overridden
+ * by `$post_type_object->label`. Default is 'Posts' / 'Pages'.
+ * - `singular_name` - Name for one object of this post type. Default is 'Post' / 'Page'.
+ * - `add_new` - Default is 'Add New' for both hierarchical and non-hierarchical types.
+ * When internationalizing this string, please use a {@link https://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context}
+ * matching your post type. Example: `_x( 'Add New', 'product', 'textdomain' );`.
+ * - `add_new_item` - Label for adding a new singular item. Default is 'Add New Post' / 'Add New Page'.
+ * - `edit_item` - Label for editing a singular item. Default is 'Edit Post' / 'Edit Page'.
+ * - `new_item` - Label for the new item page title. Default is 'New Post' / 'New Page'.
+ * - `view_item` - Label for viewing a singular item. Default is 'View Post' / 'View Page'.
+ * - `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(
'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' ) ),
$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.
*
* @since 4.4.0
* @since 4.5.0 Added the ability to pass a post type name in addition to object.
+ * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
*
- * @param object $post_type Post type name or object.
+ * @param string|WP_Post_Type $post_type Post type name or object.
* @return bool Whether the post type should be considered viewable.
*/
function is_post_type_viewable( $post_type ) {
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.
$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.
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.
$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.
$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.
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.
} 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;
}
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 );
+ }
}
/**
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 );
+ }
}
/**
);
/**
- * Filter the default list of post mime types.
+ * Filters the default list of post mime types.
*
* @since 2.5.0
*
return wp_delete_attachment( $postid, $force_delete );
/**
- * Filter whether a post deletion should take place.
+ * Filters whether a post deletion should take place.
*
* @since 4.4.0
*
*
* @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;
*
* 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
*
*
* 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.
*/
*
* @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 ) );
}
* @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 ) {
&& 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
}
$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';
}
$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;
}
}
/**
- * 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
*
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
*
$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
*
}
}
+ // 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 {
return;
}
- // wp_publish_post(_ returns no meaningful value.
+ // wp_publish_post() returns no meaningful value.
wp_publish_post( $post_id );
}
$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
*
$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
*
}
/**
- * 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
*
}
/**
- * Filter the unique post slug.
+ * Filters the unique post slug.
*
* @since 3.3.0
*
* 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
* 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
*
*/
$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;
}
/**
}
/**
- * 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
*
*
* @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
*
* 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
*
* @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 );
* @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);
}
}
+ // We cache misses as well as hits.
+ wp_cache_set( $cache_key, $foundid, 'posts' );
+
if ( $foundid ) {
return get_post( $foundid, $output );
}
* @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;
* Sub pages will be in the "directory" under the parent page post name.
*
* @since 1.5.0
+ * @since 4.6.0 Converted the `$page` parameter to optional.
*
- * @param WP_Post|object|int $page Page object or page ID.
+ * @param WP_Post|object|int $page Optional. Page ID or WP_Post object. Default is global $post.
* @return string|false Page URI, false on error.
*/
-function get_page_uri( $page ) {
+function get_page_uri( $page = 0 ) {
if ( ! $page instanceof WP_Post ) {
$page = get_post( $page );
}
foreach ( $page->ancestors as $parent ) {
$parent = get_post( $parent );
- if ( $parent ) {
+ if ( $parent && $parent->post_name ) {
$uri = $parent->post_name . '/' . $uri;
}
}
/**
- * Filter the URI for a page.
+ * Filters the URI for a page.
*
* @since 4.4.0
*
* @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`.
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 );
// $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' ) ) {
$pages = array_map( 'get_post', $pages );
/**
- * Filter the retrieved list of pages.
+ * Filters the retrieved list of pages.
*
* @since 2.1.0
*
* 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
$data['post_type'] = 'attachment';
- return wp_insert_post( $data );
+ return wp_insert_post( $data, $wp_error );
}
/**
return $data;
/**
- * Filter the attachment meta data.
+ * Filters the attachment meta data.
*
* @since 2.1.0
*
return false;
/**
- * Filter the updated attachment meta data.
+ * Filters the updated attachment meta data.
*
* @since 2.1.0
*
}
/**
- * Filter the attachment URL.
+ * Filters the attachment URL.
*
* @since 2.1.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.
*
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
*
$url = str_replace(basename($url), basename($thumb), $url);
/**
- * Filter the attachment thumbnail URL.
+ * Filters the attachment thumbnail URL.
*
* @since 2.1.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;
}
* @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 );
}
if ( !is_array($icon_files) ) {
/**
- * Filter the icon directory path.
+ * Filters the icon directory path.
*
* @since 2.0.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
*
$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
*
}
/**
- * Filter the mime type icon.
+ * Filters the mime type icon.
*
* @since 2.1.0
*
}
/**
- * 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
*/
function get_lastpostdate( $timezone = 'server', $post_type = 'any' ) {
/**
- * Filter the date the last post was published.
+ * Filters the date the last post was published.
*
* @since 2.3.0
*
* @param string $date Date the last post was published.
* @param string $timezone Location to use for getting the post published date.
- * See {@see get_lastpostdate()} for accepted `$timezone` values.
+ * See get_lastpostdate() for accepted `$timezone` values.
*/
return apply_filters( 'get_lastpostdate', _get_last_post_time( $timezone, 'date', $post_type ), $timezone );
}
* @since 1.2.0
* @since 4.4.0 The `$post_type` argument was added.
*
- * @param string $timezone Optional. The timezone for the timestamp. See {@see get_lastpostdate()}
+ * @param string $timezone Optional. The timezone for the timestamp. See get_lastpostdate()
* for information on accepted values.
* Default 'server'.
* @param string $post_type Optional. The post type to check. Default 'any'.
* @param string $lastpostmodified Date the last post was modified.
* Returning anything other than false will short-circuit the function.
* @param string $timezone Location to use for getting the post modified date.
- * See {@see get_lastpostdate()} for accepted `$timezone` values.
+ * See get_lastpostdate() for accepted `$timezone` values.
* @param string $post_type The post type to check.
*/
$lastpostmodified = apply_filters( 'pre_get_lastpostmodified', false, $timezone, $post_type );
}
/**
- * Filter the date the last post was modified.
+ * Filters the date the last post was modified.
*
* @since 2.3.0
*
* @param string $lastpostmodified Date the last post was modified.
* @param string $timezone Location to use for getting the post modified date.
- * See {@see get_lastpostdate()} for accepted `$timezone` values.
+ * See get_lastpostdate() for accepted `$timezone` values.
*/
return apply_filters( 'get_lastpostmodified', $lastpostmodified, $timezone );
}
}
$date = wp_cache_get( $key, 'timeinfo' );
+ if ( false !== $date ) {
+ return $date;
+ }
- if ( ! $date ) {
- if ( 'any' === $post_type ) {
- $post_types = get_post_types( array( 'public' => true ) );
- array_walk( $post_types, array( $wpdb, 'escape_by_ref' ) );
- $post_types = "'" . implode( "', '", $post_types ) . "'";
- } else {
- $post_types = "'" . sanitize_key( $post_type ) . "'";
- }
+ if ( 'any' === $post_type ) {
+ $post_types = get_post_types( array( 'public' => true ) );
+ 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':
- $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;
- }
+ 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;
}
/**
*
* @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 ) {
* 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
*
}
/**
- * Adds a trashed suffix For a given post.
+ * Adds a trashed suffix for a given post.
*
* Store its desired (i.e. current) slug so it can try to reclaim it
* if the post is untrashed.
* @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;
clean_post_cache( $post->ID );
return $post_name;
}
+
+/**
+ * Filter the SQL clauses of an attachment query to include filenames.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
+ * DISTINCT, fields (SELECT), and LIMITS clauses.
+ * @return array The modified clauses.
+ */
+function _filter_query_attachment_filenames( $clauses ) {
+ global $wpdb;
+ remove_filter( 'posts_clauses', __FUNCTION__ );
+
+ // Add a LEFT JOIN of the postmeta table so we don't trample existing JOINs.
+ $clauses['join'] .= " LEFT JOIN {$wpdb->postmeta} AS sq1 ON ( {$wpdb->posts}.ID = sq1.post_id AND sq1.meta_key = '_wp_attached_file' )";
+
+ $clauses['groupby'] = "{$wpdb->posts}.ID";
+
+ $clauses['where'] = preg_replace(
+ "/\({$wpdb->posts}.post_content (NOT LIKE|LIKE) (\'[^']+\')\)/",
+ "$0 OR ( sq1.meta_value $1 $2 )",
+ $clauses['where'] );
+
+ return $clauses;
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff