fix: Allow adding plugins to CMS_COMPONENT_PLUGINS by just their name

Author: fsbraun

djangocms_frontend/plugin_tag.py

@@ -25,11 +25,6 @@
     "ui_item",
 )
 
-allowed_plugin_types = tuple(
-    getattr(importlib.import_module(cls.rsplit(".", 1)[0]), cls.rsplit(".", 1)[-1]) if isinstance(cls, str) else cls
-    for cls in getattr(settings, "CMS_COMPONENT_PLUGINS", [])
-)
-
 
 def _get_plugindefaults(instance):
     defaults = {
@@ -65,7 +60,20 @@ def patch_template(template):
     return copied_template if patch else template
 
 
+def get_plugin_class(settings_string: str | type) -> type:
+    """Get the plugin class from the settings string or import it if it's a dotted path."""
+    if isinstance(settings_string, str):
+        if "." in settings_string:
+            # import the class if a dotted oath is given
+            return importlib.import_module(*settings_string.rsplit(".", 1))
+        # Get the plugin class from the plugin pool by its name
+        return plugin_pool.get_plugin(settings_string)
+    return settings_string
+
+
 def setup():
+    allowed_plugin_types = tuple(get_plugin_class(cls) for cls in getattr(settings, "CMS_COMPONENT_PLUGINS", []))
+
     for plugin in plugin_pool.get_all_plugins():
         if not issubclass(plugin, allowed_plugin_types):
             continue

docs/source/how-to/use-frontend-as-component.rst

@@ -22,8 +22,9 @@ repetition.
 
     To make plugins available as components, ensure that the
     ``CMS_COMPONENT_PLUGINS`` setting in your project's ``settings.py``
-    includes the necessary plugin classes and their subclasses. This setting
-    allows you to specify which plugins can be used directly in templates
+    is a list that includes the necessary plugin names or dotted path to
+    a plugin parent class . Only plugins named in the listing or their
+    child classes can be used directly in templates
     without creating database entries.
 
     * To include all ``djangocms-frontend`` plugins, use