mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-28 12:07:36 +01:00
0860bb2771
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs. See #41452. Built from https://develop.svn.wordpress.org/trunk@41162 git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
370 lines
8.7 KiB
PHP
370 lines
8.7 KiB
PHP
<?php
|
|
/**
|
|
* Comment API: WP_Comment class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Comments
|
|
* @since 4.4.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used to organize comments as instantiated objects with defined members.
|
|
*
|
|
* @since 4.4.0
|
|
*/
|
|
final class WP_Comment {
|
|
|
|
/**
|
|
* Comment ID.
|
|
*
|
|
* @since 4.4.0
|
|
* @var int
|
|
*/
|
|
public $comment_ID;
|
|
|
|
/**
|
|
* ID of the post the comment is associated with.
|
|
*
|
|
* @since 4.4.0
|
|
* @var int
|
|
*/
|
|
public $comment_post_ID = 0;
|
|
|
|
/**
|
|
* Comment author name.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_author = '';
|
|
|
|
/**
|
|
* Comment author email address.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_author_email = '';
|
|
|
|
/**
|
|
* Comment author URL.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_author_url = '';
|
|
|
|
/**
|
|
* Comment author IP address (IPv4 format).
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_author_IP = '';
|
|
|
|
/**
|
|
* Comment date in YYYY-MM-DD HH:MM:SS format.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_date = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* Comment GMT date in YYYY-MM-DD HH::MM:SS format.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_date_gmt = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* Comment content.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_content;
|
|
|
|
/**
|
|
* Comment karma count.
|
|
*
|
|
* @since 4.4.0
|
|
* @var int
|
|
*/
|
|
public $comment_karma = 0;
|
|
|
|
/**
|
|
* Comment approval status.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_approved = '1';
|
|
|
|
/**
|
|
* Comment author HTTP user agent.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_agent = '';
|
|
|
|
/**
|
|
* Comment type.
|
|
*
|
|
* @since 4.4.0
|
|
* @var string
|
|
*/
|
|
public $comment_type = '';
|
|
|
|
/**
|
|
* Parent comment ID.
|
|
*
|
|
* @since 4.4.0
|
|
* @var int
|
|
*/
|
|
public $comment_parent = 0;
|
|
|
|
/**
|
|
* Comment author ID.
|
|
*
|
|
* @since 4.4.0
|
|
* @var int
|
|
*/
|
|
public $user_id = 0;
|
|
|
|
/**
|
|
* Comment children.
|
|
*
|
|
* @since 4.4.0
|
|
* @var array
|
|
*/
|
|
protected $children;
|
|
|
|
/**
|
|
* Whether children have been populated for this comment object.
|
|
*
|
|
* @since 4.4.0
|
|
* @var bool
|
|
*/
|
|
protected $populated_children = false;
|
|
|
|
/**
|
|
* Post fields.
|
|
*
|
|
* @since 4.4.0
|
|
* @var array
|
|
*/
|
|
protected $post_fields = array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_title', 'post_excerpt', 'post_status', 'comment_status', 'ping_status', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_content_filtered', 'post_parent', 'guid', 'menu_order', 'post_type', 'post_mime_type', 'comment_count' );
|
|
|
|
/**
|
|
* Retrieves a WP_Comment instance.
|
|
*
|
|
* @since 4.4.0
|
|
* @static
|
|
*
|
|
* @global wpdb $wpdb WordPress database abstraction object.
|
|
*
|
|
* @param int $id Comment ID.
|
|
* @return WP_Comment|false Comment object, otherwise false.
|
|
*/
|
|
public static function get_instance( $id ) {
|
|
global $wpdb;
|
|
|
|
$comment_id = (int) $id;
|
|
if ( ! $comment_id ) {
|
|
return false;
|
|
}
|
|
|
|
$_comment = wp_cache_get( $comment_id, 'comment' );
|
|
|
|
if ( ! $_comment ) {
|
|
$_comment = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_ID = %d LIMIT 1", $comment_id ) );
|
|
|
|
if ( ! $_comment ) {
|
|
return false;
|
|
}
|
|
|
|
wp_cache_add( $_comment->comment_ID, $_comment, 'comment' );
|
|
}
|
|
|
|
return new WP_Comment( $_comment );
|
|
}
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* Populates properties with object vars.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param WP_Comment $comment Comment object.
|
|
*/
|
|
public function __construct( $comment ) {
|
|
foreach ( get_object_vars( $comment ) as $key => $value ) {
|
|
$this->$key = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convert object to array.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @return array Object as array.
|
|
*/
|
|
public function to_array() {
|
|
return get_object_vars( $this );
|
|
}
|
|
|
|
/**
|
|
* Get the children of a comment.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param array $args {
|
|
* Array of arguments used to pass to get_comments() and determine format.
|
|
*
|
|
* @type string $format Return value format. 'tree' for a hierarchical tree, 'flat' for a flattened array.
|
|
* Default 'tree'.
|
|
* @type string $status Comment status to limit results by. Accepts 'hold' (`comment_status=0`),
|
|
* 'approve' (`comment_status=1`), 'all', or a custom comment status.
|
|
* Default 'all'.
|
|
* @type string $hierarchical Whether to include comment descendants in the results.
|
|
* 'threaded' returns a tree, with each comment's children
|
|
* stored in a `children` property on the `WP_Comment` object.
|
|
* 'flat' returns a flat array of found comments plus their children.
|
|
* Pass `false` to leave out descendants.
|
|
* The parameter is ignored (forced to `false`) when `$fields` is 'ids' or 'counts'.
|
|
* Accepts 'threaded', 'flat', or false. Default: 'threaded'.
|
|
* @type string|array $orderby Comment status or array of statuses. To use 'meta_value'
|
|
* or 'meta_value_num', `$meta_key` must also be defined.
|
|
* To sort by a specific `$meta_query` clause, use that
|
|
* clause's array key. Accepts 'comment_agent',
|
|
* 'comment_approved', 'comment_author',
|
|
* 'comment_author_email', 'comment_author_IP',
|
|
* 'comment_author_url', 'comment_content', 'comment_date',
|
|
* 'comment_date_gmt', 'comment_ID', 'comment_karma',
|
|
* 'comment_parent', 'comment_post_ID', 'comment_type',
|
|
* 'user_id', 'comment__in', 'meta_value', 'meta_value_num',
|
|
* the value of $meta_key, and the array keys of
|
|
* `$meta_query`. Also accepts false, an empty array, or
|
|
* 'none' to disable `ORDER BY` clause.
|
|
* }
|
|
* @return array Array of `WP_Comment` objects.
|
|
*/
|
|
public function get_children( $args = array() ) {
|
|
$defaults = array(
|
|
'format' => 'tree',
|
|
'status' => 'all',
|
|
'hierarchical' => 'threaded',
|
|
'orderby' => '',
|
|
);
|
|
|
|
$_args = wp_parse_args( $args, $defaults );
|
|
$_args['parent'] = $this->comment_ID;
|
|
|
|
if ( is_null( $this->children ) ) {
|
|
if ( $this->populated_children ) {
|
|
$this->children = array();
|
|
} else {
|
|
$this->children = get_comments( $_args );
|
|
}
|
|
}
|
|
|
|
if ( 'flat' === $_args['format'] ) {
|
|
$children = array();
|
|
foreach ( $this->children as $child ) {
|
|
$child_args = $_args;
|
|
$child_args['format'] = 'flat';
|
|
// get_children() resets this value automatically.
|
|
unset( $child_args['parent'] );
|
|
|
|
$children = array_merge( $children, array( $child ), $child->get_children( $child_args ) );
|
|
}
|
|
} else {
|
|
$children = $this->children;
|
|
}
|
|
|
|
return $children;
|
|
}
|
|
|
|
/**
|
|
* Add a child to the comment.
|
|
*
|
|
* Used by `WP_Comment_Query` when bulk-filling descendants.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param WP_Comment $child Child comment.
|
|
*/
|
|
public function add_child( WP_Comment $child ) {
|
|
$this->children[ $child->comment_ID ] = $child;
|
|
}
|
|
|
|
/**
|
|
* Get a child comment by ID.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param int $child_id ID of the child.
|
|
* @return WP_Comment|bool Returns the comment object if found, otherwise false.
|
|
*/
|
|
public function get_child( $child_id ) {
|
|
if ( isset( $this->children[ $child_id ] ) ) {
|
|
return $this->children[ $child_id ];
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Set the 'populated_children' flag.
|
|
*
|
|
* This flag is important for ensuring that calling `get_children()` on a childless comment will not trigger
|
|
* unneeded database queries.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param bool $set Whether the comment's children have already been populated.
|
|
*/
|
|
public function populated_children( $set ) {
|
|
$this->populated_children = (bool) $set;
|
|
}
|
|
|
|
/**
|
|
* Check whether a non-public property is set.
|
|
*
|
|
* If `$name` matches a post field, the comment post will be loaded and the post's value checked.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param string $name Property name.
|
|
* @return bool
|
|
*/
|
|
public function __isset( $name ) {
|
|
if ( in_array( $name, $this->post_fields ) && 0 !== (int) $this->comment_post_ID ) {
|
|
$post = get_post( $this->comment_post_ID );
|
|
return property_exists( $post, $name );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Magic getter.
|
|
*
|
|
* If `$name` matches a post field, the comment post will be loaded and the post's value returned.
|
|
*
|
|
* @since 4.4.0
|
|
*
|
|
* @param string $name
|
|
* @return mixed
|
|
*/
|
|
public function __get( $name ) {
|
|
if ( in_array( $name, $this->post_fields ) ) {
|
|
$post = get_post( $this->comment_post_ID );
|
|
return $post->$name;
|
|
}
|
|
}
|
|
}
|