phpDocumentor
Back to top  

Controller-Class for BuddyPressRead

 Methods

Returns an Array with all activities

activity_get_activities() : array

Parameters

pages

int

pages: number of pages to display (default unset)

offset

int

offset: number of entries per page (default 10 if pages is set, otherwise unset)

limit

int

limit: number of maximum results (default 0 for unlimited)

sort

String

sort: sort ASC or DESC (default DESC)

comments

String

comments: 'stream' for within stream display, 'threaded' for below each activity item (default unset)

userid

Int

userid: userID to filter on, comma-separated for more than one ID (default unset)

component

String

component: object to filter on e.g. groups, profile, status, friends (default unset)

type

String

type: action to filter on e.g. activity_update, profile_updated (default unset)

itemid

int

itemid: object ID to filter on e.g. a group_id or forum_id or blog_id etc. (default unset)

secondaryitemid

int

secondaryitemid: secondary object ID to filter on e.g. a post_id (default unset)

Returns

arrayactivities: an array containing the activities

Returns an array with friends for the given user

friends_get_friends() : array

Parameters

username

String

username: the username you want information from (required)

Returns

arrayfriends: array with the friends the user got

Returns an array with friendship requests for the given user

friends_get_friendship_request() : array

Parameters

username

String

username: the username you want information from (required)

Returns

arrayfriends: an array containing friends with some mor info

Returns a string with the status of friendship of the two users

friends_get_friendship_status() : string

Parameters

username

String

username: the username you want information from (required)

friendname

String

friendname: the name of the possible friend (required)

Returns

stringfriendshipstatus: 'is_friend', 'not_friends' or 'pending'

Returns an array containing info about the group forum

groupforum_get_forum() : array

Parameters

forumid

int

forumid: the forumid you are searching for (if not set, forumslug is searched; forumid or forumslug required)

forumslug

String

forumslug: the slug to search for (just used if forumid is not set; forumid or forumslug required)

Returns

arrayforums: the group forum with metainfo

Returns an array containing info about the group forum

groupforum_get_forum_by_group() : array

Parameters

groupid

int

groupid: the groupid you are searching for (if not set, groupslug is searched; groupid or groupslug required)

groupslug

String

groupslug: the slug to search for (just used if groupid is not set; groupid or groupslug required)

Returns

arrayforums: the group forum for the group

Returns an array containing the topics from a group's forum

groupforum_get_forum_topics() : array

Parameters

forumid

int

forumid: the forumid you are searching for (if not set, forumid is searched; forumid or forumslug required)

forumslug

String

forumslug: the forumslug to search for (just used if forumid is not set; forumid or forumslug required)

page

int

page: the page number you want to display (default 1)

per_page

int

per_page: the number of results you want per page (default 15)

type

String

type: newest, popular, unreplied, tag (default newest)

taqgname

String

tagname: just used if type = tag

detailed

boolean

detailed: true for detailed view (default false)

Returns

arraytopics: all the group forum topics found

Returns an array containing the posts from a group's forum

groupforum_get_topic_posts() : array

Parameters

topicid

int

topicid: the topicid you are searching for (if not set, topicslug is searched; topicid or topicslug required)

topicslug

String

topicslug: the slug to search for (just used if topicid is not set; topicid or topicslugs required)

page

int

page: the page number you want to display (default 1)

per_page

int

per_page: the number of results you want per page (default 15)

order

String

order: desc for descending or asc for ascending (default asc)

Returns

arrayposts: all the group forum posts found

Returns a boolean depending on an existing invite

groups_check_user_has_invite_to_group() : boolean

Parameters

username

String

username: the username you want information from (required)

groupid

int

groupid: the groupid you are searching for (if not set, groupslug is searched; groupid or groupslug required)

groupslug

String

groupslug: the slug to search for (just used if groupid is not set; groupid or groupslug required)

type

String

type: sent to check for sent invites, all to check for all

Returns

booleanis_invited: true if invited, else false

Returns a boolean depending on an existing memebership request

groups_check_user_membership_request_to_group() : boolean

Parameters

username

String

username: the username you want information from (required)

groupit

int

groupid: the groupid you are searching for (if not set, groupslug is searched; groupid or groupslug required)

groupslug

String

groupslug: the slug to search for (just used if groupid is not set; groupid or groupslug required)

Returns

booleanmembership_requested: true if requested, else false

Returns an array containing all admins for the given group

groups_get_group_admins() : array

Parameters

groupid

int

groupid: the groupid you are searching for (if not set, groupslug is searched; groupid or groupslug required)

groupslug

String

groupslug: the slug to search for (just used if groupid is not set; groupid or groupslug required)

Returns

arraygroup_admins: array containing the admins

Returns an array containing all members for the given group

groups_get_group_members() : array

Parameters

groupid

int

groupid: the groupid you are searching for (if not set, groupslug is searched; groupid or groupslug required)

groupslug

String

groupslug: the slug to search for (just used if groupid is not set; groupid or groupslug required)

limit

int

limit: maximum members displayed

Returns

arraygroup_members: group members with some more info

Returns an array containing all mods for the given group

groups_get_group_mods() : array

Parameters

groupid

int

groupid: the groupid you are searching for (if not set, groupslug is searched; groupid or groupslug required)

groupslug

String

groupslug: the slug to search for (just used if groupid is not set; groupid or groupslug required)

Returns

arraygroup_mods: array containing the mods

Returns an array with groups matching to the given parameters

groups_get_groups() : array

Parameters

username

String

username: the username you want information from (default => all groups)

show_hidden

Boolean

show_hidden: Show hidden groups to non-admins (default: false)

type

String

type: active, newest, alphabetical, random, popular, most-forum-topics or most-forum-posts (default active)

page

int

page: The page to return if limiting per page (default 1)

per_page

int

per_page: The number of results to return per page (default 20)

Returns

arraygroups: array with meta infos

Returns an array with messages for the current username

messages_get_messages() : array

Parameters

box

String

box: the box you the messages are in (possible values are 'inbox', 'sentbox', 'notices', default is 'inbox')

per_page

int

per_page: items to be displayed per page (default 10)

limit

boolean

limit: maximum numbers of emtries (default no limit)

Returns

arraymessages: contains the messages

Returns an array with notifications for the current user

notifications_get_notifications() : array

Returns

arraynotifications: the notifications as a link

Returns an array with the profile's fields

profile_get_profile() : array

Parameters

username

String

username: the username you want information from (required)

Returns

arrayprofilefields: an array containing the profilefields

Returns the settings for the current user

settings_get_settings() : object

Returns

objectsettings: an object full of the settings

Returns an array containing all sitewide forums

sitewideforum_get_all_forums() : array

Parameters

parentid

int

parentid: all children of the given id (default 0 = all)

Returns

arrayforums: all sitewide forums

Returns an array containing info about the sitewide forum

sitewideforum_get_forum() : array

Parameters

forumid

int

forumid: the forumid you are searching for (if not set, forumslug is searched; forumid or forumslug required)

forumslug

String

forumslug: the slug to search for (just used if forumid is not set; forumid or forumslug required)

Returns

arrayforums: sitewide forum with some infos

Returns an array containing all topics of a sitewide forum

sitewideforum_get_forum_topics() : array

Parameters

forumid

int

forumid: the forumid you are searching for (if not set, forumslug is searched; forumid or forumslug required)

forumslug

String

forumslug: the slug to search for (just used if forumid is not set; forumid or forumslug required)

display_content

boolean

display_content: set this to true if you want the content to be displayed too (default false)

Returns

arrayforums->topics: array of sitewide forums with the topics in it

Returns an array containing all replies to a topic from a sitewide forum

sitewideforum_get_topic_replies() : array

Parameters

topicid

int

topicid: the topicid you are searching for (if not set, topicslug is searched; topicid or topicsslug required)

topicslug

String

topicslug: the slug to search for (just used if topicid is not set; topicid or topicslug required)

display_content

boolean

display_content: set this to true if you want the content to be displayed too (default false)

Returns

arraytopics->replies: an array containing the replies