Allow typing of comment objects, just like posts

level-level · Sep 27, 2022 · 0da62ee · 0da62ee
1 parent f18dda3
commit 0da62ee
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/src/WordPress_Object/Clarkson_Comment.php b/src/WordPress_Object/Clarkson_Comment.php
@@ -13,6 +13,14 @@
  * Object oriented wrapper for WP_Comment objects.
  */
 class Clarkson_Comment {
+
+	/**
+	 * The type of the comment.
+	 *
+	 * @var string
+	 */
+	public static $type = 'comment';
+
 	/**
 	 * WordPress representation of this comment object.
 	 *
@@ -41,6 +49,7 @@ public static function get( int $id ): ?Clarkson_Comment {
 	 */
 	public static function get_many( array $args = array() ): array {
 		$args['fields'] = '';
+		$args['type']   = static::$type;
 		$comments       = get_comments( $args );
 		return Objects::get_instance()->get_comments( $comments );
 	}

diff --git a/src/WordPress_Object/Clarkson_Object.php b/src/WordPress_Object/Clarkson_Object.php
@@ -607,6 +607,9 @@ public function has_term( $term ) {
 
 	/**
 	 * Get the comments created by this user.
+	 *
+	 * Explicitly does not get comments via the Clarkson_Comment::get_many() function,
+	 * as this would result in only returning comments of type comment.
 	 */
 	public function get_comments( array $args = array() ): array {
 		$args['user_id'] = $this->get_id();

diff --git a/src/WordPress_Object/Clarkson_User.php b/src/WordPress_Object/Clarkson_User.php
@@ -245,6 +245,9 @@ public function delete_meta( $key, $value = '' ) {
 
 	/**
 	 * Get the comments created by this user.
+	 *
+	 * Explicitly does not get comments via the Clarkson_Comment::get_many() function,
+	 * as this would result in only returning comments of type comment.
 	 */
 	public function get_comments( array $args = array() ): array {
 		$args['user_id'] = $this->get_id();