disabledUtilities config setting

brandonkelly · brandonkelly · commit 2952b85316f8 · 2023-12-27T09:50:59.000-08:00
Resolves #14044
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -4,6 +4,7 @@
 - Improved element search performance. ([#14055](https://github.com/craftcms/cms/pull/14055))
 - Added partial support for field types storing data in JSON columns (excluding MariaDB). ([#13916](https://github.com/craftcms/cms/issues/13916))
 - “Updating search indexes” jobs are no longer queued when saving elements with change tracking enabled, if no searchable fields or attributes were changed. ([#13917](https://github.com/craftcms/cms/issues/13917))
+- Added the `disabledUtilities` config setting. ([#14044](https://github.com/craftcms/cms/discussions/14044))
 - `resave` commands now pass an empty string (`''`) to fields’ `normalizeValue()` methods when `--to` is set to `:empty:`. ([#13951](https://github.com/craftcms/cms/issues/13951))
 - The `index-assets/one` and `index-assets/all` commands now accept a `--delete-empty-folders` option. ([#13947](https://github.com/craftcms/cms/discussions/13947))
 - Added `craft\helpers\ElementHelper::searchableAttributes()`.
diff --git a/src/config/GeneralConfig.php b/src/config/GeneralConfig.php
@@ -954,6 +954,26 @@ class GeneralConfig extends BaseConfig
      */
     public string|array|null $disabledPlugins = null;
 
+    /**
+     * @var string[] Array of utility IDs that should be disabled.
+     *
+     * ::: code
+     * ```php Static Config
+     *  ->disabledUtilities([
+     *      'updates',
+     *      'find-replace',
+     *  ])
+     * ```
+     * ```shell Environment Override
+     * CRAFT_DISABLED_UTILITIES=updates,find-replace
+     * ```
+     * :::
+     *
+     * @group System
+     * @since 4.6.0
+     */
+    public array $disabledUtilities = [];
+
     /**
      * @var bool Whether front end requests should respond with `X-Robots-Tag: none` HTTP headers, indicating that pages should not be indexed,
      * and links on the page should not be followed, by web crawlers.
@@ -4097,6 +4117,33 @@ public function disabledPlugins(string|array|null $value): self
         return $this;
     }
 
+    /**
+     * Array of utility IDs that should be disabled.
+     *
+     *  ::: code
+     *  ```php Static Config
+     *   ->disabledUtilities([
+     *       'updates',
+     *       'find-replace',
+     *   ])
+     *  ```
+     *  ```shell Environment Override
+     *  CRAFT_DISABLED_UTILITIES=updates,find-replace
+     *  ```
+     *  :::
+     *
+     * @group System
+     * @param string[] $value
+     * @return self
+     * @see $disabledUtilities
+     * @since 4.6.0
+     */
+    public function disabledUtilities(array $value): self
+    {
+        $this->disabledUtilities = $value;
+        return $this;
+    }
+
     /**
      * Whether front end requests should respond with `X-Robots-Tag: none` HTTP headers, indicating that pages should not be indexed,
      * and links on the page should not be followed, by web crawlers.
diff --git a/src/services/Utilities.php b/src/services/Utilities.php
@@ -96,7 +96,12 @@ public function getAllUtilityTypes(): array
         ]);
         $this->trigger(self::EVENT_REGISTER_UTILITY_TYPES, $event);
 
-        return $event->types;
+        $disabledUtilities = array_flip(Craft::$app->getConfig()->getGeneral()->disabledUtilities);
+
+        return array_values(array_filter($event->types, function(string $class) use ($disabledUtilities) {
+            /** @var string|UtilityInterface $class */
+            return !isset($disabledUtilities[$class::id()]);
+        }));
     }
 
     /**
