[ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
BuddyPress Activity Template Functions.
File Size: | 4197 lines (123 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
bp_activity_slug() X-Ref |
Output the activity component slug. since: 1.5.0 |
bp_get_activity_slug() X-Ref |
Return the activity component slug. return: string The activity component slug. since: 1.5.0 |
bp_activity_root_slug() X-Ref |
Output the activity component root slug. since: 1.5.0 |
bp_get_activity_root_slug() X-Ref |
Return the activity component root slug. return: string The activity component root slug. since: 1.5.0 |
bp_activity_directory_permalink() X-Ref |
Output activity directory permalink. since: 1.5.0 |
bp_get_activity_directory_permalink() X-Ref |
Return activity directory permalink. return: string Activity directory permalink. since: 1.5.0 |
bp_has_activities( $args = '' ) X-Ref |
Initialize the activity loop. Based on the $args passed, bp_has_activities() populates the $activities_template global, enabling the use of BuddyPress templates and template functions to display a list of activity items. return: bool Returns true when activities are found, otherwise false. since: 1.0.0 since: 2.4.0 Introduced the `$fields` parameter. param: array|string $args { |
bp_activities() X-Ref |
Determine if there are still activities left in the loop. return: bool Returns true when activities are found. since: 1.0.0 |
bp_the_activity() X-Ref |
Get the current activity object in the loop. return: object The current activity within the loop. since: 1.0.0 |
bp_activity_load_more_link() X-Ref |
Output the URL for the Load More link. since: 2.1.0 |
bp_get_activity_load_more_link() X-Ref |
Get the URL for the Load More link. return: string $link since: 2.1.0 |
bp_activity_pagination_count() X-Ref |
Output the activity pagination count. since: 1.0.0 |
bp_get_activity_pagination_count() X-Ref |
Return the activity pagination count. return: string The pagination text. since: 1.2.0 |
bp_activity_pagination_links() X-Ref |
Output the activity pagination links. since: 1.0.0 |
bp_get_activity_pagination_links() X-Ref |
Return the activity pagination links. return: string The pagination links. since: 1.0.0 |
bp_activity_has_more_items() X-Ref |
Return true when there are more activity items to be shown than currently appear. return: bool $has_more_items True if more items, false if not. since: 1.5.0 |
bp_activity_count() X-Ref |
Output the activity count. since: 1.2.0 |
bp_get_activity_count() X-Ref |
Return the activity count. return: int The activity count. since: 1.2.0 |
bp_activity_per_page() X-Ref |
Output the number of activities per page. since: 1.2.0 |
bp_get_activity_per_page() X-Ref |
Return the number of activities per page. return: int The activities per page. since: 1.2.0 |
bp_activities_title() X-Ref |
Output the activities title. since: 1.0.0 |
bp_get_activities_title() X-Ref |
Return the activities title. return: string The activities title. since: 1.0.0 |
bp_activities_no_activity() X-Ref |
{@internal Missing Description} since: 1.0.0 |
bp_get_activities_no_activity() X-Ref |
{@internal Missing Description} return: string since: 1.0.0 |
bp_activity_id() X-Ref |
Output the activity ID. since: 1.2.0 |
bp_get_activity_id() X-Ref |
Return the activity ID. return: int The activity ID. since: 1.2.0 |
bp_activity_item_id() X-Ref |
Output the activity item ID. since: 1.2.0 |
bp_get_activity_item_id() X-Ref |
Return the activity item ID. return: int The activity item ID. since: 1.2.0 |
bp_activity_secondary_item_id() X-Ref |
Output the activity secondary item ID. since: 1.2.0 |
bp_get_activity_secondary_item_id() X-Ref |
Return the activity secondary item ID. return: int The activity secondary item ID. since: 1.2.0 |
bp_activity_date_recorded() X-Ref |
Output the date the activity was recorded. since: 1.2.0 |
bp_get_activity_date_recorded() X-Ref |
Return the date the activity was recorded. return: string The date the activity was recorded. since: 1.2.0 |
bp_activity_member_display_name() X-Ref |
Output the display name of the member who posted the activity. since: 2.1.0 |
bp_get_activity_member_display_name() X-Ref |
Return the display name of the member who posted the activity. return: string The date the activity was recorded. since: 2.1.0 |
bp_activity_object_name() X-Ref |
Output the activity object name. since: 1.2.0 |
bp_get_activity_object_name() X-Ref |
Return the activity object name. return: string The activity object name. since: 1.2.0 |
bp_activity_type() X-Ref |
Output the activity type. since: 1.2.0 |
bp_get_activity_type() X-Ref |
Return the activity type. return: string The activity type. since: 1.2.0 |
bp_activity_type_part() X-Ref |
Return the activity type template part name. return: string The activity type template part name. since: 10.0.0 |
bp_activity_action_name() X-Ref |
Output the activity action name. Just a wrapper for bp_activity_type(). since: 1.2.0 |
bp_get_activity_action_name() X-Ref |
Return the activity type. Just a wrapper for bp_get_activity_type(). return: string The activity type. since: 1.2.0 |
bp_activity_user_id() X-Ref |
Output the activity user ID. since: 1.1.0 |
bp_get_activity_user_id() X-Ref |
Return the activity user ID. return: int The activity user ID. since: 1.1.0 |
bp_activity_user_link() X-Ref |
Output the activity user link. since: 1.2.0 |
bp_get_activity_user_link() X-Ref |
Return the activity user link. return: string $link The activity user link. since: 1.2.0 |
bp_activity_avatar( $args = '' ) X-Ref |
Output the avatar of the user that performed the action. since: 1.1.0 param: array|string $args See {@link bp_get_activity_avatar()} for description. |
bp_get_activity_avatar( $args = '' ) X-Ref |
Return the avatar of the user that performed the action. return: string User avatar string. since: 1.1.0 param: array|string $args { |
bp_activity_secondary_avatar( $args = '' ) X-Ref |
Output the avatar of the object that action was performed on. since: 1.2.0 param: array|string $args See {@link bp_get_activity_secondary_avatar} for description. |
bp_get_activity_secondary_avatar( $args = '' ) X-Ref |
Return the avatar of the object that action was performed on. return: string The secondary avatar. since: 1.2.0 param: array|string $args { |
bp_activity_action( $args = array() X-Ref |
Output the activity action. since: 1.2.0 param: array $args See bp_get_activity_action(). |
bp_get_activity_action( $args = array() X-Ref |
Return the activity action. return: string The activity action. since: 1.2.0 since: 1.7.0 Introduce function parameter, $args. param: array $args { |
bp_activity_content_body() X-Ref |
Output the activity content body. since: 1.2.0 |
bp_get_activity_content_body() X-Ref |
Return the activity content body. return: string The activity content body. since: 1.2.0 |
bp_activity_has_content() X-Ref |
Does the activity have content? return: bool True if activity has content, false otherwise. since: 1.2.0 since: 10.0.0 Generate a richer content for activity types supporting the feature. |
bp_activity_has_generated_content_part( $property = '' ) X-Ref |
Does this property has been generated? return: bool True if the property is not empty. False otherwise. since: 10.0.0 param: string $property The name of the property to check into the generated content. |
bp_activity_generated_content_part( $property = '' ) X-Ref |
Outputs a property of the activity generated content. since: 10.0.0 param: string $property The name of the property to check into the generated content. |
bp_activity_get_generated_content_part( $property = '', $return = '' ) X-Ref |
Returns the property of the activity generated content. return: bool|string A boolean when requested, false if there is no value, the HTML output otherwise. since: 10.0.0 param: string $property The name of the property to check into the generated content. param: string $return Whether to return the property value or a boolean to check it exists. |
bp_activity_content() X-Ref |
Output the activity content. since: 1.0.0 |
bp_get_activity_content() X-Ref |
Return the activity content. return: string The activity content. since: 1.0.0 |
bp_insert_activity_meta( $content = '' ) X-Ref |
Attach metadata about an activity item to the activity content. This metadata includes the time since the item was posted (which will appear as a link to the item's permalink). return: string The activity content with the metadata string attached. since: 1.2.0 param: string $content The activity content. |
bp_activity_user_can_delete( $activity = false ) X-Ref |
Determine if the current user can delete an activity item. return: bool True if can delete, false otherwise. since: 1.2.0 param: false|BP_Activity_Activity $activity Optional. Falls back on the current item in the loop. |
bp_activity_parent_content( $args = '' ) X-Ref |
Output the activity parent content. since: 1.2.0 param: array|string $args See {@link bp_get_activity_parent_content} for description. |
bp_get_activity_parent_content( $args = '' ) X-Ref |
Return the activity content. return: mixed False on failure, otherwise the activity parent content. since: 1.2.0 param: string $args Unused. Left over from an earlier implementation. |
bp_activity_parent_user_id() X-Ref |
Output the parent activity's user ID. since: 1.7.0 |
bp_get_activity_parent_user_id() X-Ref |
Return the parent activity's user ID. return: bool|int False if parent activity can't be found, otherwise since: 1.7.0 |
bp_activity_is_favorite() X-Ref |
Output whether or not the current activity is in a current user's favorites. since: 1.2.0 |
bp_get_activity_is_favorite() X-Ref |
Return whether the current activity is in a current user's favorites. return: bool True if user favorite, false otherwise. since: 1.2.0 |
bp_activity_comments( $args = '' ) X-Ref |
Output the comment markup for an activity item. since: 1.2.0 param: array|string $args See {@link bp_activity_get_comments} for description. |
bp_activity_get_comments( $args = '' ) X-Ref |
Get the comment markup for an activity item. return: bool since: 1.2.0 param: string $args Unused. Left over from an earlier implementation. |
bp_activity_recurse_comments( $comment ) X-Ref |
Loops through a level of activity comments and loads the template for each. Note: The recursion itself used to happen entirely in this function. Now it is split between here and the comment.php template. return: bool|string since: 1.2.0 param: object $comment The activity object currently being recursed. |
bp_activity_current_comment() X-Ref |
Utility function that returns the comment currently being recursed. return: object|bool $current_comment The activity comment currently being since: 1.5.0 |
bp_activity_comment_id() X-Ref |
Output the ID of the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_id() X-Ref |
Return the ID of the activity comment currently being displayed. return: int|bool $comment_id The ID of the activity comment currently since: 1.5.0 |
bp_activity_comment_user_id() X-Ref |
Output the ID of the author of the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_user_id() X-Ref |
Return the ID of the author of the activity comment currently being displayed. return: int|bool $user_id The user_id of the author of the displayed since: 1.5.0 |
bp_activity_comment_user_link() X-Ref |
Output the author link for the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_user_link() X-Ref |
Return the author link for the activity comment currently being displayed. return: string $user_link The URL of the activity comment author's profile. since: 1.5.0 |
bp_activity_comment_name() X-Ref |
Output the author name for the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_name() X-Ref |
Return the author name for the activity comment currently being displayed. The use of the 'bp_acomment_name' filter is deprecated. Please use 'bp_activity_comment_name'. return: string $name The full name of the activity comment author. since: 1.5.0 |
bp_activity_comment_date_recorded() X-Ref |
Output the formatted date_recorded of the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_date_recorded() X-Ref |
Return the formatted date_recorded for the activity comment currently being displayed. return: string|bool $date_recorded Time since the activity was recorded, since: 1.5.0 |
bp_activity_comment_date_recorded_raw() X-Ref |
Output the date_recorded of the activity comment currently being displayed. since: 2.3.0 |
bp_get_activity_comment_date_recorded_raw() X-Ref |
Return the date_recorded for the activity comment currently being displayed. return: string|bool $date_recorded Time since the activity was recorded, since: 2.3.0 |
bp_activity_comment_delete_link() X-Ref |
Output the 'delete' URL for the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_delete_link() X-Ref |
Gets the 'delete' URL for the activity comment currently being displayed. return: string $link The nonced URL for deleting the current since: 1.5.0 |
bp_activity_comment_content() X-Ref |
Output the content of the activity comment currently being displayed. since: 1.5.0 |
bp_get_activity_comment_content() X-Ref |
Return the content of the activity comment currently being displayed. The content is run through two filters. 'bp_get_activity_content' will apply all filters applied to activity items in general. Use 'bp_activity_comment_content' to modify the content of activity comments only. return: string $content The content of the current activity comment. since: 1.5.0 |
bp_activity_comment_count() X-Ref |
Output the activity comment count. since: 1.2.0 |
bp_activity_get_comment_count( $deprecated = null ) X-Ref |
Return the comment count of an activity item. return: int $count The activity comment count. since: 1.2.0 param: array|null $deprecated Deprecated. |
bp_activity_recurse_comment_count( $comment, $count = 0 ) X-Ref |
Return the total number of comments to the current comment. This function recursively adds the total number of comments each activity child has, and returns them. return: int $count The activity comment count. since: 1.2.0 param: object $comment Activity comment object. param: int $count The current iteration count. |
bp_activity_comment_depth( $comment = 0 ) X-Ref |
Output the depth of the current activity comment. since: 2.0.0 since: 2.8.0 Added $comment as a parameter. param: object|int $comment Object of the activity comment or activity comment ID. Usually unnecessary |
bp_activity_get_comment_depth( $comment = 0 ) X-Ref |
Return the current activity comment depth. return: int since: 2.0.0 since: 2.8.0 Added $comment as a parameter. param: object|int $comment Object of the activity comment or activity comment ID. Usually unnecessary |
bp_activity_comment_link() X-Ref |
Output the activity comment link. since: 1.2.0 |
bp_get_activity_comment_link() X-Ref |
Return the activity comment link. return: string The activity comment link. since: 1.2.0 |
bp_activity_comment_form_nojs_display() X-Ref |
Output the activity comment form no JavaScript display CSS. since: 1.2.0 |
bp_get_activity_comment_form_nojs_display() X-Ref |
Return the activity comment form no JavaScript display CSS. return: string|false The activity comment form no JavaScript since: 1.2.0 |
bp_activity_comment_form_action() X-Ref |
Output the activity comment form action. since: 1.2.0 |
bp_get_activity_comment_form_action() X-Ref |
Return the activity comment form action. return: string The activity comment form action. since: 1.2.0 |
bp_activity_permalink_id() X-Ref |
Output the activity permalink ID. since: 1.2.0 |
bp_get_activity_permalink_id() X-Ref |
Return the activity permalink ID. return: string The activity permalink ID. since: 1.2.0 |
bp_activity_thread_permalink() X-Ref |
Output the activity thread permalink. since: 1.2.0 |
bp_get_activity_thread_permalink() X-Ref |
Return the activity thread permalink. return: string $link The activity thread permalink. since: 1.2.0 |
bp_activity_comment_permalink() X-Ref |
Output the activity comment permalink. since: 1.8.0 |
bp_get_activity_comment_permalink() X-Ref |
Return the activity comment permalink. return: string $link The activity comment permalink. since: 1.8.0 |
bp_activity_favorite_link() X-Ref |
Output the activity favorite link. since: 1.2.0 |
bp_get_activity_favorite_link() X-Ref |
Return the activity favorite link. return: string The activity favorite link. since: 1.2.0 |
bp_activity_unfavorite_link() X-Ref |
Output the activity unfavorite link. since: 1.2.0 |
bp_get_activity_unfavorite_link() X-Ref |
Return the activity unfavorite link. return: string The activity unfavorite link. since: 1.2.0 |
bp_activity_css_class() X-Ref |
Output the activity CSS class. since: 1.0.0 |
bp_get_activity_css_class() X-Ref |
Return the current activity item's CSS class. return: string The activity item's CSS class. since: 1.0.0 |
bp_activity_delete_link() X-Ref |
Output the activity delete link. since: 1.1.0 |
bp_get_activity_delete_link() X-Ref |
Return the activity delete link. return: string $link Activity delete link. Contains $redirect_to arg since: 1.1.0 |
bp_activity_delete_url() X-Ref |
Output the URL to delete a single activity stream item. since: 2.1.0 |
bp_get_activity_delete_url() X-Ref |
Return the URL to delete a single activity item. return: string $link Activity delete link. Contains $redirect_to arg since: 2.1.0 |
bp_activity_latest_update( $user_id = 0 ) X-Ref |
Output the activity latest update link. since: 1.2.0 param: int $user_id See {@link bp_get_activity_latest_update()} for description. |
bp_get_activity_latest_update( $user_id = 0 ) X-Ref |
Return the activity latest update link. return: string|bool $latest_update The activity latest update link. since: 1.2.0 param: int $user_id If empty, will fall back on displayed user. |
bp_activity_filter_links( $args = false ) X-Ref |
Output the activity filter links. since: 1.1.0 param: array|bool $args See {@link bp_get_activity_filter_links()} for description. |
bp_get_activity_filter_links( $args = false ) X-Ref |
Return the activity filter links. return: string|bool $component_links The activity filter links. since: 1.1.0 param: array|bool $args { |
bp_activity_can_comment() X-Ref |
Determine if a comment can be made on an activity item. return: bool $can_comment True if item can receive comments. since: 1.2.0 |
bp_activity_can_comment_reply( $comment = false ) X-Ref |
Determine whether a comment can be made on an activity reply item. return: bool $can_comment True if comment can receive comments, since: 1.5.0 param: bool|object $comment Activity comment. |
bp_activity_can_favorite() X-Ref |
Determine whether favorites are allowed. Defaults to true, but can be modified by plugins. return: bool True if comment can receive comments. since: 1.5.0 |
bp_total_favorite_count_for_user( $user_id = 0 ) X-Ref |
Output the total favorite count for a specified user. since: 1.2.0 param: int $user_id See {@link bp_get_total_favorite_count_for_user()}. |
bp_get_total_favorite_count_for_user( $user_id = 0 ) X-Ref |
Return the total favorite count for a specified user. return: int The total favorite count for the specified user. since: 1.2.0 param: int $user_id ID of user being queried. Default: displayed user ID. |
bp_total_mention_count_for_user( $user_id = 0 ) X-Ref |
Output the total mention count for a specified user. since: 1.2.0 param: int $user_id See {@link bp_get_total_mention_count_for_user()}. |
bp_get_total_mention_count_for_user( $user_id = 0 ) X-Ref |
Return the total mention count for a specified user. return: int The total mention count for the specified user. since: 1.2.0 param: int $user_id ID of user being queried. Default: displayed user ID. |
bp_send_public_message_link() X-Ref |
Output the public message link for displayed user. since: 1.2.0 |
bp_get_send_public_message_link() X-Ref |
Return the public message link for the displayed user. return: string The public message link for the displayed user. since: 1.2.0 |
bp_activity_recurse_comments_activity_ids( $activity = array() X-Ref |
Recurse through all activity comments and return the activity comment IDs. return: array since: 2.0.0 param: array $activity Array of activities generated from {@link bp_activity_get()}. param: array $activity_ids Used for recursion purposes in this function. |
bp_mentioned_user_display_name( $user_id_or_username = false ) X-Ref |
Output the mentioned user display name. since: 1.2.0 param: int|string|bool $user_id_or_username See {@link bp_get_mentioned_user_display_name()}. |
bp_get_mentioned_user_display_name( $user_id_or_username = false ) X-Ref |
Returns the mentioned user display name. return: string The mentioned user's display name. since: 1.2.0 param: int|string|bool $user_id_or_username User ID or username. |
bp_send_public_message_button( $args = '' ) X-Ref |
Output button for sending a public message (an @-mention). since: 1.2.0 param: array|string $args See {@link bp_get_send_public_message_button()}. |
bp_get_send_public_message_button( $args = '' ) X-Ref |
Return button for sending a public message (an @-mention). return: string The button for sending a public message. since: 1.2.0 param: array|string $args { |
bp_activity_post_form_action() X-Ref |
Output the activity post form action. since: 1.2.0 |
bp_get_activity_post_form_action() X-Ref |
Return the activity post form action. return: string The activity post form action. since: 1.2.0 |
bp_activity_comments_user_avatars( $args = array() X-Ref |
Echo a list of linked avatars of users who have commented on the current activity item. Use this function to easily output activity comment authors' avatars. Avatars are wrapped in <li> elements, but you've got to provide your own <ul> or <ol> wrapper markup. since: 1.7.0 param: array $args See {@link bp_core_fetch_avatar()}. |
bp_activity_get_comments_user_ids() X-Ref |
Return the IDs of every user who's left a comment on the current activity item. return: bool|array An array of IDs, or false if none are found. since: 1.7.0 |
bp_activity_recurse_comments_user_ids( array $comments = array() X-Ref |
Recurse through all activity comments and collect the IDs of the users who wrote them. return: array Array of user IDs. since: 1.7.0 param: array $comments Array of {@link BP_Activity_Activity} items. |
bp_displayed_user_mentionname() X-Ref |
Output the mentionname for the displayed user. since: 1.9.0 |
bp_get_displayed_user_mentionname() X-Ref |
Get the mentionname for the displayed user. return: string Mentionname for the displayed user, if available. since: 1.9.0 |
bp_activity_types_list( $output = 'select', $args = '' ) X-Ref |
Echo a list of all registered activity types for use in dropdowns or checkbox lists. since: 1.7.0 param: string $output Optional. Either 'select' or 'checkbox'. Default: 'select'. param: array|string $args { |
bp_sitewide_activity_feed_link() X-Ref |
Output the sitewide activity feed link. since: 1.0.0 |
bp_get_sitewide_activity_feed_link() X-Ref |
Returns the sitewide activity feed link. return: string The sitewide activity feed link. since: 1.0.0 |
bp_member_activity_feed_link() X-Ref |
Output the member activity feed link. since: 1.2.0 |
bp_activities_member_rss_link() X-Ref |
Output the member activity feed link. since: 1.0.0 |
bp_get_member_activity_feed_link() X-Ref |
Return the member activity feed link. return: string $link The member activity feed link. since: 1.2.0 |
bp_get_activities_member_rss_link() X-Ref |
Return the member activity feed link. return: string The member activity feed link. since: 1.0.0 |
bp_activity_feed_item_guid() X-Ref |
Outputs the activity feed item guid. since: 1.0.0 |
bp_get_activity_feed_item_guid() X-Ref |
Returns the activity feed item guid. return: string The activity feed item guid. since: 1.2.0 |
bp_activity_feed_item_title() X-Ref |
Output the activity feed item title. since: 1.0.0 |
bp_get_activity_feed_item_title() X-Ref |
Return the activity feed item title. return: string $title The activity feed item title. since: 1.0.0 |
bp_activity_feed_item_link() X-Ref |
Output the activity feed item link. since: 1.0.0 |
bp_get_activity_feed_item_link() X-Ref |
Return the activity feed item link. return: string The activity feed item link. since: 1.0.0 |
bp_activity_feed_item_date() X-Ref |
Output the activity feed item date. since: 1.0.0 |
bp_get_activity_feed_item_date() X-Ref |
Return the activity feed item date. return: string The activity feed item date. since: 1.0.0 |
bp_activity_feed_item_description() X-Ref |
Output the activity feed item description. since: 1.0.0 |
bp_get_activity_feed_item_description() X-Ref |
Return the activity feed item description. return: string The activity feed item description. since: 1.0.0 |
bp_activity_sitewide_feed() X-Ref |
Template tag so we can hook activity feed to <head>. since: 1.5.0 |
bp_activity_show_filters( $context = '' ) X-Ref |
Display available filters depending on the scope. since: 2.1.0 param: string $context The current context. 'activity', 'member', |
bp_get_activity_show_filters( $context = '' ) X-Ref |
Get available filters depending on the scope. return: string HTML for <option> values. since: 2.1.0 param: string $context The current context. 'activity', 'member', |
Generated: Wed Nov 6 01:00:56 2024 | Cross-referenced by PHPXref 0.7.1 |