EVENT_BEFORE_UPDATE_SEARCH_INDEX

#9801

Author: brandonkelly

CHANGELOG.md

@@ -2,9 +2,13 @@
 
 ## Unreleased
 
+### Added
+- Added `craft\services\Elements::EVENT_BEFORE_UPDATE_SEARCH_INDEX`. ([#9801](https://github.com/craftcms/cms/discussions/9801))
+
 ### Changed
 - Checkboxes, Dropdown, Multi-select, and Radio Buttons fields now include the selected options’ labels in their search keywords. ([#9799](https://github.com/craftcms/cms/issues/9799))
 - It’s now possible for field types to disable delta name registration for nested custom fields by calling `Craft::$app->view->setIsDeltaRegistrationActive(false);` before rendering them.
+- `craft\events\ElementEvent` now extends `craft\events\CancelableEvent`.
 - `craft\models\FieldLayout::createForm()` now accepts a `registerDeltas` key in its `$config` argument, which can be set to `true` or `false` to enable/disable delta name registration for any custom fields in the form.
 - `craft\services\Elements::duplicateElement()` now has a `$placeInStructure` argument.
 - The `Craft.t()` JS method now supports translation messages with [`select` parameters](https://www.yiiframework.com/doc/guide/2.0/en/tutorial-i18n#selection).

src/events/ElementEvent.php

@@ -16,7 +16,7 @@
  * @author Pixel & Tonic, Inc. <[email protected]>
  * @since 3.0.0
  */
-class ElementEvent extends Event
+class ElementEvent extends CancelableEvent
 {
     /**
      * @var ElementInterface|null The element model associated with the event.

src/services/Elements.php

@@ -170,6 +170,16 @@ class Elements extends Component
      */
     const EVENT_AFTER_SAVE_ELEMENT = 'afterSaveElement';
 
+    /**
+     * @event ElementEvent The event that is triggered before indexing an element’s search keywords,
+     * or queuing the element’s search keywords to be updated.
+     *
+     * You may set [[\craft\events\CancelableEvent::$isValid]] to `false` to prevent the search index from being updated.
+     *
+     * @since 3.7.12
+     */
+    const EVENT_BEFORE_UPDATE_SEARCH_INDEX = 'beforeUpdateSearchIndex';
+
     /**
      * @event ElementQueryEvent The event that is triggered before resaving a batch of elements.
      */
@@ -2728,15 +2738,21 @@ private function _saveElementInternal(ElementInterface $element, bool $runValida
 
         // Update search index
         if ($updateSearchIndex && !ElementHelper::isRevision($element)) {
-            if (Craft::$app->getRequest()->getIsConsoleRequest()) {
-                Craft::$app->getSearch()->indexElementAttributes($element);
-            } else {
-                Queue::push(new UpdateSearchIndex([
-                    'elementType' => get_class($element),
-                    'elementId' => $element->id,
-                    'siteId' => $propagate ? '*' : $element->siteId,
-                    'fieldHandles' => $element->getDirtyFields(),
-                ]), 2048);
+            $event = new ElementEvent([
+                'element' => $element,
+            ]);
+            $this->trigger(self::EVENT_BEFORE_UPDATE_SEARCH_INDEX, $event);
+            if ($event->isValid) {
+                if (Craft::$app->getRequest()->getIsConsoleRequest()) {
+                    Craft::$app->getSearch()->indexElementAttributes($element);
+                } else {
+                    Queue::push(new UpdateSearchIndex([
+                        'elementType' => get_class($element),
+                        'elementId' => $element->id,
+                        'siteId' => $propagate ? '*' : $element->siteId,
+                        'fieldHandles' => $element->getDirtyFields(),
+                    ]), 2048);
+                }
             }
         }