minor #60431 [WebLink] Hint that prerender is deprecated (dunglas)

nicolas-grekas · nicolas-grekas · commit 255d35f39ae0 · 2025-05-16T10:24:06.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [WebLink] Hint that prerender is deprecated | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Issues | n/a | License | MIT [`prerender` ](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel/prerender) has been deprecated. Add a hint in the PHPDoc not to use it. I decided not to deprecate the constant and the function itself because even if the keyword is deprecated in the web platform, it can be useful. Commits ------- fc10d48 [WebLink] Hint that prerender is deprecated
diff --git a/src/Symfony/Bridge/Twig/Extension/WebLinkExtension.php b/src/Symfony/Bridge/Twig/Extension/WebLinkExtension.php
@@ -46,7 +46,7 @@ public function getFunctions(): array
     /**
      * Adds a "Link" HTTP header.
      *
-     * @param string $rel        The relation type (e.g. "preload", "prefetch", "prerender" or "dns-prefetch")
+     * @param string $rel        The relation type (e.g. "preload", "prefetch", or "dns-prefetch")
      * @param array  $attributes The attributes of this link (e.g. "['as' => true]", "['pr' => 0.5]")
      *
      * @return string The relation URI
@@ -117,7 +117,11 @@ public function prefetch(string $uri, array $attributes = []): string
     }
 
     /**
-     * Indicates to the client that it should prerender this resource .
+     * Indicates to the client that it should prerender this resource.
+     *
+     * This feature is deprecated and superseded by the Speculation Rules API.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel/prerender
      *
      * @param array $attributes The attributes of this link (e.g. "['as' => true]", "['pr' => 0.5]")
      *
diff --git a/src/Symfony/Component/WebLink/Link.php b/src/Symfony/Component/WebLink/Link.php
@@ -98,6 +98,12 @@ class Link implements EvolvableLinkInterface
     public const REL_PREDECESSOR_VERSION = 'predecessor-version';
     public const REL_PREFETCH = 'prefetch';
     public const REL_PRELOAD = 'preload';
+
+    /**
+     * This feature is deprecated and superseded by the Speculation Rules API.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel/prerender
+     */
     public const REL_PRERENDER = 'prerender';
     public const REL_PREV = 'prev';
     public const REL_PREVIEW = 'preview';
