chore: prepares for 2.0.0 release

Author: JasonTheAdams

src/Actions/EnqueueNoticesScriptsAndStyles.php

@@ -11,14 +11,14 @@
 /**
  * Checks the given admin notices and enqueues their scripts and styles if they exist and should be rendered.
  *
- * @unreleased
+ * @since 2.0.0
  */
 class EnqueueNoticesScriptsAndStyles
 {
     use HasNamespace;
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __invoke(AdminNotice ...$notices)
     {

src/Actions/NoticeShouldRender.php

@@ -13,14 +13,14 @@
 /**
  * Checks whether the given notice should be rendered based on the provided conditions.
  *
- * @unreleased
+ * @since 2.0.0
  */
 class NoticeShouldRender
 {
     use HasNamespace;
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __invoke(AdminNotice $notice): bool
     {
@@ -34,7 +34,7 @@ public function __invoke(AdminNotice $notice): bool
     /**
      * Checks whether the notice should be displayed based on the provided date limits.
      *
-     * @unreleased moved to the NoticeShouldRender class
+     * @since 2.0.0 moved to the NoticeShouldRender class
      * @since 1.0.0
      */
     private function passesDateLimits(AdminNotice $notice): bool
@@ -59,7 +59,7 @@ private function passesDateLimits(AdminNotice $notice): bool
     /**
      * Checks whether the notice should be displayed based on the provided callback.
      *
-     * @unreleased moved to the NoticeShouldRender class
+     * @since 2.0.0 moved to the NoticeShouldRender class
      * @since 1.0.0
      */
     private function passesWhenCallback(AdminNotice $notice): bool
@@ -77,7 +77,7 @@ private function passesWhenCallback(AdminNotice $notice): bool
      * Checks whether user limits were provided and they pass. Only one capability is required to pass, allowing for
      * multiple users have visibility.
      *
-     * @unreleased moved to the NoticeShouldRender class
+     * @since 2.0.0 moved to the NoticeShouldRender class
      * @since 1.0.0
      */
     private function passesUserCapabilities(AdminNotice $notice): bool
@@ -101,7 +101,7 @@ private function passesUserCapabilities(AdminNotice $notice): bool
      * Checks whether the notice is limited to specific screens and the current screen matches the conditions. Only one
      * screen condition is required to pass, allowing for the notice to appear on multiple screens.
      *
-     * @unreleased moved to the NoticeShouldRender class
+     * @since 2.0.0 moved to the NoticeShouldRender class
      * @since 1.0.0
      */
     private function passesScreenConditions(AdminNotice $notice): bool
@@ -144,7 +144,7 @@ private function passesScreenConditions(AdminNotice $notice): bool
     /**
      * Checks whether the notice has been dismissed by the user.
      *
-     * @unreleased moved to the NoticeShouldRender class
+     * @since 2.0.0 moved to the NoticeShouldRender class
      * @since 1.1.0 added namespacing to the preferences key
      * @since 1.0.0
      */

src/Actions/RenderAdminNotice.php

@@ -23,7 +23,7 @@ class RenderAdminNotice
     /**
      * Renders the admin notice
      *
-     * @unreleased custom notices have a completely different render flow
+     * @since 2.0.0 custom notices have a completely different render flow
      * @since 1.1.0 added namespacing and notice is passed to the __invoke method
      * @since 1.0.0
      */
@@ -52,7 +52,7 @@ public function __invoke(AdminNotice $notice): string
     /**
      * Generates the classes for the standard WordPress notice wrapper.
      *
-     * @unreleased notice is assumed to be standard only
+     * @since 2.0.0 notice is assumed to be standard only
      * @since 1.1.0 notice is passed instead of accessed as a property
      * @since 1.0.0
      */
@@ -81,7 +81,7 @@ private function getStandardWrapperClasses(AdminNotice $notice): string
     /**
      * Apply the needed custom attributes to the content.
      *
-     * @unreleased
+     * @since 2.0.0
      */
     private function applyCustomAttributesToContent(
         string $content,

src/AdminNotice.php

@@ -348,7 +348,7 @@ public function standard(): self
     /**
      * Sets the notice to be inline
      *
-     * @unreleased removed parameter in favor of new location parameter
+     * @since 2.0.0 removed parameter in favor of new location parameter
      * @since 1.2.0
      */
     public function inline(): self
@@ -361,7 +361,7 @@ public function inline(): self
     /**
      * Prevents the notice from being moved from the place it's rendered
      *
-     * @unreleased
+     * @since 2.0.0
      */
     public function inPlace(): self
     {
@@ -417,7 +417,7 @@ public function getId(): string
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function enqueueScript(
         string $source,
@@ -435,15 +435,15 @@ public function enqueueScript(
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function getScriptToEnqueue(): ?Script
     {
         return $this->scriptToEnqueue;
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function enqueueStylesheet(
         string $source,
@@ -457,7 +457,7 @@ public function enqueueStylesheet(
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function getStyleToEnqueue(): ?Style
     {

src/AdminNotices.php

@@ -52,7 +52,7 @@ public static function show(string $notificationId, $render): AdminNotice
     /**
      * Renders the notice in the current location while still honoring visibility conditions
      *
-     * @unreleased mark notice as inPlace to prevent movement; return null if not being rendered
+     * @since 2.0.0 mark notice as inPlace to prevent movement; return null if not being rendered
      * @since 1.0.0
      *
      * @param bool $echo whether to echo or return the notice

src/DataTransferObjects/NoticeElementProperties.php

@@ -39,7 +39,7 @@ class NoticeElementProperties
     public $customWrapperAttributes;
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __construct(AdminNotice $notice, string $namespace)
     {
@@ -54,7 +54,7 @@ public function __construct(AdminNotice $notice, string $namespace)
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      *
      * @param 'hide'|'mark-dismissed' $behavior
      */
@@ -68,7 +68,7 @@ public function customCloseBehaviorAttribute(string $behavior = self::CLOSE_BEHA
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      *
      * @param 'hide'|'mark-dismissed' $behavior
      */
@@ -82,7 +82,7 @@ public function closeAttributes(string $behavior = self::CLOSE_BEHAVIOR_HIDE): s
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     private function behaviorIsValid(string $behavior): bool
     {

src/ValueObjects/NoticeLocation.php

@@ -19,7 +19,7 @@ class NoticeLocation
     private $location;
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public static function aboveHeader(): self
     {
@@ -29,31 +29,31 @@ public static function aboveHeader(): self
     /**
      * An alias of aboveHeader(), as this is the standard WordPress location for admin notices.
      *
-     * @unreleased
+     * @since 2.0.0
      */
     public static function standard(): self
     {
         return self::belowHeader();
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public static function belowHeader(): self
     {
         return new self(self::BELOW_HEADER);
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public static function inline(): self
     {
         return new self(self::INLINE);
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __construct(string $location)
     {
@@ -63,23 +63,23 @@ public function __construct(string $location)
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __toString()
     {
         return $this->location;
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function isAboveHeader(): bool
     {
         return $this->location === self::ABOVE_HEADER;
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function isBelowHeader(): bool
     {
@@ -89,23 +89,23 @@ public function isBelowHeader(): bool
     /**
      * An alias of isAboveHeader(), as this is the standard WordPress location for admin notices.
      *
-     * @unreleased
+     * @since 2.0.0
      */
     public function isStandard(): bool
     {
         return $this->isBelowHeader();
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function isInline(): bool
     {
         return $this->location === self::INLINE;
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      *
      * @param string|self $location
      */
@@ -123,7 +123,7 @@ public function equals($location): bool
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     private function validateLocation(string $location)
     {

src/ValueObjects/Script.php

@@ -8,7 +8,7 @@
 /**
  * Represents a script that can be enqueued with WordPress
  *
- * @unreleased
+ * @since 2.0.0
  */
 class Script
 {
@@ -33,7 +33,7 @@ class Script
     private $args;
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __construct(
         string $source,
@@ -48,7 +48,7 @@ public function __construct(
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function enqueue(string $handle): void
     {

src/ValueObjects/Style.php

@@ -8,7 +8,7 @@
 /**
  * Represents a stylesheet to be enqueued in WordPress
  *
- * @unreleased
+ * @since 2.0.0
  */
 class Style
 {
@@ -33,7 +33,7 @@ class Style
     private $media;
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     public function __construct(
         string $source,
@@ -50,7 +50,7 @@ public function __construct(
     /**
      * Enqueues the stylesheet with WordPress
      *
-     * @unreleased
+     * @since 2.0.0
      */
     public function enqueue(string $handle): void
     {

tests/unit/Actions/DisplayNoticesInAdminTest.php

@@ -59,7 +59,7 @@ public function testShouldAcceptMultipleNotices(): void
     }
 
     /**
-     * @unreleased
+     * @since 2.0.0
      */
     private function getSimpleNoticeOutput(string $content): string
     {