[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-messages/ -> bp-messages-star.php (summary)

Functions related to starring private messages.

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

Defines 9 functions

  bp_get_messages_starred_slug()
  bp_messages_is_message_starred()
  bp_the_message_star_action_link()
  bp_get_the_message_star_action_link()
  bp_messages_star_set_action()
  bp_messages_star_enqueue_scripts()
  bp_messages_star_bulk_management_dropdown()
  bp_messages_star_message_css_class()
  bp_messages_filter_starred_message_threads()

Functions
Functions that are not part of a class:

bp_get_messages_starred_slug()   X-Ref
Return the starred messages slug. Defaults to 'starred'.

return: string
since: 2.3.0

bp_messages_is_message_starred( $mid = 0, $user_id = 0 )   X-Ref
Function to determine if a message ID is starred.

return: bool
since: 2.3.0
param: int $mid     The message ID. Please note that this isn't the message thread ID.
param: int $user_id The user ID.

bp_the_message_star_action_link( $args = array()   X-Ref
Output the link or raw URL for starring or unstarring a message.

since: 2.3.0
param: array $args See bp_get_the_message_star_action_link() for full documentation.

bp_get_the_message_star_action_link( $args = array()   X-Ref
Return the link or raw URL for starring or unstarring a message.

return: string
since: 2.3.0
param: array $args {

bp_messages_star_set_action( $args = array()   X-Ref
Save or delete star message meta according to a message's star status.

return: bool
since: 2.3.0
param: array $args {

bp_messages_star_enqueue_scripts()   X-Ref
Enqueues the dashicons font.

The dashicons font is used for the star / unstar icon.

since: 2.3.0

bp_messages_star_bulk_management_dropdown()   X-Ref
Add the "Add star" and "Remove star" options to the bulk management list.

since: 2.3.0

bp_messages_star_message_css_class( $retval = array()   X-Ref
Add CSS class for the current message depending on starred status.

return: array
since: 2.3.0
param: array $retval Current CSS classes.

bp_messages_filter_starred_message_threads( $r = array()   X-Ref
Filter message threads by those starred by the logged-in user.

return: array $r Array of starred message threads.
since: 2.3.0
param: array $r Current message thread arguments.



Generated: Mon Sep 23 01:01:44 2019 Cross-referenced by PHPXref 0.7.1