Actors: Add utility function to get actor type (#1473)

* Actors: Add utility function to get actor type

* Add changelog

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: obenland

.github/changelog/1473-from-description

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Introduced utility function to determine actor type based on user ID.

includes/collection/class-actors.php

@@ -298,4 +298,22 @@ public static function get_collection() {
 
 		return $return;
 	}
+
+	/**
+	 * Returns the actor type based on the user ID.
+	 *
+	 * @param int $user_id The user ID to check.
+	 * @return string The user type.
+	 */
+	public static function get_type_by_id( $user_id ) {
+		if ( self::APPLICATION_USER_ID === $user_id ) {
+			return 'application';
+		}
+
+		if ( self::BLOG_USER_ID === $user_id ) {
+			return 'blog';
+		}
+
+		return 'user';
+	}
 }

includes/collection/class-outbox.php

@@ -33,18 +33,7 @@ class Outbox {
 	 * @return false|int|\WP_Error The added item or an error.
 	 */
 	public static function add( $activity_object, $activity_type, $user_id, $content_visibility = ACTIVITYPUB_CONTENT_VISIBILITY_PUBLIC ) {
-		switch ( $user_id ) {
-			case Actors::APPLICATION_USER_ID:
-				$actor_type = 'application';
-				break;
-			case Actors::BLOG_USER_ID:
-				$actor_type = 'blog';
-				break;
-			default:
-				$actor_type = 'user';
-				break;
-		}
-
+		$actor_type            = Actors::get_type_by_id( $user_id );
 		$title                 = $activity_object->get_name() ?? $activity_object->get_content();
 		$activitypub_object_id = $activity_object->get_id();
 

includes/rest/class-outbox-controller.php

@@ -114,18 +114,6 @@ public function get_items( $request ) {
 		 */
 		$activity_types = apply_filters( 'rest_activitypub_outbox_activity_types', array( 'Announce', 'Create', 'Like', 'Update' ) );
 
-		switch ( $user_id ) {
-			case Actors::APPLICATION_USER_ID:
-				$actor_type = 'application';
-				break;
-			case Actors::BLOG_USER_ID:
-				$actor_type = 'blog';
-				break;
-			default:
-				$actor_type = 'user';
-				break;
-		}
-
 		$args = array(
 			'posts_per_page' => $request->get_param( 'per_page' ),
 			'author'         => $user_id > 0 ? $user_id : null,
@@ -137,7 +125,7 @@ public function get_items( $request ) {
 			'meta_query'     => array(
 				array(
 					'key'   => '_activitypub_activity_actor',
-					'value' => $actor_type,
+					'value' => Actors::get_type_by_id( $user_id ),
 				),
 			),
 		);

tests/includes/collection/class-test-actors.php

@@ -113,4 +113,16 @@ public function the_resource_provider() {
 			array( 'http://example.org/@blogs/', 'WP_Error' ),
 		);
 	}
+
+	/**
+	 * Test get_type_by_id()
+	 *
+	 * @covers ::get_type_by_id
+	 */
+	public function test_get_type_by_id() {
+		$this->assertSame( 'application', Actors::get_type_by_id( Actors::APPLICATION_USER_ID ) );
+		$this->assertSame( 'blog', Actors::get_type_by_id( Actors::BLOG_USER_ID ) );
+		$this->assertSame( 'user', Actors::get_type_by_id( 1 ) );
+		$this->assertSame( 'user', Actors::get_type_by_id( 2 ) );
+	}
 }