[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-templates/bp-legacy/ -> buddypress-functions.php (summary)

Functions of BuddyPress's Legacy theme.

Version: 3.1.0
File Size: 2013 lines (64 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_Legacy:: (44 methods):
  __construct()
  setup_globals()
  setup_actions()
  enqueue_styles()
  enqueue_scripts()
  locate_asset_in_stack()
  add_nojs_body_class()
  localize_scripts()
  sitewide_notices()
  secondary_avatars()
  theme_compat_page_templates()
  bp_legacy_theme_group_create_button()
  bp_legacy_theme_group_create_nav()
  bp_legacy_groups_admin_screen_hidden_input()
  bp_legacy_theme_blog_create_button()
  bp_legacy_theme_blog_create_nav()
  bp_legacy_theme_ajax_querystring()
  bp_legacy_theme_object_template_loader()
  bp_legacy_theme_messages_template_loader()
  bp_legacy_theme_invite_template_loader()
  bp_legacy_theme_requests_template_loader()
  bp_legacy_theme_activity_template_loader()
  bp_legacy_theme_post_update()
  bp_legacy_theme_new_activity_comment()
  bp_legacy_theme_delete_activity()
  bp_legacy_theme_delete_activity_comment()
  bp_legacy_theme_spam_activity()
  bp_legacy_theme_mark_activity_favorite()
  bp_legacy_theme_unmark_activity_favorite()
  bp_legacy_theme_get_single_activity_content()
  bp_legacy_theme_ajax_invite_user()
  bp_legacy_theme_ajax_addremove_friend()
  bp_legacy_theme_ajax_accept_friendship()
  bp_legacy_theme_ajax_reject_friendship()
  bp_legacy_theme_ajax_joinleave_group()
  bp_legacy_theme_ajax_close_notice()
  bp_legacy_theme_ajax_messages_send_reply()
  bp_legacy_theme_ajax_message_markunread()
  bp_legacy_theme_ajax_message_markread()
  bp_legacy_theme_ajax_messages_delete()
  bp_legacy_theme_ajax_messages_autocomplete_results()
  bp_legacy_theme_ajax_messages_star_handler()
  bp_legacy_theme_cover_image()
  bp_legacy_theme_group_manage_members_add_search()


Class: BP_Legacy  - X-Ref

Loads BuddyPress Legacy Theme functionality.

This is not a real theme by WordPress standards, and is instead used as the
fallback for any WordPress theme that does not have BuddyPress templates in it.

To make your custom theme BuddyPress compatible and customize the templates, you
can copy these files into your theme without needing to merge anything
together; BuddyPress should safely handle the rest.

See @link BP_Theme_Compat() for more.

__construct()   X-Ref
The main BuddyPress (Legacy) Loader.

since: 1.7.0

setup_globals()   X-Ref
Component global variables.

You'll want to customize the values in here, so they match whatever your
needs are.

since: 1.7.0

setup_actions()   X-Ref
Setup the theme hooks.

since: 1.7.0

enqueue_styles()   X-Ref
Load the theme CSS

since: 1.7.0
since: 2.3.0 Support custom CSS file named after the current theme or parent theme.

enqueue_scripts()   X-Ref
Enqueue the required JavaScript files

since: 1.7.0

locate_asset_in_stack( $file, $type = 'css', $script_handle = '' )   X-Ref
Get the URL and handle of a web-accessible CSS or JS asset

We provide two levels of customizability with respect to where CSS
and JS files can be stored: (1) the child theme/parent theme/theme
compat hierarchy, and (2) the "template stack" of /buddypress/css/,
/community/css/, and /css/. In this way, CSS and JS assets can be
overloaded, and default versions provided, in exactly the same way
as corresponding PHP templates.

We are duplicating some of the logic that is currently found in
bp_locate_template() and the _template_stack() functions. Those
functions were built with PHP templates in mind, and will require
refactoring in order to provide "stack" functionality for assets
that must be accessible both using file_exists() (the file path)
and at a public URI.

This method is marked private, with the understanding that the
implementation is subject to change or removal in an upcoming
release, in favor of a unified _template_stack() system. Plugin
and theme authors should not attempt to use what follows.

since: 1.8.0
return: array An array of data for the wp_enqueue_* function:
param: string $file A filename like buddypress.css.
param: string $type Optional. Either "js" or "css" (the default).
param: string $script_handle Optional. If set, used as the script name in `wp_enqueue_script`.

add_nojs_body_class( $classes )   X-Ref
Adds the no-js class to the body tag.

This function ensures that the <body> element will have the 'no-js' class by default. If you're
using JavaScript for some visual functionality in your theme, and you want to provide noscript
support, apply those styles to body.no-js.

The no-js class is removed by the JavaScript created in buddypress.js.

since: 1.7.0
return: array $classes
param: array $classes Array of classes to append to body tag.

localize_scripts()   X-Ref
Load localizations for topic script.

These localizations require information that may not be loaded even by init.

since: 1.7.0

sitewide_notices()   X-Ref
Outputs sitewide notices markup in the footer.

since: 1.7.0

secondary_avatars( $action, $activity )   X-Ref
Add secondary avatar image to this activity stream's record, if supported.

since: 1.7.0
return: string
param: string               $action   The text of this activity.
param: BP_Activity_Activity $activity Activity object.

theme_compat_page_templates( $templates = array()   X-Ref
Filter the default theme compatibility root template hierarchy, and prepend
a page template to the front if it's set.

since: 2.2.0
return: array
param: array $templates Array of templates.

bp_legacy_theme_group_create_button( $title )   X-Ref
Add the Create a Group button to the Groups directory title.

The bp-legacy puts the Create a Group button into the page title, to mimic
the behavior of bp-default.

since: 2.0.0
return: string
param: string $title Groups directory title.

bp_legacy_theme_group_create_nav()   X-Ref
Add the Create a Group nav to the Groups directory navigation.

The bp-legacy puts the Create a Group nav at the last position of
the Groups directory navigation.

since: 2.2.0

bp_legacy_groups_admin_screen_hidden_input()   X-Ref
Renders the group ID hidden input on group admin screens.

since: 2.7.0
return: string|null html

bp_legacy_theme_blog_create_button( $title )   X-Ref
Add the Create a Site button to the Sites directory title.

The bp-legacy puts the Create a Site button into the page title, to mimic
the behavior of bp-default.

since: 2.0.0
return: string
param: string $title Sites directory title.

bp_legacy_theme_blog_create_nav()   X-Ref
Add the Create a Site nav to the Sites directory navigation.

The bp-legacy puts the Create a Site nav at the last position of
the Sites directory navigation.

since: 2.2.0

bp_legacy_theme_ajax_querystring( $query_string, $object )   X-Ref
This function looks scarier than it actually is. :)
Each object loop (activity/members/groups/blogs/forums) contains default
parameters to show specific information based on the page we are currently
looking at.

The following function will take into account any cookies set in the JS and
allow us to override the parameters sent. That way we can change the results
returned without reloading the page.

By using cookies we can also make sure that user settings are retained
across page loads.

since: 1.2.0
return: string Query string for the component loops.
param: string $query_string Query string for the current request.
param: string $object       Object for cookie.

bp_legacy_theme_object_template_loader()   X-Ref
Load the template loop for the current object.

since: 1.2.0
return: string|null Prints template loop for the specified object

bp_legacy_theme_messages_template_loader()   X-Ref
Load messages template loop when searched on the private message page

since: 1.6.0
return: string|null Prints template loop for the Messages component.

bp_legacy_theme_invite_template_loader()   X-Ref
Load group invitations loop to handle pagination requests sent via AJAX.

since: 2.0.0

bp_legacy_theme_requests_template_loader()   X-Ref
Load group membership requests loop to handle pagination requests sent via AJAX.

since: 2.0.0

bp_legacy_theme_activity_template_loader()   X-Ref
Load the activity loop template when activity is requested via AJAX.

since: 1.2.0
return: string|null JSON object containing 'contents' (output of the template loop

bp_legacy_theme_post_update()   X-Ref
Processes Activity updates received via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_new_activity_comment()   X-Ref
Posts new Activity comments received via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_delete_activity()   X-Ref
Deletes an Activity item received via a POST request.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_delete_activity_comment()   X-Ref
Deletes an Activity comment received via a POST request.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_spam_activity()   X-Ref
AJAX spam an activity item or comment.

since: 1.6.0
return: mixed String on error, void on success.

bp_legacy_theme_mark_activity_favorite()   X-Ref
Mark an activity as a favourite via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_unmark_activity_favorite()   X-Ref
Un-favourite an activity via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_get_single_activity_content()   X-Ref
Fetches an activity's full, non-excerpted content via a POST request.
Used for the 'Read More' link on long activity items.

since: 1.5.0
return: string|null HTML

bp_legacy_theme_ajax_invite_user()   X-Ref
Invites a friend to join a group via a POST request.

since: 1.2.0

bp_legacy_theme_ajax_addremove_friend()   X-Ref
Friend/un-friend a user via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_ajax_accept_friendship()   X-Ref
Accept a user friendship request via a POST request.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_ajax_reject_friendship()   X-Ref
Reject a user friendship request via a POST request.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_ajax_joinleave_group()   X-Ref
Join or leave a group when clicking the "join/leave" button via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_ajax_close_notice()   X-Ref
Close and keep closed site wide notices from an admin in the sidebar, via a POST request.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_ajax_messages_send_reply()   X-Ref
Send a private message reply to a thread via a POST request.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_ajax_message_markunread()   X-Ref
Mark a private message as unread in your inbox via a POST request.

No longer used.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_ajax_message_markread()   X-Ref
Mark a private message as read in your inbox via a POST request.

No longer used.

since: 1.2.0
return: mixed String on error, void on success.

bp_legacy_theme_ajax_messages_delete()   X-Ref
Delete a private message(s) in your inbox via a POST request.

No longer used.

since: 1.2.0
return: string|null HTML

bp_legacy_theme_ajax_messages_autocomplete_results()   X-Ref
AJAX handler for autocomplete.

Displays friends only, unless BP_MESSAGES_AUTOCOMPLETE_ALL is defined.

since: 1.2.0

bp_legacy_theme_ajax_messages_star_handler()   X-Ref
AJAX callback to set a message's star status.

since: 2.3.0

bp_legacy_theme_cover_image( $params = array()   X-Ref
BP Legacy's callback for the cover image feature.

since: 2.4.0
return: null|string An array to inform about the css handle to attach the css rules to
param: array $params the current component's feature parameters.

bp_legacy_theme_group_manage_members_add_search()   X-Ref
Add a search box to a single group's manage members screen.

since: 2.7.0
return: string|null HTML for the search form.



Generated: Thu Sep 19 01:01:39 2019 Cross-referenced by PHPXref 0.7.1