./Sources/ManageNews.php
- ManageNews
- EditNews
- list_getNews
- SelectMailingMembers
- prepareMailingForPreview
- ComposeMailing
- SendMailing
- ModifyNewsSettings
ManageNews
function ManageNews(): void
The news dispatcher; doesn’t do anything, just delegates.
This is the entrance point for all News and Newsletter screens. Called by ?action=admin;area=news. It does the permission checks, and calls the appropriate function based on the requested sub-action.
- Integration hooks
- integrate_manage_news
EditNews
function EditNews(): void
Let the administrator(s) edit the news items for the forum.
It writes an entry into the moderation log. This function uses the edit_news administration area. Called by ?action=admin;area=news. Requires the edit_news permission. Can be accessed with ?action=admin;sa=editnews.
Uses a standard list (@see createList())
list_getNews
function list_getNews(): array
Prepares an array of the forum news items for display in the template
SelectMailingMembers
function SelectMailingMembers(): void
This function allows a user to select the membergroups to send their mailing to.
Called by ?action=admin;area=news;sa=mailingmembers. Requires the send_mail permission. Form is submitted to ?action=admin;area=news;mailingcompose.
prepareMailingForPreview
function prepareMailingForPreview(): void
Prepare subject and message of an email for the preview box Used in ComposeMailing and RetrievePreview (Xml.php)
ComposeMailing
function ComposeMailing(): void
Shows a form to edit a forum mailing and its recipients.
Called by ?action=admin;area=news;sa=mailingcompose. Requires the send_mail permission. Form is submitted to ?action=admin;area=news;sa=mailingsend.
SendMailing
function SendMailing(bool $clean_only = false): void
Handles the sending of the forum mailing in batches.
Called by ?action=admin;area=news;sa=mailingsend Requires the send_mail permission. Redirects to itself when more batches need to be sent. Redirects to ?action=admin;area=news;sa=mailingmembers after everything has been sent.
| Type | Parameter | Description |
|---|---|---|
bool |
$clean_only |
If set, it will only clean the variables, put them in context, then return. |
ModifyNewsSettings
function ModifyNewsSettings(bool $return_config = false): void|array
Set general news and newsletter settings and permissions.
Called by ?action=admin;area=news;sa=settings. Requires the forum_admin permission.
| Type | Parameter | Description |
|---|---|---|
bool |
$return_config |
Whether or not to return the config_vars array (used for admin search) |
- Integration hooks
- integrate_modify_news_settings
- integrate_save_news_settings