Deprecate Url::toRenderArray() and Url::renderAccess()

CR and initial patch, as there's contrib usage CR needs to be updated for Url::renderAccess() (marked @internal ATM)

+++ b/core/modules/shortcut/src/Form/SetCustomize.php
@@ -55,7 +55,9 @@ public function form(array $form, FormStateInterface $form_state) {
-      ] + $url->toRenderArray();
+        '#url' => $url,
+        '#options' => $url->getOptions(),

There's access check few lines above so no need for $render_array['#access_callback'] = [get_class(), 'renderAccess'];

and now unset() no longer needed

I checked the contrib usages, they are all doing:

if ($url->renderAccess($url->toRenderArray()))

Which seems like an extremely long way to do:

if ($url->access())

There are only two modules with a couple of usages each, so I think we could go ahead and deprecate both methods here.

Updated CR https://www.drupal.org/node/3342977 →

and new patch with todo link for removal 📌 [11.x] Remove deprecated code from \Drupal\Core\Url Active

better title

Fix CS for deprecation

1. +++ b/core/lib/Drupal/Core/Url.php
   @@ -770,8 +770,14 @@ public function toString($collect_bubbleable_metadata = FALSE) {
   +    @trigger_error('The ' . __METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use to inline its implementation. See https://www.drupal.org/node/3342977', E_USER_DEPRECATED);
   

   Maybe 'There is no direct replacement' instead of 'inline its implementation? - The uses in contrib should be refactored to something else entirely.

2. +++ b/core/lib/Drupal/Core/Url.php
   @@ -836,8 +842,14 @@ public function access(AccountInterface $account = NULL, $return_as_object = FAL
      public static function renderAccess(array $element) {
   +    @trigger_error('The ' . __METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use to inline its implementation. See https://www.drupal.org/node/3342977', E_USER_DEPRECATED);
        return $element['#url']->access();
   

   Same here.

Thanks, changed to suggested

CR updated

The example in the CR is clear and covers literally every usage in contrib.

I think this is ready to go now.

Reviewed Patch on #10, issue has been resolved as observed, can be merged.

The deprecation message for a method → does not start with 'The'. And I was getting a phpcs errors. So, I updated the patch.

I also too the liberty of removing 'direct' from the deprecation message. It did not seem to be adding information.

Thank you, curious why phpcs does not report it in CI

Committed and pushed to 10.1.x, thanks!

Automatically closed - issue fixed for 2 weeks with no activity.

I know I'm late to the party, but why is toRenderArray deprecated? I only see the access method discussed.