From 2e7d8a5f35fd29d3d58bfd1620589e94faed1d12 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mikel=20Mart=C3=ADn?= <mikel@moodle.com>
Date: Fri, 8 Nov 2024 14:03:39 +0100
Subject: [PATCH] MDL-81825 core: Replace sr_text() with visually_hidden_text()

In core renderer, replace 'sr_text' method with 'visually_hidden_text' to be
consistent with Bootstrap 5 upgrade.
---
 .upgradenotes/MDL-81825-2024110812525353.yml |  7 +++++++
 lib/classes/output/core_renderer.php         | 16 +++++++++++++++-
 2 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 .upgradenotes/MDL-81825-2024110812525353.yml

diff --git a/.upgradenotes/MDL-81825-2024110812525353.yml b/.upgradenotes/MDL-81825-2024110812525353.yml
new file mode 100644
index 0000000000000..c84092060a9f1
--- /dev/null
+++ b/.upgradenotes/MDL-81825-2024110812525353.yml
@@ -0,0 +1,7 @@
+issueNumber: MDL-81825
+notes:
+  core:
+    - message: >-
+        The 'core_renderer::sr_text()' function has been deprecated, use
+        'core_renderer::visually_hidden_text()' instead.
+      type: deprecated
diff --git a/lib/classes/output/core_renderer.php b/lib/classes/output/core_renderer.php
index 33d278f3743da..9fd50020fab96 100644
--- a/lib/classes/output/core_renderer.php
+++ b/lib/classes/output/core_renderer.php
@@ -2952,12 +2952,26 @@ public function paragraph(string $contents, ?string $classes = null, ?string $id
      *
      * @param string $contents The contents of the paragraph
      * @return string the HTML to output.
+     * @deprecated since 5.0. Use visually_hidden_text() instead.
+     * @todo Final deprecation in Moodle 6.0. See MDL-83671.
      */
+    #[\core\attribute\deprecated('core_renderer::visually_hidden_text()', since: '5.0', mdl: 'MDL-81825')]
     public function sr_text(string $contents): string {
+        \core\deprecation::emit_deprecation_if_present([$this, __FUNCTION__]);
+        return $this->visually_hidden_text($contents);
+    }
+
+    /**
+     * Outputs a visually hidden inline text (but accessible to assistive technologies).
+     *
+     * @param string $contents The contents of the paragraph
+     * @return string the HTML to output.
+     */
+    public function visually_hidden_text(string $contents): string {
         return html_writer::tag(
             'span',
             $contents,
-            ['class' => 'sr-only']
+            ['class' => 'visually-hidden']
         ) . ' ';
     }