addslashes_js (line 6520)

Escapes quotes in strings destined for Javascript

• string $text: String to be prepared for Javascript
• string $quotetype: Type of quote (single or double quote)

build_datastore (line 6416)

Saves the specified data into the datastore

• string $title: The name of the datastore item to save
• mixed $data: The data to be saved
• integer $unserialize: 1 or 0 as to whether this value is to be automatically unserialised on retrieval

cache_ordered_forums (line 4001)

Gets counter information and makes sure the forums are in the proper order for tree iteration. Changes will be made to the forum cache directly.

• boolean $getcounters: Whether or not to get the forum counter info
• boolean $getinvisibles: Whether to include invisible forums in the liast
• integer $userid: ID of the user that subscribed forums should be fetched for

cache_templates (line 3854)

Fetches a number of templates from the database and puts them into the templatecache

• array $templates: List of template names to be fetched
• string $templateidlist: Serialized array of template name => template id pairs
• bool $skip_bbcode_style: Whether to skip adding the bbcode style refs

construct_language_options (line 6259)

Constructs a language chooser HTML menu

• string $depthmark: Marker to prepend each language name with
• boolean $quickchooser: Whether or not this will build the quick chooser menu

construct_navbits (line 2986)

Returns the HTML for the navigation breadcrumb in the navbar

This function will also set the GLOBAL $pagetitle to equal whatever is the last item in the navbits

• boolean 1: Whether to include the forum breadcrumb
• array $nav_array: Array of link => title pairs from which to build the link chain

construct_phrase (line 3204)

Construct Phrase

this function is actually just a wrapper for sprintf but makes identification of phrase code easier and will not error if there are no additional arguments. The first parameter is the phrase text, and the (unlimited number of) following parameters are the variables to be parsed into that phrase.

• return: The parsed phrase

• string 0: Text of the phrase
• mixed 1: First variable to be inserted .. .. ..
• mixed 2: Nth variable to be inserted

construct_quick_nav (line 4127)

Returns the HTML for the forum jump menu

• array $navpopup: Information about current page (id, title, and link)
• integer $parentid: ID of the parent forum for the group to be shown (-1 for all)
• boolean $addbox: If true, evaluate the forumjump template too
• boolean $override: Override $complete

construct_window_page_nav (line 2799)

Returns the HTML for multi-page navigation without a fully know result set

This handles multipage navigation when we don't have a count for the resultset. The follow things must be true for this logic to work correctly

1) $confirmedcount is less than or equal to the total number of results 2) if $confirmedcount is not the total number of results, it must be at least equal to the "count" of the last result displayed in the window.

These assumptions allow us to display the window links knowing that they will be valid without knowing the full extent of the result set.

• return: Page navigation HTML
• see: fetch_seo_url()
• todo: is it correct to include the pagenav hooks here? Do we need other hooks to replace them?

• integer $pagenumber: Page number being displayed
• integer $window: Number of pages to show before and after current page
• integer $perpage: Number of items to be displayed per page
• integer $confirmedcount: Number of items confirmed in the results
• string $address: Base address for links eg: showthread.php?t=99{&page=4}
• string $address2: Ending portion of address for links
• string $anchor: The base link for seo urls (if this is used address will not be)
• array $seolink: Additonal object info for generating the seo urls
• array $objectinfo: Additonal page info for generating the seo urls
• $pageinfo

convert_bits_to_array (line 5001)

Converts a bitfield into an array of 1 / 0 values based on the array describing the resulting fields

• integer &$bitfield: (ref) Bitfield
• array $_FIELDNAMES: Array containing field definitions - array('canx' => 1, 'cany' => 2, 'canz' => 4) etc

convert_unicode_char_to_charset (line 4558)

Converts a single unicode character to the desired character set if possible.

Attempts to use iconv if it's available. Callback function for the regular expression in convert_urlencoded_unicode.

• return: Character in desired character set or as an HTML entity

• integer $unicode_int: Unicode code point value
• string $charset: Character to convert to

create_full_url (line 3802)

Translates a relative URL to a fully-qualified URL. URLs not beginning with a / are assumed to be within the main vB-directory

• string 1: Fully-qualified URL
• string $url: Relative URL

devdebug (line 4815)

Stuffs a message into the $DEVDEBUG array

• string $text: Message to store

exec_header_redirect (line 3751)

Halts execution and redirects to the specified URL invisibly

• string $url: Destination URL
• $redirectcode

exec_nocache_headers (line 4874)

Sends no-cache HTTP headers

• boolean $sendcontent: If true, send content-type header

exec_switch_bg (line 2402)

Reads $bgclass and returns the alternate table class

• return: CSS class name

• integer $alternate: If > 0, allows us to have multiple classes on one page without them overwriting each other

fetch_bbarray_cookie (line 2220)

Returns the value for an array stored in a cookie

• string $cookiename: Name of the cookie
• mixed $id: ID of the data within the cookie

fetch_email_phrases (line 3290)

Returns 2 lines of eval()-able code -- one sets $message, the other $subject.

• string $email_phrase: Name of email phrase to fetch
• integer $languageid: Language ID from which to pull the phrase (see fetch_phrase $languageid)
• string $emailsub_phrase: If not empty, select the subject phrase with the given name
• string $varprefix: Optional prefix for $message/$subject variable names (eg: $varprefix = 'test' -> $testmessage, $testsubject)

fetch_error_array (line 3318)

Converts an array of error values to error strings by calling the fetch_error function.

• return: The array of compiled error messages. Keys are preserved.

• Array(mixed) $errors: Errors to compile. Values can either be a string, which is taken be be the error varname or it can be an array in which case it is viewed as a list of parameters to pass to fetch_error

fetch_forum_clause_sql (line 1651)

Returns an SQL condition like (forumid = 1 OR forumid = 2 OR forumid = 3) for each of a forum's parents

• integer $forumid: Forum ID
• string $field: The name of the field to be used in the clause
• string $joiner: The 'joiner' word - could be 'OR' or 'AND' etc.
• string $parentlist: The parentlist of the specified forum (comma separated string)

fetch_gzipped_text (line 1975)

Returns a gzip-compressed version of the specified string

• string $text: Text to be gzipped
• integer $level: Level of Gzip compression (1-10)

fetch_lastposter_userinfo (line 3090)

Extracts member information for the action drop-down from the postinfo array

• return: member information

• array $lastpostinfo: post information

fetch_moderator_permissions (line 5554)

Returns moderator permissions bitfield for the given forum and user

• integer $forumid: Forum ID
• integer $userid: User ID
• boolean $useglobalperms: Include Global Permissions for Super Moderators

fetch_options_overrides (line 6160)

Function to override various settings in $vbulletin->options depending on user preferences

• array $userinfo: User info array

fetch_perpage (line 2525)

Returns the number of items to display on a page based on a desired value and constraints.

If the desired value is not given use the default. Under no circumstances allow a value greater than maxperpage.

• return: per page results

• integer $perpage: Desired number of results to show per-page
• integer $maxperpage: Maximum allowable results to show per-page
• integer $defaultperpage: Default number of results to show per-page

fetch_profilefield_display (line 1568)

Converts the database value of a profilefield and prepares the displayable value as $profilefield['value']

• return: Profilefield data including 'value' key

• array &$profilefield: Profilefield data (SELECT * FROM profilefield WHERE profilefieldid = $profilefieldid)
• string $profilefield_value: Database value of profilefield

fetch_random_password (line 460)

Generates a random password that is much stronger than what we currently use.

• integer $length: Length of desired password

fetch_seo_url (line 6807)

Converts raw link information into an appropriate URL Verifies that the requested linktype can be handled

• string $link: Type of link, 'thread', etc
• array $linkinfo: Specific information relevant to the page being linked to, $threadinfo, etc
• array $pageinfo: Other information relevant to the page being linked to
• string $primaryid: Override the default $linkinfo[userid] with $linkinfo[$primaryid]
• string $primarytitle: Override the default $linkinfo[title] with $linkinfo[$primarytitle]

fetch_standard_deviated_levels (line 6996)

Spreads an array of values across the given number of stepped levels based on their standard deviation from the mean value.

The function accepts an array of $id => $value and returns $id => $level.

• array $values:
  • Array of id => values
• integer $levels:
  • Number of levels to assign

fetch_stylevars (line 6099)

Sets up the Fakey stylevars

• array &$style: (ref) Style info array
• array $userinfo: User info array

fetch_threadinfo (line 1314)

Returns an array containing info for the speficied thread, or false if thread is not found

• integer &$threadid: (ref) Thread ID
• $usecache

fetch_trimmed_title (line 830)

Trims a string to the specified length while keeping whole words

• string $title: String to be trimmed
• integer $chars: Number of characters to aim for in the trimmed string
• boolean $append: Append "..." to shortened text

fetch_word_wrapped_string (line 795)

Attempts to intelligently wrap excessively long strings onto multiple lines

• string $text: Text to be wrapped
• integer $limit: If specified, max word wrap length
• string $wraptext: Text to insert at the wrap point

iif (line 48)

Essentially a wrapper for the ternary operator.

• return: Either the second or third parameter of this function
• deprecated: Deprecated as of 3.5. Use the ternary operator.

• string $expression: Expression to be evaluated
• mixed $returntrue: Return this if the expression evaluates to true
• mixed $returnfalse: Return this if the expression evaluates to false

init_language (line 6207)

Returns the initial $vbphrase array

in_coventry (line 628)

Works out if the specified user is 'in Coventry'

• integer $userid: User ID
• boolean $includeself: Whether or not to confirm that the visiting user is himself in Coventry or not

is_came_from_search_engine (line 6441)

Checks whether or not user came from search engine

is_member_of (line 560)

Works out if a user is a member of the specified usergroup(s)

This function can be overloaded to test multiple usergroups: is_member_of($user, 1, 3, 4, 6...)

• array $userinfo: User info array - must contain userid, usergroupid and membergroupids fields
• integer $usergroupid: Usergroup ID to test
• boolean $cache: Pull result from cache

is_valid_email (line 948)

Tests a string to see if it's a valid email address

• string $email: Email address

ncrencode_matches (line 4736)

NCR encodes matches from a preg_replace.

Single byte characters are preserved.

• return: The encoded character

• string $matches: The character to encode
• $skip_ascii

print_no_permission (line 3395)

Halts execution and shows an error message stating that the visitor does not have permission to view the page

print_standard_error (line 3532)

Returns eval()-able code to initiate a standard error

• deprecated: Deprecated since 3.5. Use standard_error(fetch_error(...)) instead.

• string $err_phrase: Name of error phrase
• boolean $doquery: If false, use the name of error phrase as the phrase text itself
• boolean $savebadlocation: If true, set the visitor's status on WOL to error page

process_replacement_vars (line 6548)

Returns the provided string with occurences of replacement variables replaced with their appropriate replacement values

• string $newtext: Text containing replacement variables
• array $paramstyle: Override global $style if specified

render_option_template (line 3071)

Renders the option template. Simply a helper method to shorten the length of code to do this.

• return: Option HTML

• string $optiontitle: Title of the option
• string $optionvalue: Value of the option (sent to the server on submission)
• string $optionselected: If selected, should be string: selected="selected"
• string $optionclass: A class to apply to the option

sanitize_pageresults (line 2494)

Ensures that the variables for a multi-page display are sane

• integer $numresults: Total number of items to be displayed
• integer &$page: (ref) Current page number
• integer &$perpage: (ref) Desired number of results to show per-page
• integer $maxperpage: Maximum allowable results to show per-page
• integer $defaultperpage: Default number of results to show per-page

sign_client_string (line 2312)

Signs a string we intend to pass to the client but don't want them to alter

• return: MD5 hash followed immediately by the string

• string $string: String to be signed
• $extra_entropy

standard_error (line 3560)

Halts execution and shows the specified error message

• string $error: Error message
• string $headinsert: Optional HTML code to insert in the <head> of the error page
• boolean $savebadlocation: If true, set the visitor's status on WOL to error page
• string $override_template: Optional template to force the display to use. Ignored if showing a lite error

stripncrs (line 4697)

Strips NCRs from a string.

• return: The result

• string $str: The string to strip from

strip_blank_ascii (line 673)

Replaces any non-printing ASCII characters with the specified string.

This also supports removing Unicode characters automatically when the entered value is >255 or starts with a 'u'.

• string $text: Text to be processed
• string $replace: String with which to replace non-printing characters

to_ascii (line 292)

Transliterates non ASCII chars to ASCII.

This is an approximation.

Note: Performance and accuracy is gained if the pecl translit extension is available.

• see: http://pecl.php.net/package/translit

• string $str: String to transliterate

to_utf8 (line 4603)

Converts a string to utf8

• return: The reencoded string

• string $in: The variable to clean
• string $charset: The source charset

update_loadavg (line 6483)

Updates the LoadAverage DataStore

urlimplode (line 6887)

Implodes an assoc array into a partial url query string

• return: - The parsed result

• mixed $array:
  • Array to parse
• boolean $skip_empty:
  • Whether to skip empty elements
• $skip_urlencode
• $preserve_uni

vbdate (line 4288)

Formats a UNIX timestamp into a human-readable string according to vBulletin prefs

Note: Ifvbdate() is called with a date format other than than one in $vbulletin->options[], set $locale to false unless you dynamically set the date() and strftime() formats in the vbdate() call.

• return: Formatted date string

• string $format: Date format string (same syntax as PHP's date() function)
• integer $timestamp: Unix time stamp
• boolean $doyestoday: If true, attempt to show strings like "Yesterday, 12pm" instead of full date string
• boolean $locale: If true, and user has a language locale, use strftime() to generate language specific dates
• boolean $adjust: If true, don't adjust time to user's adjusted time .. (think gmdate instead of date!)
• boolean $gmdate: If true, uses gmstrftime() and gmdate() instead of strftime() and date()
• array $userinfo: If set, use specified info instead of $vbulletin->userinfo

vbmail (line 1001)

Starts the process of sending an email - either immediately or by adding it to the mail queue.

• string $toemail: Destination email address
• string $subject: Email message subject
• string $message: Email message body
• boolean $notsubscription: If true, do not use the mail queue and send immediately
• string $from: Optional name/email to use in 'From' header
• string $uheaders: Additional headers
• string $username: Username of person sending the email

vbmail_start (line 979)

Begin adding email to the mail queue

vbsetcookie (line 2040)

Sets a cookie based on vBulletin environmental settings

• string $name: Cookie name
• mixed $value: Value to store in the cookie
• boolean $permanent: If true, do not set an expiry date for the cookie
• boolean $allowsecure: Allow secure cookies (SSL)
• boolean $httponly: Set 'httponly' for cookies in supported browsers

vbstrtolower (line 144)

Converts A-Z to a-z, doesn't change any other characters

• return: Lowercase string

• string $string: String to convert to lowercase

verify_client_string (line 2335)

Verifies a string return from a client that it has been unaltered

• return: String without the verification hash or false on failure

• string $string: String from the client to be verified
• $extra_entropy

verify_id (line 1692)

Multi-purpose function to verify that an item exists and fetch data at the same time

This function works with threads, forums, posts, users and other tables that obey the {item}id, title convention. If the data is not found and execution is not halted, a false value will be returned

• string $idname: Name of the ID field to be fetched (forumid, threadid etc.)
• integer &$id: (ref) ID of the item to be fetched
• boolean $alert: If true, halt and show error when data is not found
• boolean $selall: If true, 'SELECT *' instead of selecting just the ID field
• integer $options: Bitfield options to be passed to fetch_userinfo()

verify_security_token (line 2367)

Verifies a security token is valid

• return: True if the hash matches and is within the correct TTL

• string $request_token: Security token from the REQUEST data
• string $user_token: Security token used in the hash