Added new RenderElementsEvent

The new event allows plugin / module authors to override the template rendering for the elements index container.

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
      *
@@ -572,7 +578,7 @@ protected static function defineSearchableAttributes(): array
     /**
      * @inheritdoc
      */
-    public static function indexHtml(ElementQueryInterface $elementQuery, array $disabledElementIds = null, array $viewState, string $sourceKey = null, string $context = null, bool $includeContainer, bool $showCheckboxes): string
+    public static function indexHtml(ElementQueryInterface $elementQuery, array $disabledElementIds = null, array $viewState, string $sourceKey = null, string $context = null, bool $includeContainer, bool $showCheckboxes, array $source = null): string
     {
         $variables = [
             'viewMode' => $viewState['mode'],
@@ -621,7 +627,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);
     }
 
     /**

src/base/ElementInterface.php

@@ -350,9 +350,10 @@ public static function searchableAttributes(): array;
      * @param string|null $context
      * @param bool $includeContainer
      * @param bool $showCheckboxes
+     * @param array|null $source
      * @return string The element index HTML
      */
-    public static function indexHtml(ElementQueryInterface $elementQuery, array $disabledElementIds = null, array $viewState, string $sourceKey = null, string $context = null, bool $includeContainer, bool $showCheckboxes): string;
+    public static function indexHtml(ElementQueryInterface $elementQuery, array $disabledElementIds = null, array $viewState, string $sourceKey = null, string $context = null, bool $includeContainer, bool $showCheckboxes, array $source = null): string;
 
     /**
      * Returns the sort options for the element type.

src/controllers/ElementIndexesController.php

@@ -530,7 +530,8 @@ protected function elementResponseData(bool $includeContainer, bool $includeActi
                 $this->sourceKey,
                 $this->context,
                 $includeContainer,
-                $showCheckboxes
+                $showCheckboxes,
+                $this->source
             );
 
             $responseData['headHtml'] = $view->getHeadHtml();

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. <[email protected]>
+ * @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;
+}