benecaster_sponsor_manager_before_archive_campaign
Fires before a sponsor campaign is archived or restored on the Sponsors screen, or through POST /benecaster-sponsor-manager/v1/shows/{show_id}/campaigns/{id}/archive or …/restore. Archiving hides the campaign on its show only and deletes nothing: episodes already tied to it keep their sponsor.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$campaign_id |
int |
— | The campaign |
$show_id |
int |
— | The campaign's show |
$archived |
bool |
— | `true` when it is being archived, `false` when restored |
Example
add_action( 'benecaster_sponsor_manager_before_archive_campaign', function ( int $campaign_id, int $show_id, bool $archived ): void {
my_audit_log( $archived ? 'campaign-archiving' : 'campaign-restoring', $campaign_id, $show_id );
}, 10, 3 );
Notes
Asking for the state the campaign already has writes nothing and fires nothing. Walkthrough: Read, create, change, archive or restore the site's sponsors and a show's sponsor campaigns from code, as the Sponsors screen does.
Affects
- Benecaster → Sponsors
- POST benecaster-sponsor-manager/v1/shows/{show_id}/campaigns/{id}/archive
- POST benecaster-sponsor-manager/v1/shows/{show_id}/campaigns/{id}/restore
Need this built rather than just documented? See our services →