[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

Common template tags

Version: 4.0.0
File Size: 2601 lines (69 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 80 functions

  bp_nouveau_hook()
  bp_nouveau_plugin_hook()
  bp_nouveau_friend_hook()
  bp_nouveau_template_message_classes()
  bp_nouveau_get_template_message_type()
  bp_nouveau_has_template_message()
  bp_nouveau_has_dismiss_button()
  bp_nouveau_dismiss_button_type()
  bp_nouveau_template_message()
  bp_nouveau_get_template_message()
  bp_nouveau_template_notices()
  bp_nouveau_user_feedback()
  bp_nouveau_before_loop()
  bp_nouveau_after_loop()
  bp_nouveau_pagination()
  bp_nouveau_loop_classes()
  bp_nouveau_get_loop_classes()
  bp_nouveau_loop_is_grid()
  bp_nouveau_loop_get_grid_columns()
  bp_dir_is_vert_layout()
  bp_nouveau_avatar_args()
  bp_nouveau_has_nav()
  bp_nouveau_nav_items()
  bp_nouveau_nav_item()
  bp_nouveau_nav_id()
  bp_nouveau_get_nav_id()
  bp_nouveau_nav_classes()
  bp_nouveau_get_nav_classes()
  bp_nouveau_nav_scope()
  bp_nouveau_get_nav_scope()
  bp_nouveau_nav_link()
  bp_nouveau_get_nav_link()
  bp_nouveau_nav_link_id()
  bp_nouveau_get_nav_link_id()
  bp_nouveau_nav_link_title()
  bp_nouveau_get_nav_link_title()
  bp_nouveau_nav_link_text()
  bp_nouveau_get_nav_link_text()
  bp_nouveau_nav_has_count()
  bp_nouveau_nav_count()
  bp_nouveau_get_nav_count()
  bp_nouveau_directory_type_navs_class()
  bp_nouveau_get_directory_type_navs_class()
  bp_nouveau_directory_list_class()
  bp_nouveau_get_directory_list_class()
  bp_nouveau_directory_nav_object()
  bp_nouveau_get_directory_nav_object()
  bp_nouveau_container_classes()
  bp_nouveau_get_container_classes()
  bp_nouveau_single_item_nav_classes()
  bp_nouveau_get_single_item_nav_classes()
  bp_nouveau_single_item_subnav_classes()
  bp_nouveau_get_single_item_subnav_classes()
  bp_nouveau_groups_create_steps_classes()
  bp_nouveau_get_group_create_steps_classes()
  bp_nouveau_get_search_primary_object()
  bp_nouveau_get_search_objects()
  bp_nouveau_search_container_class()
  bp_nouveau_search_object_data_attr()
  bp_nouveau_search_selector_id()
  bp_nouveau_search_selector_name()
  bp_nouveau_search_default_text()
  bp_nouveau_search_form()
  bp_nouveau_current_object()
  bp_nouveau_filter_container_id()
  bp_nouveau_get_filter_container_id()
  bp_nouveau_filter_id()
  bp_nouveau_get_filter_id()
  bp_nouveau_filter_label()
  bp_nouveau_get_filter_label()
  bp_nouveau_filter_component()
  bp_nouveau_filter_options()
  bp_nouveau_get_filter_options()
  bp_nouveau_get_customizer_link()
  bp_nouveau_signup_hook()
  bp_nouveau_activation_hook()
  bp_nouveau_signup_form()
  bp_nouveau_signup_privacy_policy_acceptance_section()
  bp_nouveau_submit_button()
  nouveau_error_template()

Functions
Functions that are not part of a class:

bp_nouveau_hook( $pieces = array()   X-Ref
Fire specific hooks at various places of templates

param: array $pieces The list of terms of the hook to join.
since: 3.0.0

bp_nouveau_plugin_hook( $suffix = '' )   X-Ref
Fire plugin hooks in the plugins.php template (Groups and Members single items)

param: string The suffix of the hook.
since: 3.0.0

bp_nouveau_friend_hook( $suffix = '' )   X-Ref
Fire friend hooks

param: string The suffix of the hook.
since: 3.0.0

bp_nouveau_template_message_classes()   X-Ref
Add classes to style the template notice/feedback message

since: 3.0.0

bp_nouveau_get_template_message_type()   X-Ref
Get the template notice/feedback message type

return: string The type of the notice. Defaults to error.
since: 3.0.0

bp_nouveau_has_template_message()   X-Ref
Checks if a template notice/feedback message is set

return: bool True if a template notice is set. False otherwise.
since: 3.0.0

bp_nouveau_has_dismiss_button()   X-Ref
Checks if the template notice/feedback message needs a dismiss button

return: bool True if a template notice needs a dismiss button. False otherwise.
since: 3.0.0

bp_nouveau_dismiss_button_type()   X-Ref
Ouptut the dismiss type.

$type is used to set the data-attr for the button.
'clear' is tested for & used to remove cookies, if set, in buddypress-nouveau.js.
Currently template_notices(BP) will take $type = 'clear' if button set to true.

since: 3.0.0

bp_nouveau_template_message()   X-Ref
Displays a template notice/feedback message.

since: 3.0.0

bp_nouveau_get_template_message()   X-Ref
Get the template notice/feedback message and make sure core filter is applied.

return: string HTML Output.
since: 3.0.0

bp_nouveau_template_notices()   X-Ref
Template tag to display feedback notices to users, if there are to display

since: 3.0.0

bp_nouveau_user_feedback( $feedback_id = '' )   X-Ref
Displays a feedback message to the user.

param: string $feedback_id The ID of the message to display
since: 3.0.0

bp_nouveau_before_loop()   X-Ref
Template tag to wrap the before component loop

since: 3.0.0

bp_nouveau_after_loop()   X-Ref
Template tag to wrap the after component loop

since: 3.0.0

bp_nouveau_pagination( $position )   X-Ref
Pagination for loops

param: string $position
since: 3.0.0

bp_nouveau_loop_classes()   X-Ref
Display the component's loop classes

return: string CSS class attributes (escaped).
since: 3.0.0

bp_nouveau_get_loop_classes()   X-Ref
Get the component's loop classes

return: string space separated value of classes.
since: 3.0.0

bp_nouveau_loop_is_grid()   X-Ref
Checks if the layout preferences is set to grid (2 or more columns).

return: bool True if loop is displayed in grid mod. False otherwise.
since: 3.0.0

bp_nouveau_loop_get_grid_columns()   X-Ref
Returns the number of columns of the layout preferences.

return: int The number of columns.
since: 3.0.0

bp_dir_is_vert_layout()   X-Ref
Return a bool check for component directory layout.

Checks if activity, members, groups, blogs has the vert nav layout selected.

return: bool
since: 3.0.0

bp_nouveau_avatar_args()   X-Ref
Get the full size avatar args.

return: array The avatar arguments.
since: 3.0.0

bp_nouveau_has_nav( $args = array()   X-Ref
Init the Navigation Loop and check it has items.

param: array $args {
return: bool True if the Nav contains items. False otherwise.
since: 3.0.0

bp_nouveau_nav_items()   X-Ref
Checks there are still nav items to display.

return: bool True if there are still items to display. False otherwise.
since: 3.0.0

bp_nouveau_nav_item()   X-Ref
Sets the current nav item and prepare the navigation loop to iterate to next one.

since: 3.0.0

bp_nouveau_nav_id()   X-Ref
Displays the nav item ID.

since: 3.0.0

bp_nouveau_get_nav_id()   X-Ref
Retrieve the ID attribute of the current nav item.

return: string the ID attribute.
since: 3.0.0

bp_nouveau_nav_classes()   X-Ref
Displays the nav item classes.

since: 3.0.0

bp_nouveau_get_nav_classes()   X-Ref
Retrieve a space separated list of classes for the current nav item.

return: string List of classes.
since: 3.0.0

bp_nouveau_nav_scope()   X-Ref
Displays the nav item scope.

since: 3.0.0

bp_nouveau_get_nav_scope()   X-Ref
Retrieve the specific scope for the current nav item.

return: string the specific scope of the nav.
since: 3.0.0

bp_nouveau_nav_link()   X-Ref
Displays the nav item URL.

since: 3.0.0

bp_nouveau_get_nav_link()   X-Ref
Retrieve the URL for the current nav item.

return: string The URL for the nav item.
since: 3.0.0

bp_nouveau_nav_link_id()   X-Ref
Displays the nav item link ID.

since: 3.0.0

bp_nouveau_get_nav_link_id()   X-Ref
Retrieve the id attribute of the link for the current nav item.

return: string The link id for the nav item.
since: 3.0.0

bp_nouveau_nav_link_title()   X-Ref
Displays the nav item link title.

since: 3.0.0

bp_nouveau_get_nav_link_title()   X-Ref
Retrieve the title attribute of the link for the current nav item.

return: string The link title for the nav item.
since: 3.0.0

bp_nouveau_nav_link_text()   X-Ref
Displays the nav item link html text.

since: 3.0.0

bp_nouveau_get_nav_link_text()   X-Ref
Retrieve the html text of the link for the current nav item.

return: string The html text for the nav item.
since: 3.0.0

bp_nouveau_nav_has_count()   X-Ref
Checks if the nav item has a count attribute.

return: bool
since: 3.0.0

bp_nouveau_nav_count()   X-Ref
Displays the nav item count attribute.

since: 3.0.0

bp_nouveau_get_nav_count()   X-Ref
Retrieve the count attribute for the current nav item.

return: int The count attribute for the nav item.
since: 3.0.0

bp_nouveau_directory_type_navs_class()   X-Ref
Displays the directory nav class.

since: 3.0.0

bp_nouveau_get_directory_type_navs_class()   X-Ref
Provides default nav wrapper classes.

Gets the directory component nav class.
Gets user selection Customizer options.

return: string
since: 3.0.0

bp_nouveau_directory_list_class()   X-Ref
Displays the directory nav item list class.

since: 3.0.0

bp_nouveau_get_directory_list_class()   X-Ref
Gets the directory nav item list class.

return: string
since: 3.0.0

bp_nouveau_directory_nav_object()   X-Ref
Displays the directory nav item object (data-bp attribute).

since: 3.0.0

bp_nouveau_get_directory_nav_object()   X-Ref
Gets the directory nav item object.

return: array
since: 3.0.0

bp_nouveau_container_classes()   X-Ref
Output main BuddyPress container classes.

return: string CSS classes
since: 3.0.0

bp_nouveau_get_container_classes()   X-Ref
Returns the main BuddyPress container classes.

return: string CSS classes
since: 3.0.0

bp_nouveau_single_item_nav_classes()   X-Ref
Output single item nav container classes

return: string CSS classes
since: 3.0.0

bp_nouveau_get_single_item_nav_classes()   X-Ref
Returns the single item nav container classes

return: string CSS classes
since: 3.0.0

bp_nouveau_single_item_subnav_classes()   X-Ref
Output single item subnav container classes.

return: string CSS classes
since: 3.0.0

bp_nouveau_get_single_item_subnav_classes()   X-Ref
Returns the single item subnav container classes.

return: string CSS classes
since: 3.0.0

bp_nouveau_groups_create_steps_classes()   X-Ref
Output the groups create steps classes.

return: string CSS classes
since: 3.0.0

bp_nouveau_get_group_create_steps_classes()   X-Ref
Returns the groups create steps customizer option choice class.

return: string CSS classes
since: 3.0.0

bp_nouveau_get_search_primary_object( $object = '' )   X-Ref
Get the search primary object

param: string $object Optional. The primary object.
return: string The primary object.
since: 3.0.0

bp_nouveau_get_search_objects( $objects = array()   X-Ref
Get The list of search objects (primary + secondary).

param: array $objects Optional. The list of objects.
return: array The list of objects.
since: 3.0.0

bp_nouveau_search_container_class()   X-Ref
Output the search form container classes.

since: 3.0.0

bp_nouveau_search_object_data_attr( $attr = '' )   X-Ref
Output the search form data-bp attribute.

param: string $attr The data-bp attribute.
return: string The data-bp attribute.
since: 3.0.0

bp_nouveau_search_selector_id( $suffix = '', $sep = '-' )   X-Ref
Output a selector ID.

param: string $suffix Optional. A string to append at the end of the ID.
param: string $sep    Optional. The separator to use between each token.
return: string The selector ID.
since: 3.0.0

bp_nouveau_search_selector_name( $suffix = '', $sep = '_' )   X-Ref
Output the name attribute of a selector.

param: string $suffix Optional. A string to append at the end of the name.
param: string $sep    Optional. The separator to use between each token.
return: string The name attribute of a selector.
since: 3.0.0

bp_nouveau_search_default_text( $text = '', $is_attr = true )   X-Ref
Output the default search text for the search object

param: string $text    Optional. The default search text for the search object.
param: string $is_attr Optional. True if it's to be output inside an attribute. False Otherwise.
return: string The default search text.
since: 3.0.0

bp_nouveau_search_form()   X-Ref
Get the search form template part and fire some do_actions if needed.

since: 3.0.0

bp_nouveau_current_object()   X-Ref
Get the current component or action.

If on single group screens we need to switch from component to bp_current_action() to add the correct
IDs/labels for group/activity & similar screens.

since: 3.0.0

bp_nouveau_filter_container_id()   X-Ref
Output data filter container's ID attribute value.

since: 3.0.0

bp_nouveau_get_filter_container_id()   X-Ref
Get data filter container's ID attribute value.

param: string
since: 3.0.0

bp_nouveau_filter_id()   X-Ref
Output data filter's ID attribute value.

since: 3.0.0

bp_nouveau_get_filter_id()   X-Ref
Get data filter's ID attribute value.

param: string
since: 3.0.0

bp_nouveau_filter_label()   X-Ref
Output data filter's label.

since: 3.0.0

bp_nouveau_get_filter_label()   X-Ref
Get data filter's label.

param: string
since: 3.0.0

bp_nouveau_filter_component()   X-Ref
Output data filter's data-bp-filter attribute value.

since: 3.0.0

bp_nouveau_filter_options()   X-Ref
Output the <option> of the data filter's <select> element.

since: 3.0.0

bp_nouveau_get_filter_options()   X-Ref
Get the <option> of the data filter's <select> element.

return: string
since: 3.0.0

bp_nouveau_get_customizer_link( $args = array()   X-Ref
Get a link to reach a specific section into the customizer

param: array $args Optional. The argument to customize the Customizer link.
return: string HTML.
since: 3.0.0

bp_nouveau_signup_hook( $when = '', $prefix = '' )   X-Ref
Fire specific hooks into the register template

param: string $when   'before' or 'after'
param: string $prefix Use it to add terms before the hook name
since: 3.0.0

bp_nouveau_activation_hook( $when = '', $suffix = '' )   X-Ref
Fire specific hooks into the activate template

param: string $when   'before' or 'after'
param: string $prefix Use it to add terms before the hook name
since: 3.0.0

bp_nouveau_signup_form( $section = 'account_details' )   X-Ref
Output the signup form for the requested section

param: string $section Optional. The section of fields to get 'account_details' or 'blog_details'.
since: 3.0.0

bp_nouveau_signup_privacy_policy_acceptance_section()   X-Ref
Outputs the Privacy Policy acceptance area on the registration page.

since: 4.0.0

bp_nouveau_submit_button( $action )   X-Ref
Output a submit button and the nonce for the requested action.

param: string $action The action to get the submit button for. Required.
since: 3.0.0

nouveau_error_template( $message = '', $type = '' )   X-Ref
Display supplemental error or feedback messages.

This template handles in page error or feedback messages e.g signup fields
'Username exists' type registration field error notices.

param: string $message required: the message to display.
param: string $type optional: the type of error message e.g 'error'.
since: 3.0.0



Generated: Thu Dec 5 01:01:36 2019 Cross-referenced by PHPXref 0.7.1