X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..874d2a2f468a0d1e69aab49b1fe2d9d79d3e1142:/wp-includes/post.php
diff --git a/wp-includes/post.php b/wp-includes/post.php
index d537148d..94ec8f2c 100644
--- a/wp-includes/post.php
+++ b/wp-includes/post.php
@@ -180,13 +180,13 @@ add_action( 'init', 'create_initial_post_types', 0 ); // highest priority
*
* @since 2.0.0
*
- * @param int $attachment_id Attachment ID.
- * @param bool $unfiltered Whether to apply filters.
+ * @param int $attachment_id Attachment ID.
+ * @param bool $unfiltered Optional. Whether to apply filters. Default false.
* @return string|bool The file path to where the attached file should be, false otherwise.
*/
function get_attached_file( $attachment_id, $unfiltered = false ) {
$file = get_post_meta( $attachment_id, '_wp_attached_file', true );
- // If the file is relative, prepend upload dir
+ // If the file is relative, prepend upload dir.
if ( $file && 0 !== strpos($file, '/') && !preg_match('|^.:\\\|', $file) && ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) )
$file = $uploads['basedir'] . "/$file";
if ( $unfiltered )
@@ -211,8 +211,8 @@ function get_attached_file( $attachment_id, $unfiltered = false ) {
*
* @since 2.1.0
*
- * @param int $attachment_id Attachment ID
- * @param string $file File path for the attachment
+ * @param int $attachment_id Attachment ID.
+ * @param string $file File path for the attachment.
* @return bool True on success, false on failure.
*/
function update_attached_file( $attachment_id, $file ) {
@@ -242,8 +242,8 @@ function update_attached_file( $attachment_id, $file ) {
*
* @since 2.9.0
*
- * @param string $path Full path to the file
- * @return string relative path on success, unchanged path on failure.
+ * @param string $path Full path to the file.
+ * @return string Relative path on success, unchanged path on failure.
*/
function _wp_relative_upload_path( $path ) {
$new_path = $path;
@@ -304,16 +304,18 @@ function _wp_relative_upload_path( $path ) {
* post types are 'post', 'pages', and 'attachments'. The 'post_status'
* argument will accept any post status within the write administration panels.
*
- * @see get_posts() Has additional arguments that can be replaced.
* @internal Claims made in the long description might be inaccurate.
- *
* @since 2.0.0
*
- * @param mixed $args Optional. User defined arguments for replacing the defaults.
- * @param string $output Optional. Constant for return type, either OBJECT (default), ARRAY_A, ARRAY_N.
- * @return array|bool False on failure and the type will be determined by $output parameter.
+ * @see get_posts()
+ *
+ * @param mixed $args Optional. User defined arguments for replacing the defaults. Default empty.
+ * @param string $output Optional. Constant for return type. Accepts OBJECT, ARRAY_A, ARRAY_N.
+ * Default OBJECt.
+ * @return array Array of children, where the type of each element is determined by $output parameter.
+ * Empty array on failure.
*/
-function get_children($args = '', $output = OBJECT) {
+function get_children( $args = '', $output = OBJECT ) {
$kids = array();
if ( empty( $args ) ) {
if ( isset( $GLOBALS['post'] ) ) {
@@ -378,8 +380,8 @@ function get_children($args = '', $output = OBJECT) {
* @param string $post Post content.
* @return array Post before ('main'), after ('extended'), and custom readmore ('more_text').
*/
-function get_extended($post) {
- //Match the new style more links
+function get_extended( $post ) {
+ //Match the new style more links.
if ( preg_match('//', $post, $matches) ) {
list($main, $extended) = explode($matches[0], $post, 2);
$more_text = $matches[1];
@@ -389,7 +391,7 @@ function get_extended($post) {
$more_text = '';
}
- // ` leading and trailing whitespace
+ // leading and trailing whitespace.
$main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main);
$extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended);
$more_text = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $more_text);
@@ -404,12 +406,13 @@ function get_extended($post) {
* $post, must be given as a variable, since it is passed by reference.
*
* @since 1.5.1
- * @link http://codex.wordpress.org/Function_Reference/get_post
*
- * @param int|WP_Post $post Optional. Post ID or post object.
- * @param string $output Optional, default is Object. Either OBJECT, ARRAY_A, or ARRAY_N.
- * @param string $filter Optional, default is raw.
- * @return WP_Post|null WP_Post on success or null on failure
+ * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
+ * @param string $output Optional, default is Object. Accepts OBJECT, ARRAY_A, or ARRAY_N.
+ * Default OBJECT.
+ * @param string $filter Optional. Type of filter to apply. Accepts 'raw', 'edit', 'db',
+ * or 'display'. Default 'raw'.
+ * @return WP_Post|null WP_Post on success or null on failure.
*/
function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
if ( empty( $post ) && isset( $GLOBALS['post'] ) )
@@ -626,6 +629,15 @@ final class WP_Post {
*/
public $filter;
+ /**
+ * Retrieve WP_Post instance.
+ *
+ * @static
+ * @access public
+ *
+ * @param int $post_id Post ID.
+ * @return WP_Post|bool Post object, false otherwise.
+ */
public static function get_instance( $post_id ) {
global $wpdb;
@@ -650,11 +662,22 @@ final class WP_Post {
return new WP_Post( $_post );
}
+ /**
+ * Constructor.
+ *
+ * @param WP_Post $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;
@@ -671,6 +694,12 @@ final class WP_Post {
return metadata_exists( 'post', $this->ID, $key );
}
+ /**
+ * Getter.
+ *
+ * @param string $key Key to get.
+ * @return array|mixed
+ */
public function __get( $key ) {
if ( 'page_template' == $key && $this->__isset( $key ) ) {
return get_post_meta( $this->ID, '_wp_page_template', true );
@@ -696,8 +725,7 @@ final class WP_Post {
return wp_list_pluck( $terms, 'name' );
}
- // Rest of the values need filtering
-
+ // Rest of the values need filtering.
if ( 'ancestors' == $key )
$value = get_post_ancestors( $this );
else
@@ -709,6 +737,12 @@ final class WP_Post {
return $value;
}
+ /**
+ * {@Missing Summary}
+ *
+ * @param string $filter Filter.
+ * @return $this|array|bool|object|WP_Post
+ */
public function filter( $filter ) {
if ( $this->filter == $filter )
return $this;
@@ -719,6 +753,11 @@ final class WP_Post {
return sanitize_post( $this, $filter );
}
+ /**
+ * Convert object to array.
+ *
+ * @return array Object as array.
+ */
public function to_array() {
$post = get_object_vars( $this );
@@ -770,11 +809,13 @@ function get_post_ancestors( $post ) {
* supported values are found within those functions.
*
* @since 2.3.0
- * @uses sanitize_post_field() See for possible $context values.
*
- * @param string $field Post field name.
- * @param int|WP_Post $post Post ID or post object.
- * @param string $context Optional. How to filter the field. Default is 'display'.
+ * @see sanitize_post_field()
+ *
+ * @param string $field Post field name.
+ * @param int|WP_Post $post Post ID or post object.
+ * @param string $context Optional. How to filter the field. Accepts 'raw', 'edit', 'db',
+ * or 'display'. Default 'display'.
* @return string The value of the post field on success, empty string on failure.
*/
function get_post_field( $field, $post, $context = 'display' ) {
@@ -797,10 +838,10 @@ function get_post_field( $field, $post, $context = 'display' ) {
*
* @since 2.0.0
*
- * @param int|WP_Post $ID Optional. Post ID or post object.
+ * @param int|WP_Post $ID Optional. Post ID or post object. Default empty.
* @return string|bool The mime type on success, false on failure.
*/
-function get_post_mime_type($ID = '') {
+function get_post_mime_type( $ID = '' ) {
$post = get_post($ID);
if ( is_object($post) )
@@ -817,10 +858,10 @@ function get_post_mime_type($ID = '') {
*
* @since 2.0.0
*
- * @param int|WP_Post $ID Optional. Post ID or post object.
+ * @param int|WP_Post $ID Optional. Post ID or post object. Default empty.
* @return string|bool Post status on success, false on failure.
*/
-function get_post_status($ID = '') {
+function get_post_status( $ID = '' ) {
$post = get_post($ID);
if ( !is_object($post) )
@@ -830,13 +871,20 @@ function get_post_status($ID = '') {
if ( 'private' == $post->post_status )
return 'private';
- // Unattached attachments are assumed to be published
+ // Unattached attachments are assumed to be published.
if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) )
return 'publish';
- // Inherit status from the parent
- if ( $post->post_parent && ( $post->ID != $post->post_parent ) )
- return get_post_status($post->post_parent);
+ // Inherit status from the parent.
+ if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) {
+ $parent_post_status = get_post_status( $post->post_parent );
+ if ( 'trash' == $parent_post_status ) {
+ return get_post_meta( $post->post_parent, '_wp_trash_meta_status', true );
+ } else {
+ return $parent_post_status;
+ }
+ }
+
}
return $post->post_status;
@@ -854,10 +902,10 @@ function get_post_status($ID = '') {
*/
function get_post_statuses() {
$status = array(
- 'draft' => __('Draft'),
- 'pending' => __('Pending Review'),
- 'private' => __('Private'),
- 'publish' => __('Published')
+ 'draft' => __( 'Draft' ),
+ 'pending' => __( 'Pending Review' ),
+ 'private' => __( 'Private' ),
+ 'publish' => __( 'Published' )
);
return $status;
@@ -875,9 +923,9 @@ function get_post_statuses() {
*/
function get_page_statuses() {
$status = array(
- 'draft' => __('Draft'),
- 'private' => __('Private'),
- 'publish' => __('Published')
+ 'draft' => __( 'Draft' ),
+ 'private' => __( 'Private' ),
+ 'publish' => __( 'Published' )
);
return $status;
@@ -890,25 +938,42 @@ function get_page_statuses() {
* parameters given. The function will accept an array (second optional
* parameter), along with a string for the post status name.
*
- *
- * Optional $args contents:
- *
- * label - A descriptive name for the post status marked for translation. Defaults to $post_status.
- * public - Whether posts of this status should be shown in the front end of the site. Defaults to true.
- * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to false.
- * show_in_admin_all_list - Whether to include posts in the edit listing for their post type
- * show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit
- * listings, e.g. All (12) | Published (9) | My Custom Status (2) ...
- *
* Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
*
* @since 3.0.0
* @uses $wp_post_statuses Inserts new post status object into the list
*
* @param string $post_status Name of the post status.
- * @param array|string $args See above description.
+ * @param array|string $args {
+ * Optional. Array or string of post status arguments.
+ *
+ * @type bool|string $label A descriptive name for the post status marked
+ * for translation. Defaults to value of $post_status.
+ * @type bool|array $label_count Descriptive text to use for nooped plurals.
+ * Default array of $label, twice
+ * @type bool $exclude_from_search Whether to exclude posts with this post status
+ * from search results. Default is value of $internal.
+ * @type bool $_builtin Whether the status is built-in. Core-use only.
+ * Default false.
+ * @type bool $public Whether posts of this status should be shown
+ * in the front end of the site. Default true.
+ * @type bool $internal Whether the status is for internal use only.
+ * Default false.
+ * @type bool $protected Whether posts with this status should be protected.
+ * Default false.
+ * @type bool $private Whether posts with this status should be private.
+ * Default false.
+ * @type bool $publicly_queryable Whether posts with this status should be publicly-
+ * queryable. Default is value of $public.
+ * @type bool $show_in_admin_all_list Whether to include posts in the edit listing for
+ * their post type. Default is value of $internal.
+ * @type bool $show_in_admin_status_list Show in the list of statuses with post counts at
+ * the top of the edit listings,
+ * e.g. All (12) | Published (9) | My Custom Status (2)
+ * Default is value of $internal.
+ * }
*/
-function register_post_status($post_status, $args = array()) {
+function register_post_status( $post_status, $args = array() ) {
global $wp_post_statuses;
if (!is_array($wp_post_statuses))
@@ -934,6 +999,7 @@ function register_post_status($post_status, $args = array()) {
$post_status = sanitize_key($post_status);
$args->name = $post_status;
+ // Set various defaults.
if ( null === $args->public && null === $args->internal && null === $args->protected && null === $args->private )
$args->internal = true;
@@ -973,15 +1039,16 @@ function register_post_status($post_status, $args = array()) {
}
/**
- * Retrieve a post status object by name
+ * Retrieve a post status object by name.
*
* @since 3.0.0
- * @uses $wp_post_statuses
- * @see register_post_status
- * @see get_post_statuses
*
- * @param string $post_status The name of a registered post status
- * @return object A post status object
+ * @global array $wp_post_statuses List of post statuses.
+ *
+ * @see register_post_status()
+ *
+ * @param string $post_status The name of a registered post status.
+ * @return object A post status object.
*/
function get_post_status_object( $post_status ) {
global $wp_post_statuses;
@@ -996,15 +1063,18 @@ function get_post_status_object( $post_status ) {
* Get a list of all registered post status objects.
*
* @since 3.0.0
- * @uses $wp_post_statuses
- * @see register_post_status
- * @see get_post_status_object
- *
- * @param array|string $args An array of key => value arguments to match against the post status objects.
- * @param string $output The type of output to return, either post status 'names' or 'objects'. 'names' is the default.
- * @param string $operator The logical operation to perform. 'or' means only one element
- * from the array needs to match; 'and' means all elements must match. The default is 'and'.
- * @return array A list of post status names or objects
+ *
+ * @global array $wp_post_statuses List of post statuses.
+ *
+ * @see register_post_status()
+ *
+ * @param array|string $args Optional. Array or string of post status arguments. Default array.
+ * @param string $output Optional. The type of output to return. Accepts post status 'names'
+ * or 'objects'. Default 'names'.
+ * @param string $operator Optional. The logical operation to perform. 'or' means only one element
+ * from the array needs to match; 'and' means all elements must match.
+ * Default 'and'.
+ * @return array A list of post status names or objects.
*/
function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {
global $wp_post_statuses;
@@ -1020,7 +1090,8 @@ function get_post_stati( $args = array(), $output = 'names', $operator = 'and' )
* A false return value might also mean that the post type does not exist.
*
* @since 3.0.0
- * @see get_post_type_object
+ *
+ * @see get_post_type_object()
*
* @param string $post_type Post type name
* @return bool Whether post type is hierarchical.
@@ -1034,12 +1105,13 @@ function is_post_type_hierarchical( $post_type ) {
}
/**
- * Checks if a post type is registered.
+ * Check if a post type is registered.
*
* @since 3.0.0
- * @uses get_post_type_object()
*
- * @param string $post_type Post type name
+ * @see get_post_type_object()
+ *
+ * @param string $post_type Post type name.
* @return bool Whether post type is registered.
*/
function post_type_exists( $post_type ) {
@@ -1051,7 +1123,7 @@ function post_type_exists( $post_type ) {
*
* @since 2.1.0
*
- * @param int|WP_Post $post Optional. Post ID or post object.
+ * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
* @return string|bool Post type on success, false on failure.
*/
function get_post_type( $post = null ) {
@@ -1062,15 +1134,16 @@ function get_post_type( $post = null ) {
}
/**
- * Retrieve a post type object by name
+ * Retrieve a post type object by name.
*
* @since 3.0.0
- * @uses $wp_post_types
- * @see register_post_type
- * @see get_post_types
*
- * @param string $post_type The name of a registered post type
- * @return object A post type object
+ * @global array $wp_post_types List of post types.
+ *
+ * @see register_post_type()
+ *
+ * @param string $post_type The name of a registered post type.
+ * @return object A post type object.
*/
function get_post_type_object( $post_type ) {
global $wp_post_types;
@@ -1085,14 +1158,19 @@ function get_post_type_object( $post_type ) {
* Get a list of all registered post type objects.
*
* @since 2.9.0
- * @uses $wp_post_types
- * @see register_post_type
- *
- * @param array|string $args An array of key => value arguments to match against the post type objects.
- * @param string $output The type of output to return, either post type 'names' or 'objects'. 'names' is the default.
- * @param string $operator The logical operation to perform. 'or' means only one element
- * from the array needs to match; 'and' means all elements must match. The default is 'and'.
- * @return array A list of post type names or objects
+ *
+ * @global array $wp_post_types List of post types.
+ *
+ * @see register_post_type()
+ *
+ * @param array|string $args Optional. An array of key => value arguments to match against
+ * the post type objects. Default empty array.
+ * @param string $output Optional. The type of output to return. Accepts post type 'names'
+ * or 'objects'. Default 'names'.
+ * @param string $operator Optaionl. The logical operation to perform. 'or' means only one
+ * element from the array needs to match; 'and' means all elements
+ * must match. Default 'and'.
+ * @return array A list of post type names or objects.
*/
function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) {
global $wp_post_types;
@@ -1109,91 +1187,111 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* parameters given. The function will accept an array (second optional
* parameter), along with a string for the post type name.
*
- * Optional $args contents:
- *
- * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used.
- * - labels - An array of labels for this post type.
- * * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones.
- * * You can see accepted values in {@link get_post_type_labels()}.
- * - description - A short descriptive summary of what the post type is. Defaults to blank.
- * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users.
- * * Defaults to false.
- * * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are
- * inherited from public, each does not rely on this relationship and controls a very specific intention.
- * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false.
- * - exclude_from_search - Whether to exclude posts with this post type from front end search results.
- * * If not set, the opposite of public's current value is used.
- * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request().
- * * ?post_type={post_type_key}
- * * ?{post_type_key}={single_post_slug}
- * * ?{post_type_query_var}={single_post_slug}
- * * If not set, the default is inherited from public.
- * - show_ui - Whether to generate a default UI for managing this post type in the admin.
- * * If not set, the default is inherited from public.
- * - show_in_menu - Where to show the post type in the admin menu.
- * * If true, the post type is shown in its own top level menu.
- * * If false, no menu is shown
- * * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will
- * be placed as a sub menu of that.
- * * show_ui must be true.
- * * If not set, the default is inherited from show_ui
- * - show_in_nav_menus - Makes this post type available for selection in navigation menus.
- * * If not set, the default is inherited from public.
- * - show_in_admin_bar - Makes this post type available via the admin bar.
- * * If not set, the default is inherited from show_in_menu
- * - menu_position - The position in the menu order the post type should appear.
- * * show_in_menu must be true
- * * Defaults to null, which places it at the bottom of its area.
- * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon.
- * * 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.
- * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'.
- * * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the
- * capabilities, e.g. array('story', 'stories').
- * - capabilities - Array of capabilities for this post type.
- * * By default the capability_type is used as a base to construct capabilities.
- * * You can see accepted values in {@link get_post_type_capabilities()}.
- * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false.
- * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor.
- * * See {@link add_post_type_support()} for documentation.
- * - register_meta_box_cb - Provide a callback function that sets up the meta boxes
- * for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback.
- * - taxonomies - An array of taxonomy identifiers that will be registered for the post type.
- * * Default is no taxonomies.
- * * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type().
- * - has_archive - True to enable post type archives. Default is false.
- * * Will generate the proper rewrite rules if rewrite is enabled.
- * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug.
- * * To prevent rewrite, set to false.
- * * To specify rewrite rules, an array can be passed with any of these keys
- * * 'slug' => string Customize the permastruct slug. Defaults to $post_type key
- * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
- * * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive.
- * * 'pages' => bool Should the permastruct provide for pagination. Defaults to true.
- * * 'ep_mask' => const Assign an endpoint mask.
- * * If not specified and permalink_epmask is set, inherits from permalink_epmask.
- * * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK
- * - query_var - Sets the query_var key for this post type. Defaults to $post_type key
- * * If false, a post type cannot be loaded at ?{query_var}={post_slug}
- * * If specified as a string, the query ?{query_var_string}={post_slug} will be valid.
- * - can_export - Allows this post type to be exported. Defaults to true.
- * - delete_with_user - Whether to delete posts of this type when deleting a user.
- * * If true, posts of this type belonging to the user will be moved to trash when then user is deleted.
- * * If false, posts of this type belonging to the user will *not* be trashed or deleted.
- * * If not set (the default), posts are trashed if post_type_supports('author'). Otherwise posts are not trashed or deleted.
- * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY!
- * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY!
- *
* @since 2.9.0
- * @uses $wp_post_types Inserts new post type object into the list
- * @uses $wp_rewrite Gets default feeds
- * @uses $wp Adds query vars
+ *
+ * @global array $wp_post_types List of post types.
+ * @global WP_Rewrite $wp_rewrite Used for default feeds.
+ * @global WP $wp Used to add query vars.
*
* @param string $post_type Post type key, must not exceed 20 characters.
- * @param array|string $args See optional args description above.
- * @return object|WP_Error the registered post type object, or an error object.
+ * @param array|string $args {
+ * Array or string of arguments for registering a post type.
+ *
+ * @type string $label Name of the post type shown in the menu. Usually plural.
+ * Default is value of $labels['name'].
+ * @type array $labels An array of labels for this post type. If not set, post
+ * labels are inherited for non-hierarchical types and page
+ * labels for hierarchical ones. {@see get_post_type_labels()}.
+ * @type string $description A short descriptive summary of what the post type is.
+ * Default empty.
+ * @type bool $public Whether a post type is intended for use publicly either via
+ * the admin interface or by front-end users. While the default
+ * settings of $exclude_from_search, $publicly_queryable, $show_ui,
+ * and $show_in_nav_menus are inherited from public, each does not
+ * rely on this relationship and controls a very specific intention.
+ * Default false.
+ * @type bool $hierarchical Whether the post type is hierarchical (e.g. page). Default false.
+ * @type bool $exclude_from_search Whether to exclude posts with this post type from front end search
+ * results. Default is the opposite value of $public.
+ * @type bool $publicly_queryable Whether queries can be performed on the front end for the post type
+ * as part of {@see parse_request()}. Endpoints would include:
+ * * ?post_type={post_type_key}
+ * * ?{post_type_key}={single_post_slug}
+ * * ?{post_type_query_var}={single_post_slug}
+ * If not set, the default is inherited from $public.
+ * @type bool $show_ui Whether to generate a default UI for managing this post type in the
+ * admin. Default is value of $public.
+ * @type bool $show_in_menu Where to show the post type in the admin menu. To work, $show_ui
+ * must be true. If true, the post type is shown in its own top level
+ * menu. If false, no menu is shown. If a string of an existing top
+ * level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post
+ * type will be placed as a sub-menu of that.
+ * Default is value of $show_ui.
+ * @type bool $show_in_nav_menus Makes this post type available for selection in navigation menus.
+ * Default is value $public.
+ * @type bool $show_in_admin_bar Makes this post type available via the admin bar. Default is value
+ * of $show_in_menu.
+ * @type int $menu_position The position in the menu order the post type should appear. To work,
+ * $show_in_menu must be true. Default null (at the bottom).
+ * @type string $menu_icon The url to the icon to be used for this menu. Pass a base64-encoded
+ * SVG using a data URI, which will be colored to match the color scheme
+ * -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
+ * of a Dashicons helper class to use a font icon, e.g.
+ * 'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
+ * so an icon can be added via CSS. Defaults to use the posts icon.
+ * @type string $capability_type The string to use to build the read, edit, and delete capabilities.
+ * May be passed as an array to allow for alternative plurals when using
+ * this argument as a base to construct the capabilities, e.g.
+ * array('story', 'stories'). Default 'post'.
+ * @type array $capabilities Array of capabilities for this post type. $capability_type is used
+ * as a base to construct capabilities by default.
+ * {@see get_post_type_capabilities()}.
+ * @type bool $map_meta_cap Whether to use the internal default meta capability handling.
+ * Default false.
+ * @type array $supports An alias for calling {@see add_post_type_support()} directly.
+ * Defaults to array containing 'title' & 'editor'.
+ * @type callback $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
+ * edit form. Do remove_meta_box() and add_meta_box() calls in the
+ * callback. Default null.
+ * @type array $taxonomies An array of taxonomy identifiers that will be registered for the
+ * post type. Taxonomies can be registered later with
+ * {@see register_taxonomy()} or {@see register_taxonomy_for_object_type()}.
+ * Default empty array.
+ * @type bool|string $has_archive Whether there should be post type archives, or if a string, the
+ * archive slug to use. Will generate the proper rewrite rules if
+ * $rewrite is enabled. Default false.
+ * @type bool|array $rewrite {
+ * Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
+ * Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be
+ * passed with any of these keys:
+ *
+ * @type string $slug Customize the permastruct slug. Defaults to $post_type key.
+ * @type bool $with_front Whether the permastruct should be prepended with WP_Rewrite::$front.
+ * Default true.
+ * @type bool $feeds Whether the feed permastruct should be built for this post type.
+ * Default is value of $has_archive.
+ * @type bool $pages Whether the permastruct should provide for pagination. Default true.
+ * @type const $ep_mask Endpoint mask to assign. If not specified and permalink_epmask is set,
+ * inherits from $permalink_epmask. If not specified and permalink_epmask
+ * is not set, defaults to EP_PERMALINK.
+ * }
+ * @type string|bool $query_var Sets the query_var key for this post type. Defaults to $post_type
+ * key. If false, a post type cannot be loaded at
+ * ?{query_var}={post_slug}. If specified as a string, the query
+ * ?{query_var_string}={post_slug} will be valid.
+ * @type bool $can_export Whether to allow this post type to be exported. Default true.
+ * @type bool $delete_with_user Whether to delete posts of this type when deleting a user. If true,
+ * posts of this type belonging to the user will be moved to trash
+ * when then user is deleted. If false, posts of this type belonging
+ * to the user will *not* be trashed or deleted. If not set (the default),
+ * posts are trashed if post_type_supports('author'). Otherwise posts
+ * are not trashed or deleted. Default null.
+ * @type bool $_builtin FOR INTERNAL USE ONLY! True if this post type is a native or
+ * "built-in" post_type. Default false.
+ * @type string $_edit_link FOR INTERNAL USE ONLY! URL segment to use for edit link of
+ * this post type. Default 'post.php?post=%d'.
+ * }
+ * @return object|WP_Error The registered post type object, or an error object.
*/
function register_post_type( $post_type, $args = array() ) {
global $wp_post_types, $wp_rewrite, $wp;
@@ -1235,8 +1333,10 @@ function register_post_type( $post_type, $args = array() ) {
$post_type = sanitize_key( $post_type );
$args->name = $post_type;
- if ( strlen( $post_type ) > 20 )
+ if ( strlen( $post_type ) > 20 ) {
+ _doing_it_wrong( __FUNCTION__, __( 'Post types cannot exceed 20 characters in length' ), '4.0' );
return new WP_Error( 'post_type_too_long', __( 'Post types cannot exceed 20 characters in length' ) );
+ }
// If not set, default to the setting for public.
if ( null === $args->publicly_queryable )
@@ -1262,7 +1362,7 @@ function register_post_type( $post_type, $args = array() ) {
if ( null === $args->exclude_from_search )
$args->exclude_from_search = !$args->public;
- // Back compat with quirky handling in version 3.0. #14122
+ // Back compat with quirky handling in version 3.0. #14122.
if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
$args->map_meta_cap = true;
@@ -1337,6 +1437,7 @@ function register_post_type( $post_type, $args = array() ) {
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 );
@@ -1357,7 +1458,7 @@ function register_post_type( $post_type, $args = array() ) {
* @since 3.3.0
*
* @param string $post_type Post type.
- * @param array $args Arguments used to register the post type.
+ * @param object $args Arguments used to register the post type.
*/
do_action( 'registered_post_type', $post_type, $args );
@@ -1365,7 +1466,7 @@ function register_post_type( $post_type, $args = array() ) {
}
/**
- * Builds an object with all post type capabilities out of a post type object
+ * Build an object with all post type capabilities out of a post type object
*
* Post type capabilities use the 'capability_type' argument as a base, if the
* capability is not set in the 'capabilities' argument array or if the
@@ -1411,11 +1512,13 @@ function register_post_type( $post_type, $args = array() ) {
* only assigned by default if the post type is registered with the 'map_meta_cap'
* argument set to true (default is false).
*
- * @see map_meta_cap()
* @since 3.0.0
*
- * @param object $args Post type registration arguments
- * @return object object with all the capabilities as member variables
+ * @see register_post_type()
+ * @see map_meta_cap()
+ *
+ * @param object $args Post type registration arguments.
+ * @return object object with all the capabilities as member variables.
*/
function get_post_type_capabilities( $args ) {
if ( ! is_array( $args->capability_type ) )
@@ -1464,10 +1567,12 @@ function get_post_type_capabilities( $args ) {
}
/**
- * Stores or returns a list of post type meta caps for map_meta_cap().
+ * Store or return a list of post type meta caps for map_meta_cap().
*
* @since 3.1.0
* @access private
+ *
+ * @param null|array $capabilities Post type meta capabilities.
*/
function _post_type_meta_capabilities( $capabilities = null ) {
static $meta_caps = array();
@@ -1480,30 +1585,37 @@ function _post_type_meta_capabilities( $capabilities = null ) {
}
/**
- * Builds an object with all post type labels out of a post type object
+ * Build an object with all post type labels out of a post type object
*
* Accepted keys of the label array in the post type object:
- * - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages
+ *
+ * - name - general name for the post type, usually plural. The same and overridden
+ * by $post_type_object->label. Default is Posts/Pages
* - singular_name - name for one object of this post type. Default is Post/Page
- * - add_new - Default is Add New for both hierarchical and non-hierarchical types. When internationalizing this string, please use a {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} matching your post type. Example: _x('Add New', 'product');
- * - add_new_item - Default is Add New Post/Add New Page
- * - edit_item - Default is Edit Post/Edit Page
- * - new_item - Default is New Post/New Page
- * - view_item - Default is View Post/View Page
- * - search_items - Default is Search Posts/Search Pages
- * - not_found - Default is No posts found/No pages found
- * - not_found_in_trash - Default is No posts found in Trash/No pages found in Trash
- * - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical ones the default is Parent Page:
- * - all_items - String for the submenu. Default is All Posts/All Pages
- * - menu_name - Default is the same as name
- *
- * Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages).
+ * - add_new - Default is Add New for both hierarchical and non-hierarchical types.
+ * When internationalizing this string, please use a gettext context
+ * {@see http://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.
+ * - menu_name - Default is the same as name.
+ *
+ * Above, the first default value is for non-hierarchical post types (like posts)
+ * and the second one is for hierarchical post types (like pages).
*
* @since 3.0.0
* @access private
*
- * @param object $post_type_object
- * @return object object with all the labels as member variables
+ * @param object $post_type_object Post type object.
+ * @return object object with all the labels as member variables.
*/
function get_post_type_labels( $post_type_object ) {
$nohier_vs_hier_defaults = array(
@@ -1542,10 +1654,14 @@ function get_post_type_labels( $post_type_object ) {
}
/**
- * Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object
+ * Build an object with custom-something object (post type, taxonomy) labels
+ * out of a custom-something object
*
- * @access private
* @since 3.0.0
+ * @access private
+ *
+ * @param object $object A custom-something object.
+ * @param array $nohier_vs_hier_defaults Hierarchical vs non-hierarchical default labels.
*/
function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
$object->labels = (array) $object->labels;
@@ -1573,7 +1689,7 @@ function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
}
/**
- * Adds submenus for post types.
+ * Add submenus for post types.
*
* @access private
* @since 3.1.0
@@ -1581,7 +1697,7 @@ function _get_custom_object_labels( $object, $nohier_vs_hier_defaults ) {
function _add_post_type_submenus() {
foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) {
$ptype_obj = get_post_type_object( $ptype );
- // Submenus only.
+ // Sub-menus only.
if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true )
continue;
add_submenu_page( $ptype_obj->show_in_menu, $ptype_obj->labels->name, $ptype_obj->labels->all_items, $ptype_obj->cap->edit_posts, "edit.php?post_type=$ptype" );
@@ -1604,7 +1720,7 @@ add_action( 'admin_menu', '_add_post_type_submenus' );
* @since 3.0.0
*
* @param string $post_type The post type for which to add the feature.
- * @param string|array $feature The feature being added, accpets an array of
+ * @param string|array $feature The feature being added, accepts an array of
* feature strings or a single string.
*/
function add_post_type_support( $post_type, $feature ) {
@@ -1623,8 +1739,9 @@ function add_post_type_support( $post_type, $feature ) {
* Remove support for a feature from a post type.
*
* @since 3.0.0
- * @param string $post_type The post type for which to remove the feature
- * @param string $feature The feature being removed
+ *
+ * @param string $post_type The post type for which to remove the feature.
+ * @param string $feature The feature being removed.
*/
function remove_post_type_support( $post_type, $feature ) {
global $_wp_post_type_features;
@@ -1637,10 +1754,10 @@ function remove_post_type_support( $post_type, $feature ) {
* Get all the post type features
*
* @since 3.4.0
- * @param string $post_type The post type
- * @return array
+ *
+ * @param string $post_type The post type.
+ * @return array Post type supports list.
*/
-
function get_all_post_type_supports( $post_type ) {
global $_wp_post_type_features;
@@ -1651,14 +1768,14 @@ function get_all_post_type_supports( $post_type ) {
}
/**
- * Checks a post type's support for a given feature
+ * Check a post type's support for a given feature.
*
* @since 3.0.0
- * @param string $post_type The post type being checked
- * @param string $feature the feature being checked
- * @return boolean
+ *
+ * @param string $post_type The post type being checked.
+ * @param string $feature the feature being checked.
+ * @return bool Whether the post type supports the given feature.
*/
-
function post_type_supports( $post_type, $feature ) {
global $_wp_post_type_features;
@@ -1666,17 +1783,17 @@ function post_type_supports( $post_type, $feature ) {
}
/**
- * Updates the post type for the post ID.
+ * Update the post type for the post ID.
*
* The page or post cache will be cleaned for the post ID.
*
* @since 2.5.0
*
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database access abstraction object.
*
- * @param int $post_id Post ID to change post type. Not actually optional.
- * @param string $post_type Optional, default is post. Supported values are 'post' or 'page' to
- * name a few.
+ * @param int $post_id Optional. Post ID to change post type. Default 0.
+ * @param string $post_type Optional. Post type. Accepts 'post' or 'page' to
+ * name a few. Default 'post'.
* @return int Amount of rows changed. Should be 1 for success and 0 for failure.
*/
function set_post_type( $post_id = 0, $post_type = 'post' ) {
@@ -1694,27 +1811,32 @@ function set_post_type( $post_id = 0, $post_type = 'post' ) {
* Retrieve list of latest posts or posts matching criteria.
*
* The defaults are as follows:
- * 'numberposts' - Default is 5. Total number of posts to retrieve.
- * 'offset' - Default is 0. See {@link WP_Query::query()} for more.
- * 'category' - What category to pull the posts from.
- * 'orderby' - Default is 'date', which orders based on post_date. How to order the posts.
- * 'order' - Default is 'DESC'. The order to retrieve the posts.
- * 'include' - See {@link WP_Query::query()} for more.
- * 'exclude' - See {@link WP_Query::query()} for more.
- * 'meta_key' - See {@link WP_Query::query()} for more.
- * 'meta_value' - See {@link WP_Query::query()} for more.
- * 'post_type' - Default is 'post'. Can be 'page', or 'attachment' to name a few.
- * 'post_parent' - The parent of the post or post type.
- * 'post_status' - Default is 'publish'. Post status to retrieve.
*
* @since 1.2.0
- * @uses WP_Query::query() See for more default arguments and information.
- * @link http://codex.wordpress.org/Template_Tags/get_posts
*
- * @param array $args Optional. Overrides defaults.
+ * @see WP_Query::parse_query()
+ *
+ * @param array $args {
+ * Optional. Arguments to retrieve posts. {@see WP_Query::parse_query()} for more
+ * available arguments.
+ *
+ * @type int $numberposts Total number of posts to retrieve. Is an alias of $posts_per_page
+ * in WP_Query. Accepts 1+ and -1 for all. Default 5.
+ * @type int $offset The number of posts to offset before retrieval. Default 0.
+ * @type int|string $category Category ID or comma-separated list of IDs (this or any children).
+ * Is an alias of $cat in WP_Query. Default 0.
+ * @type string $orderby Which field to order posts by. Accepts post fields. Default 'date'.
+ * @type array $include An array of post IDs to retrieve, sticky posts will be included.
+ * Is an alias of $post__in in WP_Query. Default empty array.
+ * @type array $exclude An array of post IDs not to retrieve. Default empty array.
+ * @type string $meta_key Custom field key. Default empty.
+ * @type mixed $meta_value Custom field value. Default empty string.
+ * @type string $post_type Post type. Default 'post'.
+ * @type bool $suppress_filters Whether to suppress filters. Default true.
+ * }
* @return array List of posts.
*/
-function get_posts($args = null) {
+function get_posts( $args = null ) {
$defaults = array(
'numberposts' => 5, 'offset' => 0,
'category' => 0, 'orderby' => 'date',
@@ -1756,16 +1878,16 @@ function get_posts($args = null) {
* Post meta data is called "Custom Fields" on the Administration Screen.
*
* @since 1.5.0
- * @link http://codex.wordpress.org/Function_Reference/add_post_meta
*
- * @param int $post_id Post ID.
- * @param string $meta_key Metadata name.
- * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
- * @param bool $unique Optional, default is false. Whether the same key should not be added.
+ * @param int $post_id Post ID.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param bool $unique Optional. Whether the same key should not be added.
+ * Default false.
* @return int|bool Meta ID on success, false on failure.
*/
-function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) {
- // make sure meta is added to the post, not a revision
+function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {
+ // Make sure meta is added to the post, not a revision.
if ( $the_post = wp_is_post_revision($post_id) )
$post_id = $the_post;
@@ -1780,15 +1902,15 @@ function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) {
* allows removing all metadata matching key, if needed.
*
* @since 1.5.0
- * @link http://codex.wordpress.org/Function_Reference/delete_post_meta
*
- * @param int $post_id post ID
- * @param string $meta_key Metadata name.
- * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar.
+ * @param int $post_id Post ID.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if
+ * non-scalar. Default empty.
* @return bool True on success, false on failure.
*/
-function delete_post_meta($post_id, $meta_key, $meta_value = '') {
- // make sure meta is added to the post, not a revision
+function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
+ // Make sure meta is added to the post, not a revision.
if ( $the_post = wp_is_post_revision($post_id) )
$post_id = $the_post;
@@ -1799,15 +1921,15 @@ function delete_post_meta($post_id, $meta_key, $meta_value = '') {
* Retrieve post meta field for a post.
*
* @since 1.5.0
- * @link http://codex.wordpress.org/Function_Reference/get_post_meta
*
- * @param int $post_id Post ID.
- * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
- * @param bool $single Whether to return a single value.
- * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
- * is true.
+ * @param int $post_id Post ID.
+ * @param string $key Optional. The meta key to retrieve. By default, returns
+ * data for all keys. Default empty.
+ * @param bool $single Optional. Whether to return a single value. Default false.
+ * @return mixed Will be an array if $single is false. Will be value of meta data
+ * field if $single is true.
*/
-function get_post_meta($post_id, $key = '', $single = false) {
+function get_post_meta( $post_id, $key = '', $single = false ) {
return get_metadata('post', $post_id, $key, $single);
}
@@ -1820,16 +1942,17 @@ function get_post_meta($post_id, $key = '', $single = false) {
* If the meta field for the post does not exist, it will be added.
*
* @since 1.5.0
- * @link http://codex.wordpress.org/Function_Reference/update_post_meta
*
- * @param int $post_id Post ID.
- * @param string $meta_key Metadata key.
- * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
- * @param mixed $prev_value Optional. Previous value to check before removing.
- * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
+ * @param int $post_id Post ID.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
+ * @param mixed $prev_value Optional. Previous value to check before removing.
+ * Default empty.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update,
+ * false on failure.
*/
-function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {
- // make sure meta is added to the post, not a revision
+function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
+ // Make sure meta is added to the post, not a revision.
if ( $the_post = wp_is_post_revision($post_id) )
$post_id = $the_post;
@@ -1842,9 +1965,9 @@ function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {
* @since 2.3.0
*
* @param string $post_meta_key Key to search for when deleting.
- * @return bool Whether the post meta key was deleted from the database
+ * @return bool Whether the post meta key was deleted from the database.
*/
-function delete_post_meta_by_key($post_meta_key) {
+function delete_post_meta_by_key( $post_meta_key ) {
return delete_metadata( 'post', null, $post_meta_key, '', true );
}
@@ -1855,10 +1978,9 @@ function delete_post_meta_by_key($post_meta_key) {
* so the function is optimized to be called more than once.
*
* @since 1.2.0
- * @link http://codex.wordpress.org/Function_Reference/get_post_custom
*
- * @param int $post_id Post ID.
- * @return array
+ * @param int $post_id Optional. Post ID. Default is ID of the global $post.
+ * @return array Post meta for the given post.
*/
function get_post_custom( $post_id = 0 ) {
$post_id = absint( $post_id );
@@ -1874,10 +1996,10 @@ function get_post_custom( $post_id = 0 ) {
* If there are no meta fields, then nothing (null) will be returned.
*
* @since 1.2.0
- * @link http://codex.wordpress.org/Function_Reference/get_post_custom_keys
*
- * @param int $post_id post ID
- * @return array|null Either array of the keys, or null if keys could not be retrieved.
+ * @param int $post_id Optional. Post ID. Default is ID of the global $post.
+ * @return array|null Either array of the keys, or null if keys could not be
+ * retrieved.
*/
function get_post_custom_keys( $post_id = 0 ) {
$custom = get_post_custom( $post_id );
@@ -1896,10 +2018,9 @@ function get_post_custom_keys( $post_id = 0 ) {
* will be retrieved and only the meta field key values returned.
*
* @since 1.2.0
- * @link http://codex.wordpress.org/Function_Reference/get_post_custom_values
*
- * @param string $key Meta field key.
- * @param int $post_id Post ID
+ * @param string $key Optional. Meta field key. Default empty.
+ * @param int $post_id Optional. Post ID. Default is ID of the global $post.
* @return array Meta field values.
*/
function get_post_custom_values( $key = '', $post_id = 0 ) {
@@ -1919,7 +2040,7 @@ function get_post_custom_values( $key = '', $post_id = 0 ) {
*
* @since 2.7.0
*
- * @param int $post_id Optional. Post ID.
+ * @param int $post_id Optional. Post ID. Default is ID of the global $post.
* @return bool Whether post is sticky.
*/
function is_sticky( $post_id = 0 ) {
@@ -1942,18 +2063,23 @@ function is_sticky( $post_id = 0 ) {
/**
* Sanitize every post field.
*
- * If the context is 'raw', then the post object or array will get minimal santization of the int fields.
+ * If the context is 'raw', then the post object or array will get minimal
+ * sanitization of the integer fields.
*
* @since 2.3.0
- * @uses sanitize_post_field() Used to sanitize the fields.
*
- * @param object|WP_Post|array $post The Post Object or Array
- * @param string $context Optional, default is 'display'. How to sanitize post fields.
- * @return object|WP_Post|array The now sanitized Post Object or Array (will be the same type as $post)
+ * @see sanitize_post_field()
+ *
+ * @param object|WP_Post|array $post The Post Object or Array
+ * @param string $context Optional. How to sanitize post fields.
+ * Accepts 'raw', 'edit', 'db', or 'display'.
+ * Default 'display'.
+ * @return object|WP_Post|array The now sanitized Post Object or Array (will be the
+ * same type as $post).
*/
-function sanitize_post($post, $context = 'display') {
+function sanitize_post( $post, $context = 'display' ) {
if ( is_object($post) ) {
- // Check if post already filtered for this context
+ // Check if post already filtered for this context.
if ( isset($post->filter) && $context == $post->filter )
return $post;
if ( !isset($post->ID) )
@@ -1962,7 +2088,7 @@ function sanitize_post($post, $context = 'display') {
$post->$field = sanitize_post_field($field, $post->$field, $post->ID, $context);
$post->filter = $context;
} else {
- // Check if post already filtered for this context
+ // Check if post already filtered for this context.
if ( isset($post['filter']) && $context == $post['filter'] )
return $post;
if ( !isset($post['ID']) )
@@ -1977,17 +2103,17 @@ function sanitize_post($post, $context = 'display') {
/**
* Sanitize post field based on context.
*
- * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
- * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
- * when calling filters.
+ * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and
+ * 'js'. The 'display' context is used by default. 'attribute' and 'js' contexts
+ * are treated like 'display' when calling filters.
*
* @since 2.3.0
*
- * @param string $field The Post Object field name.
- * @param mixed $value The Post Object value.
- * @param int $post_id Post ID.
- * @param string $context How to sanitize post fields. Looks for 'raw', 'edit', 'db', 'display',
- * 'attribute' and 'js'.
+ * @param string $field The Post Object field name.
+ * @param mixed $value The Post Object value.
+ * @param int $post_id Post ID.
+ * @param string $context How to sanitize post fields. Looks for 'raw', 'edit',
+ * 'db', 'display', 'attribute' and 'js'.
* @return mixed Sanitized value.
*/
function sanitize_post_field($field, $value, $post_id, $context) {
@@ -1995,7 +2121,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
if ( in_array($field, $int_fields) )
$value = (int) $value;
- // Fields which contain arrays of ints.
+ // Fields which contain arrays of integers.
$array_int_fields = array( 'ancestors' );
if ( in_array($field, $array_int_fields) ) {
$value = array_map( 'absint', $value);
@@ -2019,7 +2145,8 @@ function sanitize_post_field($field, $value, $post_id, $context) {
/**
* Filter the value of a specific post field to edit.
*
- * The dynamic portion of the hook name, $field, refers to the post field name.
+ * The dynamic portion of the hook name, $field, refers to the post
+ * field name.
*
* @since 2.3.0
*
@@ -2058,7 +2185,8 @@ function sanitize_post_field($field, $value, $post_id, $context) {
/**
* Filter the value of a specific post field before saving.
*
- * The dynamic portion of the hook name, $field, refers to the post field name.
+ * The dynamic portion of the hook name, $field, refers to the post
+ * field name.
*
* @since 2.3.0
*
@@ -2083,7 +2211,8 @@ function sanitize_post_field($field, $value, $post_id, $context) {
/**
* Filter the value of a specific post field before saving.
*
- * The dynamic portion of the hook name, $field, refers to the post field name.
+ * The dynamic portion of the hook name, $field, refers to the post
+ * field name.
*
* @since 2.3.0
*
@@ -2099,7 +2228,8 @@ function sanitize_post_field($field, $value, $post_id, $context) {
/**
* Filter the value of a specific post field for display.
*
- * The dynamic portion of the hook name, $field, refers to the post field name.
+ * The dynamic portion of the hook name, $field, refers to the post
+ * field name.
*
* @since 2.3.0
*
@@ -2132,7 +2262,7 @@ function sanitize_post_field($field, $value, $post_id, $context) {
*
* @param int $post_id Post ID.
*/
-function stick_post($post_id) {
+function stick_post( $post_id ) {
$stickies = get_option('sticky_posts');
if ( !is_array($stickies) )
@@ -2145,7 +2275,7 @@ function stick_post($post_id) {
}
/**
- * Unstick a post.
+ * Un-stick a post.
*
* Sticky posts should be displayed at the top of the front page.
*
@@ -2153,7 +2283,7 @@ function stick_post($post_id) {
*
* @param int $post_id Post ID.
*/
-function unstick_post($post_id) {
+function unstick_post( $post_id ) {
$stickies = get_option('sticky_posts');
if ( !is_array($stickies) )
@@ -2172,19 +2302,19 @@ function unstick_post($post_id) {
}
/**
- * Return the cache key for wp_count_posts() based on the passed arguments
+ * Return the cache key for wp_count_posts() based on the passed arguments.
*
* @since 3.9.0
*
- * @param string $type Optional. Post type to retrieve count
- * @param string $perm Optional. 'readable' or empty.
+ * @param string $type Optional. Post type to retrieve count Default 'post'.
+ * @param string $perm Optional. 'readable' or empty. Default empty.
* @return string The cache key.
*/
function _count_posts_cache_key( $type = 'post', $perm = '' ) {
$cache_key = 'posts-' . $type;
if ( 'readable' == $perm && is_user_logged_in() ) {
$post_type_object = get_post_type_object( $type );
- if ( ! current_user_can( $post_type_object->cap->read_private_posts ) ) {
+ if ( $post_type_object && ! current_user_can( $post_type_object->cap->read_private_posts ) ) {
$cache_key .= '_' . $perm . '_' . get_current_user_id();
}
}
@@ -2202,13 +2332,11 @@ function _count_posts_cache_key( $type = 'post', $perm = '' ) {
* The $perm parameter checks for 'readable' value and if the user can read
* private posts, it will display that for the user that is signed in.
*
- * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
- *
* @since 2.5.0
*
- * @param string $type Optional. Post type to retrieve count
- * @param string $perm Optional. 'readable' or empty.
- * @return object Number of posts for each status
+ * @param string $type Optional. Post type to retrieve count. Default 'post'.
+ * @param string $perm Optional. 'readable' or empty. Default empty.
+ * @return object Number of posts for each status.
*/
function wp_count_posts( $type = 'post', $perm = '' ) {
global $wpdb;
@@ -2265,7 +2393,8 @@ function wp_count_posts( $type = 'post', $perm = '' ) {
*
* @since 2.5.0
*
- * @param string|array $mime_type Optional. Array or comma-separated list of MIME patterns.
+ * @param string|array $mime_type Optional. Array or comma-separated list of
+ * MIME patterns. Default empty.
* @return object An object containing the attachment counts by mime type.
*/
function wp_count_attachments( $mime_type = '' ) {
@@ -2285,18 +2414,20 @@ function wp_count_attachments( $mime_type = '' ) {
*
* @since 3.7.0
*
- * @param object $counts An object containing the attachment counts by mime type.
- * @param string $mime_type The mime type pattern used to filter the attachments counted.
+ * @param object $counts An object containing the attachment counts by
+ * mime type.
+ * @param string $mime_type The mime type pattern used to filter the attachments
+ * counted.
*/
return apply_filters( 'wp_count_attachments', (object) $counts, $mime_type );
}
/**
- * Get default post mime types
+ * Get default post mime types.
*
* @since 2.9.0
*
- * @return array
+ * @return array List of post mime types.
*/
function get_post_mime_types() {
$post_mime_types = array( // array( adj, noun )
@@ -2324,32 +2455,42 @@ function get_post_mime_types() {
*
* @since 2.5.0
*
- * @param string|array $wildcard_mime_types e.g. audio/mpeg or image (same as image/*) or
- * flash (same as *flash*).
- * @param string|array $real_mime_types post_mime_type values
- * @return array array(wildcard=>array(real types))
+ * @param string|array $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*)
+ * or flash (same as *flash*).
+ * @param string|array $real_mime_types Real post mime type values.
+ * @return array array(wildcard=>array(real types)).
*/
-function wp_match_mime_types($wildcard_mime_types, $real_mime_types) {
+function wp_match_mime_types( $wildcard_mime_types, $real_mime_types ) {
$matches = array();
- if ( is_string($wildcard_mime_types) )
- $wildcard_mime_types = array_map('trim', explode(',', $wildcard_mime_types));
- if ( is_string($real_mime_types) )
- $real_mime_types = array_map('trim', explode(',', $real_mime_types));
+ if ( is_string( $wildcard_mime_types ) ) {
+ $wildcard_mime_types = array_map( 'trim', explode( ',', $wildcard_mime_types ) );
+ }
+ if ( is_string( $real_mime_types ) ) {
+ $real_mime_types = array_map( 'trim', explode( ',', $real_mime_types ) );
+ }
+
+ $patternses = array();
$wild = '[-._a-z0-9]*';
+
foreach ( (array) $wildcard_mime_types as $type ) {
- $type = str_replace('*', $wild, $type);
- $patternses[1][$type] = "^$type$";
+ $regex = str_replace( '__wildcard__', $wild, preg_quote( str_replace( '*', '__wildcard__', $type ) ) );
+ $patternses[1][$type] = "^$regex$";
if ( false === strpos($type, '/') ) {
- $patternses[2][$type] = "^$type/";
- $patternses[3][$type] = $type;
+ $patternses[2][$type] = "^$regex/";
+ $patternses[3][$type] = $regex;
}
}
- asort($patternses);
- foreach ( $patternses as $patterns )
- foreach ( $patterns as $type => $pattern )
- foreach ( (array) $real_mime_types as $real )
- if ( preg_match("#$pattern#", $real) && ( empty($matches[$type]) || false === array_search($real, $matches[$type]) ) )
+ asort( $patternses );
+
+ foreach ( $patternses as $patterns ) {
+ foreach ( $patterns as $type => $pattern ) {
+ foreach ( (array) $real_mime_types as $real ) {
+ if ( preg_match( "#$pattern#", $real ) && ( empty( $matches[$type] ) || false === array_search( $real, $matches[$type] ) ) ) {
$matches[$type][] = $real;
+ }
+ }
+ }
+ }
return $matches;
}
@@ -2358,11 +2499,13 @@ function wp_match_mime_types($wildcard_mime_types, $real_mime_types) {
*
* @since 2.5.0
*
- * @param string|array $post_mime_types List of mime types or comma separated string of mime types.
- * @param string $table_alias Optional. Specify a table alias, if needed.
+ * @param string|array $post_mime_types List of mime types or comma separated string
+ * of mime types.
+ * @param string $table_alias Optional. Specify a table alias, if needed.
+ * Default empty.
* @return string The SQL AND clause for mime searching.
*/
-function wp_post_mime_type_where($post_mime_types, $table_alias = '') {
+function wp_post_mime_type_where( $post_mime_types, $table_alias = '' ) {
$where = '';
$wildcards = array('', '%', '%/%');
if ( is_string($post_mime_types) )
@@ -2400,22 +2543,25 @@ function wp_post_mime_type_where($post_mime_types, $table_alias = '') {
}
/**
- * Trashes or deletes a post or page.
+ * Trash or delete a post or page.
*
- * When the post and page is permanently deleted, everything that is tied to it is deleted also.
- * This includes comments, post meta fields, and terms associated with the post.
+ * When the post and page is permanently deleted, everything that is tied to
+ * it is deleted also. This includes comments, post meta fields, and terms
+ * associated with the post.
*
- * The post or page is moved to trash instead of permanently deleted unless trash is
- * disabled, item is already in the trash, or $force_delete is true.
+ * The post or page is moved to trash instead of permanently deleted unless
+ * trash is disabled, item is already in the trash, or $force_delete is true.
*
* @since 1.0.0
*
- * @uses wp_delete_attachment() if post type is 'attachment'.
- * @uses wp_trash_post() if item should be trashed.
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ * @see wp_delete_attachment()
+ * @see wp_trash_post()
*
- * @param int $postid Post ID.
- * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
- * @return mixed False on failure
+ * @param int $postid Optional. Post ID. Default 0.
+ * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
+ * Default false.
+ * @return array|bool|WP_Post False on failure.
*/
function wp_delete_post( $postid = 0, $force_delete = false ) {
global $wpdb;
@@ -2449,20 +2595,20 @@ function wp_delete_post( $postid = 0, $force_delete = false ) {
$parent_where = array( 'post_parent' => $postid );
if ( is_post_type_hierarchical( $post->post_type ) ) {
- // Point children of this page to its parent, also clean the cache of affected children
+ // Point children of this page to its parent, also clean the cache of affected children.
$children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type );
$children = $wpdb->get_results( $children_query );
$wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => $post->post_type ) );
}
- // Do raw query. wp_get_post_revisions() is filtered
+ // Do raw query. wp_get_post_revisions() is filtered.
$revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
// Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
foreach ( $revision_ids as $revision_id )
wp_delete_post_revision( $revision_id );
- // Point all attachments to this post up one level
+ // Point all attachments to this post up one level.
$wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
$comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $postid ));
@@ -2519,20 +2665,23 @@ function wp_delete_post( $postid = 0, $force_delete = false ) {
}
/**
- * Resets the page_on_front, show_on_front, and page_for_post settings when a
- * linked page is deleted or trashed.
+ * Reset the page_on_front, show_on_front, and page_for_post settings when
+ * a linked page is deleted or trashed.
*
* Also ensures the post is no longer sticky.
*
- * @access private
* @since 3.7.0
- * @param $post_id
+ * @access private
+ *
+ * @param int $post_id Post ID.
*/
function _reset_front_page_settings_for_post( $post_id ) {
$post = get_post( $post_id );
if ( 'page' == $post->post_type ) {
- // If the page is defined in option page_on_front or post_for_posts,
- // adjust the corresponding options
+ /*
+ * If the page is defined in option page_on_front or post_for_posts,
+ * adjust the corresponding options.
+ */
if ( get_option( 'page_on_front' ) == $post->ID ) {
update_option( 'show_on_front', 'posts' );
update_option( 'page_on_front', 0 );
@@ -2547,18 +2696,19 @@ add_action( 'before_delete_post', '_reset_front_page_settings_for_post' );
add_action( 'wp_trash_post', '_reset_front_page_settings_for_post' );
/**
- * Moves a post or page to the Trash
+ * Move a post or page to the Trash
*
* If trash is disabled, the post or page is permanently deleted.
*
* @since 2.9.0
*
- * @uses wp_delete_post() if trash is disabled
+ * @see wp_delete_post()
*
- * @param int $post_id Post ID.
- * @return mixed False on failure
+ * @param int $post_id Optional. Post ID. Default is ID of the global $post
+ * if EMPTY_TRASH_DAYS equals true.
+ * @return bool|array Post data array, otherwise false.
*/
-function wp_trash_post($post_id = 0) {
+function wp_trash_post( $post_id = 0 ) {
if ( !EMPTY_TRASH_DAYS )
return wp_delete_post($post_id, true);
@@ -2598,14 +2748,14 @@ function wp_trash_post($post_id = 0) {
}
/**
- * Restores a post or page from the Trash
+ * Restore a post or page from the Trash.
*
* @since 2.9.0
*
- * @param int $post_id Post ID.
- * @return mixed False on failure
+ * @param int $post_id Optional. Post ID. Default is ID of the global $post.
+ * @return WP_Post|bool WP_Post object. False on failure.
*/
-function wp_untrash_post($post_id = 0) {
+function wp_untrash_post( $post_id = 0 ) {
if ( !$post = get_post($post_id, ARRAY_A) )
return $post;
@@ -2645,14 +2795,16 @@ function wp_untrash_post($post_id = 0) {
}
/**
- * Moves comments for a post to the trash
+ * Moves comments for a post to the trash.
*
* @since 2.9.0
*
- * @param int|WP_Post $post Optional. Post ID or post object.
- * @return mixed False on failure
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
+ * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
+ * @return mixed False on failure.
*/
-function wp_trash_post_comments($post = null) {
+function wp_trash_post_comments( $post = null ) {
global $wpdb;
$post = get_post($post);
@@ -2674,13 +2826,13 @@ function wp_trash_post_comments($post = null) {
if ( empty($comments) )
return;
- // Cache current status for each comment
+ // Cache current status for each comment.
$statuses = array();
foreach ( $comments as $comment )
$statuses[$comment->comment_ID] = $comment->comment_approved;
add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses);
- // Set status for all comments to post-trashed
+ // Set status for all comments to post-trashed.
$result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id));
clean_comment_cache( array_keys($statuses) );
@@ -2699,14 +2851,14 @@ function wp_trash_post_comments($post = null) {
}
/**
- * Restore comments for a post from the trash
+ * Restore comments for a post from the trash.
*
* @since 2.9.0
*
- * @param int|WP_Post $post Optional. Post ID or post object.
- * @return mixed False on failure
+ * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
+ * @return mixed False on failure.
*/
-function wp_untrash_post_comments($post = null) {
+function wp_untrash_post_comments( $post = null ) {
global $wpdb;
$post = get_post($post);
@@ -2729,7 +2881,7 @@ function wp_untrash_post_comments($post = null) {
*/
do_action( 'untrash_post_comments', $post_id );
- // Restore each comment to its original status
+ // Restore each comment to its original status.
$group_by_status = array();
foreach ( $statuses as $comment_id => $comment_status )
$group_by_status[$comment_status][] = $comment_id;
@@ -2764,11 +2916,12 @@ function wp_untrash_post_comments($post = null) {
*
* @since 2.1.0
*
- * @uses wp_get_object_terms() Retrieves the categories. Args details can be found here.
+ * @see wp_get_object_terms()
*
- * @param int $post_id Optional. The Post ID.
- * @param array $args Optional. Overwrite the defaults.
- * @return array
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the
+ * global $post. Default 0.
+ * @param array $args Optional. Category arguments. Default empty.
+ * @return array List of categories.
*/
function wp_get_post_categories( $post_id = 0, $args = array() ) {
$post_id = (int) $post_id;
@@ -2789,9 +2942,10 @@ function wp_get_post_categories( $post_id = 0, $args = array() ) {
*
* @since 2.3.0
*
- * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
+ * @uses wp_get_object_terms()
*
- * @param int $post_id Optional. The Post ID
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the
+ * global $post. Defualt 0.
* @param array $args Optional. Overwrite the defaults
* @return array List of post tags.
*/
@@ -2808,11 +2962,12 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) {
*
* @since 2.8.0
*
- * @uses wp_get_object_terms() Gets the tags for returning. Args can be found here
+ * @uses wp_get_object_terms()
*
- * @param int $post_id Optional. The Post ID
- * @param string $taxonomy The taxonomy for which to retrieve terms. Defaults to post_tag.
- * @param array $args Optional. Overwrite the defaults
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the
+ * global $post. Default 0.
+ * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
+ * @param array $args Optional. {@link wp_get_object_terms()} arguments. Default empty array.
* @return array List of post tags.
*/
function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
@@ -2827,16 +2982,16 @@ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array(
}
/**
- * Retrieve number of recent posts.
+ * Retrieve a number of recent posts.
*
* @since 1.0.0
- * @uses wp_parse_args()
- * @uses get_posts()
*
- * @param string $deprecated Deprecated.
- * @param array $args Optional. Overrides defaults.
- * @param string $output Optional.
- * @return unknown.
+ * @see get_posts()
+ *
+ * @param string $deprecated Not used.
+ * @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|bool Associative array if $output equals ARRAY_A, array or false if no results.
*/
function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
@@ -2845,7 +3000,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
$args = array( 'numberposts' => absint( $args ) );
}
- // Set default arguments
+ // Set default arguments.
$defaults = array(
'numberposts' => 10, 'offset' => 0,
'category' => 0, 'orderby' => 'post_date',
@@ -2859,7 +3014,7 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
$results = get_posts( $r );
- // Backward compatibility. Prior to 3.1 expected posts to be returned in array
+ // Backward compatibility. Prior to 3.1 expected posts to be returned in array.
if ( ARRAY_A == $output ){
foreach( $results as $key => $result ) {
$results[$key] = get_object_vars( $result );
@@ -2880,30 +3035,34 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) {
* and 'post_date_gmt' keys. You can close the comments or open the comments by
* setting the value for 'comment_status' key.
*
- * @global wpdb $wpdb WordPress database abstraction object.
- *
* @since 1.0.0
*
+ * @see sanitize_post()
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @param array $postarr {
* An array of elements that make up a post to update or insert.
*
- * @type int $ID The post ID. If equal to something other than 0, the post with that ID will
- * be updated. Default 0.
+ * @type int $ID The post ID. If equal to something other than 0,
+ * the post with that ID will be updated. Default 0.
* @type string $post_status The post status. Default 'draft'.
* @type string $post_type The post type. Default 'post'.
- * @type int $post_author The ID of the user who added the post. Default the current user ID.
- * @type bool $ping_status Whether the post can accept pings. Default value of 'default_ping_status' option.
+ * @type int $post_author The ID of the user who added the post. Default is
+ * the current user ID.
+ * @type bool $ping_status Whether the post can accept pings. Default is the
+ * value of 'default_ping_status' option.
* @type int $post_parent Set this for the post it belongs to, if any. Default 0.
* @type int $menu_order The order it is displayed. Default 0.
- * @type string $to_ping Space or carriage return-separated list of URLs to ping. Default empty string.
- * @type string $pinged Space or carriage return-separated list of URLs that have been pinged.
+ * @type string $to_ping Space or carriage return-separated list of URLs to ping.
* Default empty string.
+ * @type string $pinged Space or carriage return-separated list of URLs that have
+ * been pinged. Default empty string.
* @type string $post_password The password to access the post. Default empty string.
* @type string $guid' Global Unique ID for referencing the post.
* @type string $post_content_filtered The filtered post content. Default empty string.
* @type string $post_excerpt The post excerpt. Default empty string.
* }
- * @param bool $wp_error Optional. Allow return of WP_Error on failure.
+ * @param bool $wp_error Optional. Whether to allow return of WP_Error on failure. Default false.
* @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
*/
function wp_insert_post( $postarr, $wp_error = false ) {
@@ -2915,7 +3074,7 @@ function wp_insert_post( $postarr, $wp_error = false ) {
'ping_status' => get_option('default_ping_status'), 'post_parent' => 0,
'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '',
'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0,
- 'post_content' => '', 'post_title' => '');
+ 'post_content' => '', 'post_title' => '', 'context' => '');
$postarr = wp_parse_args($postarr, $defaults);
@@ -2923,32 +3082,44 @@ function wp_insert_post( $postarr, $wp_error = false ) {
$postarr = sanitize_post($postarr, 'db');
- // export array as variables
- extract($postarr, EXTR_SKIP);
-
// Are we updating or creating?
$post_ID = 0;
$update = false;
- if ( ! empty( $ID ) ) {
+ $guid = $postarr['guid'];
+
+ if ( ! empty( $postarr['ID'] ) ) {
$update = true;
- // Get the post ID and GUID
- $post_ID = $ID;
+ // Get the post ID and GUID.
+ $post_ID = $postarr['ID'];
$post_before = get_post( $post_ID );
if ( is_null( $post_before ) ) {
- if ( $wp_error )
+ if ( $wp_error ) {
return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );
+ }
return 0;
}
$guid = get_post_field( 'guid', $post_ID );
- $previous_status = get_post_field('post_status', $ID);
+ $previous_status = get_post_field('post_status', $post_ID );
} else {
$previous_status = 'new';
}
- $maybe_empty = ! $post_content && ! $post_title && ! $post_excerpt && post_type_supports( $post_type, 'editor' )
- && post_type_supports( $post_type, 'title' ) && post_type_supports( $post_type, 'excerpt' );
+ $post_type = empty( $postarr['post_type'] ) ? 'post' : $postarr['post_type'];
+
+ $post_title = $postarr['post_title'];
+ $post_content = $postarr['post_content'];
+ $post_excerpt = $postarr['post_excerpt'];
+ if ( isset( $postarr['post_name'] ) ) {
+ $post_name = $postarr['post_name'];
+ }
+
+ $maybe_empty = 'attachment' !== $post_type
+ && ! $post_content && ! $post_title && ! $post_excerpt
+ && post_type_supports( $post_type, 'editor' )
+ && post_type_supports( $post_type, 'title' )
+ && post_type_supports( $post_type, 'excerpt' );
/**
* Filter whether the post should be considered "empty".
@@ -2967,74 +3138,89 @@ function wp_insert_post( $postarr, $wp_error = false ) {
* @param array $postarr Array of post data.
*/
if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) {
- if ( $wp_error )
+ if ( $wp_error ) {
return new WP_Error( 'empty_content', __( 'Content, title, and excerpt are empty.' ) );
- else
+ } else {
return 0;
+ }
}
- if ( empty($post_type) )
- $post_type = 'post';
-
- if ( empty($post_status) )
- $post_status = 'draft';
+ $post_status = empty( $postarr['post_status'] ) ? 'draft' : $postarr['post_status'];
+ if ( 'attachment' === $post_type && ! in_array( $post_status, array( 'inherit', 'private', 'trash' ) ) ) {
+ $post_status = 'inherit';
+ }
- if ( !empty($post_category) )
- $post_category = array_filter($post_category); // Filter out empty terms
+ if ( ! empty( $postarr['post_category'] ) ) {
+ // Filter out empty terms.
+ $post_category = array_filter( $postarr['post_category'] );
+ }
// Make sure we set a valid category.
- if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
+ if ( empty( $post_category ) || 0 == count( $post_category ) || ! is_array( $post_category ) ) {
// 'post' requires at least one category.
- if ( 'post' == $post_type && 'auto-draft' != $post_status )
+ if ( 'post' == $post_type && 'auto-draft' != $post_status ) {
$post_category = array( get_option('default_category') );
- else
+ } else {
$post_category = array();
+ }
}
- if ( empty($post_author) )
- $post_author = $user_id;
-
- // Don't allow contributors to set the post slug for pending review posts
- if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) )
+ // Don't allow contributors to set the post slug for pending review posts.
+ if ( 'pending' == $post_status && !current_user_can( 'publish_posts' ) ) {
$post_name = '';
+ }
- // Create a valid post name. Drafts and pending posts are allowed to have an empty
- // post name.
+ /*
+ * Create a valid post name. Drafts and pending posts are allowed to have
+ * an empty post name.
+ */
if ( empty($post_name) ) {
- if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
+ if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) {
$post_name = sanitize_title($post_title);
- else
+ } else {
$post_name = '';
+ }
} else {
// On updates, we need to check to see if it's using the old, fixed sanitization context.
$check_name = sanitize_title( $post_name, '', 'old-save' );
- if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $ID ) == $check_name )
+ if ( $update && strtolower( urlencode( $post_name ) ) == $check_name && get_post_field( 'post_name', $post_ID ) == $check_name ) {
$post_name = $check_name;
- else // new post, or slug has changed.
+ } else { // new post, or slug has changed.
$post_name = sanitize_title($post_name);
+ }
}
- // If the post date is empty (due to having been new or a draft) and status is not 'draft' or 'pending', set date to now
- if ( empty($post_date) || '0000-00-00 00:00:00' == $post_date )
- $post_date = current_time('mysql');
+ /*
+ * If the post date is empty (due to having been new or a draft) and status
+ * is not 'draft' or 'pending', set date to now.
+ */
+ if ( empty( $postarr['post_date'] ) || '0000-00-00 00:00:00' == $postarr['post_date'] ) {
+ $post_date = current_time( 'mysql' );
+ } else {
+ $post_date = $postarr['post_date'];
+ }
- // validate the date
- $mm = substr( $post_date, 5, 2 );
- $jj = substr( $post_date, 8, 2 );
- $aa = substr( $post_date, 0, 4 );
- $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date );
- if ( !$valid_date ) {
- if ( $wp_error )
- return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) );
- else
- return 0;
+ // Validate the date.
+ $mm = substr( $post_date, 5, 2 );
+ $jj = substr( $post_date, 8, 2 );
+ $aa = substr( $post_date, 0, 4 );
+ $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date );
+ if ( ! $valid_date ) {
+ if ( $wp_error ) {
+ return new WP_Error( 'invalid_date', __( 'Whoops, the provided date is invalid.' ) );
+ } else {
+ return 0;
}
+ }
- if ( empty($post_date_gmt) || '0000-00-00 00:00:00' == $post_date_gmt ) {
- if ( !in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) )
- $post_date_gmt = get_gmt_from_date($post_date);
- else
+ if ( empty( $postarr['post_date_gmt'] ) || '0000-00-00 00:00:00' == $postarr['post_date_gmt'] ) {
+ if ( ! in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) ) {
+ $post_date_gmt = get_gmt_from_date( $post_date );
+ } else {
$post_date_gmt = '0000-00-00 00:00:00';
+ }
+ } else {
+ $post_date_gmt = $postarr['post_date_gmt'];
}
if ( $update || '0000-00-00 00:00:00' == $post_date ) {
@@ -3045,37 +3231,58 @@ function wp_insert_post( $postarr, $wp_error = false ) {
$post_modified_gmt = $post_date_gmt;
}
- if ( 'publish' == $post_status ) {
- $now = gmdate('Y-m-d H:i:59');
- if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) )
- $post_status = 'future';
- } elseif( 'future' == $post_status ) {
- $now = gmdate('Y-m-d H:i:59');
- if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) )
- $post_status = 'publish';
+ if ( 'attachment' !== $post_type ) {
+ if ( 'publish' == $post_status ) {
+ $now = gmdate('Y-m-d H:i:59');
+ if ( mysql2date('U', $post_date_gmt, false) > mysql2date('U', $now, false) ) {
+ $post_status = 'future';
+ }
+ } elseif( 'future' == $post_status ) {
+ $now = gmdate('Y-m-d H:i:59');
+ if ( mysql2date('U', $post_date_gmt, false) <= mysql2date('U', $now, false) ) {
+ $post_status = 'publish';
+ }
+ }
}
- if ( empty($comment_status) ) {
- if ( $update )
+ if ( empty( $postarr['comment_status'] ) ) {
+ if ( $update ) {
$comment_status = 'closed';
- else
+ } else {
$comment_status = get_option('default_comment_status');
+ }
+ } else {
+ $comment_status = $postarr['comment_status'];
}
- if ( empty($ping_status) )
- $ping_status = get_option('default_ping_status');
- if ( isset($to_ping) )
- $to_ping = sanitize_trackback_urls( $to_ping );
- else
- $to_ping = '';
+ // These variables are needed by compact() later.
+ $post_content_filtered = $postarr['post_content_filtered'];
+ $post_author = empty( $postarr['post_author'] ) ? $user_id : $postarr['post_author'];
+ $ping_status = empty( $postarr['ping_status'] ) ? get_option( 'default_ping_status' ) : $postarr['ping_status'];
+ $to_ping = isset( $postarr['to_ping'] ) ? sanitize_trackback_urls( $postarr['to_ping'] ) : '';
+ $pinged = isset( $postarr['pinged'] ) ? $postarr['pinged'] : '';
+ $import_id = isset( $postarr['import_id'] ) ? $postarr['import_id'] : 0;
+
+ /*
+ * The 'wp_insert_post_parent' filter expects all variables to be present.
+ * Previously, these variables would have already been extracted
+ */
+ if ( isset( $postarr['menu_order'] ) ) {
+ $menu_order = (int) $postarr['menu_order'];
+ } else {
+ $menu_order = 0;
+ }
- if ( ! isset($pinged) )
- $pinged = '';
+ $post_password = isset( $postarr['post_password'] ) ? $postarr['post_password'] : '';
+ if ( 'private' == $post_status ) {
+ $post_password = '';
+ }
- if ( isset($post_parent) )
- $post_parent = (int) $post_parent;
- else
+ if ( isset( $postarr['post_parent'] ) ) {
+ $post_parent = (int) $postarr['post_parent'];
+ } else {
$post_parent = 0;
+ }
/**
* Filter the post parent -- used to check for and prevent hierarchy loops.
@@ -3089,28 +3296,35 @@ 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 ( isset($menu_order) )
- $menu_order = (int) $menu_order;
- else
- $menu_order = 0;
-
- if ( !isset($post_password) || 'private' == $post_status )
- $post_password = '';
+ $post_name = wp_unique_post_slug( $post_name, $post_ID, $post_status, $post_type, $post_parent );
- $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
+ // Don't unslash.
+ $post_mime_type = isset( $postarr['post_mime_type'] ) ? $postarr['post_mime_type'] : '';
- // expected_slashed (everything!)
- $data = compact( array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'guid' ) );
+ // Expected_slashed (everything!).
+ $data = compact( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'post_mime_type', 'guid' );
- /**
- * Filter slashed post data just before it is inserted into the database.
- *
- * @since 2.7.0
- *
- * @param array $data Array of slashed post data.
- * @param array $postarr Array of sanitized, but otherwise unmodified post data.
- */
- $data = apply_filters( 'wp_insert_post_data', $data, $postarr );
+ if ( 'attachment' === $post_type ) {
+ /**
+ * Filter attachment post data before it is updated in or added to the database.
+ *
+ * @since 3.9.0
+ *
+ * @param array $data An array of sanitized attachment post data.
+ * @param array $postarr An array of unsanitized attachment post data.
+ */
+ $data = apply_filters( 'wp_insert_attachment_data', $data, $postarr );
+ } else {
+ /**
+ * Filter slashed post data just before it is inserted into the database.
+ *
+ * @since 2.7.0
+ *
+ * @param array $data An array of slashed post data.
+ * @param array $postarr An array of sanitized, but otherwise unmodified post data.
+ */
+ $data = apply_filters( 'wp_insert_post_data', $data, $postarr );
+ }
$data = wp_unslash( $data );
$where = array( 'ID' => $post_ID );
@@ -3125,78 +3339,120 @@ function wp_insert_post( $postarr, $wp_error = false ) {
*/
do_action( 'pre_post_update', $post_ID, $data );
if ( false === $wpdb->update( $wpdb->posts, $data, $where ) ) {
- if ( $wp_error )
+ if ( $wp_error ) {
return new WP_Error('db_update_error', __('Could not update post in the database'), $wpdb->last_error);
- else
+ } else {
return 0;
+ }
}
} else {
- if ( isset($post_mime_type) )
- $data['post_mime_type'] = wp_unslash( $post_mime_type ); // This isn't in the update
- // If there is a suggested ID, use it if not already present
- if ( !empty($import_id) ) {
+ // If there is a suggested ID, use it if not already present.
+ if ( ! empty( $import_id ) ) {
$import_id = (int) $import_id;
if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
$data['ID'] = $import_id;
}
}
if ( false === $wpdb->insert( $wpdb->posts, $data ) ) {
- if ( $wp_error )
+ if ( $wp_error ) {
return new WP_Error('db_insert_error', __('Could not insert post into the database'), $wpdb->last_error);
- else
+ } else {
return 0;
+ }
}
$post_ID = (int) $wpdb->insert_id;
- // use the newly generated $post_ID
+ // Use the newly generated $post_ID.
$where = array( 'ID' => $post_ID );
}
- if ( empty($data['post_name']) && !in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) {
- $data['post_name'] = sanitize_title($data['post_title'], $post_ID);
+ if ( empty( $data['post_name'] ) && ! in_array( $data['post_status'], array( 'draft', 'pending', 'auto-draft' ) ) ) {
+ $data['post_name'] = sanitize_title( $data['post_title'], $post_ID );
$wpdb->update( $wpdb->posts, array( 'post_name' => $data['post_name'] ), $where );
}
- if ( is_object_in_taxonomy($post_type, 'category') )
+ if ( is_object_in_taxonomy( $post_type, 'category' ) ) {
wp_set_post_categories( $post_ID, $post_category );
+ }
- if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') )
- wp_set_post_tags( $post_ID, $tags_input );
+ if ( isset( $postarr['tags_input'] ) && is_object_in_taxonomy( $post_type, 'post_tag' ) ) {
+ wp_set_post_tags( $post_ID, $postarr['tags_input'] );
+ }
- // new-style support for all custom taxonomies
- if ( !empty($tax_input) ) {
- foreach ( $tax_input as $taxonomy => $tags ) {
+ // New-style support for all custom taxonomies.
+ if ( ! empty( $postarr['tax_input'] ) ) {
+ foreach ( $postarr['tax_input'] as $taxonomy => $tags ) {
$taxonomy_obj = get_taxonomy($taxonomy);
- if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical.
+ // array = hierarchical, string = non-hierarchical.
+ if ( is_array( $tags ) ) {
$tags = array_filter($tags);
- if ( current_user_can($taxonomy_obj->cap->assign_terms) )
+ }
+ if ( current_user_can( $taxonomy_obj->cap->assign_terms ) ) {
wp_set_post_terms( $post_ID, $tags, $taxonomy );
+ }
}
}
$current_guid = get_post_field( 'guid', $post_ID );
- // Set GUID
- if ( !$update && '' == $current_guid )
+ // Set GUID.
+ if ( ! $update && '' == $current_guid ) {
$wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post_ID ) ), $where );
+ }
+
+ if ( 'attachment' === $postarr['post_type'] ) {
+ if ( ! empty( $postarr['file'] ) ) {
+ update_attached_file( $post_ID, $postarr['file'] );
+ }
+
+ if ( ! empty( $postarr['context'] ) ) {
+ add_post_meta( $post_ID, '_wp_attachment_context', $postarr['context'], true );
+ }
+ }
clean_post_cache( $post_ID );
- $post = get_post($post_ID);
+ $post = get_post( $post_ID );
- if ( !empty($page_template) && 'page' == $data['post_type'] ) {
- $post->page_template = $page_template;
+ if ( ! empty( $postarr['page_template'] ) && 'page' == $data['post_type'] ) {
+ $post->page_template = $postarr['page_template'];
$page_templates = wp_get_theme()->get_page_templates( $post );
- if ( 'default' != $page_template && ! isset( $page_templates[ $page_template ] ) ) {
- if ( $wp_error )
+ if ( 'default' != $postarr['page_template'] && ! isset( $page_templates[ $postarr['page_template'] ] ) ) {
+ if ( $wp_error ) {
return new WP_Error('invalid_page_template', __('The page template is invalid.'));
- else
+ } else {
return 0;
+ }
}
- update_post_meta($post_ID, '_wp_page_template', $page_template);
+ update_post_meta( $post_ID, '_wp_page_template', $postarr['page_template'] );
}
- wp_transition_post_status($data['post_status'], $previous_status, $post);
+ if ( 'attachment' !== $postarr['post_type'] ) {
+ wp_transition_post_status( $data['post_status'], $previous_status, $post );
+ } else {
+ if ( $update ) {
+ /**
+ * Fires once an existing attachment has been updated.
+ *
+ * @since 2.0.0
+ *
+ * @param int $post_ID Attachment ID.
+ */
+ do_action( 'edit_attachment', $post_ID );
+ } else {
+
+ /**
+ * Fires once an attachment has been added.
+ *
+ * @since 2.0.0
+ *
+ * @param int $post_ID Attachment ID.
+ */
+ do_action( 'add_attachment', $post_ID );
+ }
+
+ return $post_ID;
+ }
if ( $update ) {
/**
@@ -3269,18 +3525,19 @@ function wp_insert_post( $postarr, $wp_error = false ) {
*
* @since 1.0.0
*
- * @param array|object $postarr Post data. Arrays are expected to be escaped, objects are not.
- * @param bool $wp_error Optional. Allow return of WP_Error on failure.
+ * @param array|object $postarr Optional. Post data. Arrays are expected to be escaped,
+ * objects are not. Default array.
+ * @param bool $wp_error Optional. Allow return of WP_Error on failure. Default false.
* @return int|WP_Error The value 0 or WP_Error on failure. The post ID on success.
*/
function wp_update_post( $postarr = array(), $wp_error = false ) {
if ( is_object($postarr) ) {
- // non-escaped post was passed
+ // Non-escaped post was passed.
$postarr = get_object_vars($postarr);
$postarr = wp_slash($postarr);
}
- // First, get all of the original fields
+ // First, get all of the original fields.
$post = get_post($postarr['ID'], ARRAY_A);
if ( is_null( $post ) ) {
@@ -3299,7 +3556,7 @@ function wp_update_post( $postarr = array(), $wp_error = false ) {
else
$post_cats = $post['post_category'];
- // Drafts shouldn't be assigned a date unless explicitly done so by the user
+ // Drafts shouldn't be assigned a date unless explicitly done so by the user.
if ( isset( $post['post_status'] ) && in_array($post['post_status'], array('draft', 'pending', 'auto-draft')) && empty($postarr['edit_date']) &&
('0000-00-00 00:00:00' == $post['post_date_gmt']) )
$clear_date = true;
@@ -3324,7 +3581,8 @@ function wp_update_post( $postarr = array(), $wp_error = false ) {
* Publish a post by transitioning the post status.
*
* @since 2.1.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int|WP_Post $post Post ID or post object.
*/
@@ -3347,10 +3605,13 @@ function wp_publish_post( $post ) {
/** This action is documented in wp-includes/post.php */
do_action( 'edit_post', $post->ID, $post );
+
/** This action is documented in wp-includes/post.php */
do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
+
/** This action is documented in wp-includes/post.php */
do_action( 'save_post', $post->ID, $post, true );
+
/** This action is documented in wp-includes/post.php */
do_action( 'wp_insert_post', $post->ID, $post, true );
}
@@ -3364,9 +3625,10 @@ function wp_publish_post( $post ) {
* @since 2.5.0
*
* @param int|WP_Post $post_id Post ID or post object.
- * @return null Nothing is returned. Which can mean that no action is required or post was published.
+ * @return null Nothing is returned. Which can mean that no action is required
+ * or post was published.
*/
-function check_and_publish_future_post($post_id) {
+function check_and_publish_future_post( $post_id ) {
$post = get_post($post_id);
@@ -3378,7 +3640,8 @@ function check_and_publish_future_post($post_id) {
$time = strtotime( $post->post_date_gmt . ' GMT' );
- if ( $time > time() ) { // Uh oh, someone jumped the gun!
+ // Uh oh, someone jumped the gun!
+ if ( $time > time() ) {
wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
return;
@@ -3392,14 +3655,15 @@ function check_and_publish_future_post($post_id) {
*
* @since 2.8.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Rewrite $wp_rewrite
- * @param string $slug the desired slug (post_name)
- * @param integer $post_ID
- * @param string $post_status no uniqueness checks are made if the post is still draft or pending
- * @param string $post_type
- * @param integer $post_parent
- * @return string unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
+ *
+ * @param string $slug The desired slug (post_name).
+ * @param int $post_ID Post ID.
+ * @param string $post_status No uniqueness checks are made if the post is still draft or pending.
+ * @param string $post_type Post type.
+ * @param int $post_parent Post parent ID.
+ * @return string Unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
*/
function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) {
if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) || ( 'inherit' == $post_status && 'revision' == $post_type ) )
@@ -3507,14 +3771,15 @@ function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_p
}
/**
- * Truncates a post slug.
+ * Truncate a post slug.
*
* @since 3.6.0
* @access private
- * @uses utf8_uri_encode() Makes sure UTF-8 characters are properly cut and encoded.
*
- * @param string $slug The slug to truncate.
- * @param int $length Max length of the slug.
+ * @see utf8_uri_encode()
+ *
+ * @param string $slug The slug to truncate.
+ * @param int $length Optional. Max length of the slug. Default 200 (characters).
* @return string The truncated slug.
*/
function _truncate_post_slug( $slug, $length = 200 ) {
@@ -3530,17 +3795,18 @@ function _truncate_post_slug( $slug, $length = 200 ) {
}
/**
- * Adds tags to a post.
+ * Add tags to a post.
*
- * @uses wp_set_post_tags() Same first two parameters, but the last parameter is always set to true.
+ * @see wp_set_post_tags()
*
* @since 2.3.0
*
- * @param int $post_id Post ID
- * @param string $tags The tags to set for the post, separated by commas.
- * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise
+ * @param int $post_id Optional. The Post ID. Does not default to the ID of the global $post.
+ * Default 0.
+ * @param string $tags Optional. The tags to set for the post, separated by commas. Default empty.
+ * @return bool|null Will return false if $post_id is not an integer or is 0. Will return null otherwise.
*/
-function wp_add_post_tags($post_id = 0, $tags = '') {
+function wp_add_post_tags( $post_id = 0, $tags = '' ) {
return wp_set_post_tags($post_id, $tags, true);
}
@@ -3548,11 +3814,14 @@ function wp_add_post_tags($post_id = 0, $tags = '') {
* Set the tags for a post.
*
* @since 2.3.0
- * @uses wp_set_object_terms() Sets the tags for the post.
*
- * @param int $post_id Post ID.
- * @param string $tags The tags to set for the post, separated by commas.
- * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
+ * @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 mixed Array of affected term IDs. WP_Error or false on failure.
*/
function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
@@ -3563,12 +3832,14 @@ function wp_set_post_tags( $post_id = 0, $tags = '', $append = false ) {
* Set the terms for a post.
*
* @since 2.8.0
- * @uses wp_set_object_terms() Sets the tags for the post.
*
- * @param int $post_id Post ID.
- * @param string $tags The tags to set for the post, separated by commas.
- * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'.
- * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags.
+ * @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 mixed Array of affected term IDs. WP_Error or false on failure.
*/
function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $append = false ) {
@@ -3587,8 +3858,10 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a
$tags = explode( ',', trim( $tags, " \n\t\r\0\x0B," ) );
}
- // Hierarchical taxonomies must always pass IDs rather than names so that children with the same
- // names but different parents aren't confused.
+ /*
+ * Hierarchical taxonomies must always pass IDs rather than names so that
+ * children with the same names but different parents aren't confused.
+ */
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
$tags = array_unique( array_map( 'intval', $tags ) );
}
@@ -3604,9 +3877,12 @@ function wp_set_post_terms( $post_id = 0, $tags = '', $taxonomy = 'post_tag', $a
*
* @since 2.1.0
*
- * @param int $post_ID Post ID.
+ * @param int $post_ID Optional. The Post ID. Does not default to the ID
+ * of the global $post. Default 0.
* @param array|int $post_categories Optional. List of categories or ID of category.
- * @param bool $append If true, don't delete existing categories, just add on. If false, replace the categories with the new categories.
+ * 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 bool|mixed
*/
function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $append = false ) {
@@ -3645,13 +3921,11 @@ function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $appe
*
* @since 2.3.0
*
- * @link http://codex.wordpress.org/Post_Status_Transitions
- *
* @param string $new_status Transition to this post status.
* @param string $old_status Previous post status.
* @param object $post Post data.
*/
-function wp_transition_post_status($new_status, $old_status, $post) {
+function wp_transition_post_status( $new_status, $old_status, $post ) {
/**
* Fires when a post is transitioned from one status to another.
*
@@ -3694,16 +3968,17 @@ function wp_transition_post_status($new_status, $old_status, $post) {
//
/**
- * Add a URL to those already pung.
+ * Add a URL to those already pinged.
*
* @since 1.5.0
- * @uses $wpdb
*
- * @param int $post_id Post ID.
- * @param string $uri Ping URI.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int $post_id Post ID.
+ * @param string $uri Ping URI.
* @return int How many rows were updated.
*/
-function add_ping($post_id, $uri) {
+function add_ping( $post_id, $uri ) {
global $wpdb;
$pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
$pung = trim($pung);
@@ -3720,7 +3995,7 @@ function add_ping($post_id, $uri) {
*/
$new = apply_filters( 'add_ping', $new );
- // expected_slashed ($new)
+ // expected_slashed ($new).
$new = wp_unslash($new);
return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) );
}
@@ -3731,9 +4006,9 @@ function add_ping($post_id, $uri) {
* @since 1.5.0
*
* @param int $post_id Post ID.
- * @return array List of enclosures
+ * @return array List of enclosures.
*/
-function get_enclosed($post_id) {
+function get_enclosed( $post_id ) {
$custom_fields = get_post_custom( $post_id );
$pung = array();
if ( !is_array( $custom_fields ) )
@@ -3764,12 +4039,13 @@ function get_enclosed($post_id) {
* Retrieve URLs already pinged for a post.
*
* @since 1.5.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $post_id Post ID.
* @return array
*/
-function get_pung($post_id) {
+function get_pung( $post_id ) {
global $wpdb;
$pung = $wpdb->get_var( $wpdb->prepare( "SELECT pinged FROM $wpdb->posts WHERE ID = %d", $post_id ));
$pung = trim($pung);
@@ -3790,12 +4066,13 @@ function get_pung($post_id) {
* Retrieve URLs that need to be pinged.
*
* @since 1.5.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $post_id Post ID
* @return array
*/
-function get_to_ping($post_id) {
+function get_to_ping( $post_id ) {
global $wpdb;
$to_ping = $wpdb->get_var( $wpdb->prepare( "SELECT to_ping FROM $wpdb->posts WHERE ID = %d", $post_id ));
$to_ping = sanitize_trackback_urls( $to_ping );
@@ -3817,28 +4094,25 @@ function get_to_ping($post_id) {
*
* @since 1.0.0
*
- * @param string $tb_list Comma separated list of URLs
- * @param int $post_id Post ID
+ * @param string $tb_list Comma separated list of URLs.
+ * @param int $post_id Post ID.
*/
-function trackback_url_list($tb_list, $post_id) {
+function trackback_url_list( $tb_list, $post_id ) {
if ( ! empty( $tb_list ) ) {
- // get post data
- $postdata = get_post($post_id, ARRAY_A);
-
- // import postdata as variables
- extract($postdata, EXTR_SKIP);
+ // Get post data.
+ $postdata = get_post( $post_id, ARRAY_A );
- // form an excerpt
- $excerpt = strip_tags($post_excerpt ? $post_excerpt : $post_content);
+ // Form an excerpt.
+ $excerpt = strip_tags( $postdata['post_excerpt'] ? $postdata['post_excerpt'] : $postdata['post_content'] );
- if (strlen($excerpt) > 255) {
- $excerpt = substr($excerpt,0,252) . '…';
+ if ( strlen( $excerpt ) > 255 ) {
+ $excerpt = substr( $excerpt, 0, 252 ) . '…';
}
- $trackback_urls = explode(',', $tb_list);
- foreach( (array) $trackback_urls as $tb_url) {
- $tb_url = trim($tb_url);
- trackback($tb_url, wp_unslash($post_title), $excerpt, $post_id);
+ $trackback_urls = explode( ',', $tb_list );
+ foreach( (array) $trackback_urls as $tb_url ) {
+ $tb_url = trim( $tb_url );
+ trackback( $tb_url, wp_unslash( $postdata['post_title'] ), $excerpt, $post_id );
}
}
}
@@ -3851,7 +4125,8 @@ function trackback_url_list($tb_list, $post_id) {
* Get a list of page IDs.
*
* @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @return array List of page IDs.
*/
@@ -3873,12 +4148,14 @@ function get_all_page_ids() {
* Use get_post() instead of get_page().
*
* @since 1.5.1
- * @deprecated 3.5.0
- *
- * @param mixed $page Page object or page ID. Passed by reference.
- * @param string $output What to output. OBJECT, ARRAY_A, or ARRAY_N.
- * @param string $filter How the return value should be filtered.
- * @return WP_Post|null WP_Post on success or null on failure
+ * @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 $filter Optional. How the return value should be filtered. Accepts 'raw',
+ * 'edit', 'db', 'display'. Default 'raw'.
+ * @return WP_Post|null WP_Post on success or null on failure.
*/
function get_page( $page, $output = OBJECT, $filter = 'raw') {
return get_post( $page, $output, $filter );
@@ -3888,12 +4165,14 @@ function get_page( $page, $output = OBJECT, $filter = 'raw') {
* Retrieves a page given its path.
*
* @since 2.1.0
- * @uses $wpdb
*
- * @param string $page_path Page path
- * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
- * @param string|array $post_type Optional. Post type or array of post types. Default page.
- * @return WP_Post|null WP_Post on success or null on failure
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $page_path Page path.
+ * @param string $output Optional. Output type. Accepts OBJECT, ARRAY_N, or ARRAY_A.
+ * Default OBJECT.
+ * @param string|array $post_type Optional. Post type or array of post types. Default 'page'.
+ * @return WP_Post|null WP_Post on success or null on failure.
*/
function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
global $wpdb;
@@ -3957,11 +4236,13 @@ function get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
* Retrieve a page given its title.
*
* @since 2.1.0
- * @uses $wpdb
*
- * @param string $page_title Page title
- * @param string $output Optional. Output type. OBJECT, ARRAY_N, or ARRAY_A. Default OBJECT.
- * @param string|array $post_type Optional. Post type or array of post types. Default 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|array $post_type Optional. Post type or array of post types. Default 'page'.
* @return WP_Post|null WP_Post on success or null on failure
*/
function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) {
@@ -4002,9 +4283,9 @@ function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' )
*
* @since 1.5.1
*
- * @param int $page_id Page ID.
- * @param array $pages List of pages' objects.
- * @return array
+ * @param int $page_id Page ID.
+ * @param array $pages List of pages' objects.
+ * @return array List of page children.
*/
function get_page_children($page_id, $pages) {
$page_list = array();
@@ -4026,8 +4307,8 @@ function get_page_children($page_id, $pages) {
*
* @since 2.0.0
*
- * @param array $pages Posts array.
- * @param int $page_id Parent page ID.
+ * @param array $pages Posts array, passed by reference.
+ * @param int $page_id Optional. Parent page ID. Default 0.
* @return array A list arranged by hierarchy. Children immediately follow their parents.
*/
function get_page_hierarchy( &$pages, $page_id = 0 ) {
@@ -4049,10 +4330,17 @@ function get_page_hierarchy( &$pages, $page_id = 0 ) {
}
/**
- * function to traverse and return all the nested children post names of a root page.
+ * Traverse and return all the nested children post names of a root page.
+ *
* $children contains parent-children relations
*
* @since 2.9.0
+ *
+ * @see _page_traverse_name()
+ *
+ * @param int $page_id Page ID.
+ * @param array &$children Parent-children relations, passed by reference.
+ * @param array &$result Result, passed by reference.
*/
function _page_traverse_name( $page_id, &$children, &$result ){
if ( isset( $children[ $page_id ] ) ){
@@ -4064,13 +4352,13 @@ function _page_traverse_name( $page_id, &$children, &$result ){
}
/**
- * Builds URI for a page.
+ * Build URI for a page.
*
* Sub pages will be in the "directory" under the parent page post name.
*
* @since 1.5.0
*
- * @param mixed $page Page object or page ID.
+ * @param WP_Post|object|int $page Page object or page ID.
* @return string|false Page URI, false on error.
*/
function get_page_uri( $page ) {
@@ -4091,7 +4379,7 @@ function get_page_uri( $page ) {
/**
* Retrieve a list of pages.
*
- * @global wpdb $wpdb WordPress database abstraction object
+ * @global wpdb $wpdb WordPress database abstraction object.
*
* @since 1.5.0
*
@@ -4128,8 +4416,6 @@ function get_page_uri( $page ) {
function get_pages( $args = array() ) {
global $wpdb;
- $pages = false;
-
$defaults = array(
'child_of' => 0, 'sort_order' => 'ASC',
'sort_column' => 'post_title', 'hierarchical' => 1,
@@ -4141,26 +4427,37 @@ function get_pages( $args = array() ) {
);
$r = wp_parse_args( $args, $defaults );
- extract( $r, EXTR_SKIP );
- $number = (int) $number;
- $offset = (int) $offset;
- // Make sure the post type is hierarchical
+ $number = (int) $r['number'];
+ $offset = (int) $r['offset'];
+ $child_of = (int) $r['child_of'];
+ $hierarchical = $r['hierarchical'];
+ $exclude = $r['exclude'];
+ $meta_key = $r['meta_key'];
+ $meta_value = $r['meta_value'];
+ $parent = $r['parent'];
+ $post_status = $r['post_status'];
+
+ // Make sure the post type is hierarchical.
$hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
- if ( !in_array( $post_type, $hierarchical_post_types ) )
- return $pages;
+ if ( ! in_array( $r['post_type'], $hierarchical_post_types ) ) {
+ return false;
+ }
- if ( $parent > 0 && ! $child_of )
+ if ( $parent > 0 && ! $child_of ) {
$hierarchical = false;
+ }
- // Make sure we have a valid post status
- if ( !is_array( $post_status ) )
+ // Make sure we have a valid post status.
+ if ( ! is_array( $post_status ) ) {
$post_status = explode( ',', $post_status );
- if ( array_diff( $post_status, get_post_stati() ) )
- return $pages;
+ }
+ if ( array_diff( $post_status, get_post_stati() ) ) {
+ return false;
+ }
- // $args can be whatever, only use the args defined in defaults to compute the key
- $key = md5( serialize( compact(array_keys($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();
@@ -4169,59 +4466,62 @@ function get_pages( $args = array() ) {
$cache_key = "get_pages:$key:$last_changed";
if ( $cache = wp_cache_get( $cache_key, 'posts' ) ) {
- // Convert to WP_Post instances
+ // Convert to WP_Post instances.
$pages = array_map( 'get_post', $cache );
/** This filter is documented in wp-includes/post.php */
$pages = apply_filters( 'get_pages', $pages, $r );
return $pages;
}
- if ( !is_array($cache) )
- $cache = array();
-
$inclusions = '';
- if ( ! empty( $include ) ) {
+ if ( ! empty( $r['include'] ) ) {
$child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
$parent = -1;
$exclude = '';
$meta_key = '';
$meta_value = '';
$hierarchical = false;
- $incpages = wp_parse_id_list( $include );
- if ( ! empty( $incpages ) )
+ $incpages = wp_parse_id_list( $r['include'] );
+ if ( ! empty( $incpages ) ) {
$inclusions = ' AND ID IN (' . implode( ',', $incpages ) . ')';
+ }
}
$exclusions = '';
if ( ! empty( $exclude ) ) {
$expages = wp_parse_id_list( $exclude );
- if ( ! empty( $expages ) )
+ if ( ! empty( $expages ) ) {
$exclusions = ' AND ID NOT IN (' . implode( ',', $expages ) . ')';
+ }
}
$author_query = '';
- if (!empty($authors)) {
- $post_authors = preg_split('/[\s,]+/',$authors);
+ if ( ! empty( $r['authors'] ) ) {
+ $post_authors = preg_split( '/[\s,]+/', $r['authors'] );
if ( ! empty( $post_authors ) ) {
foreach ( $post_authors as $post_author ) {
//Do we have an author id or an author login?
if ( 0 == intval($post_author) ) {
$post_author = get_user_by('login', $post_author);
- if ( empty($post_author) )
+ if ( empty( $post_author ) ) {
continue;
- if ( empty($post_author->ID) )
+ }
+ if ( empty( $post_author->ID ) ) {
continue;
+ }
$post_author = $post_author->ID;
}
- if ( '' == $author_query )
+ if ( '' == $author_query ) {
$author_query = $wpdb->prepare(' post_author = %d ', $post_author);
- else
+ } else {
$author_query .= $wpdb->prepare(' OR post_author = %d ', $post_author);
+ }
}
- if ( '' != $author_query )
+ if ( '' != $author_query ) {
$author_query = " AND ($author_query)";
+ }
}
}
@@ -4233,36 +4533,41 @@ function get_pages( $args = array() ) {
// meta_key and meta_value might be slashed
$meta_key = wp_unslash($meta_key);
$meta_value = wp_unslash($meta_value);
- if ( '' !== $meta_key )
+ if ( '' !== $meta_key ) {
$where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key);
- if ( '' !== $meta_value )
+ }
+ if ( '' !== $meta_value ) {
$where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value);
+ }
}
if ( is_array( $parent ) ) {
$post_parent__in = implode( ',', array_map( 'absint', (array) $parent ) );
- if ( ! empty( $post_parent__in ) )
+ if ( ! empty( $post_parent__in ) ) {
$where .= " AND post_parent IN ($post_parent__in)";
+ }
} elseif ( $parent >= 0 ) {
$where .= $wpdb->prepare(' AND post_parent = %d ', $parent);
}
if ( 1 == count( $post_status ) ) {
- $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $post_type, array_shift( $post_status ) );
+ $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $r['post_type'], array_shift( $post_status ) );
} else {
$post_status = implode( "', '", $post_status );
- $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $post_type );
+ $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $r['post_type'] );
}
$orderby_array = array();
- $allowed_keys = array('author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified',
- 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent',
- 'ID', 'rand', 'comment_count');
- foreach ( explode( ',', $sort_column ) as $orderby ) {
+ $allowed_keys = array( 'author', 'post_author', 'date', 'post_date', 'title', 'post_title', 'name', 'post_name', 'modified',
+ 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent',
+ 'ID', 'rand', 'comment_count' );
+
+ foreach ( explode( ',', $r['sort_column'] ) as $orderby ) {
$orderby = trim( $orderby );
- if ( !in_array( $orderby, $allowed_keys ) )
+ if ( ! in_array( $orderby, $allowed_keys ) ) {
continue;
+ }
switch ( $orderby ) {
case 'menu_order':
@@ -4277,10 +4582,11 @@ function get_pages( $args = array() ) {
$orderby = "$wpdb->posts.comment_count";
break;
default:
- if ( 0 === strpos( $orderby, 'post_' ) )
+ if ( 0 === strpos( $orderby, 'post_' ) ) {
$orderby = "$wpdb->posts." . $orderby;
- else
+ } else {
$orderby = "$wpdb->posts.post_" . $orderby;
+ }
}
$orderby_array[] = $orderby;
@@ -4288,16 +4594,18 @@ function get_pages( $args = array() ) {
}
$sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title";
- $sort_order = strtoupper( $sort_order );
- if ( '' !== $sort_order && !in_array( $sort_order, array( 'ASC', 'DESC' ) ) )
+ $sort_order = strtoupper( $r['sort_order'] );
+ if ( '' !== $sort_order && ! in_array( $sort_order, array( 'ASC', 'DESC' ) ) ) {
$sort_order = 'ASC';
+ }
$query = "SELECT * FROM $wpdb->posts $join WHERE ($where_post_type) $where ";
$query .= $author_query;
$query .= " ORDER BY " . $sort_column . " " . $sort_order ;
- if ( !empty($number) )
+ if ( ! empty( $number ) ) {
$query .= ' LIMIT ' . $offset . ',' . $number;
+ }
$pages = $wpdb->get_results($query);
@@ -4307,7 +4615,7 @@ function get_pages( $args = array() ) {
return $pages;
}
- // Sanitize before caching so it'll only get done once
+ // Sanitize before caching so it'll only get done once.
$num_pages = count($pages);
for ($i = 0; $i < $num_pages; $i++) {
$pages[$i] = sanitize_post($pages[$i], 'raw');
@@ -4316,11 +4624,12 @@ function get_pages( $args = array() ) {
// Update cache.
update_post_cache( $pages );
- if ( $child_of || $hierarchical )
+ if ( $child_of || $hierarchical ) {
$pages = get_page_children($child_of, $pages);
+ }
- if ( ! empty( $exclude_tree ) ) {
- $exclude = wp_parse_id_list( $exclude_tree );
+ if ( ! empty( $r['exclude_tree'] ) ) {
+ $exclude = wp_parse_id_list( $r['exclude_tree'] );
foreach( $exclude as $id ) {
$children = get_page_children( $id, $pages );
foreach ( $children as $child ) {
@@ -4337,12 +4646,13 @@ function get_pages( $args = array() ) {
}
$page_structure = array();
- foreach ( $pages as $page )
+ foreach ( $pages as $page ) {
$page_structure[] = $page->ID;
+ }
wp_cache_set( $cache_key, $page_structure, 'posts' );
- // Convert to WP_Post instances
+ // Convert to WP_Post instances.
$pages = array_map( 'get_post', $pages );
/**
@@ -4386,7 +4696,7 @@ function is_local_attachment($url) {
/**
* Insert an attachment.
*
- * If you set the 'ID' in the $object parameter, it will mean that you are
+ * If you set the 'ID' in the $args parameter, it will mean that you are
* updating and attempt to update the attachment. You can also set the
* attachment name or title by setting the key 'post_name' or 'post_title'.
*
@@ -4397,211 +4707,34 @@ function is_local_attachment($url) {
* comments are allowed. You can close them manually or keep them open by
* setting the value for the 'comment_status' key.
*
- * The $object parameter can have the following:
- * 'post_status' - Default is 'draft'. Can not be overridden, set the same as parent post.
- * 'post_type' - Default is 'post', will be set to attachment. Can not override.
- * 'post_author' - Default is current user ID. The ID of the user, who added the attachment.
- * 'ping_status' - Default is the value in default ping status option. Whether the attachment
- * can accept pings.
- * 'post_parent' - Default is 0. Can use $parent parameter or set this for the post it belongs
- * to, if any.
- * 'menu_order' - Default is 0. The order it is displayed.
- * 'to_ping' - Whether to ping.
- * 'pinged' - Default is empty string.
- * 'post_password' - Default is empty string. The password to access the attachment.
- * 'guid' - Global Unique ID for referencing the attachment.
- * 'post_content_filtered' - Attachment post content filtered.
- * 'post_excerpt' - Attachment excerpt.
- *
* @since 2.0.0
- * @uses $wpdb
*
- * @param string|array $object Arguments to override defaults.
- * @param string $file Optional filename.
- * @param int $parent Parent post ID.
+ * @see wp_insert_post()
+ *
+ * @param string|array $args Arguments for inserting an attachment.
+ * @param string $file Optional. Filename.
+ * @param int $parent Optional. Parent post ID.
* @return int Attachment ID.
*/
-function wp_insert_attachment($object, $file = false, $parent = 0) {
- global $wpdb;
-
- $user_id = get_current_user_id();
-
- $defaults = array('post_status' => 'inherit', 'post_type' => 'post', 'post_author' => $user_id,
- 'ping_status' => get_option('default_ping_status'), 'post_parent' => 0, 'post_title' => '',
- 'menu_order' => 0, 'to_ping' => '', 'pinged' => '', 'post_password' => '', 'post_content' => '',
- 'guid' => '', 'post_content_filtered' => '', 'post_excerpt' => '', 'import_id' => 0, 'context' => '');
-
- $object = wp_parse_args($object, $defaults);
- if ( !empty($parent) )
- $object['post_parent'] = $parent;
-
- unset( $object[ 'filter' ] );
-
- $object = sanitize_post($object, 'db');
-
- // export array as variables
- extract($object, EXTR_SKIP);
-
- if ( empty($post_author) )
- $post_author = $user_id;
-
- $post_type = 'attachment';
-
- if ( ! in_array( $post_status, array( 'inherit', 'private' ) ) )
- $post_status = 'inherit';
-
- if ( !empty($post_category) )
- $post_category = array_filter($post_category); // Filter out empty terms
-
- // Make sure we set a valid category.
- if ( empty($post_category) || 0 == count($post_category) || !is_array($post_category) ) {
- $post_category = array();
- }
-
- // Are we updating or creating?
- if ( !empty($ID) ) {
- $update = true;
- $post_ID = (int) $ID;
- } else {
- $update = false;
- $post_ID = 0;
- }
-
- // Create a valid post name.
- if ( empty($post_name) )
- $post_name = sanitize_title($post_title);
- else
- $post_name = sanitize_title($post_name);
-
- // expected_slashed ($post_name)
- $post_name = wp_unique_post_slug($post_name, $post_ID, $post_status, $post_type, $post_parent);
-
- if ( empty($post_date) )
- $post_date = current_time('mysql');
- if ( empty($post_date_gmt) )
- $post_date_gmt = current_time('mysql', 1);
-
- if ( empty($post_modified) )
- $post_modified = $post_date;
- if ( empty($post_modified_gmt) )
- $post_modified_gmt = $post_date_gmt;
-
- if ( empty($comment_status) ) {
- if ( $update )
- $comment_status = 'closed';
- else
- $comment_status = get_option('default_comment_status');
- }
- if ( empty($ping_status) )
- $ping_status = get_option('default_ping_status');
-
- if ( isset($to_ping) )
- $to_ping = preg_replace('|\s+|', "\n", $to_ping);
- else
- $to_ping = '';
-
- if ( isset($post_parent) )
- $post_parent = (int) $post_parent;
- else
- $post_parent = 0;
-
- if ( isset($menu_order) )
- $menu_order = (int) $menu_order;
- else
- $menu_order = 0;
-
- if ( !isset($post_password) )
- $post_password = '';
-
- if ( ! isset($pinged) )
- $pinged = '';
-
- // expected_slashed (everything!)
- $data = compact( array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_content_filtered', 'post_title', 'post_excerpt', 'post_status', 'post_type', 'comment_status', 'ping_status', 'post_password', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_parent', 'menu_order', 'post_mime_type', 'guid' ) );
-
- /**
- * Filter attachment post data before it is updated in or added
- * to the database.
- *
- * @since 3.9.0
- *
- * @param array $data Array of sanitized attachment post data.
- * @param array $object Array of un-sanitized attachment post data.
- */
- $data = apply_filters( 'wp_insert_attachment_data', $data, $object );
- $data = wp_unslash( $data );
-
- if ( $update ) {
- $wpdb->update( $wpdb->posts, $data, array( 'ID' => $post_ID ) );
- } else {
- // If there is a suggested ID, use it if not already present
- if ( !empty($import_id) ) {
- $import_id = (int) $import_id;
- if ( ! $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE ID = %d", $import_id) ) ) {
- $data['ID'] = $import_id;
- }
- }
+function wp_insert_attachment( $args, $file = false, $parent = 0 ) {
+ $defaults = array(
+ 'file' => $file,
+ 'post_parent' => 0
+ );
- $wpdb->insert( $wpdb->posts, $data );
- $post_ID = (int) $wpdb->insert_id;
- }
+ $data = wp_parse_args( $args, $defaults );
- if ( empty($post_name) ) {
- $post_name = sanitize_title($post_title, $post_ID);
- $wpdb->update( $wpdb->posts, compact("post_name"), array( 'ID' => $post_ID ) );
+ if ( ! empty( $parent ) ) {
+ $data['post_parent'] = $parent;
}
- if ( is_object_in_taxonomy($post_type, 'category') )
- wp_set_post_categories( $post_ID, $post_category );
-
- if ( isset( $tags_input ) && is_object_in_taxonomy($post_type, 'post_tag') )
- wp_set_post_tags( $post_ID, $tags_input );
+ $data['post_type'] = 'attachment';
- // support for all custom taxonomies
- if ( !empty($tax_input) ) {
- foreach ( $tax_input as $taxonomy => $tags ) {
- $taxonomy_obj = get_taxonomy($taxonomy);
- if ( is_array($tags) ) // array = hierarchical, string = non-hierarchical.
- $tags = array_filter($tags);
- if ( current_user_can($taxonomy_obj->cap->assign_terms) )
- wp_set_post_terms( $post_ID, $tags, $taxonomy );
- }
- }
-
- if ( $file )
- update_attached_file( $post_ID, $file );
-
- clean_post_cache( $post_ID );
-
- if ( ! empty( $context ) )
- add_post_meta( $post_ID, '_wp_attachment_context', $context, true );
-
- if ( $update) {
- /**
- * Fires once an existing attachment has been updated.
- *
- * @since 2.0.0
- *
- * @param int $post_ID Attachment ID.
- */
- do_action( 'edit_attachment', $post_ID );
- } else {
-
- /**
- * Fires once an attachment has been added.
- *
- * @since 2.0.0
- *
- * @param int $post_ID Attachment ID.
- */
- do_action( 'add_attachment', $post_ID );
- }
-
- return $post_ID;
+ return wp_insert_post( $data );
}
/**
- * Trashes or deletes an attachment.
+ * Trash or delete an attachment.
*
* When an attachment is permanently deleted, the file will also be removed.
* Deletion removes all post meta fields, taxonomy, comments, etc. associated
@@ -4611,10 +4744,12 @@ function wp_insert_attachment($object, $file = false, $parent = 0) {
* for media is disabled, item is already in the trash, or $force_delete is true.
*
* @since 2.0.0
- * @uses $wpdb
*
- * @param int $post_id Attachment ID.
- * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
+ * @param int $post_id Attachment ID.
+ * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
+ * Default false.
* @return mixed False on failure. Post data on success.
*/
function wp_delete_attachment( $post_id, $force_delete = false ) {
@@ -4657,7 +4792,8 @@ function wp_delete_attachment( $post_id, $force_delete = false ) {
wp_delete_object_term_relationships($post_id, array('category', 'post_tag'));
wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type));
- delete_metadata( 'post', null, '_thumbnail_id', $post_id, true ); // delete all for any posts.
+ // Delete all for any posts.
+ delete_metadata( 'post', null, '_thumbnail_id', $post_id, true );
$comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id ));
foreach ( $comment_ids as $comment_id )
@@ -4679,8 +4815,8 @@ function wp_delete_attachment( $post_id, $force_delete = false ) {
$uploadpath = wp_upload_dir();
if ( ! empty($meta['thumb']) ) {
- // Don't delete the thumb if another attachment uses it
- if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $meta['thumb'] . '%', $post_id)) ) {
+ // Don't delete the thumb if another attachment uses it.
+ if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $wpdb->esc_like( $meta['thumb'] ) . '%', $post_id)) ) {
$thumbfile = str_replace(basename($file), $meta['thumb'], $file);
/** This filter is documented in wp-admin/custom-header.php */
$thumbfile = apply_filters( 'wp_delete_file', $thumbfile );
@@ -4688,7 +4824,7 @@ function wp_delete_attachment( $post_id, $force_delete = false ) {
}
}
- // remove intermediate and backup images if there are any
+ // Remove intermediate and backup images if there are any.
foreach ( $intermediate_sizes as $intermediate ) {
/** This filter is documented in wp-admin/custom-header.php */
$intermediate_file = apply_filters( 'wp_delete_file', $intermediate['path'] );
@@ -4720,8 +4856,8 @@ function wp_delete_attachment( $post_id, $force_delete = false ) {
*
* @since 2.1.0
*
- * @param int $post_id Attachment ID
- * @param bool $unfiltered Optional, default is false. If true, filters are not run.
+ * @param int $post_id Attachment ID. Default 0.
+ * @param bool $unfiltered Optional. If true, filters are not run. Default false.
* @return string|bool Attachment meta field. False on failure.
*/
function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
@@ -4751,9 +4887,9 @@ function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
*
* @since 2.1.0
*
- * @param int $post_id Attachment ID.
- * @param array $data Attachment data.
- * @return int
+ * @param int $post_id Attachment ID.
+ * @param array $data Attachment data.
+ * @return int|bool False if $post is invalid.
*/
function wp_update_attachment_metadata( $post_id, $data ) {
$post_id = (int) $post_id;
@@ -4779,8 +4915,8 @@ function wp_update_attachment_metadata( $post_id, $data ) {
*
* @since 2.1.0
*
- * @param int $post_id Attachment ID.
- * @return string
+ * @param int $post_id Optional. Attachment ID. Default 0.
+ * @return string|bool Attachment URL, otherwise false.
*/
function wp_get_attachment_url( $post_id = 0 ) {
$post_id = (int) $post_id;
@@ -4791,19 +4927,30 @@ function wp_get_attachment_url( $post_id = 0 ) {
return false;
$url = '';
- if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) { //Get attached file
- if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { //Get upload directory
- if ( 0 === strpos($file, $uploads['basedir']) ) //Check that the upload base exists in the file location
- $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file); //replace file location with url location
- elseif ( false !== strpos($file, 'wp-content/uploads') )
+ // Get attached file.
+ if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) {
+ // Get upload directory.
+ if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) {
+ // Check that the upload base exists in the file location.
+ if ( 0 === strpos( $file, $uploads['basedir'] ) ) {
+ // Replace file location with url location.
+ $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file);
+ } elseif ( false !== strpos($file, 'wp-content/uploads') ) {
$url = $uploads['baseurl'] . substr( $file, strpos($file, 'wp-content/uploads') + 18 );
- else
- $url = $uploads['baseurl'] . "/$file"; //Its a newly uploaded file, therefor $file is relative to the basedir.
+ } else {
+ // It's a newly-uploaded file, therefore $file is relative to the basedir.
+ $url = $uploads['baseurl'] . "/$file";
+ }
}
}
- if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recommended to rely upon this.
+ /*
+ * If any of the above options failed, Fallback on the GUID as used pre-2.7,
+ * not recommended to rely upon this.
+ */
+ if ( empty($url) ) {
$url = get_the_guid( $post->ID );
+ }
/**
* Filter the attachment URL.
@@ -4826,7 +4973,7 @@ function wp_get_attachment_url( $post_id = 0 ) {
*
* @since 2.1.0
*
- * @param int $post_id Attachment ID.
+ * @param int $post_id Optional. Attachment ID. Default 0.
* @return mixed False on failure. Thumbnail file path on success.
*/
function wp_get_attachment_thumb_file( $post_id = 0 ) {
@@ -4857,7 +5004,7 @@ function wp_get_attachment_thumb_file( $post_id = 0 ) {
*
* @since 2.1.0
*
- * @param int $post_id Attachment ID
+ * @param int $post_id Optional. Attachment ID. Default 0.
* @return string|bool False on failure. Thumbnail URL on success.
*/
function wp_get_attachment_thumb_url( $post_id = 0 ) {
@@ -4892,8 +5039,8 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) {
*
* @since 2.1.0
*
- * @param int $post_id Attachment ID
- * @return bool
+ * @param int $post_id Optional. Attachment ID. Default 0.
+ * @return bool Whether the attachment is an image.
*/
function wp_attachment_is_image( $post_id = 0 ) {
$post_id = (int) $post_id;
@@ -4918,7 +5065,7 @@ function wp_attachment_is_image( $post_id = 0 ) {
* @since 2.1.0
*
* @param string|int $mime MIME type or attachment ID.
- * @return string|bool
+ * @return string|bool Icon, false otherwise.
*/
function wp_mime_type_icon( $mime = 0 ) {
if ( !is_numeric($mime) )
@@ -4997,7 +5144,7 @@ function wp_mime_type_icon( $mime = 0 ) {
wp_cache_add( 'icon_files', $icon_files, 'default', 600 );
}
- // Icon basename - extension = MIME wildcard
+ // Icon basename - extension = MIME wildcard.
foreach ( $icon_files as $file => $uri )
$types[ preg_replace('/^([^.]*).*$/', '$1', basename($file)) ] =& $icon_files[$file];
@@ -5034,7 +5181,7 @@ function wp_mime_type_icon( $mime = 0 ) {
}
/**
- * Checked for changed slugs for published post objects and save the old slug.
+ * Check for changed slugs for published post objects and save the old slug.
*
* The function is used when a post object of any type is updated,
* by comparing the current and previous post objects.
@@ -5048,27 +5195,27 @@ function wp_mime_type_icon( $mime = 0 ) {
*
* @since 2.1.0
*
- * @param int $post_id Post ID.
- * @param object $post The Post Object
- * @param object $post_before The Previous Post Object
+ * @param int $post_id Post ID.
+ * @param WP_Post $post The Post Object
+ * @param WP_Post $post_before The Previous Post Object
* @return int Same as $post_id
*/
-function wp_check_for_changed_slugs($post_id, $post, $post_before) {
- // dont bother if it hasnt changed
+function wp_check_for_changed_slugs( $post_id, $post, $post_before ) {
+ // Don't bother if it hasnt changed.
if ( $post->post_name == $post_before->post_name )
return;
- // we're only concerned with published, non-hierarchical objects
+ // We're only concerned with published, non-hierarchical objects.
if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) )
return;
$old_slugs = (array) get_post_meta($post_id, '_wp_old_slug');
- // if we haven't added this old slug before, add it now
+ // If we haven't added this old slug before, add it now.
if ( !empty( $post_before->post_name ) && !in_array($post_before->post_name, $old_slugs) )
add_post_meta($post_id, '_wp_old_slug', $post_before->post_name);
- // if the new slug was used previously, delete it from the list
+ // If the new slug was used previously, delete it from the list.
if ( in_array($post->post_name, $old_slugs) )
delete_post_meta($post_id, '_wp_old_slug', $post->post_name);
}
@@ -5083,7 +5230,7 @@ function wp_check_for_changed_slugs($post_id, $post, $post_before) {
*
* @since 2.2.0
*
- * @param string $post_type currently only supports 'post' or 'page'.
+ * @param string $post_type Post type. Currently only supports 'post' or 'page'.
* @return string SQL code that can be added to a where clause.
*/
function get_private_posts_cap_sql( $post_type ) {
@@ -5093,19 +5240,22 @@ function get_private_posts_cap_sql( $post_type ) {
/**
* Retrieve the post SQL based on capability, author, and type.
*
- * @see get_private_posts_cap_sql() for full description.
- *
* @since 3.0.0
- * @param string $post_type Post type.
- * @param bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term.
- * @param int $post_author Optional. Query posts having a single author ID.
- * @param bool $public_only Optional. Only return public posts. Skips cap checks for $current_user. Default is false.
+ *
+ * @see get_private_posts_cap_sql()
+ *
+ * @param string $post_type Post type.
+ * @param bool $full Optional. Returns a full WHERE statement instead of just
+ * an 'andalso' term. Default true.
+ * @param int $post_author Optional. Query posts having a single author ID. Default null.
+ * @param bool $public_only Optional. Only return public posts. Skips cap checks for
+ * $current_user. Default false.
* @return string SQL WHERE code that can be added to a query.
*/
function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) {
global $wpdb;
- // Private posts
+ // Private posts.
$post_type_obj = get_post_type_object( $post_type );
if ( ! $post_type_obj )
return $full ? 'WHERE 1 = 0' : ' 1 = 0 ';
@@ -5135,7 +5285,7 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null,
$sql .= "(post_status = 'publish'";
- // Only need to check the cap if $public_only is false
+ // Only need to check the cap if $public_only is false.
if ( false === $public_only ) {
if ( current_user_can( $cap ) ) {
// Does the user have the capability to view private posts? Guess so.
@@ -5165,10 +5315,11 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null,
*
* @since 0.71
*
- * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
+ * @param string $timezone The location to get the time. Accepts 'gmt', 'blog',
+ * or 'server'. Default 'server'.
* @return string The date of the last post.
*/
-function get_lastpostdate($timezone = 'server') {
+function get_lastpostdate( $timezone = 'server' ) {
/**
* Filter the date the last post was published.
*
@@ -5190,10 +5341,11 @@ function get_lastpostdate($timezone = 'server') {
*
* @since 1.2.0
*
- * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
+ * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', or 'server'.
+ * Default 'server'.
* @return string The date the post was last modified.
*/
-function get_lastpostmodified($timezone = 'server') {
+function get_lastpostmodified( $timezone = 'server' ) {
$lastpostmodified = _get_last_post_time( $timezone, 'modified' );
$lastpostdate = get_lastpostdate($timezone);
@@ -5217,7 +5369,7 @@ function get_lastpostmodified($timezone = 'server') {
* @access private
* @since 3.1.0
*
- * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
+ * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', or 'server'.
* @param string $field Field to check. Can be 'date' or 'modified'.
* @return string The date.
*/
@@ -5264,7 +5416,7 @@ function _get_last_post_time( $timezone, $field ) {
*
* @since 1.5.1
*
- * @param array $posts Array of post objects
+ * @param array $posts Array of post objects, passed by reference.
*/
function update_post_cache( &$posts ) {
if ( ! $posts )
@@ -5285,6 +5437,8 @@ function update_post_cache( &$posts ) {
*
* @since 2.0.0
*
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
* @param int|WP_Post $post Post ID or post object to remove from the cache.
*/
function clean_post_cache( $post ) {
@@ -5314,9 +5468,6 @@ function clean_post_cache( $post ) {
*/
do_action( 'clean_post_cache', $post->ID, $post );
- if ( is_post_type_hierarchical( $post->post_type ) )
- wp_cache_delete( 'get_pages', 'posts' );
-
if ( 'page' == $post->post_type ) {
wp_cache_delete( 'all_page_ids', 'posts' );
@@ -5338,16 +5489,12 @@ function clean_post_cache( $post ) {
*
* @since 1.5.0
*
- * @uses update_post_cache()
- * @uses update_object_term_cache()
- * @uses update_postmeta_cache()
- *
- * @param array $posts Array of Post objects
- * @param string $post_type The post type of the posts in $posts. Default is 'post'.
- * @param bool $update_term_cache Whether to update the term cache. Default is true.
- * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
+ * @param array $posts Array of Post objects
+ * @param string $post_type Optional. Post type. Default 'post'.
+ * @param bool $update_term_cache Optional. Whether to update the term cache. Default true.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
*/
-function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) {
+function update_post_caches( &$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true ) {
// No point in doing all this work if we didn't match any posts.
if ( !$posts )
return;
@@ -5391,9 +5538,10 @@ function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = t
* @since 2.1.0
*
* @param array $post_ids List of post IDs.
- * @return bool|array Returns false if there is nothing to update or an array of metadata.
+ * @return bool|array Returns false if there is nothing to update or an array
+ * of metadata.
*/
-function update_postmeta_cache($post_ids) {
+function update_postmeta_cache( $post_ids ) {
return update_meta_cache('post', $post_ids);
}
@@ -5403,15 +5551,16 @@ function update_postmeta_cache($post_ids) {
* Cleaning means delete from the cache. Optionally will clean the term
* object cache associated with the attachment ID.
*
- * This function will not run if $_wp_suspend_cache_invalidation is not empty. See
- * wp_suspend_cache_invalidation().
+ * This function will not run if $_wp_suspend_cache_invalidation is not empty.
*
* @since 3.0.0
*
- * @param int $id The attachment ID in the cache to clean
- * @param bool $clean_terms optional. Whether to clean terms cache
+ * @see wp_suspend_cache_invalidation()
+ *
+ * @param int $id The attachment ID in the cache to clean.
+ * @param bool $clean_terms Optional. Whether to clean terms cache. Default false.
*/
-function clean_attachment_cache($id, $clean_terms = false) {
+function clean_attachment_cache( $id, $clean_terms = false ) {
global $_wp_suspend_cache_invalidation;
if ( !empty($_wp_suspend_cache_invalidation) )
@@ -5444,18 +5593,19 @@ function clean_attachment_cache($id, $clean_terms = false) {
*
* @since 2.3.0
* @access private
- * @uses $wpdb
- * @uses wp_clear_scheduled_hook() with 'publish_future_post' and post ID.
*
- * @param string $new_status New post status
- * @param string $old_status Previous post status
- * @param object $post Object type containing the post information
+ * @see wp_clear_scheduled_hook()
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
+ * @param string $new_status New post status.
+ * @param string $old_status Previous post status.
+ * @param WP_Post $post Post object.
*/
-function _transition_post_status($new_status, $old_status, $post) {
+function _transition_post_status( $new_status, $old_status, $post ) {
global $wpdb;
if ( $old_status != 'publish' && $new_status == 'publish' ) {
- // Reset GUID if transitioning to publish and it is empty
+ // Reset GUID if transitioning to publish and it is empty.
if ( '' == get_the_guid($post->ID) )
$wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post->ID ) ), array( 'ID' => $post->ID ) );
@@ -5470,7 +5620,7 @@ function _transition_post_status($new_status, $old_status, $post) {
do_action('private_to_published', $post->ID);
}
- // If published posts changed clear the lastpostmodified cache
+ // If published posts changed clear the lastpostmodified cache.
if ( 'publish' == $new_status || 'publish' == $old_status) {
foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
wp_cache_delete( "lastpostmodified:$timezone", 'timeinfo' );
@@ -5495,10 +5645,11 @@ function _transition_post_status($new_status, $old_status, $post) {
* @since 2.3.0
* @access private
*
- * @param int $deprecated Not used. Can be set to null. Never implemented.
- * Not marked as deprecated with _deprecated_argument() as it conflicts with
- * wp_transition_post_status() and the default filter for _future_post_hook().
- * @param object $post Object type containing the post information
+ * @param int $deprecated Not used. Can be set to null. Never implemented. Not marked
+ * as deprecated with _deprecated_argument() as it conflicts with
+ * wp_transition_post_status() and the default filter for
+ * {@see _future_post_hook()}.
+ * @param WP_Post $post Post object.
*/
function _future_post_hook( $deprecated, $post ) {
wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) );
@@ -5508,13 +5659,14 @@ function _future_post_hook( $deprecated, $post ) {
/**
* Hook to schedule pings and enclosures when a post is published.
*
+ * Uses XMLRPC_REQUEST and WP_IMPORTING constants.
+ *
* @since 2.3.0
* @access private
- * @uses XMLRPC_REQUEST and WP_IMPORTING constants.
*
- * @param int $post_id The ID in the database table of the post being published
+ * @param int $post_id The ID in the database table of the post being published.
*/
-function _publish_post_hook($post_id) {
+function _publish_post_hook( $post_id ) {
if ( defined( 'XMLRPC_REQUEST' ) ) {
/**
* Fires when _publish_post_hook() is called during an XML-RPC request.
@@ -5537,13 +5689,13 @@ function _publish_post_hook($post_id) {
}
/**
- * Returns the post's parent's post_ID
+ * Return the post's parent's post_ID
*
* @since 3.1.0
*
* @param int $post_id
*
- * @return int|bool false on error
+ * @return int|bool Post parent ID, otherwise false.
*/
function wp_get_post_parent_id( $post_ID ) {
$post = get_post( $post_ID );
@@ -5553,38 +5705,37 @@ function wp_get_post_parent_id( $post_ID ) {
}
/**
- * Checks the given subset of the post hierarchy for hierarchy loops.
- * Prevents loops from forming and breaks those that it finds.
+ * Check the given subset of the post hierarchy for hierarchy loops.
*
- * Attached to the wp_insert_post_parent filter.
+ * Prevents loops from forming and breaks those that it finds. Attached
+ * to the 'wp_insert_post_parent' filter.
*
* @since 3.1.0
- * @uses wp_find_hierarchy_loop()
*
- * @param int $post_parent ID of the parent for the post we're checking.
- * @param int $post_ID ID of the post we're checking.
+ * @see wp_find_hierarchy_loop()
*
- * @return int The new post_parent for the post.
+ * @param int $post_parent ID of the parent for the post we're checking.
+ * @param int $post_ID ID of the post we're checking.
+ * @return int The new post_parent for the post, 0 otherwise.
*/
function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) {
- // Nothing fancy here - bail
+ // Nothing fancy here - bail.
if ( !$post_parent )
return 0;
- // New post can't cause a loop
+ // New post can't cause a loop.
if ( empty( $post_ID ) )
return $post_parent;
- // Can't be its own parent
+ // Can't be its own parent.
if ( $post_parent == $post_ID )
return 0;
- // Now look for larger loops
-
+ // Now look for larger loops.
if ( !$loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent ) )
return $post_parent; // No loop
- // Setting $post_parent to the given value causes a loop
+ // Setting $post_parent to the given value causes a loop.
if ( isset( $loop[$post_ID] ) )
return 0;
@@ -5596,19 +5747,19 @@ function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) {
}
/**
- * Sets a post thumbnail.
+ * Set a post thumbnail.
*
* @since 3.1.0
*
- * @param int|WP_Post $post Post ID or post object where thumbnail should be attached.
- * @param int $thumbnail_id Thumbnail to attach.
+ * @param int|WP_Post $post Post ID or post object where thumbnail should be attached.
+ * @param int $thumbnail_id Thumbnail to attach.
* @return bool True on success, false on failure.
*/
function set_post_thumbnail( $post, $thumbnail_id ) {
$post = get_post( $post );
$thumbnail_id = absint( $thumbnail_id );
if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) {
- if ( $thumbnail_html = wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) )
+ if ( wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) )
return update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id );
else
return delete_post_meta( $post->ID, '_thumbnail_id' );
@@ -5617,7 +5768,7 @@ function set_post_thumbnail( $post, $thumbnail_id ) {
}
/**
- * Removes a post thumbnail.
+ * Remove a post thumbnail.
*
* @since 3.3.0
*
@@ -5632,27 +5783,35 @@ function delete_post_thumbnail( $post ) {
}
/**
- * Deletes auto-drafts for new posts that are > 7 days old
+ * Delete auto-drafts for new posts that are > 7 days old.
*
* @since 3.4.0
+ *
+ * @global wpdb $wpdb WordPress database access abstraction object.
*/
function wp_delete_auto_drafts() {
global $wpdb;
- // Cleanup old auto-drafts more than 7 days old
+ // Cleanup old auto-drafts more than 7 days old.
$old_posts = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_status = 'auto-draft' AND DATE_SUB( NOW(), INTERVAL 7 DAY ) > post_date" );
- foreach ( (array) $old_posts as $delete )
- wp_delete_post( $delete, true ); // Force delete
+ foreach ( (array) $old_posts as $delete ) {
+ // Force delete.
+ wp_delete_post( $delete, true );
+ }
}
/**
- * Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts.
+ * Update the custom taxonomies' term counts when a post's status is changed.
+ *
+ * For example, default posts term counts (for custom taxonomies) don't include
+ * private / draft posts.
*
- * @access private
- * @param string $new_status
- * @param string $old_status
- * @param object $post
* @since 3.3.0
+ * @access private
+ *
+ * @param string $new_status New post status.
+ * @param string $old_status Old post status.
+ * @param WP_Post $post Post object.
*/
function _update_term_count_on_transition_post_status( $new_status, $old_status, $post ) {
// Update counts for the post's terms.
@@ -5666,12 +5825,13 @@ function _update_term_count_on_transition_post_status( $new_status, $old_status,
* Adds any posts from the given ids to the cache that do not already exist in cache
*
* @since 3.4.0
- *
* @access private
*
- * @param array $post_ids ID list
- * @param bool $update_term_cache Whether to update the term cache. Default is true.
- * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
+ * @see update_post_caches()
+ *
+ * @param array $post_ids ID list
+ * @param bool $update_term_cache Optional. Whether to update the term cache. Default true.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
*/
function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) {
global $wpdb;