Changeset 9834 for trunk/src/bp-activity/bp-activity-template.php
- Timestamp:
- 05/03/2015 10:51:31 PM (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-activity/bp-activity-template.php
r9833 r9834 84 84 } 85 85 /** 86 * Return activity directory permalink 86 * Return activity directory permalink. 87 87 * 88 88 * @since BuddyPress (1.5.0) … … 556 556 * @type string $scope Use a BuddyPress pre-built filter. 557 557 * - 'just-me' retrieves items belonging only to a user; this is equivalent 558 * to passing a 'user_id' argument 559 * - 'friends' retrieves items belonging to the friends of a user 560 * - 'groups' retrieves items belonging to groups to which a user belongs to 561 * - 'favorites' retrieves a user's favorited activity items 562 * - 'mentions' retrieves items where a user has received an @-mention 558 * to passing a 'user_id' argument. 559 * - 'friends' retrieves items belonging to the friends of a user. 560 * - 'groups' retrieves items belonging to groups to which a user belongs to. 561 * - 'favorites' retrieves a user's favorited activity items. 562 * - 'mentions' retrieves items where a user has received an @-mention. 563 563 * The default value of 'scope' is set to one of the above if that value 564 564 * appears in the appropriate place in the URL; eg, 'scope' will be 'groups' … … 592 592 * @type string|bool $display_comments How to handle activity comments. Possible values: 593 593 * - 'threaded' - comments appear in a threaded tree, under their parent 594 * items 594 * items. 595 595 * - 'stream' - the activity stream is presented in a flat manner, with 596 * comments sorted in chronological order alongside other activity items 597 * - false - don't fetch activity comments at all 596 * comments sorted in chronological order alongside other activity items. 597 * - false - don't fetch activity comments at all. 598 598 * Default: 'threaded'. 599 599 * @type bool $show_hidden Whether to show items marked hide_sitewide. Defaults to false, except in 600 600 * the following cases: 601 * - User is viewing his own activity stream 601 * - User is viewing his own activity stream. 602 602 * - User is viewing the activity stream of a non-public group of which he 603 * is a member 603 * is a member. 604 604 * @type string|bool $spam Spam status. 'ham_only', 'spam_only', or false to show all activity 605 605 * regardless of spam status. Default: 'ham_only'. … … 796 796 } 797 797 /** 798 * Get the URL for the Load More link 798 * Get the URL for the Load More link. 799 799 * 800 800 * @since BuddyPress (2.1.0) … … 811 811 * @since BuddyPress (2.1.0) 812 812 * 813 * @param string $link The "Load More" link URL with appropriate query args 814 * @param string $url The original URL 815 * @param object $activities_template The activity template loop global 813 * @param string $link The "Load More" link URL with appropriate query args. 814 * @param string $url The original URL. 815 * @param object $activities_template The activity template loop global. 816 816 */ 817 817 return apply_filters( 'bp_get_activity_load_more_link', $link, $url, $activities_template ); … … 1048 1048 * 1049 1049 * @global string $bp_activity_no_activity 1050 * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook 1050 * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook. 1051 1051 * @todo Deprecate. 1052 1052 * … … 1203 1203 1204 1204 /** 1205 * Output the display name of the member who posted the activity 1205 * Output the display name of the member who posted the activity. 1206 1206 * 1207 1207 * @since BuddyPress (2.1.0) … … 1214 1214 1215 1215 /** 1216 * Return the display name of the member who posted the activity 1216 * Return the display name of the member who posted the activity. 1217 1217 * 1218 1218 * @since BuddyPress (2.1.0) … … 1436 1436 * @uses bp_is_single_activity() 1437 1437 * @uses wp_parse_args() 1438 * @uses apply_filters() To call the 'bp_get_activity_avatar_object_' . $current_activity_item->component hook 1439 * @uses apply_filters() To call the 'bp_get_activity_avatar_item_id' hook 1438 * @uses apply_filters() To call the 'bp_get_activity_avatar_object_' . $current_activity_item->component hook. 1439 * @uses apply_filters() To call the 'bp_get_activity_avatar_item_id' hook. 1440 1440 * @uses bp_core_fetch_avatar() 1441 * @uses apply_filters() To call the 'bp_get_activity_avatar' hook 1441 * @uses apply_filters() To call the 'bp_get_activity_avatar' hook. 1442 1442 * 1443 1443 * @param array|string $args { … … 1564 1564 1565 1565 /** 1566 * Return the avatar of the object that action was performed on 1566 * Return the avatar of the object that action was performed on. 1567 1567 * 1568 1568 * @since BuddyPress (1.2.0) … … 1577 1577 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar' hook. 1578 1578 * 1579 * @param array $args {1579 * @param array|string $args { 1580 1580 * For a complete description of arguments, see {@link bp_core_fetch_avatar()}. 1581 1581 * @type string $alt Default value varies based on current activity … … 1741 1741 1742 1742 /** 1743 * Output the activity action 1743 * Output the activity action. 1744 1744 * 1745 1745 * @since BuddyPress (1.2.0) … … 1753 1753 1754 1754 /** 1755 * Return the activity action 1755 * Return the activity action. 1756 1756 * 1757 1757 * @since BuddyPress (1.2.0) … … 1759 1759 * @global object $activities_template {@link BP_Activity_Template} 1760 1760 * @param array $args Only parameter is "no_timestamp". If true, timestamp is shown in output. 1761 * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook 1761 * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook. 1762 1762 * @uses bp_insert_activity_meta() 1763 1763 * @uses apply_filters_ref_array() To call the 'bp_get_activity_action' hook. … … 1809 1809 1810 1810 /** 1811 * Output the activity content body 1811 * Output the activity content body. 1812 1812 * 1813 1813 * @since BuddyPress (1.2.0) … … 1820 1820 1821 1821 /** 1822 * Return the activity content body 1822 * Return the activity content body. 1823 1823 * 1824 1824 * @since BuddyPress (1.2.0) … … 1899 1899 /** 1900 1900 * If you want to filter activity update content, please use 1901 * the filter 'bp_get_activity_content_body' 1901 * the filter 'bp_get_activity_content_body'. 1902 1902 * 1903 1903 * This function is mainly for backwards compatibility. … … 1992 1992 * 1993 1993 * @global object $activities_template {@link BP_Activity_Template} 1994 * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook 1994 * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook. 1995 1995 * 1996 1996 * @param object|bool $activity Optional. Falls back on the current item in the loop. … … 2070 2070 * @param string $args Unused. Left over from an earlier implementation. 2071 2071 * 2072 * @return mixed False on failure, otherwise the activity parent content 2072 * @return mixed False on failure, otherwise the activity parent content. 2073 2073 */ 2074 2074 function bp_get_activity_parent_content( $args = '' ) { … … 2244 2244 2245 2245 /** 2246 * Loops through a level of activity comments and loads the template for each 2246 * Loops through a level of activity comments and loads the template for each. 2247 2247 * 2248 2248 * Note: The recursion itself used to happen entirely in this function. Now it is … … 2251 2251 * @since BuddyPress (1.2.0) 2252 2252 * 2253 * @param object $comment The activity object currently being recursed 2253 * @param object $comment The activity object currently being recursed. 2254 2254 * 2255 2255 * @global object $activities_template {@link BP_Activity_Template} … … 2428 2428 * @uses bp_core_get_user_domain() 2429 2429 * @uses bp_get_activity_comment_user_id() 2430 * @uses apply_filters() To call the 'bp_activity_comment_user_link' hook 2430 * @uses apply_filters() To call the 'bp_activity_comment_user_link' hook. 2431 2431 * 2432 2432 * @return string $user_link The URL of the activity comment author's profile. … … 2507 2507 * 2508 2508 * @uses bp_core_time_since() 2509 * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook 2509 * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook. 2510 2510 * 2511 2511 * @return string|bool $date_recorded Time since the activity was recorded, … … 2542 2542 * @global object $activities_template {@link BP_Activity_Template} 2543 2543 * @uses bp_core_time_since() 2544 * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook 2544 * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook. 2545 2545 * 2546 2546 * @return string|bool $date_recorded Time since the activity was recorded, 2547 * in the form "%s ago". False on failure.2547 * in the form "%s ago". False on failure. 2548 2548 */ 2549 2549 function bp_get_activity_comment_date_recorded_raw() { … … 2572 2572 2573 2573 /** 2574 * Gets the 'delete' URL for the activity comment currently being displayed 2574 * Gets the 'delete' URL for the activity comment currently being displayed. 2575 2575 * 2576 2576 * @since BuddyPress (1.5.0) … … 2697 2697 * 2698 2698 * @uses bp_activity_recurse_comment_count() 2699 * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook 2699 * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook. 2700 2700 * 2701 2701 * @param object $comment Activity comment object. … … 2742 2742 * @since BuddyPress (2.0.0) 2743 2743 * 2744 * @return int $depth Depth for the current activity comment 2744 * @return int $depth Depth for the current activity comment. 2745 2745 */ 2746 2746 function bp_activity_get_comment_depth() { … … 2991 2991 * @uses home_url() 2992 2992 * @uses bp_get_activity_root_slug() 2993 * @uses apply_filters() To call the 'bp_get_activity_favorite_link' hook 2993 * @uses apply_filters() To call the 'bp_get_activity_favorite_link' hook. 2994 2994 * 2995 2995 * @return string The activity favorite link. … … 3159 3159 3160 3160 /** 3161 * Output the URL to delete a single activity stream item 3161 * Output the URL to delete a single activity stream item. 3162 3162 * 3163 3163 * @since BuddyPress (2.1.0) … … 3169 3169 } 3170 3170 /** 3171 * Return the URL to delete a single activity item 3171 * Return the URL to delete a single activity item. 3172 3172 * 3173 3173 * @since BuddyPress (2.1.0) … … 3230 3230 * @uses bp_core_is_user_deleted() 3231 3231 * @uses bp_get_user_meta() 3232 * @uses apply_filters() To call the 'bp_get_activity_latest_update_excerpt' hook 3232 * @uses apply_filters() To call the 'bp_get_activity_latest_update_excerpt' hook. 3233 3233 * @uses bp_create_excerpt() 3234 3234 * @uses bp_get_root_domain() 3235 3235 * @uses bp_get_activity_root_slug() 3236 * @uses apply_filters() To call the 'bp_get_activity_latest_update' hook 3236 * @uses apply_filters() To call the 'bp_get_activity_latest_update' hook. 3237 3237 * 3238 3238 * @param int $user_id If empty, will fall back on displayed user. 3239 3239 * 3240 3240 * @return string|bool $latest_update The activity latest update link. 3241 * False on failure 3241 * False on failure. 3242 3242 */ 3243 3243 function bp_get_activity_latest_update( $user_id = 0 ) { … … 3545 3545 * 3546 3546 * @uses bp_activity_total_favorites_for_user() 3547 * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook 3547 * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook. 3548 3548 * 3549 3549 * @param int $user_id ID of user being queried. Default: displayed user ID. … … 3646 3646 * @uses wp_nonce_url() 3647 3647 * @uses bp_get_activity_directory_permalink() 3648 * @uses apply_filters() To call the 'bp_get_send_public_message_link' hook 3648 * @uses apply_filters() To call the 'bp_get_send_public_message_link' hook. 3649 3649 * 3650 3650 * @return string The public message link for the displayed user. … … 3714 3714 3715 3715 /** 3716 * Returns the mentioned user display name 3716 * Returns the mentioned user display name. 3717 3717 * 3718 3718 * @since BuddyPress (1.2.0) … … 4294 4294 4295 4295 /** 4296 * Output the activity feed item link 4296 * Output the activity feed item link. 4297 4297 * 4298 4298 * @since BuddyPress (1.0.0) … … 4305 4305 4306 4306 /** 4307 * Return the activity feed item link 4307 * Return the activity feed item link. 4308 4308 * 4309 4309 * @since BuddyPress (1.0.0) … … 4450 4450 * 4451 4451 * @param string $context The current context. 'activity', 'member', 4452 * 'member_groups', 'group' 4452 * 'member_groups', 'group'. 4453 4453 * 4454 4454 * @return string HTML for <option> values.
Note: See TracChangeset
for help on using the changeset viewer.