Description

Grab data from the user, manipulate the input according to the parameters then it returns the information meant to be sent to the database
This function is located in the /includes/functions_content.php file.

Parameters

Parameter

IN/OUT/INOUT

Usage

text

INOUT

Text string with the original text that is replaced with the text to send to the database generate_text_for_storage.

uid

OUT

BBCode UID, a randomly generated unique identifier to mark the bbcodes identified by the first pass encoding (which uses regular expressions) so they can be replaced using the quicker str_replace in the second pass.

bitfield

OUT

Bit field containing the information which bbcode is used in the text so only the relavant ones need to be loaded from the database.

BBCode bitfield. Used if $flags set BBCode enabled.

flags

OUT

Integer flag containing the information whether bbcode, smilies and magic urls are enabled (OPTION_FLAG_BBCODE, OPTION_FLAG_SMILIES and OPTION_FLAG_LINKS). This integer is set according to the values in the last 3 parameters. Column names vary from table to table.

allow_bbcode

IN

Whether or not to allow BBCode in the text

allow_urls

IN

Whether or not to allow automatic urls in the text

allow_smilies

IN

Whether or not to allow smilies in the text

IN means that it expects information to be stored in the variable when the function is called (most common use of parameters)OUT means that it will discard the information that is sent to the function and the variable is changed inside the functionINOUT means that the function will use the contents in the variable and it will also change those contents

Return Values

Returns the text string to display to user.

Examples

Example #1 bbcode_options

This example uses the bbcode_options field which is used in forums and groups description parsing:

Notes

Option Text Flags

The OPTION_FLAG_* constants are defined as:define('OPTION_FLAG_BBCODE', 1);define('OPTION_FLAG_SMILIES', 2);define('OPTION_FLAG_LINKS', 4);Adding these constants together will result in all three options being enabled.