[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

/src/includes/extend/buddypress/ -> functions.php (summary)

Main bbPress BuddyPress Class

File Size: 908 lines (23 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 37 functions

  bbp_get_component_name()
  bbp_filter_user_id()
  bbp_filter_is_single_user()
  bbp_filter_is_user_home()
  bbp_filter_modify_page_title()
  bbp_member_forums_screen_topics()
  bbp_member_forums_screen_replies()
  bbp_member_forums_screen_engagements()
  bbp_member_forums_screen_favorites()
  bbp_member_forums_screen_subscriptions()
  bbp_member_forums_topics_content()
  bbp_member_forums_replies_content()
  bbp_member_forums_engagements_content()
  bbp_member_forums_favorites_content()
  bbp_member_forums_subscriptions_content()
  bbp_maybe_delete_group_forum_root()
  bbp_maybe_create_group_forum_root()
  bbp_get_group_forum_ids()
  bbp_get_forum_group_ids()
  bbp_update_group_forum_ids()
  bbp_update_forum_group_ids()
  bbp_add_group_id_to_forum()
  bbp_add_forum_id_to_group()
  bbp_remove_group_id_from_forum()
  bbp_remove_forum_id_from_group()
  bbp_remove_group_id_from_all_forums()
  bbp_remove_forum_id_from_all_groups()
  bbp_is_forum_group_forum()
  bbp_group_is_admin()
  bbp_group_is_mod()
  bbp_group_is_member()
  bbp_group_is_banned()
  bbp_group_is_creator()
  bbp_get_activity_actions()
  bbp_format_activity_action_new_post()
  bbp_format_activity_action_new_topic()
  bbp_format_activity_action_new_reply()

Functions
Functions that are not part of a class:

bbp_get_component_name()   X-Ref
Return component name/ID ('forums' by default)

This is used primarily for Notifications integration.

since: 2.6.0 bbPress (r5232)
return: string

bbp_filter_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false )   X-Ref
Filter the current bbPress user ID with the current BuddyPress user ID

since: 2.1.0 bbPress (r3552)
return: int User ID
param: int $user_id
param: bool $displayed_user_fallback
param: bool $current_user_fallback

bbp_filter_is_single_user( $is = false )   X-Ref
Filter the bbPress is_single_user function with BuddyPress equivalent

since: 2.1.0 bbPress (r3552)
return: bool True if viewing single user, false if not
param: bool $is Optional. Default false

bbp_filter_is_user_home( $is = false )   X-Ref
Filter the bbPress is_user_home function with BuddyPress equivalent

since: 2.1.0 bbPress (r3552)
return: bool True if viewing single user, false if not
param: bool $is Optional. Default false

bbp_filter_modify_page_title( $new_title = '', $old_title = '', $sep = '' )   X-Ref
Add the topic title to the <title> if viewing a single group forum topic

since: 2.5.0 bbPress (r5161)
return: string The possibly modified title
param: string $new_title The title to filter
param: string $old_title (Not used)
param: string $sep The separator to use

bbp_member_forums_screen_topics()   X-Ref
Hook bbPress topics template into plugins template

since: 2.1.0 bbPress (r3552)

bbp_member_forums_screen_replies()   X-Ref
Hook bbPress replies template into plugins template

since: 2.1.0 bbPress (r3552)

bbp_member_forums_screen_engagements()   X-Ref
Hook bbPress engagements template into plugins template

since: 2.6.0 bbPress (r6320)

bbp_member_forums_screen_favorites()   X-Ref
Hook bbPress favorites template into plugins template

since: 2.1.0 bbPress (r3552)

bbp_member_forums_screen_subscriptions()   X-Ref
Hook bbPress subscriptions template into plugins template

since: 2.1.0 bbPress (r3552)

bbp_member_forums_topics_content()   X-Ref
Get the topics created template part

since: 2.1.0 bbPress (r3552)

bbp_member_forums_replies_content()   X-Ref
Get the topics replied to template part

since: 2.1.0 bbPress (r3552)

bbp_member_forums_engagements_content()   X-Ref
Get the topic engagements template part

since: 2.6.0 bbPress (r6320)

bbp_member_forums_favorites_content()   X-Ref
Get the topics favorited template part

since: 2.1.0 bbPress (r3552)

bbp_member_forums_subscriptions_content()   X-Ref
Get the topics subscribed template part

since: 2.1.0 bbPress (r3552)

bbp_maybe_delete_group_forum_root( $forum_id = 0 )   X-Ref
Clean up the group root setting if the forum is being deleted

since: 2.6.0 bbPress (r6479)
param: int $forum_id The forum ID being deleted

bbp_maybe_create_group_forum_root()   X-Ref
Handle the new group forum root creation

since: 2.6.0 bbPress (r6479)
return:

bbp_get_group_forum_ids( $group_id = 0 )   X-Ref
Get forum ID's for a group

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_get_forum_group_ids( $forum_id = 0 )   X-Ref
Get group ID's for a forum

since: 2.1.0 bbPress (r3653)
param: int $forum_id

bbp_update_group_forum_ids( $group_id = 0, $forum_ids = array()   X-Ref
Get forum ID's for a group

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_update_forum_group_ids( $forum_id = 0, $group_ids = array()   X-Ref
Update group ID's for a forum

since: 2.1.0 bbPress (r3653)
param: int $forum_id

bbp_add_group_id_to_forum( $forum_id = 0, $group_id = 0 )   X-Ref
Add a group to a forum

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_add_forum_id_to_group( $group_id = 0, $forum_id = 0 )   X-Ref
Remove a forum from a group

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_remove_group_id_from_forum( $forum_id = 0, $group_id = 0 )   X-Ref
Remove a group from a forum

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_remove_forum_id_from_group( $group_id = 0, $forum_id = 0 )   X-Ref
Remove a forum from a group

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_remove_group_id_from_all_forums( $group_id = 0 )   X-Ref
Remove a group from all forums

since: 2.1.0 bbPress (r3653)
param: int $group_id

bbp_remove_forum_id_from_all_groups( $forum_id = 0 )   X-Ref
Remove a forum from all groups

since: 2.1.0 bbPress (r3653)
param: int $forum_id

bbp_is_forum_group_forum( $forum_id = 0 )   X-Ref
Return true if a forum is a group forum

since: 2.3.0 bbPress (r4571)
return: bool True if it is a group forum, false if not
param: int $forum_id

bbp_group_is_admin()   X-Ref
Is the current user an admin of the current group

since: 2.3.0 bbPress (r4632)
return: bool If current user is an admin of the current group

bbp_group_is_mod()   X-Ref
Is the current user a moderator of the current group

since: 2.3.0 bbPress (r4632)
return: bool If current user is a moderator of the current group

bbp_group_is_member()   X-Ref
Is the current user a member of the current group

since: 2.3.0 bbPress (r4632)
return: bool If current user is a member of the current group

bbp_group_is_banned()   X-Ref
Is the current user banned from the current group

since: 2.3.0 bbPress (r4632)
return: bool If current user is banned from the current group

bbp_group_is_creator()   X-Ref
Is the current user the creator of the current group

since: 2.3.0 bbPress (r4632)
return: bool If current user the creator of the current group

bbp_get_activity_actions()   X-Ref
Return an array of allowed activity actions

since: 2.6.0 bbPress (r6370)
return: array

bbp_format_activity_action_new_post( $type = '', $action = '', $activity = false )   X-Ref
Generic function to format the dynamic BuddyPress activity action for new
topics/replies.

since: 2.6.0 bbPress (r6370)
return: string The formatted activity action.
param: string               $type     The type of post. Expects `topic` or `reply`.
param: string               $action   The current action string.
param: BP_Activity_Activity $activity The BuddyPress activity object.

bbp_format_activity_action_new_topic( $action, $activity )   X-Ref
Formats the dynamic BuddyPress activity action for new topics.

since: 2.6.0 bbPress (r6370)
return: string The formatted activity action.
param: string $action   The current action string
param: object $activity The BuddyPress activity object

bbp_format_activity_action_new_reply( $action, $activity )   X-Ref
Formats the dynamic BuddyPress activity action for new replies.

since: 2.6.0 bbPress (r6370)
return: string The formatted activity action
param: string $action   The current action string
param: object $activity The BuddyPress activity object



Generated: Thu Dec 12 01:01:25 2019 Cross-referenced by PHPXref 0.7.1