A

$vB_Api_Ad#ad_cacheProperty in class vB_Api_Ad
$vB_Api_Ad#ad_name_cacheProperty in class vB_Api_Ad
$vB_Api_Announcement#assertorProperty in class vB_Api_Announcement
$vB_Api_Blog#assertorProperty in class vB_Api_Blog
$vB_Api_Contactus#assertorProperty in class vB_Api_Contactus
$vB_Api_Content#assertorProperty in class vB_Api_Content
vB_Api_Content::add() — Method in class vB_Api_Content
Adds a new node
vB_Api_Content_Channel::add() — Method in class vB_Api_Content_Channel
Adds a new channel.
vB_Api_Content_Event::add() — Method in class vB_Api_Content_Event
Adds a new node.
vB_Api_Content_Gallery::add() — Method in class vB_Api_Content_Gallery
Adds a new node.
$vB_Api_Content_Infraction#assertorProperty in class vB_Api_Content_Infraction
vB_Api_Content_Infraction::add() — Method in class vB_Api_Content_Infraction
Adds a new infraction node
vB_Api_Content_Link::add() — Method in class vB_Api_Content_Link
Adds a new node.
$vB_Api_Content_Photo#authorsProperty in class vB_Api_Content_Photo
vB_Api_Content_Photo::add() — Method in class vB_Api_Content_Photo
Add photo record
$vB_Api_Content_Privatemessage#assertorProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::addPMRecipientsByUsernames() — Method in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::addPMRecipients() — Method in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::add() — Method in class vB_Api_Content_Privatemessage
Adds a new private message
vB_Api_Content_Privatemessage::acceptRequest() — Method in class vB_Api_Content_Privatemessage
Accepts a user follow request or a channel ownership/moderation/membership request
vB_Api_Content_Redirect::add() — Method in class vB_Api_Content_Redirect
Adds a new node.
vB_Api_Content_Report::add() — Method in class vB_Api_Content_Report
Adds a new node.
vB_Api_Content_Text::add() — Method in class vB_Api_Content_Text
Adds a new node.
vB_Api_Content_Text::autoPopulatePreviewImage() — Method in class vB_Api_Content_Text
DEPRECATED - This is now handled internally by the library, nothing is called from controllers.
vB_Api_Content_Video::add() — Method in class vB_Api_Content_Video
Adds a new node.
vB_Api_Editor::autosave() — Method in class vB_Api_Editor
Save autosave data from editor
$vB_Api_Extensions#AutoInstallProperty in class vB_Api_Extensions
$vB_Api_FCMessaging#assertorProperty in class vB_Api_FCMessaging
DB Assertor object
vB_Api_Follow::add() — Method in class vB_Api_Follow
This adds a following.- ie. the current user will now follow a user, or specified user $follower will follow a node
vB_Api_Follow::addFollow() — Method in class vB_Api_Follow
vB_Api_Follow::addSubscription() — Method in class vB_Api_Follow
vB_Api_Follow::addFollower() — Method in class vB_Api_Follow
This adds a user follower
vB_Api_Follow::approveFollowing() — Method in class vB_Api_Follow
This approves a following request made for the current user.
$vB_Api_Hv#assertorProperty in class vB_Api_Hv
$vB_Api_Logwrapper#apiProperty in class vB_Api_Logwrapper
vB_Api_Node::assertNodeidStr() — Method in class vB_Api_Node
Convert node path or id string to node id.
vB_Api_Node::addAttachment() — Method in class vB_Api_Node
Adds one or more attachments
vB_Api_Node::approve() — Method in class vB_Api_Node
Sets the approved field
vB_Api_Node::approveChannelRequest() — Method in class vB_Api_Node
Approves a channel request.
vB_Api_Node::addChannelLastData() — Method in class vB_Api_Node
This takes the total tree and adds 'last' data to it
vB_Api_Node::assembleTree() — Method in class vB_Api_Node
vB_Api_Node::addFinalBranches() — Method in class vB_Api_Node
vB_Api_Node::addChannelTotals() — Method in class vB_Api_Node
This starts at the bottom and sums the totalcount and textcount fields to topics and posts in the userChannels.
$vB_Api_Notice#assertorProperty in class vB_Api_Notice
$vB_Api_Notification#assertorProperty in class vB_Api_Notification
DB Assertor object
vB_Api_Options::addGroupSettings() — Method in class vB_Api_Options
Insert group settings
$vB_Api_Paidsubscription#apicacheProperty in class vB_Api_Paidsubscription
$vB_Api_Reputation#assertorProperty in class vB_Api_Reputation
vB_Api_Style::addThemeData() — Method in class vB_Api_Style
Adds theme data (GUID, icon, preview image) to a style if in debug mode. (used by update & insert)
vB_Api_Tags::addTags() — Method in class vB_Api_Tags
Add tags to the current item implements vB_Tag::addTagsToContent
$vB_Api_User#avatarsCacheProperty in class vB_Api_User
$vB_Api_User#avatarUserCacheProperty in class vB_Api_User
vB_Api_User::activateUserByUsername() — Method in class vB_Api_User
Activate an user with an activate ID and Username
vB_Api_User::activateUser() — Method in class vB_Api_User
Activate an user with an activate ID
vB_Api_UserGroup::addLeader() — Method in class vB_Api_UserGroup
Add a leader for an usergroup
vB_Api_Vb4_album::album() — Method in class vB_Api_Vb4_album
vB_Api_Vb4_inlinemod::approveattachments() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::approveposts() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::approvethread() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_register::addmember() — Method in class vB_Api_Vb4_register
vB_Api_Vb4_subscription::addsubscription() — Method in class vB_Api_Vb4_subscription
vB_Api_Widget::addWidgetTitles() — Method in class vB_Api_Widget
Adds the correct (phrased) widget titles to each widget in the array
vB_Api_Widget::assembleChannelConfig() — Method in class vB_Api_Widget
vB_Api_Widget::assemblePageManagerChannelsConfig() — Method in class vB_Api_Widget
$vB_Api_Wrapper#apiProperty in class vB_Api_Wrapper

B

vB_Api_Ad::buildAdTemplate() — Method in class vB_Api_Ad
Builds an ad template based on criteria
vB_Api_Content_Infraction::buildUserInfractions() — Method in class vB_Api_Content_Infraction
Builds user infractions
vB_Api_Content_Infraction::buildInfractionGroupIds() — Method in class vB_Api_Content_Infraction
Builds infraction groups for users. Also called from the cron script
$vB_Api_Content_Poll#bbcode_parserProperty in class vB_Api_Content_Poll
$vB_Api_Content_Privatemessage#bbcodeOptionsProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::buildPmTotals() — Method in class vB_Api_Content_Privatemessage
Calculates the number of private messages that a user has in the system Used to limit pm abilities based on overage of this count
vB_Api_Content_Report::bulkdelete() — Method in class vB_Api_Content_Report
Deletes one or more reports
$vB_Api_Content_Text#bbcode_parserProperty in class vB_Api_Content_Text
vB_Api_External::buildExternalRoute() — Method in class vB_Api_External
Builds an external data provider route depending on the type and extra data specified.
$vB_Api_Follow#blockedProperty in class vB_Api_Follow
vB_Api_Hook::buildHookDatastore() — Method in class vB_Api_Hook
Saves the currently installed hooks to the datastore.
vB_Api_Profile::buildSelectOptions() — Method in class vB_Api_Profile
Builds the array for various admin-controlled select options (font sizes, etc).
vB_Api_SocialGroup::buildPaginationURLs() — Method in class vB_Api_SocialGroup
Builds pagination previous and next URLs.
vB_Api_Style::buildAllStyles() — Method in class vB_Api_Style
Builds all data from the template table into the fields in the style table
vB_Api_User::banUsers() — Method in class vB_Api_User
Ban users
vB_Api_Vb4_api::blogcategorylist() — Method in class vB_Api_Vb4_api
vB_Api_Vb4_blog::blog() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_blog::bloglist() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_misc::buddylist() — Method in class vB_Api_Vb4_misc
vB_Api_Vb4_profile::buddylist() — Method in class vB_Api_Vb4_profile
vB_Api_Vb4_register::base64_url_decode() — Method in class vB_Api_Vb4_register
vB_Api_Wol::buildSpiderList() — Method in class vB_Api_Wol

C

$vB_Api_Bbcode#customTagsProperty in class vB_Api_Bbcode
Contains an array of user specified custom BB code tags.
vB_Api_Bbcode::convertWysiwygTextToBbcode() — Method in class vB_Api_Bbcode
Converts text from an editor into text ready to be saved with bbcode converted
vB_Api_Bbcode::convertUrlToBbcode() — Method in class vB_Api_Bbcode
Converts URLs into bbcode with [URL]
vB_Api_Bbcode::convertUrlToBbcodePregReplace() — Method in class vB_Api_Bbcode
Callback for preg_replace_callback in convertUrlToBbcode
vB_Api_Blog::createBlog() — Method in class vB_Api_Blog
Creates a blog channel
vB_Api_Blog::createChannel() — Method in class vB_Api_Blog
Check validity of data passed in and create a blog or group channel
vB_Api_Blog::cancelChannelTransfer() — Method in class vB_Api_Blog
Cancels a channel transfer request
vB_Api_Blog::canCreateBlog() — Method in class vB_Api_Blog
Checks if the user can create a new Blog
vB_Api_Content::cleanOptions() — Method in class vB_Api_Content
Clean unallowed options from user request, only cleans 'skipFloodCheck' for now
vB_Api_Content::cleanInput() — Method in class vB_Api_Content
Cleans the input in the $data array, directly updating $data.
vB_Api_Content::cleanPreviewContent() — Method in class vB_Api_Content
Takes a node record and removes the data cannot be viewed based on public_preview.
vB_Api_Content::createQuoteText() — Method in class vB_Api_Content
This returns the text to quote a node. Used initially for private messaging.
$vB_Api_Content_Attach#contenttypeProperty in class vB_Api_Content_Attach
vB_Api_Content_Attach::checkPermission() — Method in class vB_Api_Content_Attach
This validates that a user can upload attachments. Currently that's just verifying that they are logged in.
vB_Api_Content_Attach::cleanInput() — Method in class vB_Api_Content_Attach
Cleans the input in the $data array, directly updating $data.
vB_Api_Content_Attach::cleanSettings() — Method in class vB_Api_Content_Attach
Performs permission checks and cleaning for the 'settings' attach data and returns the serialized string that can be saved.
$vB_Api_Content_Channel#contenttypeProperty in class vB_Api_Content_Channel
vB_Api_Content_Channel::canAddChannel() — Method in class vB_Api_Content_Channel
Tells whether or not the current user can add a new channel for the given node
vB_Api_Content_Channel::cleanInput() — Method in class vB_Api_Content_Channel
Cleans the input in the $data array, directly updating $data.
vB_Api_Content_Channel::canViewReportsAndInfractions() — Method in class vB_Api_Content_Channel
Returns array of data indicating user's view permissions for the report & infraction channels.
$vB_Api_Content_Event#contenttypeProperty in class vB_Api_Content_Event
vB_Api_Content_Event::cleanInput() — Method in class vB_Api_Content_Event
Cleans the input in the $data array, directly updating $data.
$vB_Api_Content_Gallery#contenttypeProperty in class vB_Api_Content_Gallery
$vB_Api_Content_Infraction#contenttypeProperty in class vB_Api_Content_Infraction
vB_Api_Content_Infraction::canInfractNode() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can infract the (author of) the given node
vB_Api_Content_Infraction::canInfractUser() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can infract the given user
vB_Api_Content_Infraction::canViewInfraction() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can view the given infraction node
vB_Api_Content_Infraction::canViewNodeInfraction() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can view any infractions on the given node
vB_Api_Content_Infraction::canViewUserInfractions() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can view the infractions for the given user
vB_Api_Content_Infraction::canReverseInfraction() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can reverse an infraction
vB_Api_Content_Infraction::canGiveCustomInfraction() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can give custom (arbitrary value) infractions
vB_Api_Content_Infraction::canViewAdminNote() — Method in class vB_Api_Content_Infraction
Determines if the logged-in user can view admin notes
vB_Api_Content_Infraction::checkInfractionGroupChange() — Method in class vB_Api_Content_Infraction
Recalculates the members of an infraction group based on changes to it.
$vB_Api_Content_Link#contenttypeProperty in class vB_Api_Content_Link
vB_Api_Content_Link::cleanInput() — Method in class vB_Api_Content_Link
Cleans the input in the $data array, directly updating $data.
$vB_Api_Content_Photo#contenttypeProperty in class vB_Api_Content_Photo
override in client- the text name
vB_Api_Content_Photo::canDeletePhoto() — Method in class vB_Api_Content_Photo
Checks if user can delete a given photo
$vB_Api_Content_Poll#contenttypeProperty in class vB_Api_Content_Poll
vB_Api_Content_Poll::checkVoted() — Method in class vB_Api_Content_Poll
Checks if the current user has voted on this poll
$vB_Api_Content_Privatemessage#contenttypeProperty in class vB_Api_Content_Privatemessage
$vB_Api_Content_Privatemessage#canSeeProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::canUsePmSystem() — Method in class vB_Api_Content_Privatemessage
Private messaging can be disabled either by pmquota or enablepms
vB_Api_Content_Privatemessage::createMessageFolder() — Method in class vB_Api_Content_Privatemessage
Creates a new message folder. It returns false if the record already exists and the id if it is able to create the folder
vB_Api_Content_Privatemessage::checkFolders() — Method in class vB_Api_Content_Privatemessage
Checks that we have all the folders for the current user, and the set folders are there.
$vB_Api_Content_Redirect#contenttypeProperty in class vB_Api_Content_Redirect
$vB_Api_Content_Report#contenttypeProperty in class vB_Api_Content_Report
$vB_Api_Content_Text#contenttypeProperty in class vB_Api_Content_Text
vB_Api_Content_Text::checkTextLength() — Method in class vB_Api_Content_Text
Check that the $text length falls in the minChar/maxChar limits Checks some class properties as well as does a transform on the text to normalize things.
vB_Api_Content_Text::checkHtmlstateForComments() — Method in class vB_Api_Content_Text
Checks 'htmlstate' and disables it if this is a comment
vB_Api_Content_Text::cleanInput() — Method in class vB_Api_Content_Text
Cleans the input in the $data array, directly updating $data.
vB_Api_Content_Text::checkAttachmentPermissions() — Method in class vB_Api_Content_Text
Checks createpermissions.vbforum_attach and forumpermissions.maxattachments to see that user can add attachments under $data['parentid'] and that attachment limit is not exceeded. Throws exceptions meant to prevent node addition/update, so this function should be called before calling Library's add() or update()
$vB_Api_Content_Video#contenttypeProperty in class vB_Api_Content_Video
vB_Api_Editor::convertHtmlToBbcode() — Method in class vB_Api_Editor
Convert CKEditor HTML into bbcode - Received from editor mode switch to source
$vB_Api_Extensions#checkedProperty in class vB_Api_Extensions
Array of flags for controller loading
$vB_Api_Extensions#controllerProperty in class vB_Api_Extensions
Name of the API module
$vB_Api_Extensions#checkurlProperty in class vB_Api_Extensions
$vB_Api_Extensions#ClassDependancyProperty in class vB_Api_Extensions
vB_Api_Extensions::callNamed() — Method in class vB_Api_Extensions
$vB_Api_External#cleanerProperty in class vB_Api_External
vB_Api_External::createExternalOutput() — Method in class vB_Api_External
Creates an external output from site depending on the type specified.
vB_Api_Facebook::connectCurrentUser() — Method in class vB_Api_Facebook
Connects the currently logged in user to the currently logged in Facebook user
vB_Api_Follow::clearFollowCache() — Method in class vB_Api_Follow
Clears follow in class cache
$vB_Api_Help#cleanerObjProperty in class vB_Api_Help
$vB_Api_Logwrapper#controllerProperty in class vB_Api_Logwrapper
$vB_Api_Node#contentAPIsProperty in class vB_Api_Node
$vB_Api_Node#contentLibrariesProperty in class vB_Api_Node
$vB_Api_Node#channelStatisticsProperty in class vB_Api_Node
vB_Api_Node::closeNode() — Method in class vB_Api_Node
Closes a node for posting. Closed nodes can still be viewed but nobody can reply to one.
vB_Api_Node::cloneNodes() — Method in class vB_Api_Node
Clone Nodes and their children deeply into a new parent Node.
vB_Api_Node::clearUnpublishDate() — Method in class vB_Api_Node
clears the unpublishdate flag.
vB_Api_Node::clearCacheEvents() — Method in class vB_Api_Node
Clears the cache events from a given list of nodes.
vB_Api_Notice::checkNoticeCriteriaBetween() — Method in class vB_Api_Notice
Checks if the specified criteria is between 2 values.
vB_Api_Options::checkApiState() — Method in class vB_Api_Options
vB_Api_Options::changeSearchType() — Method in class vB_Api_Options
This function changes the search type for settings
vB_Api_Page::checkCustomUrl() — Method in class vB_Api_Page
This is used for setting a custom url to make sure that the new url is valid as a prefix
vB_Api_Paidsubscription::checkPermission() — Method in class vB_Api_Paidsubscription
vB_Api_Paidsubscription::checkStatus() — Method in class vB_Api_Paidsubscription
Check whether paid subscriptions system is active or not
vB_Api_Phrase::clearPhraseCache() — Method in class vB_Api_Phrase
Clears the phrase cache, needed primarily for unit test.
vB_Api_Pmchat::canUsePMChat() — Method in class vB_Api_Pmchat
Checks if 1) the current user is logged in, 2) user is in a usergroup that is allowed to use the chat system, 3) the chat is enabled globally, and 4) user did not opt out of vB Messenger via user settings.
vB_Api_Posthistory::canViewPostHistory() — Method in class vB_Api_Posthistory
Can the post history for this node be viewed? It is required that the user can edit the post in order to view the history.
vB_Api_Prefix::canUse() — Method in class vB_Api_Prefix
Can the logged in user use the prefix in question
vB_Api_Profile::cropFileData() — Method in class vB_Api_Profile
vB_Api_Reputation::checkCanUseRep() — Method in class vB_Api_Reputation
vB_Api_Route::createRoute() — Method in class vB_Api_Route
Saves a new route
$vB_Api_ScreenLayout#cacheProperty in class vB_Api_ScreenLayout
$vB_Api_Search#criteriaProperty in class vB_Api_Search
$vB_Api_Search#channelCacheProperty in class vB_Api_Search
$vB_Api_Search#cache_ttl_secProperty in class vB_Api_Search
vB_Api_SocialGroup::createSocialGroup() — Method in class vB_Api_SocialGroup
creates a new social group
vB_Api_SocialGroup::changeCategory() — Method in class vB_Api_SocialGroup
vB_Api_State::checkBeforeView() — Method in class vB_Api_State
vB_Api_State::clearStateCheck() — Method in class vB_Api_State
Clears the state check variable. Needed during unit tests but otherwise should never be needed.
vB_Api_State::checkCSRF() — Method in class vB_Api_State
vB_Api_State::checkForumClosed() — Method in class vB_Api_State
Check if Forum is closed. Allows administrators and login actions to bypass.
vB_Api_State::checkForumBusy() — Method in class vB_Api_State
vB_Api_State::checkProfileUpdate() — Method in class vB_Api_State
vB_Api_State::checkIpBan() — Method in class vB_Api_State
vB_Api_State::checkPasswordExpiry() — Method in class vB_Api_State
$vB_Api_Style#cssFileLocationProperty in class vB_Api_Style
vB_Api_Style::checkCanImportStyleXML() — Method in class vB_Api_Style
This is used mostly by the adminCP style importer. This checks if the current user has enough permissions to import the specified XML data.
vB_Api_Stylevar::canCustomizeProfile() — Method in class vB_Api_Stylevar
This is just a public method for calling the hasPermissions method
vB_Api_Stylevar::canSaveDefault() — Method in class vB_Api_Stylevar
Checkes if the current loged user has admin permisions for administration of styles
vB_Api_Tags::createSynonyms() — Method in class vB_Api_Tags
vB_Api_Tags::copyTags() — Method in class vB_Api_Tags
Copy tags from a node to another one.
$vB_Api_Template#common_templatesProperty in class vB_Api_Template
vB_Api_Template::cacheTemplates() — Method in class vB_Api_Template
Fetches a number of templates from the database and puts them into the templatecache
vB_Api_Template::checkCanSaveTemplate() — Method in class vB_Api_Template
This checks permissions for saving a template.
vB_Api_User::computeMembersOf() — Method in class vB_Api_User
Analyzes what groups this user belongs to in specific channels. Stores in member variables
vB_Api_User::clearChannelPerms() — Method in class vB_Api_User
This method clears remembered channel permission
vB_Api_User::changeHistory() — Method in class vB_Api_User
Return user change history
vB_Api_User::checkUsername() — Method in class vB_Api_User
This checks whether the a username is available and valid
vB_Api_User::currentUserHasAdminPermission() — Method in class vB_Api_User
vB_Api_User::canRemovePost() — Method in class vB_Api_User
Checks the various options as to whether the current user can physically remove a post
vB_Api_User::canCreateBlogEntry() — Method in class vB_Api_User
Tells whether the current user can create a blog entry. That can be their own permissions or GIT.
vB_Api_Vb4_Cms::content_call() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_Cms::content_edit() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_Cms::content_addcontent() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_Cms::content_view() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_Cms::categorylist() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_activity::call() — Method in class vB_Api_Vb4_activity
Default activity call.
vB_Api_Vb4_forum::call() — Method in class vB_Api_Vb4_forum
vB_Api_Vb4_forumdisplay::call() — Method in class vB_Api_Vb4_forumdisplay
vB_Api_Vb4_inlinemod::close() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_member::call() — Method in class vB_Api_Vb4_member
vB_Api_Vb4_register::call() — Method in class vB_Api_Vb4_register
vB_Api_Vb4_report::close() — Method in class vB_Api_Vb4_report
vB_Api_Vb4_showthread::call() — Method in class vB_Api_Vb4_showthread
vB_Api_Widget::cleanWidgetConfigData() — Method in class vB_Api_Widget
Cleans widget config data
vB_Api_Widget::checkProductStatus() — Method in class vB_Api_Widget
vB_Api_Widget::compareWidgets() — Method in class vB_Api_Widget
vB_Api_Widget::channelDisplaySort() — Method in class vB_Api_Widget
vB_Api_Wol::checkWOLPermission() — Method in class vB_Api_Wol
$vB_Api_Wrapper#controllerProperty in class vB_Api_Wrapper
vB_Api_Wrapper::callNamed() — Method in class vB_Api_Wrapper

D

vB_Api_Ad::delete() — Method in class vB_Api_Ad
Deletes an ad
$vB_Api_Api#dbassertorProperty in class vB_Api_Api
$vB_Api_Bbcode#disableFalseReturnOnlyProperty in class vB_Api_Bbcode
{@inheritDoc} Methods include: getSignatureInfo
vB_Api_Bbcode::doParseSignature() — Method in class vB_Api_Bbcode
Used by getSignatureInfo and parseSignatures to parse a signature
vB_Api_Blog::doMembersCount() — Method in class vB_Api_Blog
Returns the number of members for the channel (blog or group)
$vB_Api_Content#disableWhiteListProperty in class vB_Api_Content
List of methods that which can still be called as normal even when the API is disabled due to forum being closed, password expired, IP ban, etc.
$vB_Api_Content#doFloodCheckProperty in class vB_Api_Content
vB_Api_Content::delete() — Method in class vB_Api_Content
Permanently deletes a node
vB_Api_Content_Attach::delete() — Method in class vB_Api_Content_Attach
Remove an attachment
vB_Api_Content_Attach::deleteAttachment() — Method in class vB_Api_Content_Attach
Remove an attachment
vB_Api_Content_Channel::delete() — Method in class vB_Api_Content_Channel
Permanently deletes a node
vB_Api_Content_Infraction::delete() — Method in class vB_Api_Content_Infraction
Deletes an infraction. Currently the only UI for this is in the Admin CP
vB_Api_Content_Infraction::deleteInfractionGroup() — Method in class vB_Api_Content_Infraction
Deletes an infraction group
$vB_Api_Content_Photo#doFloodCheckProperty in class vB_Api_Content_Photo
vB_Api_Content_Photo::delete() — Method in class vB_Api_Content_Photo
Delete photo record
$vB_Api_Content_Privatemessage#disableWhiteListProperty in class vB_Api_Content_Privatemessage
$vB_Api_Content_Privatemessage#disableFalseReturnOnlyProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::deleteMessage() — Method in class vB_Api_Content_Privatemessage
Permanently deletes a message
vB_Api_Content_Privatemessage::deleteMessagesForUser() — Method in class vB_Api_Content_Privatemessage
Deletes all pms for a given user
vB_Api_Content_Privatemessage::deleteSentMessagesForUser() — Method in class vB_Api_Content_Privatemessage
Deletes all pms for a given user
vB_Api_Content_Privatemessage::deleteFolder() — Method in class vB_Api_Content_Privatemessage
Deletes a folder and moves its contents to trash
vB_Api_Content_Privatemessage::denyRequest() — Method in class vB_Api_Content_Privatemessage
Denies a user follow request
vB_Api_Content_Privatemessage::deleteMessages() — Method in class vB_Api_Content_Privatemessage
Delete private messages. Once deleted user won't be able to retrieve them again.
vB_Api_Content_Text::delete() — Method in class vB_Api_Content_Text
Permanently deletes a node
$vB_Api_Cron#disableWhiteListProperty in class vB_Api_Cron
vB_Api_Cron::delete() — Method in class vB_Api_Cron
Delete a cron
$vB_Api_Editor#disableFalseReturnOnlyProperty in class vB_Api_Editor
vB_Api_Editor::discardAutosave() — Method in class vB_Api_Editor
Discard autosave text
$vB_Api_Extensions#developerProperty in class vB_Api_Extensions
$vB_Api_ExternalLogin#disableWhiteListProperty in class vB_Api_ExternalLogin
$vB_Api_ExternalLogin#disableFalseReturnOnlyProperty in class vB_Api_ExternalLogin
$vB_Api_Facebook#disableFalseReturnOnlyProperty in class vB_Api_Facebook
vB_Api_Facebook::disconnectUser() — Method in class vB_Api_Facebook
Disconnects the current user from facebook
$vB_Api_Filedata#disableWhiteListProperty in class vB_Api_Filedata
Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.
vB_Api_Follow::delete() — Method in class vB_Api_Follow
This deletes a follower. needs userid and followerid, passed or taken from current session
vB_Api_Follow::denyFollowing() — Method in class vB_Api_Follow
This denies a following request made for the current user.
vB_Api_Hook::deleteHook() — Method in class vB_Api_Hook
vB_Api_Hook::decodeArguments() — Method in class vB_Api_Hook
$vB_Api_Hv#disableWhiteListProperty in class vB_Api_Hv
$vB_Api_Language#disableWhiteListProperty in class vB_Api_Language
vB_Api_Language::delete() — Method in class vB_Api_Language
Delete a language
vB_Api_Node::deleteNodes() — Method in class vB_Api_Node
Permanently/Temporarily deletes a set of nodes
vB_Api_Node::deleteNodesAsSpam() — Method in class vB_Api_Node
Delete nodes as spam
$vB_Api_Notice#disableFalseReturnOnlyProperty in class vB_Api_Notice
vB_Api_Notice::dismiss() — Method in class vB_Api_Notice
vB_Api_Notification::dismissAllNotifications() — Method in class vB_Api_Notification
Updates all notifications owned by user and marks them as read (sets the lastreadtime to current time).
vB_Api_Notification::dismissNotification() — Method in class vB_Api_Notification
Updates the specified notificationids to mark them as read, and returns a single "next" notification based on the filter parameters.
vB_Api_Notification::deleteNotification() — Method in class vB_Api_Notification
Deletes specified notificationds, but only if it's owned by the current user.
$vB_Api_Options#disableWhiteListProperty in class vB_Api_Options
vB_Api_Options::deleteGroupSettings() — Method in class vB_Api_Options
Delete group of settings
$vB_Api_Page#disableWhiteListProperty in class vB_Api_Page
vB_Api_Page::delete() — Method in class vB_Api_Page
Deletes a page
vB_Api_Page::deleteOrphanedPagetemplates() — Method in class vB_Api_Page
$vB_Api_Paidsubscription#disableFalseReturnOnlyProperty in class vB_Api_Paidsubscription
$vB_Api_Phrase#disableWhiteListProperty in class vB_Api_Phrase
vB_Api_Phrase::delete() — Method in class vB_Api_Phrase
Delete a phrase
$vB_Api_Pmchat#disableWhiteListProperty in class vB_Api_Pmchat
$vB_Api_Product#disableWhiteListProperty in class vB_Api_Product
$vB_Api_Request#disableWhiteListProperty in class vB_Api_Request
$vB_Api_Route#disableWhiteListProperty in class vB_Api_Route
$vB_Api_Site#disableWhiteListProperty in class vB_Api_Site
$vB_Api_State#disableWhiteListProperty in class vB_Api_State
$vB_Api_Style#disableWhiteListProperty in class vB_Api_Style
vB_Api_Style::deleteStyle() — Method in class vB_Api_Style
Delete style
vB_Api_Stylevar::delete() — Method in class vB_Api_Stylevar
Deletes the listed stylevars for the current user Pass false to delete all the stylevars for the current user
$vB_Api_Template#disableWhiteListProperty in class vB_Api_Template
vB_Api_Template::deleteReplacementVar() — Method in class vB_Api_Template
Delete a replacement variable
vB_Api_Template::delete() — Method in class vB_Api_Template
Delete a template
vB_Api_Template::dismissMerge() — Method in class vB_Api_Template
Dismiss automatical merge
vB_Api_Template::deleteHistoryVersion() — Method in class vB_Api_Template
Delete template history versions
vB_Api_Template::deleteAllTemplateFiles() — Method in class vB_Api_Template
vB_Api_Template::deleteTemplateInternal() — Method in class vB_Api_Template
$vB_Api_User#disableWhiteListProperty in class vB_Api_User
$vB_Api_User#disableFalseReturnOnlyProperty in class vB_Api_User
vB_Api_User::delete() — Method in class vB_Api_User
Delete a user
vB_Api_User::deleteActivation() — Method in class vB_Api_User
vB_Api_UserGroup::delete() — Method in class vB_Api_UserGroup
Delete an usergroup
vB_Api_UserGroup::deletePromotion() — Method in class vB_Api_UserGroup
Delete an usergroup promotion
vB_Api_Userrank::delete() — Method in class vB_Api_Userrank
Delete an user rank
vB_Api_Vb4_ajax::dismissnotice() — Method in class vB_Api_Vb4_ajax
vB_Api_Vb4_inlinemod::docopyposts() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::domoveposts() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::domovethreads() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::dodeleteposts() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::dodeletethreads() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::dodeletespam() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_notification::dismiss() — Method in class vB_Api_Vb4_notification
Dismisses a notification by triggering the "read_topic" event on the $threadid.
vB_Api_Vb4_notification::dismissVms() — Method in class vB_Api_Vb4_notification
Dismisses visitormessage notifications for the current user by triggering the "read_vms" event.
vB_Api_Vb4_postings::docopythread() — Method in class vB_Api_Vb4_postings
vB_Api_Vb4_profile::doaddlist() — Method in class vB_Api_Vb4_profile
vB_Api_Vb4_report::delete() — Method in class vB_Api_Vb4_report
vB_Api_Vb4_subscription::doaddsubscription() — Method in class vB_Api_Vb4_subscription
$vB_Api_Widget#disableWhiteListProperty in class vB_Api_Widget
vB_Api_Widget::deleteWidgetInstance() — Method in class vB_Api_Widget
Deletes a widget instance
vB_Api_Widget::deleteWidgetInstances() — Method in class vB_Api_Widget
Deletes multiple widget instances

E

vB_Api_Bbcode::extractVideo() — Method in class vB_Api_Bbcode
Extracts the video and photo content from text.
vB_Api_Content::extractMedia() — Method in class vB_Api_Content
Extracts the video and photo content from text.
$vB_Api_Content_Attach#extension_mapProperty in class vB_Api_Content_Attach
vB_Api_Content_Link::extractData() — Method in class vB_Api_Content_Link
Used by parsePage() to extract the data to return
$vB_Api_Extensions#extensionsProperty in class vB_Api_Extensions
Contains extensions for all API classes
$vB_Api_Extensions#extensionClassProperty in class vB_Api_Extensions
Extension class name
$vB_Api_Extensions#extensionOrderProperty in class vB_Api_Extensions
vB_Api_Hook::encodeArguments() — Method in class vB_Api_Hook
vB_Api_Language::export() — Method in class vB_Api_Language
Export language as xml
vB_Api_Paidsubscription::endsubscription() — Method in class vB_Api_Paidsubscription
User End a subscription by its own
$vB_Api_Tags#errorsProperty in class vB_Api_Tags
vB_Api_User::enableMfa() — Method in class vB_Api_User
Enable the user's current MFA record after verify password and authcode
vB_Api_User::emailPassword() — Method in class vB_Api_User
Email user a password reset email
vB_Api_Vb4_editpost::editpost() — Method in class vB_Api_Vb4_editpost
vB_Api_Vb4_private::editfolders() — Method in class vB_Api_Vb4_private

F

vB_Api_Ad::fetch() — Method in class vB_Api_Ad
Fetches an ad by its ID
vB_Api_Ad::fetchDisplayOptions() — Method in class vB_Api_Ad
Fetches display options
vB_Api_Ad::fetchDisplayoptionsHtml() — Method in class vB_Api_Ad
Fetches display options HTML
vB_Api_Announcement::fetch() — Method in class vB_Api_Announcement
Fetches announcements by channel ID
vB_Api_Bbcode::fetchTagList() — Method in class vB_Api_Bbcode
Returns the list of default BB code tags
vB_Api_Bbcode::fetchCustomTags() — Method in class vB_Api_Bbcode
Loads any user specified custom BB code tags.
vB_Api_Bbcode::fetchBbcodeOptions() — Method in class vB_Api_Bbcode
Compiles and returns an array of various bbcode-related vboptions.
vB_Api_Bbcode::fetchCensorshipInfo() — Method in class vB_Api_Bbcode
Returns an array of information to apply censorship.
vB_Api_Bbcode::fetchSmilies() — Method in class vB_Api_Bbcode
Returns an array of smilie information.
vB_Api_Blog::fetchOwner() — Method in class vB_Api_Blog
Returns the userid of the channel owner
vB_Api_Blog::fetchContributors() — Method in class vB_Api_Blog
Returns the userids of the channel contributors (moderators)
vB_Api_Blog::fetchSubscribers() — Method in class vB_Api_Blog
Fetches information about members (subscribers) for a blog.
vB_Api_Blog::fetchMembers() — Method in class vB_Api_Blog
Lists channel members
vB_Api_Contactus::fetchPredefinedSubjects() — Method in class vB_Api_Contactus
Fetch predefined contact us subjects
vB_Api_Content::fetchTableName() — Method in class vB_Api_Content
Returns the tables used by this content type.
vB_Api_ContentType::fetchContentTypeIdFromClass() — Method in class vB_Api_ContentType
Returns the integer content type id for the given content type class name
vB_Api_ContentType::fetchContentTypeClassFromId() — Method in class vB_Api_ContentType
Returns the class name for for the given content type id
vB_Api_Content_Attach::fetchImage() — Method in class vB_Api_Content_Attach
Fetch image information about an attachment
vB_Api_Content_Attach::fetchImageByFiledataid() — Method in class vB_Api_Content_Attach
Alias for vB_Api_Filedata::fetchImageByFiledataid
vB_Api_Content_Attach::fetchAttachByFiledataids() — Method in class vB_Api_Content_Attach
Fetch information of attachments without data
vB_Api_Content_Channel::fetchChannelById() — Method in class vB_Api_Content_Channel
Returns a channel record based on its node id
vB_Api_Content_Channel::fetchChannelByGUID() — Method in class vB_Api_Content_Channel
Returns a channel record based on its node guid
vB_Api_Content_Channel::fetchChannelIdByGUID() — Method in class vB_Api_Content_Channel
Returns a channel id based on its node guid
vB_Api_Content_Channel::fetchChannelIcon() — Method in class vB_Api_Content_Channel
Get a blog icon
vB_Api_Content_Channel::fetchTopLevelChannelIds() — Method in class vB_Api_Content_Channel
Fetches the top level Channels/Categories
vB_Api_Content_Link::fetchImageByLinkId() — Method in class vB_Api_Content_Link
This returns a link image by nodeid
vB_Api_Content_Photo::fetchImageByPhotoid() — Method in class vB_Api_Content_Photo
Returns an image record based on photo ID
$vB_Api_Content_Privatemessage#foldersProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::fetchSummary() — Method in class vB_Api_Content_Privatemessage
Returns a summary of messages for current user
vB_Api_Content_Privatemessage::fetchFolders() — Method in class vB_Api_Content_Privatemessage
Returns the cached folder information
vB_Api_Content_Privatemessage::fetchParticipants() — Method in class vB_Api_Content_Privatemessage
Returns an array of all users participating in a discussion
vB_Api_Content_Text::fixAttachBBCode() — Method in class vB_Api_Content_Text
DEPRECATED - This is now handled internally by the library, nothing is called from controllers.
vB_Api_Cron::fetchById() — Method in class vB_Api_Cron
Fetch a cron by its ID
vB_Api_Cron::fetchByVarname() — Method in class vB_Api_Cron
Returns a cron task based on the cron varname
vB_Api_Cron::fetchAll() — Method in class vB_Api_Cron
Fetches All cron tasks
vB_Api_Cron::fetchLog() — Method in class vB_Api_Cron
Fetch cron log
vB_Api_Editor::fetchCustomBbcode() — Method in class vB_Api_Editor
Returns the array of custom bbcode info
vB_Api_Editor::fetchAllSmilies() — Method in class vB_Api_Editor
Returns a hierarchical array of smilie data for displaying the smilies panel.
vB_Api_Editor::fetchVideoProviders() — Method in class vB_Api_Editor
Fetch list of supported video types
vB_Api_Editor::fetchAutoLoadText() — Method in class vB_Api_Editor
Retrieve Autoload Text
vB_Api_Editor::fetchContentEntryLimits() — Method in class vB_Api_Editor
$vB_Api_Extensions#foldersProperty in class vB_Api_Extensions
stores the packages folder list
$vB_Api_Extensions#foldersLoadedProperty in class vB_Api_Extensions
Folders loaded flag
vB_Api_Filedata::fetchImageByFiledataid() — Method in class vB_Api_Filedata
Fetch image information about an attachment based on file data id
vB_Api_Filedata::fetchFiledataByid() — Method in class vB_Api_Filedata
fetch filedata records based on filedata ids
vB_Api_Filedata::fetchLegacyAttachments() — Method in class vB_Api_Filedata
Returns filedataids, filenames & other publicly visible properties of requested legacy attachments.
vB_Api_Filedata::fetchPhotoFiledataid() — Method in class vB_Api_Filedata
fetch filedataid(s) for the passed photo nodeid(s)
vB_Api_Filedata::fetchAttachFiledataid() — Method in class vB_Api_Filedata
fetch filedataid(s) for the passed attachment nodeid(s)
$vB_Api_Follow#followersProperty in class vB_Api_Follow
vB_Api_Help::findItem() — Method in class vB_Api_Help
vB_Api_Help::findFirst() — Method in class vB_Api_Help
vB_Api_Hv::fetchHvType() — Method in class vB_Api_Hv
Fetch Current Hv Type Possible Values: - Image - Question - Recaptcha - Disabled
vB_Api_Hv::fetchHvImage() — Method in class vB_Api_Hv
Fetch Human Verification Image Data
vB_Api_Hv::fetchHvQuestion() — Method in class vB_Api_Hv
Fetch Human Verification Question Data
vB_Api_Hv::fetchRequireHvcheck() — Method in class vB_Api_Hv
Returns whether or not the user requires a human verification test to complete the specified action
vB_Api_Icon::fetchAll() — Method in class vB_Api_Icon
Returns the array of post icons that the current user can use.
vB_Api_Language::fetchAll() — Method in class vB_Api_Language
Fetch all languages
vB_Api_Language::fetchLanguageSelector() — Method in class vB_Api_Language
Simplified version of the fetchAll function,
vB_Api_Node::fetchAlbumChannel() — Method in class vB_Api_Node
returns id of the Albums Channel
vB_Api_Node::fetchPMChannel() — Method in class vB_Api_Node
returns id of the Private Message Channel
vB_Api_Node::fetchVMChannel() — Method in class vB_Api_Node
returns id of the Vistor Message Channel
vB_Api_Node::fetchReportChannel() — Method in class vB_Api_Node
returns id of the Report Channel
vB_Api_Node::fetchForumChannel() — Method in class vB_Api_Node
Returns the nodeid of the root forum channel
vB_Api_Node::fetchInfractionChannel() — Method in class vB_Api_Node
Returns the nodeid of the infraction channel
vB_Api_Node::fetchArticleChannel() — Method in class vB_Api_Node
Returns the nodeid of the articles channel
vB_Api_Node::fetchActivity() — Method in class vB_Api_Node
returns array of all node content for a user's activity
vB_Api_Node::fetchModLogs() — Method in class vB_Api_Node
Fetches the moderator logs for a node
vB_Api_Node::fetchUseridsFromNodeids() — Method in class vB_Api_Node
Fetch userids from given nodeids
vB_Api_Node::fetchUsersFromNodeids() — Method in class vB_Api_Node
Fetch users from given nodeids
vB_Api_Node::fetchChannelNodeTree() — Method in class vB_Api_Node
Fetch node tree structure of the specified parent id as the root. Root is excluded from the tree structure.
vB_Api_Node::fetchChannelDetails() — Method in class vB_Api_Node
vB_Api_Notice::fetch() — Method in class vB_Api_Notice
Fetch notices to be displayed
vB_Api_Notice::fetchDismissedNotices() — Method in class vB_Api_Notice
Fetches the IDs of the dismissed notices so we do not display them for the user.
vB_Api_Notification::fetchNotificationsForCurrentUser() — Method in class vB_Api_Notification
Return current user's notifications from DB.
vB_Api_Options::fetch() — Method in class vB_Api_Options
This function returns the options data from the specified option groups, in a multi dimensional array having the group name as key and the options as values.
vB_Api_Options::fetchStatic() — Method in class vB_Api_Options
Returns the requested vBulletin options as specified by the $options parameter.
vB_Api_Options::fetchValues() — Method in class vB_Api_Options
Fetch option values
vB_Api_Page::fetchPageById() — Method in class vB_Api_Page
Get information for a page
vB_Api_Page::fetchRouteClass() — Method in class vB_Api_Page
Returns the pagetemplate record given a pageid
vB_Api_PageTemplate::fetchPageTemplateList() — Method in class vB_Api_PageTemplate
Returns a list of all page templates and widget instances associated with them.
vB_Api_Paidsubscription::fetchAll() — Method in class vB_Api_Paidsubscription
Fetch all subscriptions that an user can join and already joined It also fetches active payment APIs
vB_Api_Paidsubscription::fetchActivePaymentApis() — Method in class vB_Api_Paidsubscription
Fetch all active payment APIs.
vB_Api_Paidsubscription::fetchSubscribed() — Method in class vB_Api_Paidsubscription
Fetch all active subscriptions current user is subscribed too
vB_Api_Phrase::fetchByGroup() — Method in class vB_Api_Phrase
Fetch phrases by group
vB_Api_Phrase::fetch() — Method in class vB_Api_Phrase
Fetch phrases
vB_Api_Phrase::fetchOrphans() — Method in class vB_Api_Phrase
Fetch orphan phrases
vB_Api_Phrase::findUpdates() — Method in class vB_Api_Phrase
Find custom phrases that need updating
vB_Api_Phrase::fetch_phrasetypes() — Method in class vB_Api_Phrase
Fetches an array of existing phrase types from the database
vB_Api_Phrase::fetchEmailPhrases() — Method in class vB_Api_Phrase
Returns message and subject for an email.
vB_Api_Posthistory::fetchHistory() — Method in class vB_Api_Posthistory
Retrieves the posthistory for this node.
vB_Api_Posthistory::fetchHistoryComparison() — Method in class vB_Api_Posthistory
Retrieves the comparison of two post history items
vB_Api_Prefix::fetch() — Method in class vB_Api_Prefix
Fetch available prefixes of a Channel. It has permission check, So if an user doesn't have permission to use a prefix, the prefix won't be returned.
vB_Api_Profile::fetchMedia() — Method in class vB_Api_Profile
Lists the media for a user
vB_Api_Reputation::fetchWhovoted() — Method in class vB_Api_Reputation
Fetch whovoted a node
vB_Api_Reputation::fetchVotecount() — Method in class vB_Api_Reputation
Fetch vote count for a node
vB_Api_Reputation::fetchReputationImageInfo() — Method in class vB_Api_Reputation
Fetch reputation image info for displaying it in a node Ported from vB4's fetch_reputation_image() function
vB_Api_Route::fetchAll() — Method in class vB_Api_Route
Returns the array of routes for the application
vB_Api_Route::fetchLegacyPostUrl() — Method in class vB_Api_Route
Returns the URL for the legacy postid
vB_Api_Route::fetchLegacyThreadUrl() — Method in class vB_Api_Route
Returns the URL for the legacy threadid
vB_Api_ScreenLayout::fetchScreenLayoutList() — Method in class vB_Api_ScreenLayout
Returns a list of all "selectable" screen layouts. Currently excludes the "bare full" layout, which is used specifically for the PM Chat window.
vB_Api_Style::fetchStyleVars() — Method in class vB_Api_Style
Get Style Vars
vB_Api_Style::fetchStyles() — Method in class vB_Api_Style
Fetch All styles
vB_Api_Style::fetchCssLocation() — Method in class vB_Api_Style
gets the css File Location, which only means something if storecssasfiles is set to 2.
vB_Api_Stylevar::fetch() — Method in class vB_Api_Stylevar
Fetches the stylevar values for the user $userid Pass false for $stylevars to get all the stylevars Pass 0 for userid to retrieve the stylevar for the current user Returns an associative array with keys being the list specified in the $stylevar If any of the stylevars is not customized for the specified user, the value from the default stylevar will be returned instead Pass false for $falback to limit the results to the custom stylevars only
vB_Api_Stylevar::fetch_default_stylevar() — Method in class vB_Api_Stylevar
vB_Api_Stylevar::fetch_user_stylevars() — Method in class vB_Api_Stylevar
Fetches the stylevar values for the user $userid
vB_Api_Stylevar::fetchCustomizationPermissions() — Method in class vB_Api_Stylevar
Returns all the permissions that the currently logged user has for customizing profile
vB_Api_Tags::fetchTagsForCloud() — Method in class vB_Api_Tags
Get an array of tags for building tag cloud
vB_Api_Tags::fetchTagsForTagNavigation() — Method in class vB_Api_Tags
Returns an array of tags for the tag navigation widget
vB_Api_Tags::fetchTagByText() — Method in class vB_Api_Tags
Fetch tag by label
vB_Api_Template::fetch() — Method in class vB_Api_Template
Fetch one template based on its name and style ID.
vB_Api_Template::fetchBulk() — Method in class vB_Api_Template
Fetches a bulk of templates from the database
vB_Api_Template::fetchByID() — Method in class vB_Api_Template
Fetch template by its ID
vB_Api_Template::fetchUncompiled() — Method in class vB_Api_Template
Fetch one uncompiled template based on its name and style ID.
vB_Api_Template::fetchReplacementVar() — Method in class vB_Api_Template
Find the replacement var by title and styleid
vB_Api_Template::fetchReplacementVarById() — Method in class vB_Api_Template
Find the replacement var by templateid
vB_Api_Template::fetchOriginal() — Method in class vB_Api_Template
Fetch original (not customized) template content
vB_Api_Template::findUpdates() — Method in class vB_Api_Template
Find custom templates that need updating
vB_Api_Template::fetchVersion() — Method in class vB_Api_Template
Fetch current or historical uncompiled version of a template
vB_Api_Template::fetchSpecialTemplates() — Method in class vB_Api_Template
vB_Api_Template::fetchCommonTemplates() — Method in class vB_Api_Template
vB_Api_Template::fetchTemplateHooks() — Method in class vB_Api_Template
vB_Api_User::fetchProfileInfo() — Method in class vB_Api_User
This gets the information needed for a user's profile. Only public information unless this is an admin or the user.
vB_Api_User::fetchUserSettings() — Method in class vB_Api_User
Fetches the needed info for user settings
vB_Api_User::fetchUserinfo() — Method in class vB_Api_User
Fetches an array containing info for the specified user, or false if user is not found
vB_Api_User::fetchCurrentUserinfo() — Method in class vB_Api_User
Fetches an array containing info for the current user
vB_Api_User::fetchUserName() — Method in class vB_Api_User
Fetches the username for a userid, or false if user is not found
vB_Api_User::fetchMusername() — Method in class vB_Api_User
fetches the proper username markup and title
vB_Api_User::fetchByUsername() — Method in class vB_Api_User
Fetch user by its username
vB_Api_User::fetchByEmail() — Method in class vB_Api_User
Fetch user by its email
vB_Api_User::find() — Method in class vB_Api_User
Find user
vB_Api_User::fetchAvatar() — Method in class vB_Api_User
Fetches the URL for a User's Avatar
vB_Api_User::fetchAvatars() — Method in class vB_Api_User
Fetch the Avatars for a userid array
vB_Api_User::fetchProfileFieldsForRegistration() — Method in class vB_Api_User
Fetches the Profile Fields that needs to be displayed in Registration From
vB_Api_User::fetchAwaitingModerate() — Method in class vB_Api_User
Fetch a list of users who are awaiting moderate or Coppa
vB_Api_User::fetchPruneUsers() — Method in class vB_Api_User
Return a list of users for pruning or moving
vB_Api_User::fetchReferrers() — Method in class vB_Api_User
Return a report of referrers
vB_Api_User::fetchUserSearchCondition() — Method in class vB_Api_User
Convert the search array to the assertor conditions.
vB_Api_User::fetchSignature() — Method in class vB_Api_User
Get the profile information so the presentation can render it
vB_Api_User::fetchBirthdays() — Method in class vB_Api_User
Fetch today's birthdays
vB_Api_User::fetchUsernames() — Method in class vB_Api_User
Returns an array with the usernames for the user ids and optionally the profileUrl for the user
vB_Api_User::fetchUsersPms() — Method in class vB_Api_User
Fetch private messages statistics from all the users.
vB_Api_User::fetchAdminUser() — Method in class vB_Api_User
This implements vB_PermissionContext::getAdminUser().
vB_Api_User::fetchUserProfileFields() — Method in class vB_Api_User
This gets the current user profile fields from the database.
vB_Api_User::fetchTimeOffset() — Method in class vB_Api_User
Adjust GMT time back to user's time Use "gm" versions of date/time functions with this offset, not ones that rely on current server's system timezone.
vB_Api_UserGroup::fetchUsergroupList() — Method in class vB_Api_UserGroup
Returns a list of all user groups.
vB_Api_UserGroup::fetchPrivateGroups() — Method in class vB_Api_UserGroup
Fetch the special groups. Used by permissions check. Each is a systemgroupid in the usergroups table
vB_Api_UserGroup::fetchUsergroupByID() — Method in class vB_Api_UserGroup
Fetch usergroup information by its ID
vB_Api_UserGroup::fetchUsergroupBySystemID() — Method in class vB_Api_UserGroup
Fetch usergroup information by its SystemID
vB_Api_UserGroup::fetchDefaultData() — Method in class vB_Api_UserGroup
Fetch default usergroup data for adding or editing new usergroup
vB_Api_UserGroup::fetchPromotions() — Method in class vB_Api_UserGroup
Fetch a list of usergroup promotions
vB_Api_UserGroup::fetchJoinRequests() — Method in class vB_Api_UserGroup
Fetch a list of usergroup join requests
vB_Api_UserGroup::fetchBannedUsergroups() — Method in class vB_Api_UserGroup
Fetch a list of banned usergroups
vB_Api_Userrank::fetchById() — Method in class vB_Api_Userrank
Fetch Userrank By RankID
vB_Api_Userrank::fetchAll() — Method in class vB_Api_Userrank
Fetch All user ranks
vB_Api_Vb4_api::forumlist() — Method in class vB_Api_Vb4_api
vB_Api_Vb4_login::facebook() — Method in class vB_Api_Vb4_login
Login with facebook logged user
vB_Api_Vb4_register::fbconnect() — Method in class vB_Api_Vb4_register
Connect logged in user to facebook account
vB_Api_Vb4_register::fbdisconnect() — Method in class vB_Api_Vb4_register
Disconnect fb account from the logged in user
vB_Api_Widget::fetchConfigSchema() — Method in class vB_Api_Widget
Returns the widget configuration schema for the given widget instance.
vB_Api_Widget::fetchTabbedSubWidgetConfigs() — Method in class vB_Api_Widget
vB_Api_Widget::fetchConfigAndIsUserEditable() — Method in class vB_Api_Widget
vB_Api_Widget::fetchConfig() — Method in class vB_Api_Widget
Returns the final configuration for a specific widget instance.
vB_Api_Widget::fetchSearchConfig() — Method in class vB_Api_Widget
Returns the final configuration for the search widget instance.
vB_Api_Widget::fetchAdminConfig() — Method in class vB_Api_Widget
Returns the admin configuration for a specific widget instance.
vB_Api_Widget::fetchChannelConfig() — Method in class vB_Api_Widget
Returns the channel configuration for a specific widget instance.
vB_Api_Widget::fetchUserConfig() — Method in class vB_Api_Widget
Returns the user configuration for a specific widget instance.
vB_Api_Widget::fetchDefaultConfig() — Method in class vB_Api_Widget
Returns the default configuration for a specific widget instance.
vB_Api_Widget::fetchDefaultConfigWithoutInstance() — Method in class vB_Api_Widget
vB_Api_Widget::fetchWidget() — Method in class vB_Api_Widget
Returns the basic widget data for a widget
vB_Api_Widget::fetchWidgets() — Method in class vB_Api_Widget
Returns the basic widget data for multiple widgets
vB_Api_Widget::fetchWidgetInstances() — Method in class vB_Api_Widget
Returns multiple widget instances
vB_Api_Widget::fetchWidgetInstancesByPageTemplateId() — Method in class vB_Api_Widget
Returns all widget instances that are associated with the given page template id. These are the widget instances that should shown on that page template.
vB_Api_Widget::fetchHierarchicalWidgetInstancesByPageTemplateId() — Method in class vB_Api_Widget
Returns all widget instances that are associated with the given page template id in a hierarchical array indexed by section number.
vB_Api_Widget::fetchLayoutSectionInfo() — Method in class vB_Api_Widget
Returns an array of info, including the widget instances, to loop over and display all the layout sections.
vB_Api_Widget::fetchChannelWidgetAdminConfig() — Method in class vB_Api_Widget
Returns the structure which was previously stored in the adminconfig field of widgetinstancetable
vB_Api_Widget::fetchPageManagerForums() — Method in class vB_Api_Widget
vB_Api_Widget::fetchPageManagerGroups() — Method in class vB_Api_Widget
vB_Api_Widget::fetchWidgetInstanceTemplates() — Method in class vB_Api_Widget
vB_Api_Widget::fetchWidgetGuidToWidgetidMap() — Method in class vB_Api_Widget
vB_Api_Wol::fetchAll() — Method in class vB_Api_Wol
Fetch who is online records
vB_Api_Wol::fetchCounts() — Method in class vB_Api_Wol
Fetch online user counts

G

vB_Api_Bbcode::getSignatureInfo() — Method in class vB_Api_Bbcode
Fetches and parses to html a user's signature
vB_Api_Blog::getBlogChannel() — Method in class vB_Api_Blog
vB_Api_Blog::getBlogInfo() — Method in class vB_Api_Blog
vB_Api_Blog::getChannelAdminPerms() — Method in class vB_Api_Blog
Returns a list of channel owner permissions and their values
vB_Api_Blog::getBlogSidebarModules() — Method in class vB_Api_Blog
Returns the widget instances that are used for blog sidebar.
vB_Api_Blog::getMembersCount() — Method in class vB_Api_Blog
Gets the number of members for the given blog channel
vB_Api_Content::getTextCountChange() — Method in class vB_Api_Content
Returns textCountChange property
vB_Api_Content::getContentApi() — Method in class vB_Api_Content
Returns a content api of the appropriate type
vB_Api_Content::getContent() — Method in class vB_Api_Content
Alias for @getFullContent
vB_Api_Content::getFullContent() — Method in class vB_Api_Content
Returns the node content plus the channel routeid and title, and starter route and title, and permissions and other data
vB_Api_Content::getBareContent() — Method in class vB_Api_Content
Returns the node content, channel routeid and title, and starter route and title, but no permissions or other subsidiary data
vB_Api_Content::getConversationParent() — Method in class vB_Api_Content
Gets the conversation starter for a node. If the node is a channel it returns the channel array.
vB_Api_Content::getIndexableContent() — Method in class vB_Api_Content
The classes that inherit this should implement this function It should return the content that should be indexed If there is a title field, the array key for that field should be 'title', the rest of the text can have any key
vB_Api_Content::getBbcodeOptions() — Method in class vB_Api_Content
Returns an array with bbcode options for the node.
vB_Api_Content::getTimeNow() — Method in class vB_Api_Content
Gives the current board time- needed to set publishdate.
vB_Api_Content::getQuoteText() — Method in class vB_Api_Content
This returns the text to quote a node. Used initially for private messaging.
vB_Api_Content_Attach::getGenericChannelAttachmentPermissions() — Method in class vB_Api_Content_Attach
vB_Api_Content_Attach::getAttachmentPermissions() — Method in class vB_Api_Content_Attach
Retrieves the permissions for the specified file type and upload method
vB_Api_Content_Attach::getAvailableSettings() — Method in class vB_Api_Content_Attach
Returns an array of settings that can be saved.
vB_Api_Content_Attach::getImageExtensions() — Method in class vB_Api_Content_Attach
Returns a string[] of accepted extensions that use the img tag for display.
vB_Api_Content_Channel::getBbcodeOptions() — Method in class vB_Api_Content_Channel
Returns an array with bbcode options for the node.
vB_Api_Content_Channel::getContributors() — Method in class vB_Api_Content_Channel
Returs the contributors for a channel
vB_Api_Content_Channel::getTopLevelChannel() — Method in class vB_Api_Content_Channel
Fetches the top level Channel/Category for a node/nodes
vB_Api_Content_Channel::getCanModerate() — Method in class vB_Api_Content_Channel
Determines if the current user can moderate the passed node
vB_Api_Content_Event::getDefaultEventTimestamps() — Method in class vB_Api_Content_Event
Generate the default start and end timestamps for when creating a new Event.
vB_Api_Content_Event::getEventDateTimeStr() — Method in class vB_Api_Content_Event
vB_Api_Content_Event::getEndOfDayUnixtime() — Method in class vB_Api_Content_Event
vB_Api_Content_Infraction::getInfraction() — Method in class vB_Api_Content_Infraction
Returns an infraction node based on its nodeid
vB_Api_Content_Infraction::getNodeInfraction() — Method in class vB_Api_Content_Infraction
Returns the infraction node for the given node (if it has an infraction)
vB_Api_Content_Infraction::getUserInfractions() — Method in class vB_Api_Content_Infraction
Returns the infraction nodes for infractions that the given user has received.
vB_Api_Content_Infraction::getParticipants() — Method in class vB_Api_Content_Infraction
Returns the usernames of those users that participated in an infraction conversation.
vB_Api_Content_Infraction::getInfractionsByType() — Method in class vB_Api_Content_Infraction
Returns a certain type of infractions
vB_Api_Content_Infraction::getAutomaticBanList() — Method in class vB_Api_Content_Infraction
Returns a list of automatic bans or an empty array if there are none.
vB_Api_Content_Infraction::getInfractionLevels() — Method in class vB_Api_Content_Infraction
Returns an array of information for the infraction levels that are currently set up
vB_Api_Content_Infraction::getInfractionGroups() — Method in class vB_Api_Content_Infraction
Gets the infraction groups
vB_Api_Content_Infraction::getQuotes() — Method in class vB_Api_Content_Infraction
returns a string (if int is passed) or array of strings with nodeids as keys (when an array is passed) with quoted strings in bbcode format.
vB_Api_Content_Infraction::getChannelId() — Method in class vB_Api_Content_Infraction
Returns the Infraction channel ID
vB_Api_Content_Privatemessage::getMessage() — Method in class vB_Api_Content_Privatemessage
Gets a message
vB_Api_Content_Privatemessage::getRequest() — Method in class vB_Api_Content_Privatemessage
Get a single request
vB_Api_Content_Privatemessage::getBbcodeOptions() — Method in class vB_Api_Content_Privatemessage
Returns an array with bbcode options for PMs
vB_Api_Content_Privatemessage::getFolderMsgCount() — Method in class vB_Api_Content_Privatemessage
Gets the count of undeleted messages in a folder
vB_Api_Content_Privatemessage::getUnreadInboxCount() — Method in class vB_Api_Content_Privatemessage
Gets the count of undeleted messages & notifications
vB_Api_Content_Privatemessage::getHeaderCounts() — Method in class vB_Api_Content_Privatemessage
Gets the count of undeleted privatemessages, requests, notifications & reports
vB_Api_Content_Privatemessage::getOpenReportsCount() — Method in class vB_Api_Content_Privatemessage
Gets the count of open reports
vB_Api_Content_Privatemessage::getReplyText() — Method in class vB_Api_Content_Privatemessage
Returns the text for a "reply" or "forward" message. Not implemented yet
vB_Api_Content_Privatemessage::getFullContent() — Method in class vB_Api_Content_Privatemessage
Returns the node content as an associative array
vB_Api_Content_Privatemessage::getForward() — Method in class vB_Api_Content_Privatemessage
Gets the title and forward
vB_Api_Content_Privatemessage::getSearchJSON() — Method in class vB_Api_Content_Privatemessage
Returns a formatted json string appropriate for the search api interface
vB_Api_Content_Privatemessage::getPendingPostFolderId() — Method in class vB_Api_Content_Privatemessage
Gets the pending posts folder id
vB_Api_Content_Privatemessage::getInfractionFolderId() — Method in class vB_Api_Content_Privatemessage
Gets the infractions folder id
vB_Api_Content_Privatemessage::getDeletedItemsFolderId() — Method in class vB_Api_Content_Privatemessage
Gets the deleted_items folder id
vB_Api_Content_Privatemessage::getFolderInfoFromId() — Method in class vB_Api_Content_Privatemessage
Gets the folder information from a given folderid. The folderid requested should belong to the user who is requesting.
vB_Api_Content_Report::getReportNodes() — Method in class vB_Api_Content_Report
Converts report nodes to associated nodes
vB_Api_Content_Text::getQuotes() — Method in class vB_Api_Content_Text
Returns a string with quoted strings in bbcode format.
vB_Api_Content_Text::getDataForParse() — Method in class vB_Api_Content_Text
Gets the data the presentation layer needs to have to parse the rawtext.
vB_Api_Content_Video::getVideoFromUrl() — Method in class vB_Api_Content_Video
Get information from video's URL.
vB_Api_Content_Video::getVideoThumbnail() — Method in class vB_Api_Content_Video
Extracts the thumbnail from og:image meta data
vB_Api_Extensions::getExtensions() — Method in class vB_Api_Extensions
Returns all the extensions for a controller.
vB_Api_Extensions::getExtensionOrder() — Method in class vB_Api_Extensions
vB_Api_Extensions::getExtensionList() — Method in class vB_Api_Extensions
Returns all the currently loaded extension.
vB_Api_External::getHeadersFromLastOutput() — Method in class vB_Api_External
Get a list of valid headers values from last output data regarding on the data and external type specified. (vB_External_Export::$headers).
vB_Api_External::getCacheData() — Method in class vB_Api_External
Gets useful information for external cache logic, such as cachetime and cachehash.
vB_Api_ExternalLogin::getState() — Method in class vB_Api_ExternalLogin
vB_Api_Facebook::getLoggedInFbUserId() — Method in class vB_Api_Facebook
Checks for a currrently logged in user through facebook api
vB_Api_Facebook::getVbUseridFromFbUserid() — Method in class vB_Api_Facebook
Checks if current facebook user is associated with a vb user, and returns vb userid if so
vB_Api_Facebook::getFbProfileUrl() — Method in class vB_Api_Facebook
Get the logged in user's profile url.
vB_Api_Facebook::getFbProfilePicUrl() — Method in class vB_Api_Facebook
Get the logged in user's profile picture url.
vB_Api_Facebook::getFbUserInfo() — Method in class vB_Api_Facebook
Grabs logged in user info from faceboook if user is logged in
vB_Api_Facebook::getAllUserInfo() — Method in class vB_Api_Facebook
Get the results from several functions in one call.
vB_Api_Follow::getUserList() — Method in class vB_Api_Follow
This gets the followers.
vB_Api_Follow::getSubscribedDiscussion() — Method in class vB_Api_Follow
This gets the subscriptions to content nodes
vB_Api_Follow::getFollowers() — Method in class vB_Api_Follow
This lists all the current followers, based userid param or current users's userid
vB_Api_Follow::getFollowersForCurrentUser() — Method in class vB_Api_Follow
Gets the followers for the current user
vB_Api_Follow::getFollowing() — Method in class vB_Api_Follow
This lists what a user is following- the parameters, not the content
vB_Api_Follow::getFollowingChannels() — Method in class vB_Api_Follow
vB_Api_Follow::getFollowingActivities() — Method in class vB_Api_Follow
Get following activity
vB_Api_Follow::getFollowingUsers() — Method in class vB_Api_Follow
vB_Api_Follow::getFollowingUserActivities() — Method in class vB_Api_Follow
Get Following User Activities
vB_Api_Follow::getFollowingContent() — Method in class vB_Api_Follow
This lists the content for the user's set parameters
vB_Api_Follow::getContentFollowers() — Method in class vB_Api_Follow
Lists the users that are following the given content
vB_Api_Follow::getFollowingContentForTab() — Method in class vB_Api_Follow
Same as getFollowingContent but implements the 'seemore' button logic.
vB_Api_Follow::getFollowingForCurrentUser() — Method in class vB_Api_Follow
Gets the following for the current user. Uses $this->getFollowing
vB_Api_Follow::getFollowingInfo() — Method in class vB_Api_Follow
This gets the params needed for the getFollowing method from the pageInfo array data (query params).
vB_Api_Follow::getPaginationInfo() — Method in class vB_Api_Follow
vB_Api_Follow::getUnsubscribeText() — Method in class vB_Api_Follow
Gets the message type to be displayed for the unsubscribe overlay
vB_Api_Follow::getFollowingParameters() — Method in class vB_Api_Follow
This gets the following parameters- not the content
vB_Api_Follow::getNodeSubscribers() — Method in class vB_Api_Follow
Return all the subscribers from a given nodeid.
vB_Api_Follow::getSubscribersForNotifications() — Method in class vB_Api_Follow
Return the subscribers who should receive a notification for node $nodeid, excluding $skipUsers
vB_Api_Help::getTitles() — Method in class vB_Api_Help
fetches the help hierarchy, title phrases are included but text phrases are not
vB_Api_Help::getAnswers() — Method in class vB_Api_Help
fetches the FAQs item belonging to the given group under the "answers" key title and test phrases are included
vB_Api_Help::getAnswer() — Method in class vB_Api_Help
fetches one FAQ with the title and text phrases filled in
vB_Api_Hook::getHookList() — Method in class vB_Api_Hook
vB_Api_Hook::getHookProductList() — Method in class vB_Api_Hook
vB_Api_Hook::getXmlHooks() — Method in class vB_Api_Hook
vB_Api_Hook::getHookInfo() — Method in class vB_Api_Hook
vB_Api_Hv::generateToken() — Method in class vB_Api_Hv
Generate a HV token
vB_Api_Hv::getRecaptchaLanguage() — Method in class vB_Api_Hv
The recaptcha languages codes don't map perfectly to what vBulletin has. This translates from the user lang code to what recaptcha expects.
vB_Api_Node::getNode() — Method in class vB_Api_Node
gets one node.
vB_Api_Node::getNodes() — Method in class vB_Api_Node
Gets the node info for a list of nodes
vB_Api_Node::getNodeAttachments() — Method in class vB_Api_Node
Gets the attachment information for a node. Which may be empty.
vB_Api_Node::getNodeAttachmentsPublicInfo() — Method in class vB_Api_Node
Gets the "public" attachment information for a node. Which may be empty.
vB_Api_Node::getAttachmentPublicInfo() — Method in class vB_Api_Node
Gets the "public" attachment information for a single attachment. If the user cannot view this attachment, it will be empty. Depending on the cangetattachment or cangetimgattachment permissions, the returned data will be consumed to create an anchor, an image, or unparsed bbcode.
vB_Api_Node::getContentforNodes() — Method in class vB_Api_Node
Gets the content info for a list of nodes
vB_Api_Node::getFullContentforNodes() — Method in class vB_Api_Node
Gets the content info for a list of nodes
vB_Api_Node::getNodeContent() — Method in class vB_Api_Node
This gets a content record based on nodeid. Useful from ajax.
vB_Api_Node::getNodeFullContent() — Method in class vB_Api_Node
This gets a content record based on nodeid including channel and starter information.
vB_Api_Node::getQuoteFullContent() — Method in class vB_Api_Node
This gets a content record based on nodeid including channel and starter information.
vB_Api_Node::getAlbums() — Method in class vB_Api_Node
This returns all the albums in a channel. Those can be photogalleries or text with attachments.
vB_Api_Node::getMergePostsInfo() — Method in class vB_Api_Node
Validates whether nodes can be merged and returns merging info.
vB_Api_Node::getOptions() — Method in class vB_Api_Node
gets the node option bitfields
vB_Api_Node::getHostName() — Method in class vB_Api_Node
vB_Api_Node::getGuestChannels() — Method in class vB_Api_Node
Fetches a list of channels that guests can access. Basically a public access for getUserChannels() but only for userid 0.
vB_Api_Node::getCurrentUserChannels() — Method in class vB_Api_Node
Returns a list of channels that the current user can access.
vB_Api_Node::getUserChannels() — Method in class vB_Api_Node
vB_Api_Node::getChannelTree() — Method in class vB_Api_Node
This function builds the basic channel tree. This is global, without reference to depth or user permissions.
vB_Api_Node::getNodeReadTime() — Method in class vB_Api_Node
Returns the node read time for the current user and the given nodeid
vB_Api_Node::getFirstChildAfterTime() — Method in class vB_Api_Node
Returns the first immediate child node of the given node that was created after the given timestamp
vB_Api_Node::getNodeviews() — Method in class vB_Api_Node
Fetch nodeview count(s) for nodeid(s), used by mergeNodeviewsForTopics() below
vB_Api_Node::getPreviewOnly() — Method in class vB_Api_Node
Return only the safe data for a node for which previewonly is set
vB_Api_Node::getCreatepermissionsForEdit() — Method in class vB_Api_Node
Return the specified node's createpermissions for editing for the current user
vB_Api_Node::getCanDeleteForEdit() — Method in class vB_Api_Node
Return whether the user can delete the node or not. Used by createcontent controller
vB_Api_Node::getChannelStatistics() — Method in class vB_Api_Node
Returns channel statistics-- number of topics / posts.
vB_Api_Options::getSettingsXML() — Method in class vB_Api_Options
This function gets the settings for given product or vbulletin if not specified
vB_Api_Options::getGroupSettingsXML() — Method in class vB_Api_Options
This function gets a product or set vbulletin as default and prints the XML file for it's options.
vB_Api_Page::getPageNav() — Method in class vB_Api_Page
vB_Api_Page::getPagingInfo() — Method in class vB_Api_Page
Get pagination information for frontend use
vB_Api_Page::getURLs() — Method in class vB_Api_Page
vB_Api_Page::getOrphanedPagetemplates() — Method in class vB_Api_Page
vB_Api_Page::getAllCurrentModuleInstances() — Method in class vB_Api_Page
vB_Api_Page::getAllTabbedContainerSubModulesInstances() — Method in class vB_Api_Page
vB_Api_Page::getAllSubModulesInstances() — Method in class vB_Api_Page
vB_Api_Page::getQryCount() — Method in class vB_Api_Page
This returns the number and type of database asserts. This is similar to but a bit smaller than the number of queries executed.
vB_Api_Phrase::getLanguageid() — Method in class vB_Api_Phrase
Fetch the "best" languageid in the order of current session's languageid, the default languageid from datastore, or the master languageid (-1).
vB_Api_Phrase::getPhrases() — Method in class vB_Api_Phrase
Fetch raw phrases
vB_Api_Profile::getAllowedFonts() — Method in class vB_Api_Profile
return font information for profile customization
vB_Api_Profile::getDefaultAvatars() — Method in class vB_Api_Profile
Get the default avatars- creates the profile UI tab
vB_Api_Profile::getLanguages() — Method in class vB_Api_Profile
Get languages for current user settings
vB_Api_Profile::getStyles() — Method in class vB_Api_Profile
Get styles for current user settings
vB_Api_Profile::getMediaNav() — Method in class vB_Api_Profile
Lists the media navigationfor a user
vB_Api_Profile::getAlbum() — Method in class vB_Api_Profile
Returns the album data for presentation on the media detail page for either a node, or one of the two pseudo-Albums
vB_Api_Profile::getSlideshow() — Method in class vB_Api_Profile
vB_Api_Request::getRequestInfo() — Method in class vB_Api_Request
Returns an array of request information
vB_Api_Route::GetSpecialRoutes() — Method in class vB_Api_Route
vB_Api_Route::getRoute() — Method in class vB_Api_Route
Returns a matching route if available for $pathInfo
vB_Api_Route::getRouteByIdent() — Method in class vB_Api_Route
vB_Api_Route::getChannelConversationRoute() — Method in class vB_Api_Route
Returns the route id for the generic conversation route
vB_Api_Route::getAbsoluteNodeUrl() — Method in class vB_Api_Route
Get fullURL of a node. It appends frontendurl to the relative node route.
vB_Api_Route::getNodeUrl() — Method in class vB_Api_Route
Get URL of a node
vB_Api_Route::getUrl() — Method in class vB_Api_Route
Returns one URL
vB_Api_Route::getUrls() — Method in class vB_Api_Route
get the urls in one batch
vB_Api_Route::getHash() — Method in class vB_Api_Route
get a unique hash
vB_Api_Search::getCacheTTL() — Method in class vB_Api_Search
Returns the cache ttl in seconds
vB_Api_Search::getSearchResult() — Method in class vB_Api_Search
vB_Api_Search::getSearchResultsCriteria() — Method in class vB_Api_Search
Search for nodes
vB_Api_Search::getInitialNodes() — Method in class vB_Api_Search
Search for nodeids and returns the resultid as well as the page value
vB_Api_Search::getInitialResults() — Method in class vB_Api_Search
Search for nodes and returns the resultid as well as the page value
vB_Api_Search::getMoreNodes() — Method in class vB_Api_Search
Get the node_ids from a search resultId
vB_Api_Search::getMoreResults() — Method in class vB_Api_Search
Get the nodes from a search resultId
vB_Api_Search::getInfo() — Method in class vB_Api_Search
vB_Api_Search::getPageNumber() — Method in class vB_Api_Search
Get the page number where the specified node is at on the node list.
vB_Api_Search::getChannels() — Method in class vB_Api_Search
Returns the Channel structure
vB_Api_Search::getChannelFromTree() — Method in class vB_Api_Search
This takes the channel tree produced by getChannels, finds the specified channel recursively, then returns that channel's sub tree. Used internally by getChannels.
vB_Api_Search::getForumChannels() — Method in class vB_Api_Search
vB_Api_Search::getSearchableContentTypes() — Method in class vB_Api_Search
vB_Api_Search::get_good_words() — Method in class vB_Api_Search
vB_Api_Search::get_all_bad_words() — Method in class vB_Api_Search
vB_Api_Search::get_bad_words() — Method in class vB_Api_Search
vB_Api_Site::getSiteStatistics() — Method in class vB_Api_Site
Returns an array of general statistics for the site
vB_Api_SocialGroup::getSGChannel() — Method in class vB_Api_SocialGroup
vB_Api_SocialGroup::getMembersCount() — Method in class vB_Api_SocialGroup
Gets the number of members for the given blog channel
vB_Api_SocialGroup::getSGInfo() — Method in class vB_Api_SocialGroup
gets Get info on every SG Channel
vB_Api_SocialGroup::getSGOwnerPerms() — Method in class vB_Api_SocialGroup
Get the current user's permissions for own stuff (eg. Own groups, own discussions, own messages)
vB_Api_SocialGroup::getCategories() — Method in class vB_Api_SocialGroup
returns the category list- direct children of the social group channel
vB_Api_Style::getValidStyleFromPreference() — Method in class vB_Api_Style
Get the style from the list of preferences -- will check that the desired styles exist and are available for the user to
vB_Api_Style::generateStyle() — Method in class vB_Api_Style
vB_Api_Style::getThemeInfo() — Method in class vB_Api_Style
Returns an array of theme information if the user has permission.
vB_Api_Stylevar::get() — Method in class vB_Api_Stylevar
Fetches the value of the stylevar for the user $userid Pass 0 for userid to retrieve the stylevar for the current user If the stylevar is not customized for the specified user, the value from the default stylevar will be returned Pass false for $falback to limit the results to the custom stylevar only
vB_Api_Tags::getTagSynonyms() — Method in class vB_Api_Tags
Get synonyms of a given tag
vB_Api_Tags::getTagsList() — Method in class vB_Api_Tags
Gets the tag list from an specific node.
vB_Api_Tags::getNodeTags() — Method in class vB_Api_Tags
Get tags with full info (userid, tagid, tagtext) from node.
vB_Api_Tags::getAutocomplete() — Method in class vB_Api_Tags
vB_Api_Tags::getTags() — Method in class vB_Api_Tags
Get the tags
vB_Api_Tags::getExceptionFromErrors() — Method in class vB_Api_Tags
vB_Api_Template::getTemplateID() — Method in class vB_Api_Template
Get template ID by its template name and style id
vB_Api_Template::getTemplateIds() — Method in class vB_Api_Template
Get a list of template IDs by thier template names and style id
vB_Api_Template::getCssTemplateSbEditor() — Method in class vB_Api_Template
This is the counterpart to saveCssTemplateSbEditor(). Returns the template record, including template text and the textonly value.
vB_Api_Template::getTextonlyDS() — Method in class vB_Api_Template
gets the current textonly array
$vB_Api_User#groupInTopicProperty in class vB_Api_User
vB_Api_User::getGroupInTopic() — Method in class vB_Api_User
This returns a user's additional permissions from the groupintopic table
vB_Api_User::getModeratorsOf() — Method in class vB_Api_User
Returns a list of channels where this user is moderator
vB_Api_User::getMembersOf() — Method in class vB_Api_User
Returns a list of channels where this user is moderator
vB_Api_User::getCanCreate() — Method in class vB_Api_User
This is a wrapper for userContext getCanCreate- it returns the content types a user can create
vB_Api_User::getPrivacyConsentRequired() — Method in class vB_Api_User
Return if the privacy consent is required for the current session
vB_Api_User::getAutocomplete() — Method in class vB_Api_User
Returns suggested usernames for the username autocomplete popup menu.
vB_Api_User::getProfileFieldConditions() — Method in class vB_Api_User
vB_Api_User::generateMailingList() — Method in class vB_Api_User
Generates users mailing list for the given criteria.
vB_Api_User::getUsersFromCriteria() — Method in class vB_Api_User
Fetch users and info from a given user criteria Used for admincp - verticalresponse.
vB_Api_User::getUsertitleFromPosts() — Method in class vB_Api_User
Get the user title regarding the given posts.
vB_Api_User::getPrivacyOptions() — Method in class vB_Api_User
Mostly a getter for user privacy options.
vB_Api_User::getGitCanStart() — Method in class vB_Api_User
This likes the channels below a parent node where a user can create starters based on groupintopic
vB_Api_User::getPersonalData() — Method in class vB_Api_User
Returns a report on "personal information" for a user
vB_Api_UserGroup::getModeratorGroupId() — Method in class vB_Api_UserGroup
Returns the usergroupid for moderator group
vB_Api_UserGroup::getOwnerGroupId() — Method in class vB_Api_UserGroup
Returns the usergroupid for owner group
vB_Api_UserGroup::getMemberGroupId() — Method in class vB_Api_UserGroup
Returns the usergroupid for member group
vB_Api_UserGroup::getMultipleGroupIds() — Method in class vB_Api_UserGroup
Returns the usergroupids for multiple specified SYSGROUPID constants
vB_Api_Vb4_api::gotonewpost() — Method in class vB_Api_Vb4_api
Takes You to the first unread post of the thread or if there are no unread posts it takes you to the last post
vB_Api_Vb4_api::getnewtop() — Method in class vB_Api_Vb4_api
vB_Api_Vb4_facebook::getVbfromfacebook() — Method in class vB_Api_Vb4_facebook
Returns list of vbUser info about the list of facebook user ids
vB_Api_Vb4_notification::get() — Method in class vB_Api_Vb4_notification
Fetch unread notifications of the specified type, descending by date
vB_Api_Vb4_notification::getAbsoluteAvatarUrl() — Method in class vB_Api_Vb4_notification
vB_Api_Widget::getWidgetDefinition() — Method in class vB_Api_Widget
fetches the rows from the widgetdefinition table for a widgetid
vB_Api_Widget::getWidgetList() — Method in class vB_Api_Widget
Returns widget & widget definition data (e.g. for xml export)

H

vB_Api_Bbcode::hasBbcode() — Method in class vB_Api_Bbcode
Determines if the text contains bbcode.
vB_Api_Route::handleRouteExceptions() — Method in class vB_Api_Route
vB_Api_Template::history() — Method in class vB_Api_Template
Return editing history of a template, including old versions and diffs between versions
vB_Api_Template::historyByTemplateID() — Method in class vB_Api_Template
Return editing history of a template by its ID, including old versions and diffs between versions
vB_Api_User::hasPermissions() — Method in class vB_Api_User
Returns global permission value or specific value for a nodeid for current user.
vB_Api_User::havePermissions() — Method in class vB_Api_User
Returns permission values of a group of nodes for current user.

I

vB_Api_Api::init() — Method in class vB_Api_Api
Initializes an API client
vB_Api_Bbcode::initInfo() — Method in class vB_Api_Bbcode
Returns an array of bbcode parsing information. {see vB_Api_Bbcode::fetchTagList}
vB_Api_Blog::isBlogNode() — Method in class vB_Api_Blog
Determines if the given node is a blog-related node (blog entry).
vB_Api_Blog::isChannelModerator() — Method in class vB_Api_Blog
Indicates if the given user or current user is owner or mod from given channel.
vB_Api_Blog::isChannelMember() — Method in class vB_Api_Blog
Indicates if the current user is member of a given channelid
vB_Api_Content::isPublished() — Method in class vB_Api_Content
Determines if this record is in a published state
vB_Api_Content::isVisitorMessage() — Method in class vB_Api_Content
Determines whether a specific node is a visitor message
$vB_Api_Content_Attach#inlistProperty in class vB_Api_Content_Attach
$vB_Api_Content_Attach#imageHandlerProperty in class vB_Api_Content_Attach
vB_Api_Content_Attach::isImage() — Method in class vB_Api_Content_Attach
Returns an true of the extension & size requested would be treated as an image attachment
$vB_Api_Content_Infraction#infractionChannelProperty in class vB_Api_Content_Infraction
$vB_Api_Content_Photo#inlistProperty in class vB_Api_Content_Photo
$vB_Api_Content_Photo#imageHandlerProperty in class vB_Api_Content_Photo
$vB_Api_Extensions#infourlProperty in class vB_Api_Extensions
vB_Api_Facebook::isFacebookEnabled() — Method in class vB_Api_Facebook
Is facebook enabled on this site.
vB_Api_Follow::isFollowingUser() — Method in class vB_Api_Follow
This indicates if user is following user's profile page.
vB_Api_Follow::isFollowingContent() — Method in class vB_Api_Follow
This indicates if user is following content.
vB_Api_Language::import() — Method in class vB_Api_Language
Import a language
vB_Api_Node::inlinemodAuthCheck() — Method in class vB_Api_Node
Check whether current logged-in user is "authenticated" for moderation actions.
vB_Api_Node::incrementNodeview() — Method in class vB_Api_Node
Insert/Update nodeview for nodeid
vB_Api_Options::importSettingsXML() — Method in class vB_Api_Options
This function gets the settings for given product or vbulletin if not specified
vB_Api_Options::insertSetting() — Method in class vB_Api_Options
This function inserts a Settings value
vB_Api_Pmchat::isMessageParticipant() — Method in class vB_Api_Pmchat
Checks if current user is a recipient of $nodeid
vB_Api_Search::is_index_word() — Method in class vB_Api_Search
vB_Api_SocialGroup::isSGNode() — Method in class vB_Api_SocialGroup
Determines if the given node is a blog-related node (blog entry).
vB_Api_SocialGroup::isSGChannel() — Method in class vB_Api_SocialGroup
Determines if the given node is a Social group channel.
vB_Api_Style::insertStyle() — Method in class vB_Api_Style
Insert style
vB_Api_Stylevar::isProfileCustomized() — Method in class vB_Api_Stylevar
Check whether the profile page of an user is customized
vB_Api_Tags::insertTags() — Method in class vB_Api_Tags
vB_Api_Template::insert() — Method in class vB_Api_Template
Insert a new template
vB_Api_Template::insertReplacementVar() — Method in class vB_Api_Template
Insert a replacement var
vB_Api_User::isBanned() — Method in class vB_Api_User
Check whether a user is banned.
vB_Api_User::isBannedEmail() — Method in class vB_Api_User
Check whether an email address is banned from the forums
vB_Api_User::isMfaEnabled() — Method in class vB_Api_User
Gets whether or not the user has an enabled MFA record
vB_Api_User::inviteMembers() — Method in class vB_Api_User
Invites members to a given node channel passing either an array of userids or usernames.
vB_Api_Vb4_private::insertpm() — Method in class vB_Api_Vb4_private
vB_Api_Widget::isSystemWidget() — Method in class vB_Api_Widget

K

vB_Api_Options::killSetting() — Method in class vB_Api_Options
This function deletes specified settings
vB_Api_Tags::killTags() — Method in class vB_Api_Tags
vB_Api_User::killActivation() — Method in class vB_Api_User

L

vB_Api_Ad::listAdsByLocation() — Method in class vB_Api_Ad
Lists ads for a location
$vB_Api_Blog#libraryProperty in class vB_Api_Blog
vB_Api_Blog::leaveChannel() — Method in class vB_Api_Blog
Handles leave in special channels for the current or specified user.
$vB_Api_Content#libraryProperty in class vB_Api_Content
vB_Api_Content_Privatemessage::listFolders() — Method in class vB_Api_Content_Privatemessage
Lists the folders.
vB_Api_Content_Privatemessage::listMessages() — Method in class vB_Api_Content_Privatemessage
Lists messages for current user
vB_Api_Content_Privatemessage::listNotifications() — Method in class vB_Api_Content_Privatemessage
Lists notifications for current user
vB_Api_Content_Privatemessage::listSpecialPrivateMessages() — Method in class vB_Api_Content_Privatemessage
Lists messages for current user
vB_Api_Content_Privatemessage::listRequests() — Method in class vB_Api_Content_Privatemessage
Lists messages for current user
vB_Api_Extensions::loadAllExtensions() — Method in class vB_Api_Extensions
Loads an array of all extensions
$vB_Api_External#libraryProperty in class vB_Api_External
$vB_Api_ExternalLogin#libraryProperty in class vB_Api_ExternalLogin
$vB_Api_FCMessaging#libraryProperty in class vB_Api_FCMessaging
Instance of vB_Library_Notification
$vB_Api_Node#libraryProperty in class vB_Api_Node
vB_Api_Node::listNodeContent() — Method in class vB_Api_Node
lists the nodes that should be displayed on a specific page including content detail.
vB_Api_Node::listNodeFullContent() — Method in class vB_Api_Node
lists the nodes that should be displayed on a specific page including content detail.
vB_Api_Node::listNodeFullContentCount() — Method in class vB_Api_Node
Lists the "total count" that can be expected from a listNodeFullContent() call with infinite $perpage param.
vB_Api_Node::listAlbums() — Method in class vB_Api_Node
This returns a list of a user's albums
vB_Api_Node::listPendingPosts() — Method in class vB_Api_Node
Gets the list of unapproved posts for the current user
vB_Api_Node::listPendingPostsForCurrentUser() — Method in class vB_Api_Node
Function wrapper for listPendingPosts but used for current user.
$vB_Api_Notification#libraryProperty in class vB_Api_Notification
Instance of vB_Library_Notification
$vB_Api_Options#libraryProperty in class vB_Api_Options
$vB_Api_Phrase#libraryProperty in class vB_Api_Phrase
vB_Api_Product::loadProductJsRollups() — Method in class vB_Api_Product
Parsed list of js rollup files
vB_Api_Product::loadProductCssRollups() — Method in class vB_Api_Product
Parsed list of css rollup files
vB_Api_Product::loadProductCpnavFiles() — Method in class vB_Api_Product
Get list of cpnav files
$vB_Api_Reputation#libraryProperty in class vB_Api_Reputation
vB_Api_Site::loadHeaderNavbar() — Method in class vB_Api_Site
Gets the header navbar data
vB_Api_Site::loadFooterNavbar() — Method in class vB_Api_Site
Gets the footer navbar data
$vB_Api_State#locationProperty in class vB_Api_State
$vB_Api_Style#libraryProperty in class vB_Api_Style
vB_Api_Tags::logSearchTags() — Method in class vB_Api_Tags
Saves the seached for tags so we can build a search tag cloud based on it
$vB_Api_Template#libraryProperty in class vB_Api_Template
vB_Api_Template::loadLanguage() — Method in class vB_Api_Template
Preload basic language information we're going to need.
$vB_Api_User#libraryProperty in class vB_Api_User
$vB_Api_User#loadedAvatarUseridsProperty in class vB_Api_User
Array of userids that have already been used to batch-fetch avatar information
vB_Api_User::login() — Method in class vB_Api_User
Login a user
vB_Api_User::login2() — Method in class vB_Api_User
Login a user
vB_Api_User::loginSpecificUser() — Method in class vB_Api_User
Login a user for which we have the userid
vB_Api_User::loginExternal() — Method in class vB_Api_User
Log in via a third party provider.
vB_Api_User::logout() — Method in class vB_Api_User
Logout user
vB_Api_Vb4_Cms::list_category() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_Cms::list_section() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_Cms::list_author() — Method in class vB_Api_Vb4_Cms
vB_Api_Vb4_events::listing() — Method in class vB_Api_Vb4_events
vB_Api_Vb4_login::login() — Method in class vB_Api_Vb4_login
Login. Wraps user.login (because we need to do some mapi specific tasks)
vB_Api_Vb4_login::logout() — Method in class vB_Api_Vb4_login

M

$vB_Api_Ad#max_displayorderProperty in class vB_Api_Ad
vB_Api_Content_Privatemessage::moveMessage() — Method in class vB_Api_Content_Privatemessage
Moves a message to a different folder
$vB_Api_Extensions#minverProperty in class vB_Api_Extensions
$vB_Api_Extensions#maxverProperty in class vB_Api_Extensions
vB_Api_Node::moveNodes() — Method in class vB_Api_Node
Moves nodes to a new parent
vB_Api_Node::movePosts() — Method in class vB_Api_Node
DEPRECATED Move multiple posts to a new topic or to a new channel. Use moveNodes function.
vB_Api_Node::mergeTopics() — Method in class vB_Api_Node
Merge several topics into a target topic
vB_Api_Node::mergePosts() — Method in class vB_Api_Node
Performs the actual merging, using edited input from UI.
vB_Api_Node::markRead() — Method in class vB_Api_Node
Marks a node as read using the appropriate method.
vB_Api_Node::markReadMultiple() — Method in class vB_Api_Node
Mark multiple nodes read
vB_Api_Node::markUnreadMultiple() — Method in class vB_Api_Node
Mark multiple nodes unread
vB_Api_Node::markChannelsRead() — Method in class vB_Api_Node
Marks a channel, its child channels and all contained topics as read
vB_Api_Node::manageDeletedNode() — Method in class vB_Api_Node
Manages a deleted node regarding options being passed.
vB_Api_Node::mergeNodeviewsForTopics() — Method in class vB_Api_Node
Merges the nodeviews into the topics array, used by the display_Topics template
vB_Api_Node::mergePostedStatusForTopics() — Method in class vB_Api_Node
Merges "posted" info into the topics array, used by the display_Topics template.
vB_Api_Tags::mergeTags() — Method in class vB_Api_Tags
Merge tags from nodes.
vB_Api_Tags::moveTags() — Method in class vB_Api_Tags
Move tags from one node to another one.
vB_Api_Template::massMerge() — Method in class vB_Api_Template
Massive merge templates
$vB_Api_User#moderatorsOfProperty in class vB_Api_User
$vB_Api_User#membersOfProperty in class vB_Api_User
vB_Api_User::memberList() — Method in class vB_Api_User
Fetch a list of user based on the provided criteria
vB_Api_User::moderate() — Method in class vB_Api_User
Moderate users
vB_Api_User::merge() — Method in class vB_Api_User
Merge two users
vB_Api_Vb4_api::mobilepublisher() — Method in class vB_Api_Vb4_api
vB_Api_Vb4_newattachment::manageattach() — Method in class vB_Api_Vb4_newattachment
vB_Api_Vb4_private::movepm() — Method in class vB_Api_Vb4_private
vB_Api_Vb4_private::managepm() — Method in class vB_Api_Vb4_private
vB_Api_Vb4_private::messagelist() — Method in class vB_Api_Vb4_private
vB_Api_Vb4_visitormessage::message() — Method in class vB_Api_Vb4_visitormessage

N

$vB_Api_Content#nodeApiProperty in class vB_Api_Content
$vB_Api_Content_Privatemessage#notificationTypesProperty in class vB_Api_Content_Privatemessage
vB_Api_Cron::nextRun() — Method in class vB_Api_Cron
Returns the cron next run time.
vB_Api_User::needMFA() — Method in class vB_Api_User
Indicates if the current user needs to provide an MFA code for login.
vB_Api_User::needsCoppa() — Method in class vB_Api_User
This checks whether a user needs COPPA approval based on birthdate. Responds to Ajax call
vB_Api_Vb4_newreply::newreply() — Method in class vB_Api_Vb4_newreply
vB_Api_Vb4_newthread::newthread() — Method in class vB_Api_Vb4_newthread
$vB_Api_Widget#nonPlaceableWidgetCategoriesProperty in class vB_Api_Widget

O

$vB_Api_Content#optionsProperty in class vB_Api_Content
vB_Api_Content_Report::openClose() — Method in class vB_Api_Content_Report
Opens or closes reports
vB_Api_Node::openNode() — Method in class vB_Api_Node
opens a node for posting
vB_Api_Vb4_inlinemod::open() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_report::open() — Method in class vB_Api_Vb4_report
$vB_Api_Wol#onlineusersProperty in class vB_Api_Wol

P

vB_Api_Bbcode::parseWysiwygHtmlToBbcode() — Method in class vB_Api_Bbcode
Parses HTML produced by a WYSIWYG editor and produces the corresponding BBCode formatted text
vB_Api_Bbcode::parseSignature() — Method in class vB_Api_Bbcode
Fetches and parses to html a user's signature
vB_Api_Bbcode::parseSignatures() — Method in class vB_Api_Bbcode
Fetches and parses to html signatures
$vB_Api_Content_Channel#primarykeyProperty in class vB_Api_Content_Channel
$vB_Api_Content_Gallery#primarykeyProperty in class vB_Api_Content_Gallery
$vB_Api_Content_Link#providersProperty in class vB_Api_Content_Link
vB_Api_Content_Link::parsePage() — Method in class vB_Api_Content_Link
Parse HTML Page and get its title/meta and images
$vB_Api_Content_Photo#primarykeyProperty in class vB_Api_Content_Photo
We need the primary key field name.
$vB_Api_Content_Privatemessage#pmChannelProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::previewMessages() — Method in class vB_Api_Content_Privatemessage
Gets the preview for the messages
vB_Api_Cron::pruneLog() — Method in class vB_Api_Cron
Prune Cron
$vB_Api_Extensions#productProperty in class vB_Api_Extensions
$vB_Api_Extensions#ProductDependancyProperty in class vB_Api_Extensions
$vB_Api_Node#previewFieldsProperty in class vB_Api_Node
vB_Api_Node::publish() — Method in class vB_Api_Node
Validates permission and sets a node to published status
vB_Api_Page::pageSave() — Method in class vB_Api_Page
Saves a page based on page editor info
vB_Api_Page::preload() — Method in class vB_Api_Page
This preloads information for the current page.
vB_Api_Paidsubscription::placeOrder() — Method in class vB_Api_Paidsubscription
Place a subscription order
$vB_Api_Phrase#phrasecacheProperty in class vB_Api_Phrase
vB_Api_Phrase::parsePhrases() — Method in class vB_Api_Phrase
Handled output from query from fetch() and fetchByGroup()
vB_Api_Phrase::processOrphans() — Method in class vB_Api_Phrase
Process orphan phrases
vB_Api_Route::preloadRoutes() — Method in class vB_Api_Route
Preloads a list of routes to reduce database traffic
vB_Api_Tags::promoteTags() — Method in class vB_Api_Tags
vB_Api_Template::processReplacementVars() — Method in class vB_Api_Template
Process the replacement variables.
$vB_Api_User#permissionContextProperty in class vB_Api_User
$vB_Api_User#privacyOptionsProperty in class vB_Api_User
$vB_Api_User#pendingAvatarUseridsProperty in class vB_Api_User
An array of userids to batch-fetch avatar information for.
vB_Api_User::prune() — Method in class vB_Api_User
Do prune/move users (step 1)
vB_Api_User::pruneUpdateposts() — Method in class vB_Api_User
Do prune/move users (step 2). Userids to be updated are stored in adminutil table.
vB_Api_User::processPasswordResetLockout() — Method in class vB_Api_User
$vB_Api_UserGroup#privateGroupsProperty in class vB_Api_UserGroup
$vB_Api_Vb4_activity#perpageProperty in class vB_Api_Vb4_activity
Results per page
vB_Api_Vb4_album::picture() — Method in class vB_Api_Vb4_album
vB_Api_Vb4_blog::post_postcomment() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_blog::post_comment() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_blog::post_updateblog() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_blog::post_editblog() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_blog::post_newblog() — Method in class vB_Api_Vb4_blog
vB_Api_Vb4_newreply::postreply() — Method in class vB_Api_Vb4_newreply
vB_Api_Vb4_newthread::postthread() — Method in class vB_Api_Vb4_newthread
vB_Api_Vb4_poll::pollvote() — Method in class vB_Api_Vb4_poll
Votes on a poll
vB_Api_Vb4_private::parseRecipients() — Method in class vB_Api_Vb4_private
vB_Api_Vb4_register::parse_signed_facebook_request() — Method in class vB_Api_Vb4_register
vB_Api_Vb4_search::process() — Method in class vB_Api_Vb4_search
$vB_Api_Widget#preloadWidgetIdsProperty in class vB_Api_Widget
$vB_Api_Widget#pagetemplateidProperty in class vB_Api_Widget
vB_Api_Widget::preProcessConfigValues() — Method in class vB_Api_Widget
Pre-compiles a few specific config values for consumption in templates.

Q

vB_Api_Ad::quickSave() — Method in class vB_Api_Ad
Saves the active status and display orders for multiple ads

R

vB_Api_Ad::replaceAdTemplate() — Method in class vB_Api_Ad
Replaces ad code into correct template
vB_Api_Blog::removeChannelMember() — Method in class vB_Api_Blog
Handles removing a channel member
vB_Api_Blog::removeChannelModerator() — Method in class vB_Api_Blog
Handles removing a channel moderator
vB_Api_Content_Infraction::reverseInfraction() — Method in class vB_Api_Content_Infraction
Reverse an infraction
vB_Api_Content_Infraction::reverseNodeInfraction() — Method in class vB_Api_Content_Infraction
Reverses the infraction associated with the given node
vB_Api_Content_Link::rel2abs() — Method in class vB_Api_Content_Link
Function to convert relative URL to absolute given a base URL From http://bsd-noobz.com/blog/php-script-for-converting-relative-to-absolute-url
vB_Api_Content_Privatemessage::resetFolders() — Method in class vB_Api_Content_Privatemessage
Clears the cached folder information
vB_Api_Content_Redirect::removeRedirectsFromNode() — Method in class vB_Api_Content_Redirect
Remove redirects that point to this node
$vB_Api_Content_Report#reportChannelProperty in class vB_Api_Content_Report
vB_Api_Cron::run() — Method in class vB_Api_Cron
Run cron
vB_Api_Cron::runById() — Method in class vB_Api_Cron
Run a cron
vB_Api_Cron::runByVarname() — Method in class vB_Api_Cron
Run a cron
$vB_Api_Extensions#resultVarNameProperty in class vB_Api_Extensions
vB_Api_Extensions::resetExtensions() — Method in class vB_Api_Extensions
clears the loaded folders & extensions.
vB_Api_Follow::removeFollowing() — Method in class vB_Api_Follow
Removes following from channels or users including all posts related.
vB_Api_Follow::removeFollower() — Method in class vB_Api_Follow
This removes a follower from user.
vB_Api_Language::rebuild() — Method in class vB_Api_Language
Rebuld languages
vB_Api_Node::removeAttachment() — Method in class vB_Api_Node
delete one or more attachments
vB_Api_Node::requestChannel() — Method in class vB_Api_Node
This creates a request for access to a channel
vB_Api_Phrase::replace() — Method in class vB_Api_Phrase
Find and replace phrases in languages
vB_Api_Phrase::renderPhrases() — Method in class vB_Api_Phrase
Returns rendered phrases from phrase strings and/or data
vB_Api_Product::removeProducts() — Method in class vB_Api_Product
Disables or deletes a set of products (does not run any uninstall code.
vB_Api_Profile::resetAvatar() — Method in class vB_Api_Profile
$vB_Api_State#routeProperty in class vB_Api_State
vB_Api_Tags::removeTags() — Method in class vB_Api_Tags
Remove tags from an item Implements vB_Tag::deleteTag
vB_Api_Template::revertAllInStyle() — Method in class vB_Api_Template
Revert all templates in a style
$vB_Api_User#referralsProperty in class vB_Api_User
vB_Api_User::registerNeedAvatarForUsers() — Method in class vB_Api_User
Registers userids that we will later be fetching avatars for. If we register the userids here, they can be fetched in batches.
vB_Api_User::resetMfaSecret() — Method in class vB_Api_User
Reset the current user's MFA secret
vB_Api_UserGroup::removeLeader() — Method in class vB_Api_UserGroup
Remove usergroup leader from an usergroup
vB_Api_Vb4_subscription::removesubscription() — Method in class vB_Api_Vb4_subscription
vB_Api_Widget::renameWidget() — Method in class vB_Api_Widget
Rename custom widget
vB_Api_Wol::register() — Method in class vB_Api_Wol
Register an online action Example: vB_Api::instanceInternal('Wol')->register('viewing_x', array(array('nodeid', $nodeid)));
vB_Api_Wol::refreshUsers() — Method in class vB_Api_Wol

S

vB_Api_Ad::save() — Method in class vB_Api_Ad
Updates an existing ad or saves a new ad
vB_Api_Ad::saveNumberOfHeaderAds() — Method in class vB_Api_Ad
Saves the number of header ads to use (this can be 1 or 2)
vB_Api_Blog::subscribeChannel() — Method in class vB_Api_Blog
Handles subscription in special channels for the current user.
vB_Api_Blog::saveBlogSidebarModules() — Method in class vB_Api_Blog
Saves channel configuration for blog sidebar
vB_Api_Contactus::sendMail() — Method in class vB_Api_Contactus
Send contact us mail
vB_Api_Content_Attach::setLogo() — Method in class vB_Api_Content_Attach
Sets the main logo for a file
vB_Api_Content_Channel::switchForumCategory() — Method in class vB_Api_Content_Channel
Converts a channel from a forum to a category or vice versa.
vB_Api_Content_Event::splitUnixtimestamp() — Method in class vB_Api_Content_Event
$vB_Api_Content_Gallery#showSignatureProperty in class vB_Api_Content_Gallery
vB_Api_Content_Infraction::saveInfractionGroup() — Method in class vB_Api_Content_Infraction
Adds or updates an infraction group
vB_Api_Content_Privatemessage::setRead() — Method in class vB_Api_Content_Privatemessage
Sets a message to read
$vB_Api_Content_Text#showSignatureProperty in class vB_Api_Content_Text
vB_Api_Cron::save() — Method in class vB_Api_Cron
Insert a new cron or Update an existing cron
vB_Api_Cron::switchActive() — Method in class vB_Api_Cron
Toggle the enable/disable status of a cron
$vB_Api_Editor#smilieImagesProperty in class vB_Api_Editor
$vB_Api_Editor#smilieDescriptionsProperty in class vB_Api_Editor
$vB_Api_Editor#smilieCategoriesProperty in class vB_Api_Editor
$vB_Api_Editor#smilieDataProperty in class vB_Api_Editor
vB_Api_ExternalLogin::showExternalLoginButton() — Method in class vB_Api_ExternalLogin
vB_Api_ExternalLogin::showExternalRegistrationBlock() — Method in class vB_Api_ExternalLogin
vB_Api_FCMessaging::sendFCM() — Method in class vB_Api_FCMessaging
vB_Api_Filedata::sanitizeFiletype() — Method in class vB_Api_Filedata
Ensures that Sent in thumbnail type is valid
$vB_Api_Follow#subscriptionsProperty in class vB_Api_Follow
vB_Api_Help::searchTitles() — Method in class vB_Api_Help
Searches for keywords in the FAQ title and/or text
vB_Api_Hook::saveHook() — Method in class vB_Api_Hook
$vB_Api_Language#stylesProperty in class vB_Api_Language
vB_Api_Language::save() — Method in class vB_Api_Language
Insert or update language
vB_Api_Language::setDefault() — Method in class vB_Api_Language
Set language as default language
vB_Api_Mail::send() — Method in class vB_Api_Mail
sends a batch of emails
vB_Api_Node::setPublishDate() — Method in class vB_Api_Node
Sets the publishdate and (optionally) the unpublish date of a node
vB_Api_Node::setUnPublishDate() — Method in class vB_Api_Node
Sets the unpublish date
vB_Api_Node::setUnPublished() — Method in class vB_Api_Node
sets a node to not published
vB_Api_Node::setFeatured() — Method in class vB_Api_Node
sets a list of nodes to be featured
vB_Api_Node::setUnFeatured() — Method in class vB_Api_Node
sets a node list to be not featured
vB_Api_Node::setSticky() — Method in class vB_Api_Node
Sets or unsets the sticky field
vB_Api_Node::setApproved() — Method in class vB_Api_Node
Sets or unsets the approved field
vB_Api_Node::setApprovedPost() — Method in class vB_Api_Node
Approves a post. Since the publish date might be affected user will need moderate and publish posts permissions.
vB_Api_Node::setNodeOptions() — Method in class vB_Api_Node
Set the node options
vB_Api_Node::setNodePerms() — Method in class vB_Api_Node
Set the node special permissions
vB_Api_Node::showIp() — Method in class vB_Api_Node
Checks if ip should be shown
vB_Api_Page::saveTabbedContainerSubModules() — Method in class vB_Api_Page
vB_Api_Page::saveSubModules() — Method in class vB_Api_Page
vB_Api_Page::savePreCacheInfo() — Method in class vB_Api_Page
This saves preload information for the current page.
$vB_Api_Paidsubscription#subobjProperty in class vB_Api_Paidsubscription
$vB_Api_Phrase#stylesProperty in class vB_Api_Phrase
vB_Api_Phrase::search() — Method in class vB_Api_Phrase
Search phrases
vB_Api_Phrase::save() — Method in class vB_Api_Phrase
Add a new phrase or update an existing phrase
$vB_Api_Search#search_jsonProperty in class vB_Api_Search
$vB_Api_Search#showFilterListProperty in class vB_Api_Search
vB_Api_Session::startGuestSession() — Method in class vB_Api_Session
starts a new lightweight (no shutdown) guest session and returns the session object.
vB_Api_Site::saveHeaderNavbar() — Method in class vB_Api_Site
Stores the header navbar data.
vB_Api_Site::saveFooterNavbar() — Method in class vB_Api_Site
Stores the footer navbar data.
$vB_Api_SocialGroup#sgChannelProperty in class vB_Api_SocialGroup
vB_Api_SocialGroup::saveCategory() — Method in class vB_Api_SocialGroup
creates a new category
$vB_Api_State#segmentsProperty in class vB_Api_State
$vB_Api_State#stateProperty in class vB_Api_State
vB_Api_State::setRoute() — Method in class vB_Api_State
vB_Api_State::setLocation() — Method in class vB_Api_State
vB_Api_State::serverOverloaded() — Method in class vB_Api_State
Determines if the server is over the defined load limits
vB_Api_Style::setDefaultStyle() — Method in class vB_Api_Style
Sets the site default style
vB_Api_Stylevar::save() — Method in class vB_Api_Stylevar
Saves the stylevars specified in the array for the current user
vB_Api_Stylevar::save_default() — Method in class vB_Api_Stylevar
Saves the stylevars specified in the array as default style for the whole site
vB_Api_Tags::sortTagsByTagText() — Method in class vB_Api_Tags
Sort function for fetchTagsForTagNavigation
$vB_Api_Template#special_templatesProperty in class vB_Api_Template
vB_Api_Template::saveCssTemplateSbEditor() — Method in class vB_Api_Template
This is just a wrapper for delete, save, and update. The presentation layer doesn't actually know which is correct. This forces textonly = 1 if the user doesn't have 'canadmintemplates'.
vB_Api_Template::search() — Method in class vB_Api_Template
Search and fetch a list of templates
vB_Api_Template::searchAndReplace() — Method in class vB_Api_Template
Search and Replace templates.
vB_Api_Template::saveAllTemplatesToFile() — Method in class vB_Api_Template
vB_Api_User::setCurrentUserFlags() — Method in class vB_Api_User
Set current user flags to display or not certain user items.
vB_Api_User::setGroupInTopic() — Method in class vB_Api_User
This grants a user additional permissions in a specific channel, by adding to the groupintopic table
vB_Api_User::saveEmailPassword() — Method in class vB_Api_User
Shortcut to saving only email and password if user only has permission to modify password and email
vB_Api_User::save() — Method in class vB_Api_User
Insert or Update an user
vB_Api_User::sendActivateEmail() — Method in class vB_Api_User
vB_Api_User::saveSignature() — Method in class vB_Api_User
Verifies and saves a signature for current logged in user. Returns the signature.
vB_Api_User::searchIP() — Method in class vB_Api_User
Search IP Addresses
vB_Api_User::searchUsersByIP() — Method in class vB_Api_User
Search IP Addresses
vB_Api_User::setMfaEnabled() — Method in class vB_Api_User
Sets the users MFA record to enabled or disabled
vB_Api_User::setNewPassword() — Method in class vB_Api_User
Set a new password for a user. Used by "forgot password" function.
vB_Api_User::setDefaultAvatar() — Method in class vB_Api_User
This sets a user to use one of the default avatars.
vB_Api_User::setPrivacyConsent() — Method in class vB_Api_User
Set privacy consent and eu status for user
vB_Api_User::saveEditorState() — Method in class vB_Api_User
Saves the content entry UI editor "state" where state is the show/hide state of the following 3 content entry UIs: ckeditor toolbar, attachements panel, and smilies panel.
vB_Api_UserGroup::save() — Method in class vB_Api_UserGroup
Insert a new usergroup or update an existing usergroup
vB_Api_UserGroup::savePromotion() — Method in class vB_Api_UserGroup
Insert a new usergroup promotion or update an existing one
$vB_Api_Userrank#stylesProperty in class vB_Api_Userrank
vB_Api_Userrank::save() — Method in class vB_Api_Userrank
Insert a new user rank or update existing user rank
vB_Api_Vb4_Cms::sectionlist() — Method in class vB_Api_Vb4_Cms
$vB_Api_Vb4_activity#sectionProperty in class vB_Api_Vb4_activity
vB_Api_Vb4_inlinemod::stick() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::spamthread() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_private::sendemail() — Method in class vB_Api_Vb4_private
vB_Api_Vb4_private::showpm() — Method in class vB_Api_Vb4_private
vB_Api_Vb4_report::sendemail() — Method in class vB_Api_Vb4_report
vB_Api_Vb4_search::showresults() — Method in class vB_Api_Vb4_search
$vB_Api_Widget#sectionnumberProperty in class vB_Api_Widget
vB_Api_Widget::saveNewWidgetInstance() — Method in class vB_Api_Widget
vB_Api_Widget::saveWidgetinstanceContainerinstanceid() — Method in class vB_Api_Widget
vB_Api_Widget::saveAdminConfig() — Method in class vB_Api_Widget
Saves an admin widget configuration for the given widget instance
vB_Api_Widget::saveChannelConfig() — Method in class vB_Api_Widget
Saves a channel widget configuration for the given widget instance
vB_Api_Widget::saveDefaultConfig() — Method in class vB_Api_Widget
Saves the 'default' config for a widget; updates the widgetdefinitions default field currently only used for customized_copy widgets
vB_Api_Widget::saveChannel() — Method in class vB_Api_Widget
Saves (inserts/updates) one channel record. Used by {see saveChannelWidgetConfig, saveChannels}
vB_Api_Widget::saveChannelPageTemplate() — Method in class vB_Api_Widget
Creates a page template record for a channel. Used by {see saveChannelWidgetConfig, saveChannels}
vB_Api_Widget::saveChannels() — Method in class vB_Api_Widget
Recursively saves all channels in the Channel Widget Used by {see saveChannelWidgetConfig}
vB_Api_Widget::saveForums() — Method in class vB_Api_Widget
Saves the configuration for the Channel Widget, including creating/saving channels as necessary.
vB_Api_Widget::saveChannelWidgetConfig() — Method in class vB_Api_Widget
Saves the configuration for the Channel Widget, including creating/saving channels as necessary.
vB_Api_Widget::saveSearchWidgetConfig() — Method in class vB_Api_Widget
Saves the configuration for the Search Widget,

T

$vB_Api_Content_Attach#typesProperty in class vB_Api_Content_Attach
$vB_Api_Content_Attach#tablenameProperty in class vB_Api_Content_Attach
$vB_Api_Content_Channel#tablenameProperty in class vB_Api_Content_Channel
$vB_Api_Content_Event#tablenameProperty in class vB_Api_Content_Event
$vB_Api_Content_Event#textCountChangeProperty in class vB_Api_Content_Event
$vB_Api_Content_Event#textRequiredProperty in class vB_Api_Content_Event
$vB_Api_Content_Gallery#tablenameProperty in class vB_Api_Content_Gallery
$vB_Api_Content_Gallery#textCountChangeProperty in class vB_Api_Content_Gallery
$vB_Api_Content_Gallery#textRequiredProperty in class vB_Api_Content_Gallery
$vB_Api_Content_Infraction#tablenameProperty in class vB_Api_Content_Infraction
$vB_Api_Content_Link#tablenameProperty in class vB_Api_Content_Link
$vB_Api_Content_Link#textRequiredProperty in class vB_Api_Content_Link
$vB_Api_Content_Photo#tablenameProperty in class vB_Api_Content_Photo
The table for the type-specific data.
$vB_Api_Content_Photo#textCountChangeProperty in class vB_Api_Content_Photo
$vB_Api_Content_Poll#tablenameProperty in class vB_Api_Content_Poll
$vB_Api_Content_Poll#textCountChangeProperty in class vB_Api_Content_Poll
$vB_Api_Content_Poll#tableFieldsProperty in class vB_Api_Content_Poll
$vB_Api_Content_Poll#textRequiredProperty in class vB_Api_Content_Poll
$vB_Api_Content_Privatemessage#tablenameProperty in class vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::toTrashcan() — Method in class vB_Api_Content_Privatemessage
Moves a node to the trashcan. Wrapper for deleteMessage()
$vB_Api_Content_Redirect#tablenameProperty in class vB_Api_Content_Redirect
$vB_Api_Content_Report#tablenameProperty in class vB_Api_Content_Report
$vB_Api_Content_Text#tablenameProperty in class vB_Api_Content_Text
$vB_Api_Content_Text#textCountChangeProperty in class vB_Api_Content_Text
$vB_Api_Content_Text#textRequiredProperty in class vB_Api_Content_Text
$vB_Api_Content_Video#tablenameProperty in class vB_Api_Content_Video
$vB_Api_Content_Video#textRequiredProperty in class vB_Api_Content_Video
$vB_Api_Extensions#titleProperty in class vB_Api_Extensions
$vB_Api_Tags#tagsObjProperty in class vB_Api_Tags
$vB_Api_Vb4_activity#topChannelsProperty in class vB_Api_Vb4_activity
$vB_Api_Vb4_subscription#topChannelsProperty in class vB_Api_Vb4_subscription

U

vB_Api_Ad::updateAdCache() — Method in class vB_Api_Ad
Populates the ad cache properties $ad_cache and $ad_name_cache
vB_Api_Blog::userCanComment() — Method in class vB_Api_Blog
Returns whether current user can comment in the blog or not
$vB_Api_Content#usercontextProperty in class vB_Api_Content
vB_Api_Content::update() — Method in class vB_Api_Content
Updates a record
vB_Api_Content_Attach::upload() — Method in class vB_Api_Content_Attach
Uploads a file
vB_Api_Content_Attach::uploadPhoto() — Method in class vB_Api_Content_Attach
Uploads a photo. Only use for images.
vB_Api_Content_Attach::uploadProfilePicture() — Method in class vB_Api_Content_Attach
Uploads a file without dimension check - to be cropped later. Only use for images.
vB_Api_Content_Attach::uploadAttachment() — Method in class vB_Api_Content_Attach
Uploads an attachment
vB_Api_Content_Attach::uploadUrl() — Method in class vB_Api_Content_Attach
Upload an image based on the url
vB_Api_Content_Channel::update() — Method in class vB_Api_Content_Channel
Updates the given channel
vB_Api_Content_Event::update() — Method in class vB_Api_Content_Event
Updates a record
vB_Api_Content_Gallery::updateFromWeb() — Method in class vB_Api_Content_Gallery
Updates from a web save
vB_Api_Content_Infraction::update() — Method in class vB_Api_Content_Infraction
Cannot update an infraction
vB_Api_Content_Privatemessage::updateFolderTitle() — Method in class vB_Api_Content_Privatemessage
Updates the title
vB_Api_Content_Privatemessage::undeleteMessage() — Method in class vB_Api_Content_Privatemessage
Moves a message back to user inbox folder
vB_Api_Content_Redirect::update() — Method in class vB_Api_Content_Redirect
Redirect is not allowed to be updated.
vB_Api_Content_Report::update() — Method in class vB_Api_Content_Report
Report is not allowed to be updated.
vB_Api_Content_Text::update() — Method in class vB_Api_Content_Text
Updates a record
vB_Api_Cron::updateEnabled() — Method in class vB_Api_Cron
Update enable status of crons
vB_Api_Facebook::userIsLoggedIn() — Method in class vB_Api_Facebook
Checks if the current user is logged into facebook
$vB_Api_Follow#userFollowersProperty in class vB_Api_Follow
$vB_Api_Follow#userFollowingProperty in class vB_Api_Follow
$vB_Api_Follow#userListCacheProperty in class vB_Api_Follow
vB_Api_Follow::updateUser() — Method in class vB_Api_Follow
vB_Api_Follow::unsubscribeItems() — Method in class vB_Api_Follow
Unsubscribe items from user.
vB_Api_Hook::updateHookStatus() — Method in class vB_Api_Hook
vB_Api_Node::undeleteNodes() — Method in class vB_Api_Node
undeletes a set of nodes
vB_Api_Node::unPublish() — Method in class vB_Api_Node
Validates permission and sets a node to unpublished status
vB_Api_Node::unsetSticky() — Method in class vB_Api_Node
Unsets sticky field
vB_Api_Node::unapprove() — Method in class vB_Api_Node
Unsets the approved field
vB_Api_Options::updateSetting() — Method in class vB_Api_Options
This function updates specified settings
vB_Api_Options::updateValue() — Method in class vB_Api_Options
This updates a value in datastore settings
vB_Api_Options::updateAttachPath() — Method in class vB_Api_Options
This updates the attachpath value in datastore settings
vB_Api_Options::updateAttachSetting() — Method in class vB_Api_Options
This updates the attachpath value in datastore settings
vB_Api_Options::updateGroupSettings() — Method in class vB_Api_Options
This function updates group settings.
vB_Api_Page::updateNewPageRoute() — Method in class vB_Api_Page
Sets the route for the specified page to the specified routeid. Also appears to update the route records for channels associated with this page.
vB_Api_Profile::uploadUrl() — Method in class vB_Api_Profile
Upload an avatar from a URL and set it to be this user's custom avatar
vB_Api_Profile::upload() — Method in class vB_Api_Profile
Upload an avatar and set it as the user's profile image.
vB_Api_Reputation::unvote() — Method in class vB_Api_Reputation
Unvote a node
vB_Api_State::updateLoadavg() — Method in class vB_Api_State
$vB_Api_Style#userContextProperty in class vB_Api_Style
vB_Api_Style::updateStyle() — Method in class vB_Api_Style
Update style
vB_Api_Tags::updateUserTags() — Method in class vB_Api_Tags
Adds new tags and/or deletes tags (added by the current user) if they have removed them from the list
vB_Api_Tags::updateTags() — Method in class vB_Api_Tags
Sets the tag matching tag text (case insensitive) to the exact text given Used to fix case when merging tags.
vB_Api_Template::update() — Method in class vB_Api_Template
Update a template
vB_Api_Template::updateReplacementVar() — Method in class vB_Api_Template
Update the replacement text for a replacement var
$vB_Api_User#usersProperty in class vB_Api_User
$vB_Api_User#usertitleCacheProperty in class vB_Api_User
vB_Api_User::unsetGroupInTopic() — Method in class vB_Api_User
This removes additional permissions a user was given in a specific channel, by removing from the groupintopic table
vB_Api_User::updateAvatar() — Method in class vB_Api_User
Update avatar
vB_Api_User::updateSigPic() — Method in class vB_Api_User
Update profile picture
vB_Api_User::useCoppa() — Method in class vB_Api_User
This checks whether the site uses COPPA review
vB_Api_User::updateIgnorelist() — Method in class vB_Api_User
Updates the user ignore list
vB_Api_User::updateStatus() — Method in class vB_Api_User
Updates the user status
vB_Api_User::userTimeStrToUnixtimestamp() — Method in class vB_Api_User
vB_Api_User::unixtimestampToUserDateString() — Method in class vB_Api_User
vB_Api_User::updateGuestPrivacyConsent() — Method in class vB_Api_User
Updates guest privacy consent
$vB_Api_UserGroup#usergroupcacheProperty in class vB_Api_UserGroup
vB_Api_UserGroup::updateDisplayGroup() — Method in class vB_Api_UserGroup
Update user's display group
vB_Api_Vb4_album::updatealbum() — Method in class vB_Api_Vb4_album
vB_Api_Vb4_album::user() — Method in class vB_Api_Vb4_album
vB_Api_Vb4_editpost::updatepost() — Method in class vB_Api_Vb4_editpost
vB_Api_Vb4_inlinemod::unapproveattachments() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::unapproveposts() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::unapprovethread() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::undeleteposts() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::undeletethread() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod::unstick() — Method in class vB_Api_Vb4_inlinemod
vB_Api_Vb4_profile::updateavatar() — Method in class vB_Api_Vb4_profile
vB_Api_Vb4_profile::updatelist() — Method in class vB_Api_Vb4_profile

V

vB_Api_Ad
vB_Api_Ad Advertising API
vB_Api_Announcement
vB_Api_Announcement
vB_Api_Api
vB_Api_Api
vB_Api_Bbcode
vB_Api_Bbcode
vB_Api_Blog
vB_Api_Blog
vB_Api_Contactus
vB_Api_Contactus vBulletin Contact Us API
vB_Api_Content
vB_Api_Content
vB_Api_Content::verify_limits() — Method in class vB_Api_Content
Checks the "limit" permissions for this content item
vB_Api_ContentType
vB_Api_ContentType
vB_Api_Content_Attach
vB_Api_Content_Attach
vB_Api_Content_Channel
vB_Api_Content_Channel
vB_Api_Content_Channel::validateIcon() — Method in class vB_Api_Content_Channel
Checks the permissions to upload a channel icon
vB_Api_Content_Event
vB_Api_Content_Event
vB_Api_Content_Gallery
vB_Api_Content_Gallery
vB_Api_Content_Gallery::validateGalleryData() — Method in class vB_Api_Content_Gallery
Validates the gallery data
vB_Api_Content_Infraction
vB_Api_Content_Infraction
vB_Api_Content_Link
vB_Api_Content_link
vB_Api_Content_Photo
vB_Api_Content_Photo
vB_Api_Content_Photo::verify_limits() — Method in class vB_Api_Content_Photo
For checking the photo specific limits
vB_Api_Content_Photo::validateFileData() — Method in class vB_Api_Content_Photo
Validate filedata record
vB_Api_Content_Poll
vB_Api_Content_Poll
vB_Api_Content_Poll::vote() — Method in class vB_Api_Content_Poll
Vote on a Poll (for the current user)
vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage
vB_Api_Content_Privatemessage::validateRequest() — Method in class vB_Api_Content_Privatemessage
Verifies that the request exists and its valid.
vB_Api_Content_Redirect
vB_Api_Content_Redirect
vB_Api_Content_Report
vB_Api_Content_Report
vB_Api_Content_Text
vB_Api_Content_Text
vB_Api_Content_Video
vB_Api_Content_Video
vB_Api_Cron
vB_Api_Cron
vB_Api_Editor
vB_Api_Editor
vB_Api_Extensions
vB_Api_Extensions
$vB_Api_Extensions#versionProperty in class vB_Api_Extensions
vB_Api_External
vB_Api_External
vB_Api_External::validateOptions() — Method in class vB_Api_External
Validate external data options (vB_External_Export::$options) and set default values.
vB_Api_ExternalLogin
vB_Api_ExternalLogin
vB_Api_FCMessaging
vB_Api_FCMessaging
vB_Api_Facebook
vB_Api_Facebook
vB_Api_Filedata
vB_Api_Filedata
vB_Api_Follow
vB_Api_Follow
vB_Api_Follow::validate() — Method in class vB_Api_Follow
vB_Api_Follow::validateFollowInformation() — Method in class vB_Api_Follow
Validates the follow information passed.
vB_Api_Follow::validateFollower() — Method in class vB_Api_Follow
vB_Api_Help
vB_Api_FAQ
vB_Api_Hook
vB_Api_Hook
vB_Api_Hv
vB_Api_Hv vBulletin Human Verification API
vB_Api_Hv::verifyToken() — Method in class vB_Api_Hv
Verify a HV token and its answer
vB_Api_Icon
vB_Api_Icon
vB_Api_Language
vB_Api_Language
vB_Api_Logwrapper
vB_Api_Wrapper This class is just a wrapper for API classes so that exceptions can be handled and translated for the client.
vB_Api_Mail
vB_Api_Mail
vB_Api_Node
vB_Api_Node
vB_Api_Node::validateNodeList() — Method in class vB_Api_Node
Given a list of nodes, removes those the user can't see.
vB_Api_Node::validateMergePosts() — Method in class vB_Api_Node
Validates whether nodes can be merged and returns the merging info. If nodes cannot be merged, an error is returned.
vB_Api_Notice
vB_Api_Notice
vB_Api_Notification
vB_Api_Notification
vB_Api_Null
vB_Api_Null Dummy API class, does nothing, its used as a dummy class when a call is made to a none existent core class, which may exist as a custom API extension only.
vB_Api_Options
vB_Api_Options
vB_Api_Options::validateSettings() — Method in class vB_Api_Options
This function changes the search type for settings
vB_Api_Page
vB_Api_Page
vB_Api_PageTemplate
vB_Api_PageTemplate
vB_Api_Paidsubscription
vB_Api_Paidsubscription
vB_Api_Phrase
vB_Api_Phrase
vB_Api_Pmchat
vB_Api_Posthistory
vB_Api_Posthistory
vB_Api_Prefix
vB_Api_Prefix
vB_Api_Product
vB_Api_Product
vB_Api_Profile
vB_Api_Profile
vB_Api_Reputation
vB_Api_Reputation
vB_Api_Reputation::vote() — Method in class vB_Api_Reputation
Vote a node
vB_Api_Request
vB_Api_Request
vB_Api_Route
vB_Api_Route
vB_Api_ScreenLayout
vB_Api_ScreenLayout
vB_Api_Search
vB_Api_Search
vB_Api_Session
vB_Api_Session
vB_Api_Site
vB_Api_Site
vB_Api_SocialGroup
vB_Api_Socialgroup
vB_Api_State
vB_Api_State
vB_Api_Style
vB_Api_Style
vB_Api_Stylevar
vB_Api_Stylevar
vB_Api_Tags
vB_Api_Tags
vB_Api_Tags::validTags() — Method in class vB_Api_Tags
Checks if the taglist contains invalid tags
vB_Api_Template
vB_Api_Template
vB_Api_User
vB_Api_User
vB_Api_User::vBMktime() — Method in class vB_Api_User
translate a year/month/day/hour/minute to a Unix timestamp.
vB_Api_User::verifyFlashMessageSignature() — Method in class vB_Api_User
Verifies that a flash message passed through the URL is signed and valid
vB_Api_UserGroup
vB_Api_UserGroup
vB_Api_Userrank
vB_Api_Userrank
vB_Api_Vb4_Cms
vB_Api_Vb4_Cms
vB_Api_Vb4_activity
vB_Api_Vb4_activity
vB_Api_Vb4_ajax
vB_Api_Vb4_ajax
vB_Api_Vb4_album
vB_Api_Vb4_album
vB_Api_Vb4_api
vB_Api_Vb4_api
vB_Api_Vb4_blog
vB_Api_Vb4_blog
vB_Api_Vb4_editpost
vB_Api_Vb4_editpost
vB_Api_Vb4_events
vB_Api_Vb4_events
vB_Api_Vb4_facebook
vB_Api_Vb4_register
vB_Api_Vb4_forum
vB_Api_Vb4_forum
vB_Api_Vb4_forumdisplay
vB_Api_Vb4_forumdisplay
vB_Api_Vb4_inlinemod
vB_Api_Vb4_inlinemod
vB_Api_Vb4_login
vB_Api_Vb4_register
vB_Api_Vb4_member
vB_Api_Vb4_member
vB_Api_Vb4_misc
vB_Api_Vb4_misc
vB_Api_Vb4_newattachment
vB_Api_Vb4_newattachment
vB_Api_Vb4_newreply
vB_Api_Vb4_newreply
vB_Api_Vb4_newthread
vB_Api_Vb4_newthread
vB_Api_Vb4_notification
vB_Api_Vb4_notification
vB_Api_Vb4_poll
vB_Api_Vb4_poll
vB_Api_Vb4_postings
vB_Api_Vb4_postings
vB_Api_Vb4_private
vB_Api_Vb4_private
vB_Api_Vb4_profile
vB_Api_Vb4_profile
vB_Api_Vb4_register
vB_Api_Vb4_register
vB_Api_Vb4_report
vB_Api_Vb4_report
vB_Api_Vb4_search
vB_Api_Vb4_search
vB_Api_Vb4_showthread
vB_Api_Vb4_showthread
vB_Api_Vb4_subscription
vB_Api_Vb4_subscription
vB_Api_Vb4_subscription::viewsubscription() — Method in class vB_Api_Vb4_subscription
vB_Api_Vb4_visitormessage
vB_Api_Vb4_visitormessage
vB_Api_Widget
vB_Api_Widget
vB_Api_Wol
vB_Api_Wol Who is online API
vB_Api_Wrapper
vB_Api_Wrapper This class is just a wrapper for API classes so that exceptions can be handled and translated for the client.
vB_Api_Wrapper::validateCall() — Method in class vB_Api_Wrapper
This method prevents catchable fatal errors when calling the API with missing arguments

W

vB_Api_Ad::wrapAdTemplate() — Method in class vB_Api_Ad
Wraps an ad template in a div with the correct id
$vB_Api_Route#whitelistPrefixProperty in class vB_Api_Route
$vB_Api_Route#whitelistRouteProperty in class vB_Api_Route

_

vB_Api_Ad::__construct() — Method in class vB_Api_Ad
Constructor
vB_Api_Announcement::__construct() — Method in class vB_Api_Announcement
Constructor
vB_Api_Api::__construct() — Method in class vB_Api_Api
Constructor
vB_Api_Bbcode::__construct() — Method in class vB_Api_Bbcode
Constructor
vB_Api_Blog::__construct() — Method in class vB_Api_Blog
Constructor
vB_Api_Contactus::__construct() — Method in class vB_Api_Contactus
Constructor
vB_Api_Content::__construct() — Method in class vB_Api_Content
Constructor
vB_Api_ContentType::__construct() — Method in class vB_Api_ContentType
Constructor
vB_Api_Content_Attach::__construct() — Method in class vB_Api_Content_Attach
Constructor
vB_Api_Content_Channel::__construct() — Method in class vB_Api_Content_Channel
Normal constructor- protected to prevent direct instantiation
vB_Api_Content_Event::__construct() — Method in class vB_Api_Content_Event
Constructor, cannot be instantiated externally
vB_Api_Content_Gallery::__construct() — Method in class vB_Api_Content_Gallery
Normal constructor- protected to prevent direct instantiation
vB_Api_Content_Infraction::__construct() — Method in class vB_Api_Content_Infraction
Constructor, no direct instantiation
vB_Api_Content_Link::__construct() — Method in class vB_Api_Content_Link
Normal constructor- protected to prevent direct instantiation
vB_Api_Content_Photo::__construct() — Method in class vB_Api_Content_Photo
Normal constructor- protected to prevent direct instantiation
vB_Api_Content_Poll::__construct() — Method in class vB_Api_Content_Poll
Constructor, cannot be instantiated externally
vB_Api_Content_Privatemessage::__construct() — Method in class vB_Api_Content_Privatemessage
Constructor, no external instantiation.
vB_Api_Content_Redirect::__construct() — Method in class vB_Api_Content_Redirect
Constructor, no external instantiation.
vB_Api_Content_Report::__construct() — Method in class vB_Api_Content_Report
Constructor, no external instantiation.
vB_Api_Content_Text::__construct() — Method in class vB_Api_Content_Text
Normal constructor- protected to prevent direct instantiation
vB_Api_Content_Video::__construct() — Method in class vB_Api_Content_Video
Constructor, no external instantiation
vB_Api_Editor::__construct() — Method in class vB_Api_Editor
Constructor
vB_Api_Extensions::__construct() — Method in class vB_Api_Extensions
vB_Api_External::__construct() — Method in class vB_Api_External
vB_Api_ExternalLogin::__construct() — Method in class vB_Api_ExternalLogin
Constructor
vB_Api_FCMessaging::__construct() — Method in class vB_Api_FCMessaging
vB_Api_Follow::__construct() — Method in class vB_Api_Follow
vB_Api_Help::__construct() — Method in class vB_Api_Help
Initializes an Api Help object
vB_Api_Hook::__construct() — Method in class vB_Api_Hook
vB_Api_Hv::__construct() — Method in class vB_Api_Hv
vB_Api_Icon::__construct() — Method in class vB_Api_Icon
vB_Api_Icon::_writeDebugOutput() — Method in class vB_Api_Icon
Writes debugging output to the filesystem for AJAX calls
vB_Api_Language::__construct() — Method in class vB_Api_Language
vB_Api_Logwrapper::__construct() — Method in class vB_Api_Logwrapper
vB_Api_Logwrapper::__call() — Method in class vB_Api_Logwrapper
vB_Api_Node::__construct() — Method in class vB_Api_Node
vB_Api_Notice::__construct() — Method in class vB_Api_Notice
vB_Api_Notification::__construct() — Method in class vB_Api_Notification
vB_Api_Null::__construct() — Method in class vB_Api_Null
vB_Api_Options::__construct() — Method in class vB_Api_Options
vB_Api_Paidsubscription::__construct() — Method in class vB_Api_Paidsubscription
vB_Api_Phrase::__construct() — Method in class vB_Api_Phrase
vB_Api_Product::__construct() — Method in class vB_Api_Product
vB_Api_Profile::__construct() — Method in class vB_Api_Profile
vB_Api_Reputation::__construct() — Method in class vB_Api_Reputation
vB_Api_Request::__construct() — Method in class vB_Api_Request
vB_Api_Route::__construct() — Method in class vB_Api_Route
vB_Api_ScreenLayout::__construct() — Method in class vB_Api_ScreenLayout
vB_Api_State::__construct() — Method in class vB_Api_State
vB_Api_Style::__construct() — Method in class vB_Api_Style
vB_Api_Template::__construct() — Method in class vB_Api_Template
vB_Api_User::__construct() — Method in class vB_Api_User
Constructor
vB_Api_User::_processProfileFields() — Method in class vB_Api_User
Process Profile Fields for templates
vB_Api_User::_searchRegisterIP() — Method in class vB_Api_User
Rewrite function construct_ip_register_table()
vB_Api_User::_searchUserIP() — Method in class vB_Api_User
Rewrite function construct_user_ip_table()
vB_Api_User::_searchIPUsage() — Method in class vB_Api_User
Rewrite function construct_ip_usage_table()
vB_Api_UserGroup::__construct() — Method in class vB_Api_UserGroup
vB_Api_Widget::__construct() — Method in class vB_Api_Widget
vB_Api_Widget::_getNewPageTemplateId() — Method in class vB_Api_Widget
Generates a new page template ID for the new page template that that widgets are being configured for. Needed to be able to generate a widget instance ID for the new widget instance.
vB_Api_Widget::_getNewWidgetInstanceId() — Method in class vB_Api_Widget
Generates a new widget instance ID for the widget instance being configured.
vB_Api_Widget::_getWidgetInstance() — Method in class vB_Api_Widget
Returns stored widget instance data for the given widget instance ID
vB_Api_Widget::_getWidgetConfigFields() — Method in class vB_Api_Widget
Returns the configuration fields needed to configure a widget of this type.
vB_Api_Widget::_getWidgetDefinition() — Method in class vB_Api_Widget
Returns the config fields that define a widget
vB_Api_Widget::_getChannelSelectOptions() — Method in class vB_Api_Widget
Gets the channel select options for the 'ChannelSelect' config type
vB_Api_Widget::_doGetChannelSelectOptions() — Method in class vB_Api_Widget
Gets the channel select options for the 'ChannelSelect' config type Recursive function, only called from _getChannelSelectOptions
vB_Api_Widget::_getProfileFieldSelectOptions() — Method in class vB_Api_Widget
Gets the profile field select options for the 'ProfileFieldSelect' config type
vB_Api_Widget::_getContentTypeSelectOptions() — Method in class vB_Api_Widget
Gets the content type select options for the 'ContentTypeSelect' config type
vB_Api_Widget::_cmpWigetDefFields() — Method in class vB_Api_Widget
compare function for widget definition sorting
vB_Api_Widget::_writeDebugOutput() — Method in class vB_Api_Widget
Writes debugging output to the filesystem for AJAX calls
vB_Api_Wol::__construct() — Method in class vB_Api_Wol
vB_Api_Wrapper::__construct() — Method in class vB_Api_Wrapper
vB_Api_Wrapper::__call() — Method in class vB_Api_Wrapper