[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

Common functions

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

Defines 18 functions

  bp_nouveau_ajax_querystring()
  bp_nouveau_ajax_button()
  bp_nouveau_wrapper()
  bp_nouveau_register_sidebars()
  bp_nouveau_is_object_nav_in_sidebar()
  bp_nouveau_current_user_can()
  bp_nouveau_parse_hooked_dir_nav()
  bp_nouveau_parse_hooked_options()
  bp_nouveau_get_component_filters()
  bp_nouveau_get_temporary_setting()
  bp_nouveau_get_appearance_settings()
  bp_nouveau_customizer_grid_choices()
  bp_nouveau_sanitize_nav_order()
  bp_nouveau_theme_cover_image()
  bp_nouveau_get_user_feedback()
  bp_nouveau_get_signup_fields()
  bp_nouveau_get_submit_button()
  bp_nouveau_set_nav_item_order()

Functions
Functions that are not part of a class:

bp_nouveau_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.

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

bp_nouveau_ajax_button( $output = '', $button = null, $before = '', $after = '', $r = array()   X-Ref

return: string
since: 3.0.0

bp_nouveau_wrapper( $args = array()   X-Ref
Output HTML content into a wrapper.

since: 3.0.0
param: array $args {

bp_nouveau_register_sidebars()   X-Ref
Register the 2 sidebars for the Group & User default front page

since: 3.0.0

bp_nouveau_is_object_nav_in_sidebar()   X-Ref

return: bool
since: 3.0.0

bp_nouveau_current_user_can( $capability = '' )   X-Ref

return: bool
since: 3.0.0

bp_nouveau_parse_hooked_dir_nav( $hook = '', $component = '', $position = 99 )   X-Ref
Parse an html output to a list of component's directory nav item.

return: array A list of component's dir nav items
since: 3.0.0
param: string $hook      The hook to fire.
param: string $component The component nav belongs to.
param: int    $position  The position of the nav item.

bp_nouveau_parse_hooked_options( $hook = '', $filters = array()   X-Ref
Run specific "select filter" hooks to catch the options and build an array out of them

return: array
since: 3.0.0
param: string $hook
param: array  $filters

bp_nouveau_get_component_filters( $context = '', $component = '' )   X-Ref
Get Dropdawn filters for the current component of the one passed in params

return: array the dropdown filters
since: 3.0.0
param: string $context   'directory', 'user' or 'group'
param: string $component The BuddyPress component ID

bp_nouveau_get_temporary_setting( $option = '', $retval = false )   X-Ref
When previewing make sure to get the temporary setting of the customizer.
This is necessary when we need to get these very early.

return: mixed The value for the requested option.
since: 3.0.0
param: string $option the index of the setting to get.
param: mixed  $retval the value to use as default.

bp_nouveau_get_appearance_settings( $option = '' )   X-Ref
Get the BP Nouveau Appearance settings.

return: array|false|mixed
since: 3.0.0
param: string $option Leave empty to get all settings, specify a value for a specific one.
param: mixed          An array of settings, the value of the requested setting.

bp_nouveau_customizer_grid_choices( $type = 'option' )   X-Ref
Returns the choices for the Layout option of the customizer
or the list of corresponding css classes.

return: array The list of labels or classes preserving keys.
since: 3.0.0
param: string $type 'option' to get the labels, 'classes' to get the classes

bp_nouveau_sanitize_nav_order( $option = '' )   X-Ref
Sanitize a list of slugs to save it as an array

return: array An array of nav items slugs.
since: 3.0.0
param: string $option A comma separated list of nav items slugs.

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

return: string
since: 3.0.0
param: array $params Optional. The current component's feature parameters.

bp_nouveau_get_user_feedback( $feedback_id = '' )   X-Ref
All user feedback messages are available here

return: string|false The list of parameters for the message
since: 3.0.0
param: string $feedback_id The ID of the message.

bp_nouveau_get_signup_fields( $section = '' )   X-Ref
Get the signup fields for the requested section

return: array|false The list of signup fields for the requested section. False if not found.
since: 3.0.0
param: string $section Optional. The section of fields to get 'account_details' or 'blog_details'.

bp_nouveau_get_submit_button( $action = '' )   X-Ref
Get Some submit buttons data.

return: array|false The list of the submit button parameters for the requested action
since: 3.0.0
param: string $action The action requested.

bp_nouveau_set_nav_item_order( $nav = null, $order = array()   X-Ref
Reorder a BuddyPress item nav according to a given list of nav item slugs

return: bool True on success. False otherwise.
since: 3.0.0
param: object $nav         The BuddyPress Item Nav object to reorder
param: array  $order       A list of slugs ordered (eg: array( 'profile', 'activity', etc..) )
param: string $parent_slug A parent slug if it's a secondary nav we are reordering (case of the Groups single item)



Generated: Sat Sep 19 01:01:37 2020 Cross-referenced by PHPXref 0.7.1