Unofficial SMF API Documentation

./Sources/Post.php

Post

function Post(array $post_errors = array()): void

Handles showing the post screen, loading the post to be modified, and loading any post quoted.

Type Parameter Description
array $post_errors Holds any errors found while tyring to post
Integration hooks
integrate_post_start
integrate_preview_post
integrate_post_errors
integrate_post_end

Post2

function Post2(): void

Posts or saves the message composed with Post().

requires various permissions depending on the action. handles attachment, post, and calendar saving. sends off notifications, and allows for announcements and moderation. accessed from ?action=post2.

Integration hooks
integrate_post2_start
integrate_post2_pre
integrate_poll_add_edit
integrate_post2_end

AnnounceTopic

function AnnounceTopic(): void

Handle the announce topic function (action=announce).

checks the topic announcement permissions and loads the announcement template. requires the announce_topic permission. uses the ManageMembers template and Post language file. call the right function based on the sub-action.

AnnouncementSelectMembergroup

function AnnouncementSelectMembergroup(): void

Allow a user to chose the membergroups to send the announcement to.

lets the user select the membergroups that will receive the topic announcement.

AnnouncementSend

function AnnouncementSend(): void

Send the announcement in chunks.

splits the members to be sent a topic announcement into chunks. composes notification messages in all languages needed. does the actual sending of the topic announcements in chunks. calculates a rough estimate of the percentage items sent.

getTopic

function getTopic(): void

Get the topic for display purposes.

gets a summary of the most recent posts in a topic. depends on the topicSummaryPosts setting. if you are editing a post, only shows posts previous to that post.

Integration hooks
integrate_getTopic_previous_post

QuoteFast

function QuoteFast(): void

Loads a post an inserts it into the current editing text box.

uses the Post language file. uses special (sadly browser dependent) javascript to parse entities for internationalization reasons. accessed with ?action=quotefast.

JavaScriptModify

function JavaScriptModify(): void

Used to edit the body or subject of a message inline called from action=jsmodify from script and topic js

Integration hooks
integrate_post_JavascriptModify
integrate_jsmodify_xml

Suggest an edit to this page on GitHub