Function add_plugin

cms/api.py:395–449

Adds a plugin to a placeholder and returns it. :param placeholder: Placeholder to add the plugin to :type placeholder: :class:`cms.models.placeholdermodel.Placeholder` instance :param plugin_type: What type of plugin to add :type plugin_type: str or :class:`cms.plugin_base.CMSP

(placeholder, plugin_type, language, position="last-child", target=None, **data)

@transaction.atomic
def add_plugin(placeholder, plugin_type, language, position="last-child", target=None, **data):
    """
    Adds a plugin to a placeholder and returns it.

    :param placeholder: Placeholder to add the plugin to
    :type placeholder: :class:`cms.models.placeholdermodel.Placeholder` instance
    :param plugin_type: What type of plugin to add
    :type plugin_type: str or :class:`cms.plugin_base.CMSPluginBase` sub-class, must be a valid plugin
    :param str language: Language code for this plugin, must be in :setting:`django:LANGUAGES`
    :param str position: Position to add this plugin to the placeholder. Allowed positions are ``"last-child"``
                         (default), ``"first-child"``, ``"left"``, ``"right"``.
    :param target: Parent plugin. Must be plugin instance
    :param data: Data for the plugin type instance
    """
    # validate placeholder
    assert isinstance(placeholder, Placeholder)

    # validate and normalize plugin type
    plugin_model, plugin_type = _verify_plugin_type(plugin_type)

    if target:
        if position == "last-child":
            new_pos = placeholder.get_next_plugin_position(language, parent=target, insert_order="last")
            parent_id = target.pk
        elif position == "first-child":
            new_pos = placeholder.get_next_plugin_position(language, parent=target, insert_order="first")
            parent_id = target.pk
        elif position == "left":
            new_pos = target.position
            parent_id = target.parent_id
        elif position == "right":
            new_pos = target.position + 1 + target._get_descendants_count()
            parent_id = target.parent_id
        else:
            raise Exception("position not supported: %s" % position)
    else:
        assert position in ("first-child", "last-child")
        if position == "last-child":
            new_pos = placeholder.get_next_plugin_position(language, insert_order="last")
        else:
            new_pos = 1
        parent_id = None

    plugin_base = CMSPlugin(
        plugin_type=plugin_type,
        placeholder=placeholder,
        position=new_pos,
        language=language,
        parent_id=parent_id,
    )
    plugin_base = placeholder.add_plugin(plugin_base)
    plugin = plugin_model(**data)
    plugin_base.set_base_attr(plugin)
    plugin.save()
    return plugin


def create_page_user(