Add a helper for getting the since value.

wp-hooks · Sep 8, 2024 · 39a7667 · 39a7667
1 parent 407b652
commit 39a7667
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/src/Doc.php b/src/Doc.php
@@ -59,6 +59,10 @@ public function getParams(): array {
 		return $this->tags->getParams();
 	}
 
+	public function getSince(): string {
+		return $this->tags->getSince();
+	}
+
 	public function getReturnTypeString(): ?string {
 		return $this->tags->getReturnTypeString();
 	}

diff --git a/src/Tags.php b/src/Tags.php
@@ -55,6 +55,22 @@ public function getParams(): array {
 		return $this->getByType( 'param' );
 	}
 
+	public function getSince(): string {
+		foreach ( $this->tags as $tag ) {
+			if ( $tag->getName() === 'since' ) {
+				$since = $tag->getContent();
+
+				if ( strpos( $since, 'MU' ) !== false ) {
+					$since = '3.0.0';
+				}
+
+				return $since;
+			}
+		}
+
+		return '';
+	}
+
 	/**
 	 * @return array<int, Tag>
 	 * @phpstan-return list<Tag>

diff --git a/tests/phpunit/HooksTest.php b/tests/phpunit/HooksTest.php
@@ -91,6 +91,15 @@ public function testCanCountParams(): void {
 		self::assertSame( 2, $count );
 	}
 
+	public function testCanGetSince(): void {
+		$hooks = $this->getFilters();
+		$hook = $hooks->find( 'wp_tag_cloud' );
+
+		$since = $hook->getDoc()->getSince();
+
+		self::assertSame( '2.3.0', $since );
+	}
+
 	/**
 	 * @return array<string, array<int, string>>
 	 * @phpstan-return array{