[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-templates/bp-nouveau/includes/groups/ -> functions.php (summary)

Groups functions

Version: 10.0.0
File Size: 1303 lines (40 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 39 functions

  bp_nouveau_message_markup_wrapper()
  bp_nouveau_groups_register_scripts()
  bp_nouveau_groups_enqueue_scripts()
  bp_nouveau_groups_disallow_all_members_invites()
  bp_nouveau_is_groups_invitations_active()
  bp_nouveau_groups_localize_scripts()
  bp_nouveau_groups_get_inviter_ids()
  bp_nouveau_prepare_group_potential_invites_for_js()
  bp_nouveau_get_group_potential_invites()
  bp_nouveau_group_invites_create_steps()
  bp_nouveau_group_setup_nav()
  bp_nouveau_groups_invites_custom_message()
  bp_nouveau_prepare_group_for_js()
  bp_nouveau_groups_invites_restriction_nav()
  bp_nouveau_groups_invites_restriction_admin_nav()
  bp_nouveau_groups_screen_invites_restriction()
  bp_nouveau_restrict_rest_group_invite_to_friends()
  bp_nouveau_get_groups_directory_nav_items()
  bp_nouveau_get_groups_filters()
  bp_nouveau_groups_catch_button_args()
  bp_nouveau_get_hooked_group_meta()
  bp_nouveau_groups_do_group_boxes()
  bp_nouveau_groups_front_page_description()
  bp_nouveau_groups_customizer_sections()
  bp_nouveau_groups_customizer_settings()
  bp_nouveau_groups_customizer_controls()
  bp_nouveau_group_reset_front_template()
  bp_nouveau_group_locate_template_part()
  bp_nouveau_group_get_template_part()
  bp_nouveau_group_is_home_widgets()
  bp_nouveau_group_activity_widget_overrides()
  bp_nouveau_group_groups_widget_overrides()
  bp_nouveau_group_members_widget_overrides()
  bp_nouveau_groups_add_home_widget_filters()
  bp_nouveau_groups_remove_home_widget_filters()
  bp_nouveau_group_get_core_create_screens()
  bp_nouveau_group_get_core_manage_screens()
  bp_nouveau_groups_notification_filters()
  bp_nouveau_rest_group_invites_get_items_permissions_check()

Functions
Functions that are not part of a class:

bp_nouveau_message_markup_wrapper( $message, $type )   X-Ref
Provide a convenience function to add markup wrapper for message strings

param: string $message The message text string
param: string $type    The message type - 'error, 'info', 'warning', success'
since: 3.0
return: string

bp_nouveau_groups_register_scripts( $scripts = array()   X-Ref
Register Scripts for the Groups component

param: array $scripts Optional. The array of scripts to register.
since: 3.0.0
return: array The same array with the specific groups scripts.

bp_nouveau_groups_enqueue_scripts()   X-Ref
Enqueue the groups scripts

since: 3.0.0

bp_nouveau_groups_disallow_all_members_invites( $default = false )   X-Ref
Can all members be invited to join any group?

param: bool $default False to allow. True to disallow.
since: 3.0.0
return: bool

bp_nouveau_is_groups_invitations_active()   X-Ref
Activate the Groups invitations feature if any member can be invited.

param: bool True if any member can be invited. False otherwise.
since: 10.0.0

bp_nouveau_groups_localize_scripts( $params = array()   X-Ref
Localize the strings needed for the Group's Invite UI

param: array $params Associative array containing the JS Strings needed by scripts
since: 3.0.0
return: array The same array with specific strings for the Group's Invite UI if needed.

bp_nouveau_groups_get_inviter_ids( $user_id, $group_id )   X-Ref

since: 3.0.0

bp_nouveau_prepare_group_potential_invites_for_js( $user )   X-Ref

since: 3.0.0

bp_nouveau_get_group_potential_invites( $args = array()   X-Ref

since: 3.0.0

bp_nouveau_group_invites_create_steps( $steps = array()   X-Ref
Rename the Group invite step.

param: array $steps The Group create steps.
since: 3.0.0
since: 10.0.0 The function is no more creating a Group invite step.
return: array       The Group create steps.

bp_nouveau_group_setup_nav()   X-Ref
Rename the Group Invites nav.

since: 3.0.0
since: 10.0.0 The function is no longer creating a Group invite nav.

bp_nouveau_groups_invites_custom_message( $message = '' )   X-Ref
Includes a message into the sent invitation email.

param: string $message The message to send with the invite
since: 3.0.0

bp_nouveau_prepare_group_for_js( $item )   X-Ref
Format a Group for a json reply

since: 3.0.0

bp_nouveau_groups_invites_restriction_nav()   X-Ref
Group invites restriction settings navigation.

since: 3.0.0

bp_nouveau_groups_invites_restriction_admin_nav( $wp_admin_nav )   X-Ref
Group invites restriction settings Admin Bar navigation.

param: array $wp_admin_nav The list of settings admin subnav items.
since: 3.0.0
return: array The list of settings admin subnav items.

bp_nouveau_groups_screen_invites_restriction()   X-Ref
Group invites restriction screen.

since: 3.0.0

bp_nouveau_restrict_rest_group_invite_to_friends( $retval, $request )   X-Ref
Makes sure the BP REST API groups/invites endpoint respects invite restrictions.

param: bool|WP_Error   $retval  Whether the request can continue.
param: WP_REST_Request $request The request sent to the API.
since: 7.2.1
return: bool|WP_Error

bp_nouveau_get_groups_directory_nav_items()   X-Ref

since: 3.0.0

bp_nouveau_get_groups_filters( $context = '' )   X-Ref
Get Dropdown filters for the groups component

param: string $context 'directory' or 'user'
since: 3.0.0
return: array the filters

bp_nouveau_groups_catch_button_args( $button = array()   X-Ref
Catch the arguments for buttons

param: array $button The arguments of the button that BuddyPress is about to create.
since: 3.0.0
return: array An empty array to stop the button creation process.

bp_nouveau_get_hooked_group_meta()   X-Ref
Catch the content hooked to the 'bp_group_header_meta' action

since: 3.0.0
return: string|bool HTML Output if hooked. False otherwise.

bp_nouveau_groups_do_group_boxes()   X-Ref
Display the Widgets of Group extensions into the default front page?

since: 3.0.0
return: bool True to display. False otherwise.

bp_nouveau_groups_front_page_description()   X-Ref
Display description of the Group into the default front page?

since: 3.0.0
return: bool True to display. False otherwise.

bp_nouveau_groups_customizer_sections( $sections = array()   X-Ref
Add sections to the customizer for the groups component.

param: array $sections the Customizer sections to add.
since: 3.0.0
return: array the Customizer sections to add.

bp_nouveau_groups_customizer_settings( $settings = array()   X-Ref
Add settings to the customizer for the groups component.

param: array $settings Optional. The settings to add.
since: 3.0.0
return: array the settings to add.

bp_nouveau_groups_customizer_controls( $controls = array()   X-Ref
Add controls for the settings of the customizer for the groups component.

param: array $controls Optional. The controls to add.
since: 3.0.0
return: array the controls to add.

bp_nouveau_group_reset_front_template( $templates = array()   X-Ref
Add the default group front template to the front template hierarchy.

param: array           $templates Optional. The list of templates for the front.php template part.
param: BP_Groups_Group $group Optional. The group object.
since: 3.0.0
return: array The same list with the default front template if needed.

bp_nouveau_group_locate_template_part( $template = '' )   X-Ref
Locate a single group template into a specific hierarchy.

param: string $template Optional. The template part to get (eg: activity, members...).
since: 3.0.0
return: string The located template.

bp_nouveau_group_get_template_part( $template = '' )   X-Ref
Load a single group template part

param: string $template Optional. The template part to get (eg: activity, members...).
since: 3.0.0
return: string HTML output.

bp_nouveau_group_is_home_widgets()   X-Ref
Are we inside the Current group's default front page sidebar?

since: 3.0.0
return: bool True if in the group's home sidebar. False otherwise.

bp_nouveau_group_activity_widget_overrides( $args = array()   X-Ref
Filter the Latest activities Widget to only keep the one of the group displayed

param: array $args Optional. The Activities Template arguments.
since: 3.0.0
return: array The Activities Template arguments.

bp_nouveau_group_groups_widget_overrides( $args = array()   X-Ref
Filter the Groups widget to only keep the displayed group.

param: array $args Optional. The Groups Template arguments.
since: 3.0.0
return: array The Groups Template arguments.

bp_nouveau_group_members_widget_overrides( $args = array()   X-Ref
Filter the Members widgets to only keep members of the displayed group.

param: array $args Optional. The Members Template arguments.
since: 3.0.0
return: array The Members Template arguments.

bp_nouveau_groups_add_home_widget_filters()   X-Ref
Init the Group's default front page filters as we're in the sidebar

since: 3.0.0

bp_nouveau_groups_remove_home_widget_filters()   X-Ref
Remove the Group's default front page filters as we're no more in the sidebar

since: 3.0.0

bp_nouveau_group_get_core_create_screens( $id = '' )   X-Ref
Get the hook, nonce, and eventually a specific template for Core Group's create screens.

param: string $id Optional. The screen id
since: 3.0.0
return: mixed An array containing the hook dynamic part, the nonce, and eventually a specific template.

bp_nouveau_group_get_core_manage_screens( $id = '' )   X-Ref
Get the hook and nonce for Core Group's manage screens.

param: string $id Optional. The screen id
since: 3.0.0
return: mixed An array containing the hook dynamic part and the nonce.

bp_nouveau_groups_notification_filters()   X-Ref
Register notifications filters for the groups component.

since: 3.0.0

bp_nouveau_rest_group_invites_get_items_permissions_check( $retval, $request )   X-Ref
Makes sure the Nouveau specific behavior about Group invites visibility is applied to the REST API.

param: true|WP_Error   $retval  Whether the current user can list invites.
param: WP_REST_Request $request The request sent to the API.
since: 7.2.1
return: true|WP_Error Whether the current user can list invites.



Generated: Sat Apr 27 01:00:55 2024 Cross-referenced by PHPXref 0.7.1