-
FAQ
- Forum Search
- Community
- Online Manual
- Support Helpers of the Month
- Function Database
modifyPost
Description
Updates a post after it's been modified
Syntax
void modifyPost (array &$msgOptions, array &$topicOptions, array &$posterOptions)
Parameter &$msgOptions
Expected type: Array
Description: Things related specifically to the individual post
Array Elements of $msgOptions Key Optional Expected type Description id no Integer The message ID body yes Escaped String The actual text of the post email yes Escaped String The email address of the poster icon yes String The message icon modify_time yes Integer The timestamp corresponding to when the message was modified (only set in certain cases) name yes Escaped String The name of the poster smileys_enable yes Boolean Whether or not smileys are enabled for this post subject yes Escaped String The subject of the post
Parameter &$topicOptions
Expected type: Array
Description: Information relating to the entire topic
Array Elements of $topicOptions Key Optional Expected type Description id no Integer The topic ID mark_as_read no Boolean Whether or not to mark the topic read (always true) lock_mode yes Integer 0 if the topic is being unlocked, 1 if it's being locked (defaults to null) poll yes Integer The ID of the poll associated with this topic (defaults to null) sticky_mode yes Integer 0 if the topic is being un-stickied, 1 if it's being stickied (defaults to null)
Parameter &$posterOptions
Expected type: Array
Description: An array of info about the poster
Array Elements of $posterOptions Key Optional Expected type Description email yes Escaped String The email of the poster name yes Escaped String The name of the poster
Notes
- At least one of the optional items in $msgOptions will always be set
- Called from Post2()
- Only updates things that have changed
- Updates the custom search index if one exists
- The modify_time option is only set if it's been longer than the "Courtesy Edit Wait Time" since the post was made or last modified
- As long as at least one of the optional topicOptions is set, all three will be updated
Advertisement:- Help | Terms and Rules | Go Up ▲
- Copyright © 2022 Simple Machines. All Rights Reserved.
- Page created in 0.119 seconds with 13 queries.
- Forum Search