Updated Drupal to 8.6. This goes with the following updates because it's possible...

[yaffs-website] / web / core / lib / Drupal / Core / Plugin / plugin.api.php

diff --git a/web/core/lib/Drupal/Core/Plugin/plugin.api.php b/web/core/lib/Drupal/Core/Plugin/plugin.api.php
new file mode 100644 (file)
index 0000000..5c85c11
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Plugin/plugin.api.php
@@ -0,0 +1,68 @@
+<?php
+
+/**
+ * @file
+ * Hooks provided by the Plugin system.
+ */
+
+/**
+ * @addtogroup hooks
+ * @{
+ */
+
+/**
+ * Alter the filtering of plugin definitions for a specific plugin type.
+ *
+ * TYPE (e.g. "block", "layout") limits hook scope to a plugin type.
+ * For example, HOOK_plugin_filter_block_alter() would be invoked
+ * by a hook listener which specifies the 'block' plugin list,
+ * e.g., BlockLibraryController or ChooseBlockController.
+ *
+ * @param \Drupal\Component\Plugin\Definition\PluginDefinitionInterface[]|array[] $definitions
+ *   The array of plugin definitions.
+ * @param mixed[] $extra
+ *   An associative array containing additional information provided by the code
+ *   requesting the filtered definitions.
+ * @param string $consumer
+ *   A string identifying the consumer of these plugin definitions.
+ */
+function hook_plugin_filter_TYPE_alter(array &$definitions, array $extra, $consumer) {
+  // Remove the "Help" block from the Block UI list.
+  if ($consumer == 'block_ui') {
+    unset($definitions['help_block']);
+  }
+
+  // If the theme is specified, remove the branding block from the Bartik theme.
+  if (isset($extra['theme']) && $extra['theme'] === 'bartik') {
+    unset($definitions['system_branding_block']);
+  }
+
+  // Remove the "Main page content" block from everywhere.
+  unset($definitions['system_main_block']);
+}
+
+/**
+ * Alter the filtering of plugin definitions for a specific type and consumer.
+ *
+ * TYPE (e.g. "block", "layout") limits hook scope to a plugin type.
+ * CONSUMER (e.g., "block_ui", "layout_builder") limits hook scope to one or
+ * more listeners, typically provided the same module. For example,
+ * HOOK_plugin_filter_layout__layout_builder_alter() would affect
+ * Layout Builder's listeners for the 'layout' plugin type (see
+ * ChooseSectionController), while HOOK_plugin_filter_block__block_ui_alter()
+ * would affect the Block UI's listeners for the 'block' plugin type.
+ *
+ * @param \Drupal\Component\Plugin\Definition\PluginDefinitionInterface[]|array[] $definitions
+ *   The array of plugin definitions.
+ * @param mixed[] $extra
+ *   An associative array containing additional information provided by the code
+ *   requesting the filtered definitions.
+ */
+function hook_plugin_filter_TYPE__CONSUMER_alter(array &$definitions, array $extra) {
+  // Explicitly remove the "Help" block for this consumer.
+  unset($definitions['help_block']);
+}
+
+/**
+ * @} End of "addtogroup hooks".
+ */