webbuilders-group/silverstripe-add-to-campaigns

Capability to add any Versioned object to a campaign easily for CMS Admins

2.0.0 2025-06-26 18:04 UTC

Requires

• silverstripe/campaign-admin: ~3.0

BSD-3-Clause

• Ed Chipman

• silverstripe
• campaigns

README

Capability to add any Versioned object to a campaign easily for CMS Admins via an "Add to Campaign" button in the CMS just like pages.

Maintainer Contact

• Ed Chipman (UndefinedOffset)

Requirements

• SilverStripe Campaign Admin ~3.0

Installation

composer require webbuilders-group/silverstripe-add-to-campaigns

Usage

By default all SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest instances will get an extension that will automatically configure the GridFieldDetailForm_ItemRequest edit form for the "Add to Campaign" functionality for all allowed classes. To add a class to the allowed support in your config.yml you must add the below. The DataObject must include the SilverStripe\Versioned\Versioned extension as well.

WebbuildersGroup\AddToCampaigns\Control\Admin\AddToCampaignController:
  campaignable_classes:
    - 'Full\DataObject\ClassName\Including\Namespace'

If you have not modified your GridFieldDetailForm_ItemRequest actions from the default GridFieldDetailForm_ItemRequest::getFormActions() the "Add to Campaign" button should be automatically be added to all allowed classes. If you have you can add the following to where ever you are setting up your form actions for your DataObject in your GridFieldDetailForm_ItemRequest extension.

use SilverStripe\CampaignAdmin\AddToCampaignHandler_FormAction;

/** ... **/

if (($myDataObject->isPublished() || $myDataObject->isOnDraft()) && $myDataObject->canPublish()) {
    $moreOptions->push(
        AddToCampaignHandler_FormAction::create()
            ->removeExtraClass('btn-primary')
            ->addExtraClass('btn-secondary')
    );
}