Skip to main content

benecaster_sponsor_manager_before_archive_message

Action Premium sponsor-manager

Fires before a sponsor message is archived or restored on the Sponsors screen’s Messages tab, or through POST /benecaster-sponsor-manager/v1/shows/{show_id}/messages/{id}/archive or …/restore. An archived message’s tag shows nothing wherever it is placed, like one past its end date; restoring brings the copy back. Nothing deletes a message.

Parameters

Name Type Default Description
$message_id int — The message
$show_id int — The message's show
$archived bool — `true` when it is being archived, `false` when restored

Example

add_action( 'benecaster_sponsor_manager_before_archive_message', function ( int $message_id, int $show_id, bool $archived ): void {
    my_audit_log( $archived ? 'sponsor-message-archiving' : 'sponsor-message-restoring', $message_id, $show_id );
}, 10, 3 );

Notes

Asking for the state the message already has writes nothing and fires nothing. Walkthrough: Read or write a show's sponsor messages from code, as the Sponsors screen's Messages tab does.

Affects

  • Benecaster → Sponsors → Messages
  • POST benecaster-sponsor-manager/v1/shows/{show_id}/messages/{id}/archive
  • POST benecaster-sponsor-manager/v1/shows/{show_id}/messages/{id}/restore

Need this built rather than just documented? See our services →