MDL-80072 core: Deprecate format_text smiley option

This was actually deprecated in Moodle 2.0 but did not emit.
moodle · Feb 12, 2024 · 85c1dd0 · 85c1dd0
1 parent d56303a
commit 85c1dd0
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 12 deletions.
diff --git a/admin/tool/dbtransfer/locallib.php b/admin/tool/dbtransfer/locallib.php
@@ -170,7 +170,6 @@ function tool_dbtransfer_create_maintenance_file() {
     $options = new stdClass();
     $options->trusted = false;
     $options->noclean = false;
-    $options->smiley = false;
     $options->filter = false;
     $options->para = true;
     $options->newlines = false;

diff --git a/admin/tool/messageinbound/classes/edit_handler_form.php b/admin/tool/messageinbound/classes/edit_handler_form.php
@@ -46,7 +46,6 @@ public function definition() {
         $formatoptions = new stdClass();
         $formatoptions->trusted = false;
         $formatoptions->noclean = false;
-        $formatoptions->smiley = false;
         $formatoptions->filter = false;
         $formatoptions->para = true;
         $formatoptions->newlines = false;

diff --git a/admin/tool/messageinbound/renderer.php b/admin/tool/messageinbound/renderer.php
@@ -67,7 +67,6 @@ public function messageinbound_handlers_table(array $handlers) {
         $descriptionoptions = new stdClass();
         $descriptionoptions->trusted = false;
         $descriptionoptions->noclean = false;
-        $descriptionoptions->smiley = false;
         $descriptionoptions->filter = false;
         $descriptionoptions->para = true;
         $descriptionoptions->newlines = false;

diff --git a/admin/user/user_bulk_message.php b/admin/user/user_bulk_message.php
@@ -47,7 +47,6 @@
     $options = new stdClass();
     $options->para     = false;
     $options->newlines = true;
-    $options->smiley   = false;
     $options->trusted = trusttext_trusted(\context_system::instance());
 
     $msg = format_text($formdata->messagebody['text'], $formdata->messagebody['format'], $options);

diff --git a/grade/edit/tree/grade.php b/grade/edit/tree/grade.php
@@ -111,7 +111,6 @@
         $grade->feedback  = '';
     } else {
         $options = new stdClass();
-        $options->smiley  = false;
         $options->filter  = false;
         $options->noclean = false;
         $options->para    = false;

diff --git a/lib/classes/output/chooser_item.php b/lib/classes/output/chooser_item.php
@@ -86,7 +86,6 @@ public function export_for_template(renderer_base $output) {
         $options = new stdClass();
         $options->trusted = false;
         $options->noclean = false;
-        $options->smiley = false;
         $options->filter = false;
         $options->para = true;
         $options->newlines = false;

diff --git a/lib/tablelib.php b/lib/tablelib.php
@@ -933,9 +933,6 @@ function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL
             if (!isset($options->newlines)) {
                 $options->newlines = false;
             }
-            if (!isset($options->smiley)) {
-                $options->smiley = false;
-            }
             if (!isset($options->filter)) {
                 $options->filter = false;
             }

diff --git a/lib/upgrade.txt b/lib/upgrade.txt
@@ -46,6 +46,7 @@ information provided here is intended especially for developers.
   The old method will be maintained, but new code should use the new method with first-class parameters.
 * The fourth parameter to `format_text` now emits a deprecation notice.
   It was originally deprecated in Moodle 2.0.
+* The smiley option for format_text has been removed. It was deprecated in Moodle 2.0.
 
 === 4.3 ===
 

diff --git a/lib/weblib.php b/lib/weblib.php
@@ -1318,6 +1318,15 @@ function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseidd
     $params['text'] =  $text;
 
     if ($options) {
+        // The smiley option was deprecated in Moodle 2.0.
+        if (array_key_exists('smiley', $options)) {
+            unset($options['smiley']);
+            debugging(
+                'The smiley option is deprecated and no longer used.',
+                DEBUG_DEVELOPER,
+            );
+        }
+
         $validoptions = [
             'text',
             'format',
@@ -1332,7 +1341,6 @@ function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseidd
             'allowid',
             'noclean',
             'nocache',
-            'smiley',
         ];
 
         $invalidoptions = array_diff(array_keys($options), $validoptions);
@@ -3743,7 +3751,6 @@ function get_formatted_help_string($identifier, $component, $ajax = false, $a =
         $options = new stdClass();
         $options->trusted = false;
         $options->noclean = false;
-        $options->smiley = false;
         $options->filter = false;
         $options->para = true;
         $options->newlines = false;

diff --git a/tag/edit.php b/tag/edit.php
@@ -78,7 +78,6 @@
 $data->relatedtags = core_tag_tag::get_item_tags_array('core', 'tag', $tag->id);
 
 $options = new stdClass();
-$options->smiley = false;
 $options->filter = false;
 
 // convert and remove any XSS