Make it possible to show a header message for datatables (#12146)

* Make it possible to show a header message for datatables

* update changelog

* add comment that messages will be printed raw

2 files changed, 10 insertions, 0 deletions

diff --git a/core/Plugin/Visualization.php b/core/Plugin/Visualization.php
index 6bb2c3a4f8..bd46547e64 100644
--- a/core/Plugin/Visualization.php
+++ b/core/Plugin/Visualization.php
@@ -38,6 +38,7 @@ use Piwik\API\Request as ApiRequest;
  * itself:
  *
  * - report documentation,
+ * - a header message (if {@link Piwik\ViewDataTable\Config::$show_header_message} is set),
  * - a footer message (if {@link Piwik\ViewDataTable\Config::$show_footer_message} is set),
  * - a list of links to related reports (if {@link Piwik\ViewDataTable\Config::$related_reports} is set),
  * - a button that allows users to switch visualizations,
diff --git a/core/ViewDataTable/Config.php b/core/ViewDataTable/Config.php
index 2c7a59beff..2a2a927da4 100644
--- a/core/ViewDataTable/Config.php
+++ b/core/ViewDataTable/Config.php
@@ -372,7 +372,16 @@ class   Config
     public $show_ecommerce = false;
 
     /**
+     * Stores an HTML message (if any) to display above the datatable view.
+     *
+     * Attention: Message will be printed raw. Don't forget to escape where needed!
+     */
+    public $show_header_message = false;
+
+    /**
      * Stores an HTML message (if any) to display under the datatable view.
+     *
+     * Attention: Message will be printed raw. Don't forget to escape where needed!
      */
     public $show_footer_message = false;