mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-10 22:58:33 +02:00
WordPress has supported custom page templates for over 12 years, allowing developers to create various layouts for specific pages. While this feature is very helpful, it has always been limited to the 'page' post type and not was not available to other post types. By opening up the page template functionality to all post types, we continue to improve the template hierarchy's flexibility. In addition to the `Template Name` file header, the post types supported by a template can be specified using `Template Post Type: post, foo, bar`. When at least one template exists for a post type, the 'Post Attributes' meta box will be displayed in the back end, without the need to add post type support for `'page-attributes'`. 'Post Attributes' can be customized per post type using the `'attributes'` label when registering a post type. Props johnbillion, Mte90, dipesh.kakadiya, swissspidy. Fixes #18375. Built from https://develop.svn.wordpress.org/trunk@38951 git-svn-id: http://core.svn.wordpress.org/trunk@38894 1a063a9b-81f0-0310-95a4-ce76da25c4cd
343 lines
5.8 KiB
PHP
343 lines
5.8 KiB
PHP
<?php
|
|
/**
|
|
* Post API: WP_Post class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Post
|
|
* @since 4.4.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used to implement the WP_Post object.
|
|
*
|
|
* @since 3.5.0
|
|
*
|
|
* @property string $page_template
|
|
*
|
|
* @property-read array $ancestors
|
|
* @property-read int $post_category
|
|
* @property-read string $tag_input
|
|
*
|
|
*/
|
|
final class WP_Post {
|
|
|
|
/**
|
|
* Post ID.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $ID;
|
|
|
|
/**
|
|
* ID of post author.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_author = 0;
|
|
|
|
/**
|
|
* The post's local publication time.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_date = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* The post's GMT publication time.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_date_gmt = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* The post's content.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_content = '';
|
|
|
|
/**
|
|
* The post's title.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_title = '';
|
|
|
|
/**
|
|
* The post's excerpt.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_excerpt = '';
|
|
|
|
/**
|
|
* The post's status.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_status = 'publish';
|
|
|
|
/**
|
|
* Whether comments are allowed.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $comment_status = 'open';
|
|
|
|
/**
|
|
* Whether pings are allowed.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $ping_status = 'open';
|
|
|
|
/**
|
|
* The post's password in plain text.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_password = '';
|
|
|
|
/**
|
|
* The post's slug.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_name = '';
|
|
|
|
/**
|
|
* URLs queued to be pinged.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $to_ping = '';
|
|
|
|
/**
|
|
* URLs that have been pinged.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $pinged = '';
|
|
|
|
/**
|
|
* The post's local modified time.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_modified = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* The post's GMT modified time.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_modified_gmt = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* A utility DB field for post content.
|
|
*
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_content_filtered = '';
|
|
|
|
/**
|
|
* ID of a post's parent post.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $post_parent = 0;
|
|
|
|
/**
|
|
* The unique identifier for a post, not necessarily a URL, used as the feed GUID.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $guid = '';
|
|
|
|
/**
|
|
* A field used for ordering posts.
|
|
*
|
|
* @var int
|
|
*/
|
|
public $menu_order = 0;
|
|
|
|
/**
|
|
* The post's type, like post or page.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_type = 'post';
|
|
|
|
/**
|
|
* An attachment's mime type.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $post_mime_type = '';
|
|
|
|
/**
|
|
* Cached comment count.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $comment_count = 0;
|
|
|
|
/**
|
|
* Stores the post object's sanitization level.
|
|
*
|
|
* Does not correspond to a DB field.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $filter;
|
|
|
|
/**
|
|
* Retrieve WP_Post instance.
|
|
*
|
|
* @static
|
|
* @access public
|
|
*
|
|
* @global wpdb $wpdb WordPress database abstraction object.
|
|
*
|
|
* @param int $post_id Post ID.
|
|
* @return WP_Post|false Post object, false otherwise.
|
|
*/
|
|
public static function get_instance( $post_id ) {
|
|
global $wpdb;
|
|
|
|
if ( ! is_numeric( $post_id ) || $post_id != floor( $post_id ) || ! $post_id ) {
|
|
return false;
|
|
}
|
|
|
|
$post_id = (int) $post_id;
|
|
|
|
$_post = wp_cache_get( $post_id, 'posts' );
|
|
|
|
if ( ! $_post ) {
|
|
$_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id ) );
|
|
|
|
if ( ! $_post )
|
|
return false;
|
|
|
|
$_post = sanitize_post( $_post, 'raw' );
|
|
wp_cache_add( $_post->ID, $_post, 'posts' );
|
|
} elseif ( empty( $_post->filter ) ) {
|
|
$_post = sanitize_post( $_post, 'raw' );
|
|
}
|
|
|
|
return new WP_Post( $_post );
|
|
}
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param WP_Post|object $post Post object.
|
|
*/
|
|
public function __construct( $post ) {
|
|
foreach ( get_object_vars( $post ) as $key => $value )
|
|
$this->$key = $value;
|
|
}
|
|
|
|
/**
|
|
* Isset-er.
|
|
*
|
|
* @param string $key Property to check if set.
|
|
* @return bool
|
|
*/
|
|
public function __isset( $key ) {
|
|
if ( 'ancestors' == $key )
|
|
return true;
|
|
|
|
if ( 'page_template' == $key )
|
|
return true;
|
|
|
|
if ( 'post_category' == $key )
|
|
return true;
|
|
|
|
if ( 'tags_input' == $key )
|
|
return true;
|
|
|
|
return metadata_exists( 'post', $this->ID, $key );
|
|
}
|
|
|
|
/**
|
|
* Getter.
|
|
*
|
|
* @param string $key Key to get.
|
|
* @return mixed
|
|
*/
|
|
public function __get( $key ) {
|
|
if ( 'page_template' == $key && $this->__isset( $key ) ) {
|
|
return get_post_meta( $this->ID, '_wp_page_template', true );
|
|
}
|
|
|
|
if ( 'post_category' == $key ) {
|
|
if ( is_object_in_taxonomy( $this->post_type, 'category' ) )
|
|
$terms = get_the_terms( $this, 'category' );
|
|
|
|
if ( empty( $terms ) )
|
|
return array();
|
|
|
|
return wp_list_pluck( $terms, 'term_id' );
|
|
}
|
|
|
|
if ( 'tags_input' == $key ) {
|
|
if ( is_object_in_taxonomy( $this->post_type, 'post_tag' ) )
|
|
$terms = get_the_terms( $this, 'post_tag' );
|
|
|
|
if ( empty( $terms ) )
|
|
return array();
|
|
|
|
return wp_list_pluck( $terms, 'name' );
|
|
}
|
|
|
|
// Rest of the values need filtering.
|
|
if ( 'ancestors' == $key )
|
|
$value = get_post_ancestors( $this );
|
|
else
|
|
$value = get_post_meta( $this->ID, $key, true );
|
|
|
|
if ( $this->filter )
|
|
$value = sanitize_post_field( $key, $value, $this->ID, $this->filter );
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* {@Missing Summary}
|
|
*
|
|
* @param string $filter Filter.
|
|
* @return self|array|bool|object|WP_Post
|
|
*/
|
|
public function filter( $filter ) {
|
|
if ( $this->filter == $filter )
|
|
return $this;
|
|
|
|
if ( $filter == 'raw' )
|
|
return self::get_instance( $this->ID );
|
|
|
|
return sanitize_post( $this, $filter );
|
|
}
|
|
|
|
/**
|
|
* Convert object to array.
|
|
*
|
|
* @return array Object as array.
|
|
*/
|
|
public function to_array() {
|
|
$post = get_object_vars( $this );
|
|
|
|
foreach ( array( 'ancestors', 'page_template', 'post_category', 'tags_input' ) as $key ) {
|
|
if ( $this->__isset( $key ) )
|
|
$post[ $key ] = $this->__get( $key );
|
|
}
|
|
|
|
return $post;
|
|
}
|
|
}
|