[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-notifications/ -> bp-notifications-template.php (summary)

BuddyPress Notifications Template Functions.

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

Defines 49 functions

  bp_notifications_slug()
  bp_get_notifications_slug()
  bp_notifications_permalink()
  bp_get_notifications_permalink()
  bp_notifications_unread_permalink()
  bp_get_notifications_unread_permalink()
  bp_notifications_read_permalink()
  bp_get_notifications_read_permalink()
  bp_has_notifications()
  bp_the_notifications()
  bp_the_notification()
  bp_the_notification_id()
  bp_get_the_notification_id()
  bp_the_notification_item_id()
  bp_get_the_notification_item_id()
  bp_the_notification_secondary_item_id()
  bp_get_the_notification_secondary_item_id()
  bp_the_notification_component_name()
  bp_get_the_notification_component_name()
  bp_the_notification_component_action()
  bp_get_the_notification_component_action()
  bp_the_notification_date_notified()
  bp_get_the_notification_date_notified()
  bp_the_notification_time_since()
  bp_get_the_notification_time_since()
  bp_the_notification_description()
  bp_get_the_notification_description()
  bp_the_notification_mark_read_link()
  bp_get_the_notification_mark_read_link()
  bp_the_notification_mark_read_url()
  bp_get_the_notification_mark_read_url()
  bp_the_notification_mark_unread_link()
  bp_get_the_notification_mark_unread_link()
  bp_the_notification_mark_unread_url()
  bp_get_the_notification_mark_unread_url()
  bp_the_notification_mark_link()
  bp_get_the_notification_mark_link()
  bp_the_notification_delete_link()
  bp_get_the_notification_delete_link()
  bp_the_notification_delete_url()
  bp_get_the_notification_delete_url()
  bp_the_notification_action_links()
  bp_get_the_notification_action_links()
  bp_notifications_pagination_count()
  bp_get_notifications_pagination_count()
  bp_notifications_pagination_links()
  bp_get_notifications_pagination_links()
  bp_notifications_sort_order_form()
  bp_notifications_bulk_management_dropdown()

Functions
Functions that are not part of a class:

bp_notifications_slug()   X-Ref
Output the notifications component slug.

since: 1.9.0

bp_get_notifications_slug()   X-Ref
Return the notifications component slug.

since: 1.9.0
return: string Slug of the Notifications component.

bp_notifications_permalink( $user_id = 0 )   X-Ref
Output the notifications permalink for a user.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_notifications_permalink( $user_id = 0 )   X-Ref
Return the notifications permalink.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.
return: string Notifications permalink.

bp_notifications_unread_permalink( $user_id = 0 )   X-Ref
Output the unread notifications permalink for a user.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_notifications_unread_permalink( $user_id = 0 )   X-Ref
Return the unread notifications permalink.

param: int $user_id The user ID.
since: 2.6.0 Added $user_id as a parameter.
return: string Unread notifications permalink.

bp_notifications_read_permalink( $user_id = 0 )   X-Ref
Output the read notifications permalink for a user.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_notifications_read_permalink( $user_id = 0 )   X-Ref
Return the read notifications permalink.

since: 1.9.0
return: string Read notifications permalink.

bp_has_notifications( $args = '' )   X-Ref
Initialize the notifications loop.

Based on the $args passed, bp_has_notifications() populates
buddypress()->notifications->query_loop global, enabling the use of BP
templates and template functions to display a list of notifications.

param: array|string $args {
since: 1.9.0
return: bool

bp_the_notifications()   X-Ref
Get the notifications returned by the template loop.

since: 1.9.0
return: array List of notifications.

bp_the_notification()   X-Ref
Get the current notification object in the loop.

since: 1.9.0
return: object The current notification within the loop.

bp_the_notification_id()   X-Ref
Output the ID of the notification currently being iterated on.

since: 1.9.0

bp_get_the_notification_id()   X-Ref
Return the ID of the notification currently being iterated on.

since: 1.9.0
return: int ID of the current notification.

bp_the_notification_item_id()   X-Ref
Output the associated item ID of the notification currently being iterated on.

since: 1.9.0

bp_get_the_notification_item_id()   X-Ref
Return the associated item ID of the notification currently being iterated on.

since: 1.9.0
return: int ID of the item associated with the current notification.

bp_the_notification_secondary_item_id()   X-Ref
Output the secondary associated item ID of the notification currently being iterated on.

since: 1.9.0

bp_get_the_notification_secondary_item_id()   X-Ref
Return the secondary associated item ID of the notification currently being iterated on.

since: 1.9.0
return: int ID of the secondary item associated with the current notification.

bp_the_notification_component_name()   X-Ref
Output the name of the component associated with the notification currently being iterated on.

since: 1.9.0

bp_get_the_notification_component_name()   X-Ref
Return the name of the component associated with the notification currently being iterated on.

since: 1.9.0
return: int Name of the component associated with the current notification.

bp_the_notification_component_action()   X-Ref
Output the name of the action associated with the notification currently being iterated on.

since: 1.9.0

bp_get_the_notification_component_action()   X-Ref
Return the name of the action associated with the notification currently being iterated on.

since: 1.9.0
return: int Name of the action associated with the current notification.

bp_the_notification_date_notified()   X-Ref
Output the timestamp of the current notification.

since: 1.9.0

bp_get_the_notification_date_notified()   X-Ref
Return the timestamp of the current notification.

since: 1.9.0
return: string Timestamp of the current notification.

bp_the_notification_time_since()   X-Ref
Output the timestamp of the current notification.

since: 1.9.0

bp_get_the_notification_time_since()   X-Ref
Return the timestamp of the current notification.

since: 1.9.0
return: string Timestamp of the current notification.

bp_the_notification_description()   X-Ref
Output full-text description for a specific notification.

since: 1.9.0

bp_get_the_notification_description()   X-Ref
Get full-text description for a specific notification.

since: 1.9.0
return: string

bp_the_notification_mark_read_link( $user_id = 0 )   X-Ref
Output the mark read link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_mark_read_link( $user_id = 0 )   X-Ref
Return the mark read link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_mark_read_url( $user_id = 0 )   X-Ref
Output the URL used for marking a single notification as read.

Since this function directly outputs a URL, it is escaped.

param: int $user_id The user ID.
since: 2.1.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_mark_read_url( $user_id = 0 )   X-Ref
Return the URL used for marking a single notification as read.

param: int $user_id The user ID.
since: 2.1.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_mark_unread_link( $user_id = 0 )   X-Ref
Output the mark unread link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_mark_unread_link( $user_id = 0 )   X-Ref
Return the mark unread link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_mark_unread_url( $user_id = 0 )   X-Ref
Output the URL used for marking a single notification as unread.

Since this function directly outputs a URL, it is escaped.

param: int $user_id The user ID.
since: 2.1.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_mark_unread_url( $user_id = 0 )   X-Ref
Return the URL used for marking a single notification as unread.

param: int $user_id The user ID.
since: 2.1.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_mark_link( $user_id = 0 )   X-Ref
Output the mark link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_mark_link( $user_id = 0 )   X-Ref
Return the mark link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_delete_link( $user_id = 0 )   X-Ref
Output the delete link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_delete_link( $user_id = 0 )   X-Ref
Return the delete link for the current notification.

param: int $user_id The user ID.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_delete_url( $user_id = 0 )   X-Ref
Output the URL used for deleting a single notification.

Since this function directly outputs a URL, it is escaped.

param: int $user_id The user ID.
since: 2.1.0
since: 2.6.0 Added $user_id as a parameter.

bp_get_the_notification_delete_url( $user_id = 0 )   X-Ref
Return the URL used for deleting a single notification.

param: int $user_id The user ID.
since: 2.1.0
since: 2.6.0 Added $user_id as a parameter.
return: string

bp_the_notification_action_links( $args = '' )   X-Ref
Output the action links for the current notification.

param: array|string $args Array of arguments.
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter to $args.

bp_get_the_notification_action_links( $args = '' )   X-Ref
Return the action links for the current notification.

param: array|string $args {
since: 1.9.0
since: 2.6.0 Added $user_id as a parameter to $args.
return: string HTML links for actions to take on single notifications.

bp_notifications_pagination_count()   X-Ref
Output the pagination count for the current notification loop.

since: 1.9.0

bp_get_notifications_pagination_count()   X-Ref
Return the pagination count for the current notification loop.

since: 1.9.0
return: string HTML for the pagination count.

bp_notifications_pagination_links()   X-Ref
Output the pagination links for the current notification loop.

since: 1.9.0

bp_get_notifications_pagination_links()   X-Ref
Return the pagination links for the current notification loop.

since: 1.9.0
return: string HTML for the pagination links.

bp_notifications_sort_order_form()   X-Ref
Output the form for changing the sort order of notifications.

since: 1.9.0

bp_notifications_bulk_management_dropdown()   X-Ref
Output the dropdown for bulk management of notifications.

since: 2.2.0



Generated: Mon Dec 9 01:01:38 2019 Cross-referenced by PHPXref 0.7.1