Added new RenderElementsEvent

leevigraham · leevigraham · commit 8cd998c89d6d · 2020-05-20T21:50:07.000+10:00
The new event allows plugin / module authors to override the template rendering for the elements index container.
diff --git a/src/base/Element.php b/src/base/Element.php
@@ -29,6 +29,7 @@
 use craft\events\RegisterElementSourcesEvent;
 use craft\events\RegisterElementTableAttributesEvent;
 use craft\events\RegisterPreviewTargetsEvent;
+use craft\events\RenderElementsEvent;
 use craft\events\SetElementRouteEvent;
 use craft\events\SetElementTableAttributeHtmlEvent;
 use craft\helpers\ArrayHelper;
@@ -187,6 +188,11 @@ abstract class Element extends Component implements ElementInterface
      */
     const EVENT_REGISTER_HTML_ATTRIBUTES = 'registerHtmlAttributes';
 
+    /**
+     * @event RenderElementsEvent The event that is triggered when rendering elements
+     */
+    const EVENT_RENDER_ELEMENTS = 'renderElements';
+
     /**
      * @event SetElementRouteEvent The event that is triggered when defining the route that should be used when this element’s URL is requested
      *
@@ -574,17 +580,19 @@ protected static function defineSearchableAttributes(): array
      */
     public static function indexHtml(ElementQueryInterface $elementQuery, array $disabledElementIds = null, array $viewState, string $sourceKey = null, string $context = null, bool $includeContainer, bool $showCheckboxes): string
     {
+        $source = ElementHelper::findSource(static::class, $sourceKey, $context);
+
         $variables = [
             'viewMode' => $viewState['mode'],
             'context' => $context,
             'disabledElementIds' => $disabledElementIds,
             'collapsedElementIds' => Craft::$app->getRequest()->getParam('collapsedElementIds'),
             'showCheckboxes' => $showCheckboxes,
+            'source' => $source
         ];
 
         // Special case for sorting by structure
         if (isset($viewState['order']) && $viewState['order'] === 'structure') {
-            $source = ElementHelper::findSource(static::class, $sourceKey, $context);
 
             if (isset($source['structureId'])) {
                 $elementQuery->orderBy(['lft' => SORT_ASC]);
@@ -621,7 +629,14 @@ public static function indexHtml(ElementQueryInterface $elementQuery, array $dis
 
         $template = '_elements/' . $viewState['mode'] . 'view/' . ($includeContainer ? 'container' : 'elements');
 
-        return Craft::$app->getView()->renderTemplate($template, $variables);
+        // Give plugins a chance to modify the element rendering
+        $event = new RenderElementsEvent([
+            'variables' => $variables,
+            'template' => $template
+        ]);
+        Event::trigger(static::class, self::EVENT_RENDER_ELEMENTS, $event);
+
+        return Craft::$app->getView()->renderTemplate($event->template, $event->variables);
     }
 
     /**
diff --git a/src/events/RenderElementsEvent.php b/src/events/RenderElementsEvent.php
@@ -0,0 +1,31 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\events;
+
+use craft\base\ElementActionInterface;
+use craft\elements\db\ElementQueryInterface;
+use yii\base\Event;
+
+/**
+ * Render Element event class.
+ *
+ * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
+ * @since 3.0.0
+ */
+class RenderElementsEvent extends Event
+{
+    /**
+     * @var string the template to render
+     */
+    public $template;
+
+    /**
+     * @var array the variables passed to the template
+     */
+    public $variables;
+}
