diff options
Diffstat (limited to 'srcs/wordpress/wp-includes/post.php')
| -rw-r--r-- | srcs/wordpress/wp-includes/post.php | 7226 |
1 files changed, 7226 insertions, 0 deletions
diff --git a/srcs/wordpress/wp-includes/post.php b/srcs/wordpress/wp-includes/post.php new file mode 100644 index 0000000..9ecd442 --- /dev/null +++ b/srcs/wordpress/wp-includes/post.php @@ -0,0 +1,7226 @@ +<?php +/** + * Core Post API + * + * @package WordPress + * @subpackage Post + */ + +// +// Post Type Registration +// + +/** + * Creates the initial post types when 'init' action is fired. + * + * See {@see 'init'}. + * + * @since 2.9.0 + */ +function create_initial_post_types() { + register_post_type( + 'post', + array( + 'labels' => array( + 'name_admin_bar' => _x( 'Post', 'add new from admin bar' ), + ), + 'public' => true, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'post', + 'map_meta_cap' => true, + 'menu_position' => 5, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'delete_with_user' => true, + 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'trackbacks', 'custom-fields', 'comments', 'revisions', 'post-formats' ), + 'show_in_rest' => true, + 'rest_base' => 'posts', + 'rest_controller_class' => 'WP_REST_Posts_Controller', + ) + ); + + register_post_type( + 'page', + array( + 'labels' => array( + 'name_admin_bar' => _x( 'Page', 'add new from admin bar' ), + ), + 'public' => true, + 'publicly_queryable' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'page', + 'map_meta_cap' => true, + 'menu_position' => 20, + 'hierarchical' => true, + 'rewrite' => false, + 'query_var' => false, + 'delete_with_user' => true, + 'supports' => array( 'title', 'editor', 'author', 'thumbnail', 'page-attributes', 'custom-fields', 'comments', 'revisions' ), + 'show_in_rest' => true, + 'rest_base' => 'pages', + 'rest_controller_class' => 'WP_REST_Posts_Controller', + ) + ); + + register_post_type( + 'attachment', + array( + 'labels' => array( + 'name' => _x( 'Media', 'post type general name' ), + 'name_admin_bar' => _x( 'Media', 'add new from admin bar' ), + 'add_new' => _x( 'Add New', 'add new media' ), + 'edit_item' => __( 'Edit Media' ), + 'view_item' => __( 'View Attachment Page' ), + 'attributes' => __( 'Attachment Attributes' ), + ), + 'public' => true, + 'show_ui' => true, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'post.php?post=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'post', + 'capabilities' => array( + 'create_posts' => 'upload_files', + ), + 'map_meta_cap' => true, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'show_in_nav_menus' => false, + 'delete_with_user' => true, + 'supports' => array( 'title', 'author', 'comments' ), + 'show_in_rest' => true, + 'rest_base' => 'media', + 'rest_controller_class' => 'WP_REST_Attachments_Controller', + ) + ); + add_post_type_support( 'attachment:audio', 'thumbnail' ); + add_post_type_support( 'attachment:video', 'thumbnail' ); + + register_post_type( + 'revision', + array( + 'labels' => array( + 'name' => __( 'Revisions' ), + 'singular_name' => __( 'Revision' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + '_edit_link' => 'revision.php?revision=%d', /* internal use only. don't use this when registering your own post type. */ + 'capability_type' => 'post', + 'map_meta_cap' => true, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'can_export' => false, + 'delete_with_user' => true, + 'supports' => array( 'author' ), + ) + ); + + register_post_type( + 'nav_menu_item', + array( + 'labels' => array( + 'name' => __( 'Navigation Menu Items' ), + 'singular_name' => __( 'Navigation Menu Item' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'hierarchical' => false, + 'rewrite' => false, + 'delete_with_user' => false, + 'query_var' => false, + ) + ); + + register_post_type( + 'custom_css', + array( + 'labels' => array( + 'name' => __( 'Custom CSS' ), + 'singular_name' => __( 'Custom CSS' ), + ), + 'public' => false, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'delete_with_user' => false, + 'can_export' => true, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'supports' => array( 'title', 'revisions' ), + 'capabilities' => array( + 'delete_posts' => 'edit_theme_options', + 'delete_post' => 'edit_theme_options', + 'delete_published_posts' => 'edit_theme_options', + 'delete_private_posts' => 'edit_theme_options', + 'delete_others_posts' => 'edit_theme_options', + 'edit_post' => 'edit_css', + 'edit_posts' => 'edit_css', + 'edit_others_posts' => 'edit_css', + 'edit_published_posts' => 'edit_css', + 'read_post' => 'read', + 'read_private_posts' => 'read', + 'publish_posts' => 'edit_theme_options', + ), + ) + ); + + register_post_type( + 'customize_changeset', + array( + 'labels' => array( + 'name' => _x( 'Changesets', 'post type general name' ), + 'singular_name' => _x( 'Changeset', 'post type singular name' ), + 'menu_name' => _x( 'Changesets', 'admin menu' ), + 'name_admin_bar' => _x( 'Changeset', 'add new on admin bar' ), + 'add_new' => _x( 'Add New', 'Customize Changeset' ), + 'add_new_item' => __( 'Add New Changeset' ), + 'new_item' => __( 'New Changeset' ), + 'edit_item' => __( 'Edit Changeset' ), + 'view_item' => __( 'View Changeset' ), + 'all_items' => __( 'All Changesets' ), + 'search_items' => __( 'Search Changesets' ), + 'not_found' => __( 'No changesets found.' ), + 'not_found_in_trash' => __( 'No changesets found in Trash.' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'map_meta_cap' => true, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'can_export' => false, + 'delete_with_user' => false, + 'supports' => array( 'title', 'author' ), + 'capability_type' => 'customize_changeset', + 'capabilities' => array( + 'create_posts' => 'customize', + 'delete_others_posts' => 'customize', + 'delete_post' => 'customize', + 'delete_posts' => 'customize', + 'delete_private_posts' => 'customize', + 'delete_published_posts' => 'customize', + 'edit_others_posts' => 'customize', + 'edit_post' => 'customize', + 'edit_posts' => 'customize', + 'edit_private_posts' => 'customize', + 'edit_published_posts' => 'do_not_allow', + 'publish_posts' => 'customize', + 'read' => 'read', + 'read_post' => 'customize', + 'read_private_posts' => 'customize', + ), + ) + ); + + register_post_type( + 'oembed_cache', + array( + 'labels' => array( + 'name' => __( 'oEmbed Responses' ), + 'singular_name' => __( 'oEmbed Response' ), + ), + 'public' => false, + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'delete_with_user' => false, + 'can_export' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'supports' => array(), + ) + ); + + register_post_type( + 'user_request', + array( + 'labels' => array( + 'name' => __( 'User Requests' ), + 'singular_name' => __( 'User Request' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'hierarchical' => false, + 'rewrite' => false, + 'query_var' => false, + 'can_export' => false, + 'delete_with_user' => false, + 'supports' => array(), + ) + ); + + register_post_type( + 'wp_block', + array( + 'labels' => array( + 'name' => _x( 'Blocks', 'post type general name' ), + 'singular_name' => _x( 'Block', 'post type singular name' ), + 'menu_name' => _x( 'Blocks', 'admin menu' ), + 'name_admin_bar' => _x( 'Block', 'add new on admin bar' ), + 'add_new' => _x( 'Add New', 'Block' ), + 'add_new_item' => __( 'Add New Block' ), + 'new_item' => __( 'New Block' ), + 'edit_item' => __( 'Edit Block' ), + 'view_item' => __( 'View Block' ), + 'all_items' => __( 'All Blocks' ), + 'search_items' => __( 'Search Blocks' ), + 'not_found' => __( 'No blocks found.' ), + 'not_found_in_trash' => __( 'No blocks found in Trash.' ), + 'filter_items_list' => __( 'Filter blocks list' ), + 'items_list_navigation' => __( 'Blocks list navigation' ), + 'items_list' => __( 'Blocks list' ), + 'item_published' => __( 'Block published.' ), + 'item_published_privately' => __( 'Block published privately.' ), + 'item_reverted_to_draft' => __( 'Block reverted to draft.' ), + 'item_scheduled' => __( 'Block scheduled.' ), + 'item_updated' => __( 'Block updated.' ), + ), + 'public' => false, + '_builtin' => true, /* internal use only. don't use this when registering your own post type. */ + 'show_ui' => true, + 'show_in_menu' => false, + 'rewrite' => false, + 'show_in_rest' => true, + 'rest_base' => 'blocks', + 'rest_controller_class' => 'WP_REST_Blocks_Controller', + 'capability_type' => 'block', + 'capabilities' => array( + // You need to be able to edit posts, in order to read blocks in their raw form. + 'read' => 'edit_posts', + // You need to be able to publish posts, in order to create blocks. + 'create_posts' => 'publish_posts', + 'edit_posts' => 'edit_posts', + 'edit_published_posts' => 'edit_published_posts', + 'delete_published_posts' => 'delete_published_posts', + 'edit_others_posts' => 'edit_others_posts', + 'delete_others_posts' => 'delete_others_posts', + ), + 'map_meta_cap' => true, + 'supports' => array( + 'title', + 'editor', + ), + ) + ); + + register_post_status( + 'publish', + array( + 'label' => _x( 'Published', 'post status' ), + 'public' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of published posts. */ + 'label_count' => _n_noop( + 'Published <span class="count">(%s)</span>', + 'Published <span class="count">(%s)</span>' + ), + ) + ); + + register_post_status( + 'future', + array( + 'label' => _x( 'Scheduled', 'post status' ), + 'protected' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of scheduled posts. */ + 'label_count' => _n_noop( + 'Scheduled <span class="count">(%s)</span>', + 'Scheduled <span class="count">(%s)</span>' + ), + ) + ); + + register_post_status( + 'draft', + array( + 'label' => _x( 'Draft', 'post status' ), + 'protected' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of draft posts. */ + 'label_count' => _n_noop( + 'Draft <span class="count">(%s)</span>', + 'Drafts <span class="count">(%s)</span>' + ), + 'date_floating' => true, + ) + ); + + register_post_status( + 'pending', + array( + 'label' => _x( 'Pending', 'post status' ), + 'protected' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of pending posts. */ + 'label_count' => _n_noop( + 'Pending <span class="count">(%s)</span>', + 'Pending <span class="count">(%s)</span>' + ), + 'date_floating' => true, + ) + ); + + register_post_status( + 'private', + array( + 'label' => _x( 'Private', 'post status' ), + 'private' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of private posts. */ + 'label_count' => _n_noop( + 'Private <span class="count">(%s)</span>', + 'Private <span class="count">(%s)</span>' + ), + ) + ); + + register_post_status( + 'trash', + array( + 'label' => _x( 'Trash', 'post status' ), + 'internal' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of trashed posts. */ + 'label_count' => _n_noop( + 'Trash <span class="count">(%s)</span>', + 'Trash <span class="count">(%s)</span>' + ), + 'show_in_admin_status_list' => true, + ) + ); + + register_post_status( + 'auto-draft', + array( + 'label' => 'auto-draft', + 'internal' => true, + '_builtin' => true, /* internal use only. */ + 'date_floating' => true, + ) + ); + + register_post_status( + 'inherit', + array( + 'label' => 'inherit', + 'internal' => true, + '_builtin' => true, /* internal use only. */ + 'exclude_from_search' => false, + ) + ); + + register_post_status( + 'request-pending', + array( + 'label' => _x( 'Pending', 'request status' ), + 'internal' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of pending requests. */ + 'label_count' => _n_noop( + 'Pending <span class="count">(%s)</span>', + 'Pending <span class="count">(%s)</span>' + ), + 'exclude_from_search' => false, + ) + ); + + register_post_status( + 'request-confirmed', + array( + 'label' => _x( 'Confirmed', 'request status' ), + 'internal' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of confirmed requests. */ + 'label_count' => _n_noop( + 'Confirmed <span class="count">(%s)</span>', + 'Confirmed <span class="count">(%s)</span>' + ), + 'exclude_from_search' => false, + ) + ); + + register_post_status( + 'request-failed', + array( + 'label' => _x( 'Failed', 'request status' ), + 'internal' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of failed requests. */ + 'label_count' => _n_noop( + 'Failed <span class="count">(%s)</span>', + 'Failed <span class="count">(%s)</span>' + ), + 'exclude_from_search' => false, + ) + ); + + register_post_status( + 'request-completed', + array( + 'label' => _x( 'Completed', 'request status' ), + 'internal' => true, + '_builtin' => true, /* internal use only. */ + /* translators: %s: Number of completed requests. */ + 'label_count' => _n_noop( + 'Completed <span class="count">(%s)</span>', + 'Completed <span class="count">(%s)</span>' + ), + 'exclude_from_search' => false, + ) + ); +} + +/** + * Retrieve attached file path based on attachment ID. + * + * By default the path will go through the 'get_attached_file' filter, but + * passing a true to the $unfiltered argument of get_attached_file() will + * return the file path unfiltered. + * + * The function works by getting the single post meta name, named + * '_wp_attached_file' and returning it. This is a convenience function to + * prevent looking up the meta name and provide a mechanism for sending the + * attached filename through a filter. + * + * @since 2.0.0 + * + * @param int $attachment_id Attachment ID. + * @param bool $unfiltered Optional. Whether to apply filters. Default false. + * @return string|false The file path to where the attached file should be, false otherwise. + */ +function get_attached_file( $attachment_id, $unfiltered = false ) { + $file = get_post_meta( $attachment_id, '_wp_attached_file', true ); + + // If the file is relative, prepend upload dir. + if ( $file && 0 !== strpos( $file, '/' ) && ! preg_match( '|^.:\\\|', $file ) ) { + $uploads = wp_get_upload_dir(); + if ( false === $uploads['error'] ) { + $file = $uploads['basedir'] . "/$file"; + } + } + + if ( $unfiltered ) { + return $file; + } + + /** + * Filters the attached file based on the given ID. + * + * @since 2.1.0 + * + * @param string $file Path to attached file. + * @param int $attachment_id Attachment ID. + */ + return apply_filters( 'get_attached_file', $file, $attachment_id ); +} + +/** + * Update attachment file path based on attachment ID. + * + * Used to update the file path of the attachment, which uses post meta name + * '_wp_attached_file' to store the path of the attachment. + * + * @since 2.1.0 + * + * @param int $attachment_id Attachment ID. + * @param string $file File path for the attachment. + * @return bool True on success, false on failure. + */ +function update_attached_file( $attachment_id, $file ) { + if ( ! get_post( $attachment_id ) ) { + return false; + } + + /** + * Filters the path to the attached file to update. + * + * @since 2.1.0 + * + * @param string $file Path to the attached file to update. + * @param int $attachment_id Attachment ID. + */ + $file = apply_filters( 'update_attached_file', $file, $attachment_id ); + + $file = _wp_relative_upload_path( $file ); + if ( $file ) { + return update_post_meta( $attachment_id, '_wp_attached_file', $file ); + } else { + return delete_post_meta( $attachment_id, '_wp_attached_file' ); + } +} + +/** + * Return relative path to an uploaded file. + * + * The path is relative to the current upload dir. + * + * @since 2.9.0 + * @access private + * + * @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; + + $uploads = wp_get_upload_dir(); + if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) { + $new_path = str_replace( $uploads['basedir'], '', $new_path ); + $new_path = ltrim( $new_path, '/' ); + } + + /** + * Filters the relative path to an uploaded file. + * + * @since 2.9.0 + * + * @param string $new_path Relative path to the file. + * @param string $path Full path to the file. + */ + return apply_filters( '_wp_relative_upload_path', $new_path, $path ); +} + +/** + * Retrieve all children of the post parent ID. + * + * Normally, without any enhancements, the children would apply to pages. In the + * context of the inner workings of WordPress, pages, posts, and attachments + * share the same table, so therefore the functionality could apply to any one + * of them. It is then noted that while this function does not work on posts, it + * does not mean that it won't work on posts. It is recommended that you know + * what context you wish to retrieve the children of. + * + * Attachments may also be made the child of a post, so if that is an accurate + * statement (which needs to be verified), it would then be possible to get + * all of the attachments for a post. Attachments have since changed since + * version 2.5, so this is most likely inaccurate, but serves generally as an + * example of what is possible. + * + * The arguments listed as defaults are for this function and also of the + * get_posts() function. The arguments are combined with the get_children defaults + * and are then passed to the get_posts() function, which accepts additional arguments. + * You can replace the defaults in this function, listed below and the additional + * arguments listed in the get_posts() function. + * + * The 'post_parent' is the most important argument and important attention + * needs to be paid to the $args parameter. If you pass either an object or an + * integer (number), then just the 'post_parent' is grabbed and everything else + * is lost. If you don't specify any arguments, then it is assumed that you are + * in The Loop and the post parent will be grabbed for from the current post. + * + * The 'post_parent' argument is the ID to get the children. The 'numberposts' + * is the amount of posts to retrieve that has a default of '-1', which is + * used to get all of the posts. Giving a number higher than 0 will only + * retrieve that amount of posts. + * + * The 'post_type' and 'post_status' arguments can be used to choose what + * criteria of posts to retrieve. The 'post_type' can be anything, but WordPress + * post types are 'post', 'pages', and 'attachments'. The 'post_status' + * argument will accept any post status within the write administration panels. + * + * @since 2.0.0 + * + * @see get_posts() + * @todo Check validity of description. + * + * @global WP_Post $post Global post object. + * + * @param mixed $args Optional. User defined arguments for replacing the defaults. Default empty. + * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to + * a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT. + * @return array Array of children, where the type of each element is determined by $output parameter. + * Empty array on failure. + */ +function get_children( $args = '', $output = OBJECT ) { + $kids = array(); + if ( empty( $args ) ) { + if ( isset( $GLOBALS['post'] ) ) { + $args = array( 'post_parent' => (int) $GLOBALS['post']->post_parent ); + } else { + return $kids; + } + } elseif ( is_object( $args ) ) { + $args = array( 'post_parent' => (int) $args->post_parent ); + } elseif ( is_numeric( $args ) ) { + $args = array( 'post_parent' => (int) $args ); + } + + $defaults = array( + 'numberposts' => -1, + 'post_type' => 'any', + 'post_status' => 'any', + 'post_parent' => 0, + ); + + $parsed_args = wp_parse_args( $args, $defaults ); + + $children = get_posts( $parsed_args ); + + if ( ! $children ) { + return $kids; + } + + if ( ! empty( $parsed_args['fields'] ) ) { + return $children; + } + + update_post_cache( $children ); + + foreach ( $children as $key => $child ) { + $kids[ $child->ID ] = $children[ $key ]; + } + + if ( $output == OBJECT ) { + return $kids; + } elseif ( $output == ARRAY_A ) { + $weeuns = array(); + foreach ( (array) $kids as $kid ) { + $weeuns[ $kid->ID ] = get_object_vars( $kids[ $kid->ID ] ); + } + return $weeuns; + } elseif ( $output == ARRAY_N ) { + $babes = array(); + foreach ( (array) $kids as $kid ) { + $babes[ $kid->ID ] = array_values( get_object_vars( $kids[ $kid->ID ] ) ); + } + return $babes; + } else { + return $kids; + } +} + +/** + * Get extended entry info (<!--more-->). + * + * There should not be any space after the second dash and before the word + * 'more'. There can be text or space(s) after the word 'more', but won't be + * referenced. + * + * The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before + * the `<!--more-->`. The 'extended' key has the content after the + * `<!--more-->` comment. The 'more_text' key has the custom "Read More" text. + * + * @since 1.0.0 + * + * @param string $post Post content. + * @return array Post before ('main'), after ('extended'), and custom read more ('more_text'). + */ +function get_extended( $post ) { + //Match the new style more links. + if ( preg_match( '/<!--more(.*?)?-->/', $post, $matches ) ) { + list($main, $extended) = explode( $matches[0], $post, 2 ); + $more_text = $matches[1]; + } else { + $main = $post; + $extended = ''; + $more_text = ''; + } + + // 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 ); + + return array( + 'main' => $main, + 'extended' => $extended, + 'more_text' => $more_text, + ); +} + +/** + * Retrieves post data given a post ID or post object. + * + * See sanitize_post() for optional $filter values. Also, the parameter + * `$post`, must be given as a variable, since it is passed by reference. + * + * @since 1.5.1 + * + * @global WP_Post $post Global post object. + * + * @param int|WP_Post|null $post Optional. Post ID or post object. Defaults to global $post. + * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to + * a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT. + * @param string $filter Optional. Type of filter to apply. Accepts 'raw', 'edit', 'db', + * or 'display'. Default 'raw'. + * @return WP_Post|array|null Type corresponding to $output on success or null on failure. + * When $output is OBJECT, a `WP_Post` instance is returned. + */ +function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) { + if ( empty( $post ) && isset( $GLOBALS['post'] ) ) { + $post = $GLOBALS['post']; + } + + if ( $post instanceof WP_Post ) { + $_post = $post; + } elseif ( is_object( $post ) ) { + if ( empty( $post->filter ) ) { + $_post = sanitize_post( $post, 'raw' ); + $_post = new WP_Post( $_post ); + } elseif ( 'raw' == $post->filter ) { + $_post = new WP_Post( $post ); + } else { + $_post = WP_Post::get_instance( $post->ID ); + } + } else { + $_post = WP_Post::get_instance( $post ); + } + + if ( ! $_post ) { + return null; + } + + $_post = $_post->filter( $filter ); + + if ( $output == ARRAY_A ) { + return $_post->to_array(); + } elseif ( $output == ARRAY_N ) { + return array_values( $_post->to_array() ); + } + + return $_post; +} + +/** + * Retrieve ancestors of a post. + * + * @since 2.5.0 + * + * @param int|WP_Post $post Post ID or post object. + * @return array Ancestor IDs or empty array if none are found. + */ +function get_post_ancestors( $post ) { + $post = get_post( $post ); + + if ( ! $post || empty( $post->post_parent ) || $post->post_parent == $post->ID ) { + return array(); + } + + $ancestors = array(); + + $id = $post->post_parent; + $ancestors[] = $id; + + while ( $ancestor = get_post( $id ) ) { + // Loop detection: If the ancestor has been seen before, break. + if ( empty( $ancestor->post_parent ) || ( $ancestor->post_parent == $post->ID ) || in_array( $ancestor->post_parent, $ancestors ) ) { + break; + } + + $id = $ancestor->post_parent; + $ancestors[] = $id; + } + + return $ancestors; +} + +/** + * Retrieve data from a post field based on Post ID. + * + * Examples of the post field will be, 'post_type', 'post_status', 'post_content', + * etc and based off of the post object property or key names. + * + * The context values are based off of the taxonomy filter functions and + * supported values are found within those functions. + * + * @since 2.3.0 + * @since 4.5.0 The `$post` parameter was made optional. + * + * @see sanitize_post_field() + * + * @param string $field Post field name. + * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post. + * @param string $context Optional. How to filter the field. Accepts 'raw', 'edit', 'db', + * or 'display'. Default 'display'. + * @return string The value of the post field on success, empty string on failure. + */ +function get_post_field( $field, $post = null, $context = 'display' ) { + $post = get_post( $post ); + + if ( ! $post ) { + return ''; + } + + if ( ! isset( $post->$field ) ) { + return ''; + } + + return sanitize_post_field( $field, $post->$field, $post->ID, $context ); +} + +/** + * Retrieve the mime type of an attachment based on the ID. + * + * This function can be used with any post type, but it makes more sense with + * attachments. + * + * @since 2.0.0 + * + * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post. + * @return string|false The mime type on success, false on failure. + */ +function get_post_mime_type( $post = null ) { + $post = get_post( $post ); + + if ( is_object( $post ) ) { + return $post->post_mime_type; + } + + return false; +} + +/** + * Retrieve the post status based on the post ID. + * + * If the post ID is of an attachment, then the parent post status will be given + * instead. + * + * @since 2.0.0 + * + * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.. + * @return string|false Post status on success, false on failure. + */ +function get_post_status( $post = null ) { + $post = get_post( $post ); + + if ( ! is_object( $post ) ) { + return false; + } + + if ( 'attachment' == $post->post_type ) { + if ( 'private' == $post->post_status ) { + return 'private'; + } + + // 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 ) ) { + $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; + } + } + } + + /** + * Filters the post status. + * + * @since 4.4.0 + * + * @param string $post_status The post status. + * @param WP_Post $post The post object. + */ + return apply_filters( 'get_post_status', $post->post_status, $post ); +} + +/** + * Retrieve all of the WordPress supported post statuses. + * + * Posts have a limited set of valid status values, this provides the + * post_status values and descriptions. + * + * @since 2.5.0 + * + * @return array List of post statuses. + */ +function get_post_statuses() { + $status = array( + 'draft' => __( 'Draft' ), + 'pending' => __( 'Pending Review' ), + 'private' => __( 'Private' ), + 'publish' => __( 'Published' ), + ); + + return $status; +} + +/** + * Retrieve all of the WordPress support page statuses. + * + * Pages have a limited set of valid status values, this provides the + * post_status values and descriptions. + * + * @since 2.5.0 + * + * @return array List of page statuses. + */ +function get_page_statuses() { + $status = array( + 'draft' => __( 'Draft' ), + 'private' => __( 'Private' ), + 'publish' => __( 'Published' ), + ); + + return $status; +} + +/** + * Return statuses for privacy requests. + * + * @since 4.9.6 + * @access private + * + * @return array + */ +function _wp_privacy_statuses() { + return array( + 'request-pending' => __( 'Pending' ), // Pending confirmation from user. + 'request-confirmed' => __( 'Confirmed' ), // User has confirmed the action. + 'request-failed' => __( 'Failed' ), // User failed to confirm the action. + 'request-completed' => __( 'Completed' ), // Admin has handled the request. + ); +} + +/** + * Register a post status. Do not use before init. + * + * A simple function for creating or modifying a post status based on the + * parameters given. The function will accept an array (second optional + * parameter), along with a string for the post status name. + * + * Arguments prefixed with an _underscore shouldn't be used by plugins and themes. + * + * @since 3.0.0 + * @global array $wp_post_statuses Inserts new post status object into the list + * + * @param string $post_status Name of the post status. + * @param array|string $args { + * Optional. Array or string of post status arguments. + * + * @type bool|string $label A descriptive name for the post status marked + * for translation. Defaults to value of $post_status. + * @type bool|array $label_count Descriptive text to use for nooped plurals. + * Default array of $label, twice + * @type bool $exclude_from_search Whether to exclude posts with this post status + * from search results. Default is value of $internal. + * @type bool $_builtin Whether the status is built-in. Core-use only. + * Default false. + * @type bool $public Whether posts of this status should be shown + * in the front end of the site. Default false. + * @type bool $internal Whether the status is for internal use only. + * Default false. + * @type bool $protected Whether posts with this status should be protected. + * Default false. + * @type bool $private Whether posts with this status should be private. + * Default false. + * @type bool $publicly_queryable Whether posts with this status should be publicly- + * queryable. Default is value of $public. + * @type bool $show_in_admin_all_list Whether to include posts in the edit listing for + * their post type. Default is value of $internal. + * @type bool $show_in_admin_status_list Show in the list of statuses with post counts at + * the top of the edit listings, + * e.g. All (12) | Published (9) | My Custom Status (2) + * Defau |