MDL-84720 reportbuilder: note change of column sort field behaviour.

2025-03-03 16:10:25 +00:00
parent 688478cfa4
commit 19a9c8b70f
2 changed files with 9 additions and 1 deletions
@@ -0,0 +1,8 @@
+issueNumber: MDL-83718
+notes:
+  core_reportbuilder:
+    - message: >-
+        For columns implementing custom sorting via their `set_is_sortable`
+        method, the specified sort fields must also be part of the columns
+        initially selected fields
+      type: changed
@@ -563,7 +563,7 @@ final class column {
     * Sets the column as sortable
     *
     * @param bool $issortable
-     * @param array $sortfields Define the fields that should be used when the column is sorted, typically a subset of the fields
+     * @param array $sortfields Define the fields that should be used when the column is sorted. Must be a subset of the fields
     *      selected for the column, via {@see add_field}. If omitted then the first selected field is used
     * @return self
     */