Changeset 7405
- Timestamp:
- 10/10/2013 01:33:46 PM (11 years ago)
- File:
-
- 1 edited
-
trunk/bp-activity/bp-activity-template.php (modified) (165 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/bp-activity/bp-activity-template.php
r7228 r7405 2 2 3 3 /** 4 * BuddyPress Activity Template Functions 4 * BuddyPress Activity Template Functions. 5 5 * 6 6 * @package BuddyPress … … 12 12 13 13 /** 14 * Output the activity component slug 14 * Output the activity component slug. 15 15 * 16 16 * @since BuddyPress (1.5) … … 22 22 } 23 23 /** 24 * Return the activity component slug 24 * Return the activity component slug. 25 25 * 26 26 * @since BuddyPress (1.5) 27 27 * 28 * @global object $bp BuddyPress global settings 29 * @uses apply_filters() To call the 'bp_get_activity_slug' hook 28 * @global object $bp BuddyPress global settings. 29 * @uses apply_filters() To call the 'bp_get_activity_slug' hook. 30 * 31 * @return string The activity component slug. 30 32 */ 31 33 function bp_get_activity_slug() { … … 35 37 36 38 /** 37 * Output the activity component root slug 39 * Output the activity component root slug. 38 40 * 39 41 * @since BuddyPress (1.5) … … 45 47 } 46 48 /** 47 * Return the activity component root slug 49 * Return the activity component root slug. 48 50 * 49 51 * @since BuddyPress (1.5) 50 52 * 51 * @global object $bp BuddyPress global settings 52 * @uses apply_filters() To call the 'bp_get_activity_root_slug' hook 53 * @global object $bp BuddyPress global settings. 54 * @uses apply_filters() To call the 'bp_get_activity_root_slug' hook. 55 * 56 * @return string The activity component root slug. 53 57 */ 54 58 function bp_get_activity_root_slug() { … … 58 62 59 63 /** 60 * Output member directory permalink64 * Output activity directory permalink. 61 65 * 62 66 * @since BuddyPress (1.5) … … 68 72 } 69 73 /** 70 * Return memberdirectory permalink74 * Return activity directory permalink 71 75 * 72 76 * @since BuddyPress (1.5) … … 75 79 * @uses bp_get_root_domain() 76 80 * @uses bp_get_activity_root_slug() 77 * @uses apply_filters() To call the 'bp_get_activity_directory_permalink' hook 78 * 79 * @return string Activity directory permalink 81 * @uses apply_filters() To call the 'bp_get_activity_directory_permalink' hook. 82 * 83 * @return string Activity directory permalink. 80 84 */ 81 85 function bp_get_activity_directory_permalink() { … … 84 88 85 89 /** 86 * The main activity template loop 87 * 88 * This is responsible for loading a group of activity items and displaying them 90 * The main activity template loop class. 91 * 92 * This is responsible for loading a group of activity items and displaying them. 89 93 * 90 94 * @since BuddyPress (1.0) … … 106 110 107 111 /** 108 * Constructor method 109 * 110 * See definition of $defaults below, as well as $defaults in bp_has_activities(), for 111 * description of $args array 112 * 113 * @param array $args 112 * Constructor method. 113 * 114 * The arguments passed to this class constructor are of the same 115 * format as {@link BP_Activity_Activity::get()}. 116 * 117 * @see BP_Activity_Activity::get() for a description of the argument 118 * structure, as well as default values. 119 * 120 * @param array $args { 121 * Array of arguments. Supports all arguments from 122 * BP_Activity_Activity::get(), as well as 'page_arg' and 123 * 'include'. Default values for 'per_page' and 'display_comments' 124 * differ from the originating function, and are described below. 125 * @type string $page_arg The string used as a query parameter in 126 * pagination links. Default: 'acpage'. 127 * @type array|bool $include Pass an array of activity IDs to 128 * retrieve only those items, or false to noop the 'include' 129 * parameter. 'include' differs from 'in' in that 'in' forms 130 * an IN clause that works in conjunction with other filters 131 * passed to the function, while 'include' is interpreted as 132 * an exact list of items to retrieve, which skips all other 133 * filter-related parameters. Default: false. 134 * @type int|bool $per_page Default: 20. 135 * @type string|bool $display_comments Default: 'threaded'. 136 * } 114 137 */ 115 138 function __construct( $args ) { … … 226 249 } 227 250 251 /** 252 * Whether there are activity items available in the loop. 253 * 254 * @see bp_has_activities() 255 * 256 * @return bool True if there are items in the loop, otherwise false. 257 */ 228 258 function has_activities() { 229 259 if ( $this->activity_count ) … … 233 263 } 234 264 265 /** 266 * Set up the next activity item and iterate index. 267 * 268 * @return object The next activity item to iterate over. 269 */ 235 270 function next_activity() { 236 271 $this->current_activity++; … … 240 275 } 241 276 277 /** 278 * Rewind the posts and reset post index. 279 */ 242 280 function rewind_activities() { 243 281 $this->current_activity = -1; … … 247 285 } 248 286 287 /** 288 * Whether there are activity items left in the loop to iterate over. 289 * 290 * This method is used by {@link bp_activities()} as part of the while loop 291 * that controls iteration inside the activities loop, eg: 292 * while ( bp_activities() ) { ... 293 * 294 * @see bp_activities() 295 * 296 * @return bool True if there are more activity items to show, 297 * otherwise false. 298 */ 249 299 function user_activities() { 250 300 if ( $this->current_activity + 1 < $this->activity_count ) { … … 260 310 } 261 311 312 /** 313 * Set up the current activity item inside the loop. 314 * 315 * Used by {@link bp_the_activity()} to set up the current activity item 316 * data while looping, so that template tags used during that iteration 317 * make reference to the current activity item. 318 * 319 * @see bp_the_activity() 320 */ 262 321 function the_activity() { 263 322 … … 274 333 275 334 /** 276 * Initializes the activity loop. 277 * 278 * Based on the $args passed, bp_has_activities() populates the $activities_template global. 335 * Initialize the activity loop. 336 * 337 * Based on the $args passed, bp_has_activities() populates the 338 * $activities_template global, enabling the use of BuddyPress templates and 339 * template functions to display a list of activity items. 279 340 * 280 341 * @since BuddyPress (1.0) 281 342 * 282 * @param array $args Arguments for limiting the contents of the activity loop. Can be passed as an associative array or as a URL argument string283 *284 343 * @global object $activities_template {@link BP_Activity_Template} 285 * @global object $bp BuddyPress global settings 344 * @global object $bp BuddyPress global settings. 286 345 * @uses groups_is_user_member() 287 346 * @uses bp_current_action() … … 294 353 * @uses groups_get_user_groups() 295 354 * @uses bp_activity_get_user_favorites() 296 * @uses apply_filters() To call the 'bp_has_activities' hook 297 * 298 * @return bool Returns true when activities are found 355 * @uses apply_filters() To call the 'bp_has_activities' hook. 356 * 357 * @param array $args { 358 * Arguments for limiting the contents of the activity loop. Most 359 * arguments are in the same format as {@link BP_Activity_Activity::get()}. 360 * However, because the format of the arguments accepted here differs in 361 * a number of ways, and because bp_has_activities() determines some 362 * default arguments in a dynamic fashion, we list all accepted arguments 363 * here as well. 364 * 365 * Arguments can be passed as an associative array, or as a URL query 366 * string (eg, 'user_id=4&display_comments=threaded'). 367 * 368 * @type int $page Which page of results to fetch. Using page=1 without 369 * per_page will result in no pagination. Default: 1. 370 * @type int|bool $per_page Number of results per page. Default: 20. 371 * @type string $page_arg The string used as a query parameter in 372 * pagination links. Default: 'acpage'. 373 * @type int|bool $max Maximum number of results to return. 374 * Default: false (unlimited). 375 * @type string $sort 'ASC' or 'DESC'. Default: 'DESC'. 376 * @type array|bool $exclude Array of activity IDs to exclude. Default: false. 377 * @type array|bool $in Array of IDs to limit query by (IN). 'in' is 378 * intended to be used in conjunction with other filter parameters. 379 * Default: false. 380 * @type array|bool $include Array of exact activity IDs to query. 381 * Providing an 'include' array will override all other filters 382 * passed in the argument array. When viewing a the permalink page 383 * for a single activity item, this value defaults to the ID of that 384 * item. Otherwise the default is false. 385 * @type array $meta_query Limit by activitymeta by passing an array of 386 * meta_query conditions. See {@link WP_Meta_Query::queries} for a 387 * description of the syntax. 388 * @type string $search_terms Limit results by a search term. Default: false. 389 * @type string|bool $scope Use one of BuddyPress's pre-built filters. In 390 * each case, the term 'current user' refers to the displayed user 391 * when looking at a user profile, and otherwise to the logged-in user. 392 * - 'just-me' retrieves items belonging only to the logged-in user; 393 * this is equivalent to passing a 'user_id' argument 394 * - 'friends' retrieves items belonging to the friends of the 395 * current user 396 * - 'groups' retrieves items associated with the groups to which 397 * the current user belongs 398 * - 'favorites' retrieves the current user's favorited activity 399 * items 400 * - 'mentions' retrieves activity items where the current user has 401 * received an @-mention 402 * The default value of 'scope' is set to one of the above if that 403 * value appears in the appropriate place in the URL; eg, 'scope' will 404 * be 'groups' when visiting http://example.com/members/joe/activity/groups/. 405 * Otherwise defaults to false. 406 * @type int|array|bool $user_id The ID(s) of user(s) whose activity should 407 * be fetched. Pass a single ID or an array of IDs. When viewing a 408 * user profile page (but not that user's activity subpages, ie My 409 * Friends, My Groups, etc), 'user_id' defaults to the ID of the 410 * displayed user. Otherwise the default is false. 411 * @type string|array|bool $object Filters by the `component` column in the 412 * database, which is generally the component ID in the case of 413 * BuddyPress components, or the plugin slug in the case of plugins. 414 * For example, 'groups' will limit results to those that are 415 * associated with the BP Groups component. Accepts a single 416 * component string, or an array of multiple components. Defaults to 417 * 'groups' when viewing the page of a single group, the My Groups 418 * activity filter, or the Activity > Groups filter of a user profile. 419 * Otherwise defaults to false. 420 * @type string|array|bool $action Filters by the `type` column in the 421 * database, which is a string categorizing the activity item (eg, 422 * 'new_blog_post', 'created_group'). Accepts a single type string, 423 * or an array of multiple types. Defaults to false. 424 * @type int|array|bool $primary_id Filters by the `item_id` column in the 425 * database. The meaning of 'primary_id' differs between components/ 426 * types; for example, in the case of 'created_group', 'primary_id' 427 * is the ID of the group. Accepts a single ID, or an array of 428 * multiple IDs. When viewing a single group, defaults to the current 429 * group ID. When viewing a user's Groups stream page, defaults to 430 * the IDs of the user's groups. Otherwise defaults to false. 431 * @type int|array|bool $secondary_id Filters by the `secondary_item_id` 432 * column in the database. The meaning of 'secondary_id' differs 433 * between components/types. Accepts a single ID, or an array of 434 * multiple IDs. Defaults to false. 435 * @type string|bool $display_comments How to handle activity comments. 436 * Possible values: 437 * - 'threaded' - comments appear in a threaded tree, under their 438 * parent items 439 * - 'stream' - the activity stream is presented in a flat manner, 440 * with comments sorted in chronological order alongside other 441 * activity items 442 * - false - don't fetch activity comments at all 443 * Default: 'threaded'. 444 * @type bool $show_hidden Whether to show items marked hide_sitewide. 445 * Defaults to false, except in the following cases: 446 * - User is viewing his own activity stream 447 * - User is viewing the activity stream of a non-public group of 448 * which he is a member 449 * @type bool $show_hidden Normally defaults to false, except when: 450 * - a user is viewing his own activity stream 451 * - a user is viewing the activity stream of a non-public group of 452 * which he is a member 453 * @type string|bool $spam Spam status. 'ham_only', 'spam_only', or false 454 * to show all activity regardless of spam status. Default: 'ham_only'. 455 * } 456 * @return bool Returns true when activities are found, otherwise false. 299 457 */ 300 458 function bp_has_activities( $args = '' ) { … … 475 633 476 634 /** 477 * Determine sif there are still activities left in the loop.635 * Determine if there are still activities left in the loop. 478 636 * 479 637 * @since BuddyPress (1.0) … … 482 640 * @uses BP_Activity_Template::user_activities() {@link BP_Activity_Template::user_activities()} 483 641 * 484 * @return bool Returns true when activities are found 642 * @return bool Returns true when activities are found. 485 643 */ 486 644 function bp_activities() { … … 490 648 491 649 /** 492 * Get s the current activity object in the loop650 * Get the current activity object in the loop. 493 651 * 494 652 * @since BuddyPress (1.0) … … 497 655 * @uses BP_Activity_Template::the_activity() {@link BP_Activity_Template::the_activity()} 498 656 * 499 * @return object The current activity within the loop 657 * @return object The current activity within the loop. 500 658 */ 501 659 function bp_the_activity() { … … 505 663 506 664 /** 507 * Output s the activity pagination count665 * Output the activity pagination count. 508 666 * 509 667 * @since BuddyPress (1.0) … … 517 675 518 676 /** 519 * Return s the activity pagination count677 * Return the activity pagination count. 520 678 * 521 679 * @since BuddyPress (1.2) … … 524 682 * @uses bp_core_number_format() 525 683 * 526 * @return string The pagination text 684 * @return string The pagination text. 527 685 */ 528 686 function bp_get_activity_pagination_count() { … … 538 696 539 697 /** 540 * Output s the activity pagination links698 * Output the activity pagination links. 541 699 * 542 700 * @since BuddyPress (1.0) … … 549 707 550 708 /** 551 * Outputs the activity pagination links709 * Return the activity pagination links. 552 710 * 553 711 * @since BuddyPress (1.0) 554 712 * 555 713 * @global object $activities_template {@link BP_Activity_Template} 556 * @uses apply_filters() To call the 'bp_get_activity_pagination_links' hook 557 * 558 * @return string The pagination links 714 * @uses apply_filters() To call the 'bp_get_activity_pagination_links' hook. 715 * 716 * @return string The pagination links. 559 717 */ 560 718 function bp_get_activity_pagination_links() { … … 565 723 566 724 /** 567 * Return s true when there are more activity items to be shown than currently appear725 * Return true when there are more activity items to be shown than currently appear. 568 726 * 569 727 * @since BuddyPress (1.5) 570 728 * 571 729 * @global object $activities_template {@link BP_Activity_Template} 572 * @uses apply_filters() To call the 'bp_activity_has_more_items' hook 573 * 574 * @return bool $has_more_items True if more items, false if not 730 * @uses apply_filters() To call the 'bp_activity_has_more_items' hook. 731 * 732 * @return bool $has_more_items True if more items, false if not. 575 733 */ 576 734 function bp_activity_has_more_items() { … … 584 742 585 743 /** 586 * Output s the activity count744 * Output the activity count. 587 745 * 588 746 * @since BuddyPress (1.2) … … 595 753 596 754 /** 597 * Return s the activity count598 * 599 * @since BuddyPress (1.2) 600 * 601 * @global object $activities_template {@link BP_Activity_Template} 602 * @uses apply_filters() To call the 'bp_get_activity_count' hook 603 * 604 * @return int The activity count 755 * Return the activity count. 756 * 757 * @since BuddyPress (1.2) 758 * 759 * @global object $activities_template {@link BP_Activity_Template} 760 * @uses apply_filters() To call the 'bp_get_activity_count' hook. 761 * 762 * @return int The activity count. 605 763 */ 606 764 function bp_get_activity_count() { … … 611 769 612 770 /** 613 * Output s the number of activities per page771 * Output the number of activities per page. 614 772 * 615 773 * @since BuddyPress (1.2) … … 622 780 623 781 /** 624 * Return s the number of activities per page625 * 626 * @since BuddyPress (1.2) 627 * 628 * @global object $activities_template {@link BP_Activity_Template} 629 * @uses apply_filters() To call the 'bp_get_activity_per_page' hook 630 * 631 * @return int The activities per page 782 * Return the number of activities per page. 783 * 784 * @since BuddyPress (1.2) 785 * 786 * @global object $activities_template {@link BP_Activity_Template} 787 * @uses apply_filters() To call the 'bp_get_activity_per_page' hook. 788 * 789 * @return int The activities per page. 632 790 */ 633 791 function bp_get_activity_per_page() { … … 638 796 639 797 /** 640 * Output s the activities title798 * Output the activities title. 641 799 * 642 800 * @since BuddyPress (1.0) 643 801 * 644 802 * @uses bp_get_activities_title() 803 * @todo Deprecate. 645 804 */ 646 805 function bp_activities_title() { … … 649 808 650 809 /** 651 * Return s the activities title810 * Return the activities title. 652 811 * 653 812 * @since BuddyPress (1.0) 654 813 * 655 814 * @global string $bp_activity_title 656 * @uses apply_filters() To call the 'bp_get_activities_title' hook 657 * 658 * @return int The activities title 815 * @uses apply_filters() To call the 'bp_get_activities_title' hook. 816 * @todo Deprecate. 817 * 818 * @return int The activities title. 659 819 */ 660 820 function bp_get_activities_title() { … … 670 830 * 671 831 * @uses bp_get_activities_no_activity() 832 * @todo Deprecate. 672 833 */ 673 834 function bp_activities_no_activity() { … … 682 843 * @global string $bp_activity_no_activity 683 844 * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook 845 * @todo Deprecate. 684 846 * 685 847 * @return string … … 692 854 693 855 /** 694 * Output s the activity id856 * Output the activity ID. 695 857 * 696 858 * @since BuddyPress (1.2) … … 703 865 704 866 /** 705 * Return s the activity id706 * 707 * @since BuddyPress (1.2) 708 * 709 * @global object $activities_template {@link BP_Activity_Template} 710 * @uses apply_filters() To call the 'bp_get_activity_id' hook 711 * 712 * @return int The activity id867 * Return the activity ID. 868 * 869 * @since BuddyPress (1.2) 870 * 871 * @global object $activities_template {@link BP_Activity_Template} 872 * @uses apply_filters() To call the 'bp_get_activity_id' hook. 873 * 874 * @return int The activity ID. 713 875 */ 714 876 function bp_get_activity_id() { … … 718 880 719 881 /** 720 * Output s the activity item id882 * Output the activity item ID. 721 883 * 722 884 * @since BuddyPress (1.2) … … 729 891 730 892 /** 731 * Return s the activity item id732 * 733 * @since BuddyPress (1.2) 734 * 735 * @global object $activities_template {@link BP_Activity_Template} 736 * @uses apply_filters() To call the 'bp_get_activity_item_id' hook 737 * 738 * @return int The activity item id893 * Return the activity item ID. 894 * 895 * @since BuddyPress (1.2) 896 * 897 * @global object $activities_template {@link BP_Activity_Template} 898 * @uses apply_filters() To call the 'bp_get_activity_item_id' hook. 899 * 900 * @return int The activity item ID. 739 901 */ 740 902 function bp_get_activity_item_id() { … … 744 906 745 907 /** 746 * Output s the activity secondary item id908 * Output the activity secondary item ID. 747 909 * 748 910 * @since BuddyPress (1.2) … … 755 917 756 918 /** 757 * Return s the activity secondary item id758 * 759 * @since BuddyPress (1.2) 760 * 761 * @global object $activities_template {@link BP_Activity_Template} 762 * @uses apply_filters() To call the 'bp_get_activity_secondary_item_id' hook 763 * 764 * @return int The activity secondary item id919 * Return the activity secondary item ID. 920 * 921 * @since BuddyPress (1.2) 922 * 923 * @global object $activities_template {@link BP_Activity_Template} 924 * @uses apply_filters() To call the 'bp_get_activity_secondary_item_id' hook. 925 * 926 * @return int The activity secondary item ID. 765 927 */ 766 928 function bp_get_activity_secondary_item_id() { … … 770 932 771 933 /** 772 * Output s the date the activity was recorded934 * Output the date the activity was recorded. 773 935 * 774 936 * @since BuddyPress (1.2) … … 781 943 782 944 /** 783 * Return s the date the activity was recorded784 * 785 * @since BuddyPress (1.2) 786 * 787 * @global object $activities_template {@link BP_Activity_Template} 788 * @uses apply_filters() To call the 'bp_get_activity_date_recorded' hook 789 * 790 * @return string The date the activity was recorded 945 * Return the date the activity was recorded. 946 * 947 * @since BuddyPress (1.2) 948 * 949 * @global object $activities_template {@link BP_Activity_Template} 950 * @uses apply_filters() To call the 'bp_get_activity_date_recorded' hook. 951 * 952 * @return string The date the activity was recorded. 791 953 */ 792 954 function bp_get_activity_date_recorded() { … … 796 958 797 959 /** 798 * Output s the activity object name960 * Output the activity object name. 799 961 * 800 962 * @since BuddyPress (1.2) … … 807 969 808 970 /** 809 * Return s the activity object name810 * 811 * @since BuddyPress (1.2) 812 * 813 * @global object $activities_template {@link BP_Activity_Template} 814 * @uses apply_filters() To call the 'bp_get_activity_object_name' hook 815 * 816 * @return string The activity object name 971 * Return the activity object name. 972 * 973 * @since BuddyPress (1.2) 974 * 975 * @global object $activities_template {@link BP_Activity_Template} 976 * @uses apply_filters() To call the 'bp_get_activity_object_name' hook. 977 * 978 * @return string The activity object name. 817 979 */ 818 980 function bp_get_activity_object_name() { … … 822 984 823 985 /** 824 * Output s the activity type986 * Output the activity type. 825 987 * 826 988 * @since BuddyPress (1.2) … … 833 995 834 996 /** 835 * Return s the activity type836 * 837 * @since BuddyPress (1.2) 838 * 839 * @global object $activities_template {@link BP_Activity_Template} 840 * @uses apply_filters() To call the 'bp_get_activity_type' hook 841 * 842 * @return string The activity type 997 * Return the activity type. 998 * 999 * @since BuddyPress (1.2) 1000 * 1001 * @global object $activities_template {@link BP_Activity_Template} 1002 * @uses apply_filters() To call the 'bp_get_activity_type' hook. 1003 * 1004 * @return string The activity type. 843 1005 */ 844 1006 function bp_get_activity_type() { … … 848 1010 849 1011 /** 850 * Output s the activity action name851 * 852 * Just a wrapper for bp_activity_type() 1012 * Output the activity action name. 1013 * 1014 * Just a wrapper for bp_activity_type(). 853 1015 * 854 1016 * @since BuddyPress (1.2) … … 863 1025 864 1026 /** 865 * Return s the activity type866 * 867 * Just a wrapper for bp_get_activity_type() 1027 * Return the activity type. 1028 * 1029 * Just a wrapper for bp_get_activity_type(). 868 1030 * 869 1031 * @since BuddyPress (1.2) 870 1032 * @deprecated BuddyPress (1.5) 871 1033 * 872 * @todo Properly deprecate in favor of bp_get_activity_type() 1034 * @todo Properly deprecate in favor of bp_get_activity_type(). 873 1035 * 874 1036 * @uses bp_get_activity_type() 875 1037 * 876 * @return string The activity type 1038 * @return string The activity type. 877 1039 */ 878 1040 function bp_get_activity_action_name() { return bp_get_activity_type(); } 879 1041 880 1042 /** 881 * Output s the activity user id1043 * Output the activity user ID. 882 1044 * 883 1045 * @since BuddyPress (1.1) … … 890 1052 891 1053 /** 892 * Return s the activity user id1054 * Return the activity user ID. 893 1055 * 894 1056 * @since BuddyPress (1.1) 895 1057 * 896 1058 * @global object $activities_template {@link BP_Activity_Template} 897 * @uses apply_filters() To call the 'bp_get_activity_user_id' hook 898 * 899 * @return int The activity user id1059 * @uses apply_filters() To call the 'bp_get_activity_user_id' hook. 1060 * 1061 * @return int The activity user ID. 900 1062 */ 901 1063 function bp_get_activity_user_id() { … … 905 1067 906 1068 /** 907 * Output s the activity user link1069 * Output the activity user link. 908 1070 * 909 1071 * @since BuddyPress (1.2) … … 916 1078 917 1079 /** 918 * Return s the activity user link1080 * Return the activity user link. 919 1081 * 920 1082 * @since BuddyPress (1.2) … … 922 1084 * @global object $activities_template {@link BP_Activity_Template} 923 1085 * @uses bp_core_get_user_domain() 924 * @uses apply_filters() To call the 'bp_get_activity_user_link' hook 925 * 926 * @return string $link The activity user link 1086 * @uses apply_filters() To call the 'bp_get_activity_user_link' hook. 1087 * 1088 * @return string $link The activity user link. 927 1089 */ 928 1090 function bp_get_activity_user_link() { … … 938 1100 939 1101 /** 940 * Output the avatar of the user that performed the action 1102 * Output the avatar of the user that performed the action. 941 1103 * 942 1104 * @since BuddyPress (1.1) 943 1105 * 944 * @param array $args 945 * 1106 * @see bp_get_activity_avatar() for description of arguments. 946 1107 * @uses bp_get_activity_avatar() 1108 * 1109 * @param array $args See {@link bp_get_activity_avatar()} for description. 947 1110 */ 948 1111 function bp_activity_avatar( $args = '' ) { … … 950 1113 } 951 1114 /** 952 * Return the avatar of the user that performed the action 1115 * Return the avatar of the user that performed the action. 953 1116 * 954 1117 * @since BuddyPress (1.1) 955 1118 * 956 * @param array $args optional 957 * 1119 * @see bp_core_fetch_avatar() For a description of the arguments. 958 1120 * @global object $activities_template {@link BP_Activity_Template} 959 1121 * @global object $bp BuddyPress global settings … … 965 1127 * @uses apply_filters() To call the 'bp_get_activity_avatar' hook 966 1128 * 967 * @return string User avatar 1129 * @param array $args { 1130 * Arguments are listed here with an explanation of their defaults. 1131 * For more information about the arguments, see 1132 * {@link bp_core_fetch_avatar()}. 1133 * @type string $alt Default: 'Profile picture of [user name]' if 1134 * activity user name is available, otherwise 'Profile picture'. 1135 * @type string $class Default: 'avatar'. 1136 * @type string|bool $email Default: Email of the activity's 1137 * associated user, if available. Otherwise false. 1138 * @type string $type Default: 'full' when viewing a single activity 1139 * permalink page, otherwise 'thumb'. 1140 * @type int|bool $user_id Default: ID of the activity's user. 1141 * } 1142 * @return string User avatar string. 968 1143 */ 969 1144 function bp_get_activity_avatar( $args = '' ) { … … 1035 1210 1036 1211 /** 1037 * Output the avatar of the object that action was performed on 1038 * 1039 * @since BuddyPress (1.2) 1040 * 1041 * @param array $args optional 1042 * 1212 * Output the avatar of the object that action was performed on. 1213 * 1214 * @since BuddyPress (1.2) 1215 * 1216 * @see bp_get_activity_secondary_avatar() for description of arguments. 1043 1217 * @uses bp_get_activity_secondary_avatar() 1218 * 1219 * @param array $args See {@link bp_get_activity_secondary_avatar} for description. 1044 1220 */ 1045 1221 function bp_activity_secondary_avatar( $args = '' ) { … … 1052 1228 * @since BuddyPress (1.2) 1053 1229 * 1054 * @param array $args optional 1055 * 1230 * @see bp_core_fetch_avatar() for description of arguments. 1056 1231 * @global object $activities_template {@link BP_Activity_Template} 1057 1232 * @uses wp_parse_args() 1058 1233 * @uses get_blog_option() 1059 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar_object_' . $activities_template->activity->component hook 1060 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar_item_id' hook 1234 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar_object_' . $activities_template->activity->component hook. 1235 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar_item_id' hook. 1061 1236 * @uses bp_core_fetch_avatar() 1062 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar' hook 1063 * 1237 * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar' hook. 1238 * 1239 * @param array $args { 1240 * For a complete description of arguments, see {@link bp_core_fetch_avatar()}. 1241 * @type string $alt Default value varies based on current activity 1242 * item component. 1243 * @type string $type Default: 'full' when viewing a single activity 1244 * permalink page, otherwise 'thumb'. 1245 * @type string $class Default: 'avatar'. 1246 * @type string|bool $email Default: email of the activity's user. 1247 * @type int|bool $user_id Default: ID of the activity's user. 1248 * } 1064 1249 * @return string The secondary avatar 1065 1250 */ … … 1192 1377 * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook 1193 1378 * @uses bp_insert_activity_meta() 1194 * @uses apply_filters_ref_array() To call the 'bp_get_activity_action' hook 1195 * 1196 * @return string The activity action 1379 * @uses apply_filters_ref_array() To call the 'bp_get_activity_action' hook. 1380 * 1381 * @param array $args { 1382 * @type bool $no_timestamp Whether to exclude the timestamp. 1383 * } 1384 * @return string The activity action. 1197 1385 */ 1198 1386 function bp_get_activity_action( $args = array() ) { … … 1233 1421 * @global object $activities_template {@link BP_Activity_Template} 1234 1422 * @uses bp_insert_activity_meta() 1235 * @uses apply_filters_ref_array() To call the 'bp_get_activity_content_body' hook 1236 * 1237 * @return string The activity content body 1423 * @uses apply_filters_ref_array() To call the 'bp_get_activity_content_body' hook. 1424 * 1425 * @return string The activity content body. 1238 1426 */ 1239 1427 function bp_get_activity_content_body() { … … 1254 1442 * @global object $activities_template {@link BP_Activity_Template} 1255 1443 * 1256 * @return bool True if activity has content, false otherwise 1444 * @return bool True if activity has content, false otherwise. 1257 1445 */ 1258 1446 function bp_activity_has_content() { … … 1266 1454 1267 1455 /** 1268 * Output the activity content 1456 * Output the activity content. 1269 1457 * 1270 1458 * @since BuddyPress (1.0) 1271 1459 * @deprecated BuddyPress (1.5) 1272 1460 * 1273 * @todo properly deprecate this function 1461 * @todo properly deprecate this function. 1274 1462 * 1275 1463 * @uses bp_get_activity_content() … … 1280 1468 1281 1469 /** 1282 * Return the activity content 1470 * Return the activity content. 1283 1471 * 1284 1472 * @since BuddyPress (1.0) 1285 1473 * @deprecated BuddyPress (1.5) 1286 1474 * 1287 * @todo properly deprecate this function 1475 * @todo properly deprecate this function. 1288 1476 * 1289 1477 * @uses bp_get_activity_action() 1290 1478 * @uses bp_get_activity_content_body() 1291 * @uses apply_filters() To call the 'bp_get_activity_content' hook 1292 * 1293 * @return string The activity content 1479 * @uses apply_filters() To call the 'bp_get_activity_content' hook. 1480 * 1481 * @return string The activity content. 1294 1482 */ 1295 1483 function bp_get_activity_content() { … … 1306 1494 1307 1495 /** 1308 * Insert activity meta 1309 * 1310 * @since BuddyPress (1.2) 1311 * 1312 * @param string $content 1496 * Attach metadata about an activity item to the activity content. 1497 * 1498 * This metadata includes the time since the item was posted (which will appear 1499 * as a link to the item's permalink). 1500 * 1501 * @since BuddyPress (1.2) 1313 1502 * 1314 1503 * @global object $activities_template {@link BP_Activity_Template} 1315 1504 * @uses bp_core_time_since() 1316 * @uses apply_filters_ref_array() To call the 'bp_activity_time_since' hook 1505 * @uses apply_filters_ref_array() To call the 'bp_activity_time_since' hook. 1317 1506 * @uses bp_is_single_activity() 1318 1507 * @uses bp_activity_get_permalink() 1319 1508 * @uses esc_attr__() 1320 * @uses apply_filters_ref_array() To call the 'bp_activity_permalink' hook 1321 * @uses apply_filters() To call the 'bp_insert_activity_meta' hook 1322 * 1323 * @return string The activity content 1509 * @uses apply_filters_ref_array() To call the 'bp_activity_permalink' hook. 1510 * @uses apply_filters() To call the 'bp_insert_activity_meta' hook. 1511 * 1512 * @param string $content The activity content. 1513 * @return string The activity content with the metadata string attached. 1324 1514 */ 1325 1515 function bp_insert_activity_meta( $content ) { … … 1342 1532 1343 1533 /** 1344 * Determine if the current user can delete an activity item 1345 * 1346 * @since BuddyPress (1.2) 1347 * 1348 * @param object $activity Optional 1534 * Determine if the current user can delete an activity item. 1535 * 1536 * @since BuddyPress (1.2) 1349 1537 * 1350 1538 * @global object $activities_template {@link BP_Activity_Template} 1351 1539 * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook 1352 1540 * 1353 * @return bool True if can delete, false otherwise 1541 * @param object $activity Optional. Falls back on the current item in the loop. 1542 * @return bool True if can delete, false otherwise. 1354 1543 */ 1355 1544 function bp_activity_user_can_delete( $activity = false ) { … … 1377 1566 1378 1567 /** 1379 * Output the activity parent content 1380 * 1381 * @since BuddyPress (1.2) 1382 * 1383 * @param array $args Optional 1384 * 1568 * Output the activity parent content. 1569 * 1570 * @since BuddyPress (1.2) 1571 * 1572 * @see bp_get_activity_parent_content() for a description of arguments. 1385 1573 * @uses bp_get_activity_parent_content() 1574 * 1575 * @param array $args See {@link bp_get_activity_parent_content} for description. 1386 1576 */ 1387 1577 function bp_activity_parent_content( $args = '' ) { … … 1390 1580 1391 1581 /** 1392 * Return the activity content 1393 * 1394 * @since BuddyPress (1.2) 1395 * 1396 * @param array $args Optional 1582 * Return the activity content. 1583 * 1584 * @since BuddyPress (1.2) 1397 1585 * 1398 1586 * @global object $activities_template {@link BP_Activity_Template} 1399 1587 * @uses wp_parse_args() 1400 * @uses apply_filters() To call the 'bp_get_activity_parent_content' hook 1401 * 1588 * @uses apply_filters() To call the 'bp_get_activity_parent_content' hook. 1589 * 1590 * @param array $args { 1591 * Array of optional arguments. 1592 * @deprecated bool $hide_user No longer used. 1593 * } 1402 1594 * @return mixed False on failure, otherwise the activity parent content 1403 1595 */ … … 1441 1633 1442 1634 /** 1443 * Output the parent activity's user ID 1635 * Output the parent activity's user ID. 1444 1636 * 1445 1637 * @since BuddyPress (1.7) … … 1450 1642 1451 1643 /** 1452 * Return the parent activity's user ID 1644 * Return the parent activity's user ID. 1645 * 1646 * @since BuddyPress (1.7) 1453 1647 * 1454 1648 * @global BP_Activity_Template $activities_template 1455 * @return bool|int False if parent activity can't be found, otherwise returns the parent activity's user ID 1456 * @since BuddyPress (1.7) 1649 * 1650 * @return bool|int False if parent activity can't be found, otherwise 1651 * the parent activity's user ID. 1457 1652 */ 1458 1653 function bp_get_activity_parent_user_id() { … … 1481 1676 1482 1677 /** 1483 * Output whether or not the current activity is in a current user's favorites 1678 * Output whether or not the current activity is in a current user's favorites. 1484 1679 * 1485 1680 * @since BuddyPress (1.2) … … 1492 1687 1493 1688 /** 1494 * Return whether or not the current activity is in a current user's favorites1495 * 1496 * @since BuddyPress (1.2) 1497 * 1498 * @global object $activities_template {@link BP_Activity_Template} 1499 * @uses apply_filters() To call the 'bp_get_activity_is_favorite' hook 1500 * 1501 * @return bool True if user favorite, false otherwise 1689 * Return whether the current activity is in a current user's favorites. 1690 * 1691 * @since BuddyPress (1.2) 1692 * 1693 * @global object $activities_template {@link BP_Activity_Template} 1694 * @uses apply_filters() To call the 'bp_get_activity_is_favorite' hook. 1695 * 1696 * @return bool True if user favorite, false otherwise. 1502 1697 */ 1503 1698 function bp_get_activity_is_favorite() { … … 1508 1703 1509 1704 /** 1510 * Echoes the comment markup for an activity item1705 * Output the comment markup for an activity item. 1511 1706 * 1512 1707 * @since BuddyPress (1.2) … … 1521 1716 1522 1717 /** 1523 * Get s the comment markup for an activity item1718 * Get the comment markup for an activity item. 1524 1719 * 1525 1720 * @since BuddyPress (1.2) … … 1591 1786 1592 1787 /** 1593 * Utility function that returns the comment currently being recursed 1788 * Utility function that returns the comment currently being recursed. 1594 1789 * 1595 1790 * @since BuddyPress (1.5) 1596 1791 * 1597 1792 * @global object $activities_template {@link BP_Activity_Template} 1598 * @uses apply_filters() To call the 'bp_activity_current_comment' hook 1599 * 1600 * @return object|bool $current_comment The activity comment currently being displayed. False on failure 1793 * @uses apply_filters() To call the 'bp_activity_current_comment' hook. 1794 * 1795 * @return object|bool $current_comment The activity comment currently being 1796 * displayed. False on failure. 1601 1797 */ 1602 1798 function bp_activity_current_comment() { … … 1610 1806 1611 1807 /** 1612 * Echoes the id of the activity comment currently being displayed1808 * Output the ID of the activity comment currently being displayed. 1613 1809 * 1614 1810 * @since BuddyPress (1.5) … … 1621 1817 1622 1818 /** 1623 * Gets the id of the activity comment currently being displayed1819 * Return the ID of the activity comment currently being displayed. 1624 1820 * 1625 1821 * @since BuddyPress (1.5) 1626 1822 * 1627 1823 * @global object $activities_template {@link BP_Activity_Template} 1628 * @uses apply_filters() To call the 'bp_activity_comment_id' hook 1629 * 1630 * @return int $comment_id The id of the activity comment currently being displayed 1824 * @uses apply_filters() To call the 'bp_activity_comment_id' hook. 1825 * 1826 * @return int|bool $comment_id The ID of the activity comment 1827 * currently being displayed, false if none is found. 1631 1828 */ 1632 1829 function bp_get_activity_comment_id() { … … 1639 1836 1640 1837 /** 1641 * Echoes the user_id of the author of the activity comment currently being displayed1838 * Output the ID of the author of the activity comment currently being displayed. 1642 1839 * 1643 1840 * @since BuddyPress (1.5) … … 1650 1847 1651 1848 /** 1652 * Gets the user_id of the author of the activity comment currently being displayed1849 * Return the ID of the author of the activity comment currently being displayed. 1653 1850 * 1654 1851 * @since BuddyPress (1.5) 1655 1852 * 1656 1853 * @global object $activities_template {@link BP_Activity_Template} 1657 * @uses apply_filters() To call the 'bp_activity_comment_user_id' hook 1658 * 1659 * @return int|bool $user_id The user_id of the author of the displayed activity comment. False on failure 1854 * @uses apply_filters() To call the 'bp_activity_comment_user_id' hook. 1855 * 1856 * @return int|bool $user_id The user_id of the author of the displayed 1857 * activity comment. False on failure. 1660 1858 */ 1661 1859 function bp_get_activity_comment_user_id() { … … 1668 1866 1669 1867 /** 1670 * Echoes the author link for the activity comment currently being displayed1868 * Output the author link for the activity comment currently being displayed. 1671 1869 * 1672 1870 * @since BuddyPress (1.5) … … 1679 1877 1680 1878 /** 1681 * Gets the author link for the activity comment currently being displayed1879 * Return the author link for the activity comment currently being displayed. 1682 1880 * 1683 1881 * @since BuddyPress (1.5) … … 1687 1885 * @uses apply_filters() To call the 'bp_activity_comment_user_link' hook 1688 1886 * 1689 * @return string $user_link The URL of the activity comment author's profile 1887 * @return string $user_link The URL of the activity comment author's profile. 1690 1888 */ 1691 1889 function bp_get_activity_comment_user_link() { … … 1696 1894 1697 1895 /** 1698 * Echoes the author name for the activity comment currently being displayed1896 * Output the author name for the activity comment currently being displayed. 1699 1897 * 1700 1898 * @since BuddyPress (1.5) … … 1707 1905 1708 1906 /** 1709 * Gets the author name for the activity comment currently being displayed 1710 * 1711 * The use of the bp_acomment_name filter is deprecated. Please use bp_activity_comment_name 1907 * Return the author name for the activity comment currently being displayed. 1908 * 1909 * The use of the 'bp_acomment_name' filter is deprecated. Please use 1910 * 'bp_activity_comment_name'. 1712 1911 * 1713 1912 * @since BuddyPress (1.5) 1714 1913 * 1715 1914 * @global object $activities_template {@link BP_Activity_Template} 1716 * @uses apply_filters() To call the 'bp_acomment_name' hook 1717 * @uses apply_filters() To call the 'bp_activity_comment_name' hook 1718 * 1719 * @return string $name The full name of the activity comment author 1915 * @uses apply_filters() To call the 'bp_acomment_name' hook. 1916 * @uses apply_filters() To call the 'bp_activity_comment_name' hook. 1917 * 1918 * @return string $name The full name of the activity comment author. 1720 1919 */ 1721 1920 function bp_get_activity_comment_name() { … … 1731 1930 1732 1931 /** 1733 * Echoes the date_recorded of the activity comment currently being displayed1932 * Output the date_recorded of the activity comment currently being displayed. 1734 1933 * 1735 1934 * @since BuddyPress (1.5) … … 1742 1941 1743 1942 /** 1744 * Gets the date_recorded for the activity comment currently being displayed1943 * Return the date_recorded for the activity comment currently being displayed. 1745 1944 * 1746 1945 * @since BuddyPress (1.5) … … 1750 1949 * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook 1751 1950 * 1752 * @return string|bool $date_recorded Time since the activity was recorded, of the form "%s ago". False on failure 1951 * @return string|bool $date_recorded Time since the activity was recorded, 1952 * in the form "%s ago". False on failure. 1753 1953 */ 1754 1954 function bp_get_activity_comment_date_recorded() { … … 1764 1964 1765 1965 /** 1766 * Echoes the 'delete' URL for the activity comment currently being displayed1966 * Output the 'delete' URL for the activity comment currently being displayed. 1767 1967 * 1768 1968 * @since BuddyPress (1.5) … … 1783 1983 * @uses bp_get_activity_slug() 1784 1984 * @uses bp_get_activity_comment_id() 1785 * @uses apply_filters() To call the 'bp_activity_comment_delete_link' hook 1786 * 1787 * @return string $link The nonced URL for deleting the current activity comment 1985 * @uses apply_filters() To call the 'bp_activity_comment_delete_link' hook. 1986 * 1987 * @return string $link The nonced URL for deleting the current 1988 * activity comment. 1788 1989 */ 1789 1990 function bp_get_activity_comment_delete_link() { … … 1794 1995 1795 1996 /** 1796 * Echoes the content of the activity comment currently being displayed1997 * Output the content of the activity comment currently being displayed. 1797 1998 * 1798 1999 * @since BuddyPress (1.5) … … 1805 2006 1806 2007 /** 1807 * Gets the content of the activity comment currently being displayed 1808 * 1809 * The content is run through two filters. bp_get_activity_content will apply all filters 1810 * applied to activity items in general. Use bp_activity_comment_content to modify the 1811 * content of activity comments only. 2008 * Return the content of the activity comment currently being displayed. 2009 * 2010 * The content is run through two filters. 'bp_get_activity_content' 2011 * will apply all filters applied to activity items in general. Use 2012 * 'bp_activity_comment_content' to modify the content of activity 2013 * comments only. 1812 2014 * 1813 2015 * @since BuddyPress (1.5) 1814 2016 * 1815 2017 * @global object $activities_template {@link BP_Activity_Template} 1816 * @uses apply_filters() To call the 'bp_get_activity_content' hook 1817 * @uses apply_filters() To call the 'bp_activity_comment_content' hook 1818 * 1819 * @return string $content The content of the current activity comment 2018 * @uses apply_filters() To call the 'bp_get_activity_content' hook. 2019 * @uses apply_filters() To call the 'bp_activity_comment_content' hook. 2020 * 2021 * @return string $content The content of the current activity comment. 1820 2022 */ 1821 2023 function bp_get_activity_comment_content() { … … 1828 2030 1829 2031 /** 1830 * Echoes the activity comment count2032 * Output the activity comment count. 1831 2033 * 1832 2034 * @since BuddyPress (1.2) … … 1839 2041 1840 2042 /** 1841 * Gets the content of the activity comment currently being displayed 1842 * 1843 * The content is run through two filters. bp_get_activity_content will apply all filters 1844 * applied to activity items in general. Use bp_activity_comment_content to modify the 1845 * content of activity comments only. 1846 * 1847 * @since BuddyPress (1.2) 1848 * 2043 * Return the content of the activity comment currently being displayed. 2044 * 2045 * The content is run through two filters. 'bp_get_activity_content' 2046 * will apply all filters applied to activity items in general. Use 2047 * 'bp_activity_comment_content' to modify the content of activity 2048 * comments only. 2049 * 2050 * @since BuddyPress (1.2) 2051 * 2052 * @global object $activities_template {@link BP_Activity_Template} 2053 * @uses bp_activity_recurse_comment_count() 2054 * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook. 1849 2055 * @todo deprecate $args 1850 2056 * 1851 * @global object $activities_template {@link BP_Activity_Template} 1852 * @uses bp_activity_recurse_comment_count() 1853 * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook 1854 * 1855 * @return int $count The activity comment count. Defaults to zero 2057 * @param array $args Deprecated. 2058 * @return int $count The activity comment count. 1856 2059 */ 1857 2060 function bp_activity_get_comment_count( $args = '' ) { … … 1867 2070 1868 2071 /** 1869 * Gets the content of the activity comment currently being displayed2072 * Return the content of the activity comment currently being displayed. 1870 2073 * 1871 * The content is run through two filters. bp_get_activity_content will apply all filters 1872 * applied to activity items in general. Use bp_activity_comment_content to modify the 1873 * content of activity comments only. 2074 * The content is run through two filters. 'bp_get_activity_content' 2075 * will apply all filters applied to activity items in general. 2076 * Use bp_activity_comment_content to modify the content of 2077 * activity comments only. 1874 2078 * 1875 2079 * @since BuddyPress (1.2) 1876 2080 * 2081 * @uses bp_activity_recurse_comment_count() 2082 * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook 1877 2083 * @todo investigate why bp_activity_recurse_comment_count() is used while being declared 1878 2084 * 1879 * @param object $comment Activity comments object 1880 * 1881 * @uses bp_activity_recurse_comment_count() 1882 * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook 1883 * 2085 * @param object $comment Activity comment object. 2086 * @param int $count The current iteration count. 1884 2087 * @return int $count The activity comment count. 1885 2088 */ … … 1898 2101 1899 2102 /** 1900 * Echoes the activity comment link2103 * Output the activity comment link. 1901 2104 * 1902 2105 * @since BuddyPress (1.2) … … 1909 2112 1910 2113 /** 1911 * Gets the activity comment link1912 * 1913 * @since BuddyPress (1.2) 1914 * 1915 * @global object $activities_template {@link BP_Activity_Template} 1916 * @uses apply_filters() To call the 'bp_get_activity_comment_link' hook 1917 * 1918 * @return string The activity comment link 2114 * Return the activity comment link. 2115 * 2116 * @since BuddyPress (1.2) 2117 * 2118 * @global object $activities_template {@link BP_Activity_Template} 2119 * @uses apply_filters() To call the 'bp_get_activity_comment_link' hook. 2120 * 2121 * @return string The activity comment link. 1919 2122 */ 1920 2123 function bp_get_activity_comment_link() { … … 1924 2127 1925 2128 /** 1926 * Echoes the activity comment form no javascript display CSS2129 * Output the activity comment form no javascript display CSS. 1927 2130 * 1928 2131 * @since BuddyPress (1.2) … … 1935 2138 1936 2139 /** 1937 * Gets the activity comment form no javascript display CSS 1938 * 1939 * @since BuddyPress (1.2) 1940 * 1941 * @global object $activities_template {@link BP_Activity_Template} 1942 * 1943 * @return string|bool The activity comment form no javascript display CSS. False on failure 2140 * Return the activity comment form no javascript display CSS. 2141 * 2142 * @since BuddyPress (1.2) 2143 * 2144 * @global object $activities_template {@link BP_Activity_Template} 2145 * 2146 * @return string|bool The activity comment form no javascript 2147 * display CSS. False on failure 1944 2148 */ 1945 2149 function bp_get_activity_comment_form_nojs_display() { … … 1952 2156 1953 2157 /** 1954 * Echoes the activity comment form action2158 * Output the activity comment form action. 1955 2159 * 1956 2160 * @since BuddyPress (1.2) … … 1963 2167 1964 2168 /** 1965 * Gets the activity comment form action2169 * Return the activity comment form action. 1966 2170 * 1967 2171 * @since BuddyPress (1.2) … … 1969 2173 * @uses home_url() 1970 2174 * @uses bp_get_activity_root_slug() 1971 * @uses apply_filters() To call the 'bp_get_activity_comment_form_action' hook 1972 * 1973 * @return string The activity comment form action 2175 * @uses apply_filters() To call the 'bp_get_activity_comment_form_action' hook. 2176 * 2177 * @return string The activity comment form action. 1974 2178 */ 1975 2179 function bp_get_activity_comment_form_action() { … … 1978 2182 1979 2183 /** 1980 * Echoes the activity permalink id2184 * Output the activity permalink ID. 1981 2185 * 1982 2186 * @since BuddyPress (1.2) … … 1989 2193 1990 2194 /** 1991 * Gets the activity permalink id1992 * 1993 * @since BuddyPress (1.2) 1994 * 1995 * @uses apply_filters() To call the 'bp_get_activity_permalink_id' hook 1996 * 1997 * @return string The activity permalink id2195 * Return the activity permalink ID. 2196 * 2197 * @since BuddyPress (1.2) 2198 * 2199 * @uses apply_filters() To call the 'bp_get_activity_permalink_id' hook. 2200 * 2201 * @return string The activity permalink ID. 1998 2202 */ 1999 2203 function bp_get_activity_permalink_id() { … … 2002 2206 2003 2207 /** 2004 * Echoes the activity thread permalink2208 * Output the activity thread permalink. 2005 2209 * 2006 2210 * @since BuddyPress (1.2) … … 2013 2217 2014 2218 /** 2015 * Gets the activity thread permalink2219 * Return the activity thread permalink. 2016 2220 * 2017 2221 * @since BuddyPress (1.2) 2018 2222 * 2019 2223 * @uses bp_activity_get_permalink() 2020 * @uses apply_filters() To call the 'bp_get_activity_thread_permalink' hook 2021 * 2022 * @return string $link The activity thread permalink 2224 * @uses apply_filters() To call the 'bp_get_activity_thread_permalink' hook. 2225 * 2226 * @return string $link The activity thread permalink. 2023 2227 */ 2024 2228 function bp_get_activity_thread_permalink() { … … 2031 2235 2032 2236 /** 2033 * Echoes the activity comment permalink2237 * Output the activity comment permalink. 2034 2238 * 2035 2239 * @since BuddyPress (1.8) … … 2041 2245 } 2042 2246 /** 2043 * Gets the activity comment permalink2247 * Return the activity comment permalink. 2044 2248 * 2045 2249 * @since BuddyPress (1.8) 2046 2250 * 2047 2251 * @uses bp_activity_get_permalink() 2048 * @uses apply_filters() To call the 'bp_get_activity_comment_permalink' hook 2049 * 2050 * @return string $link The activity comment permalink 2252 * @uses apply_filters() To call the 'bp_get_activity_comment_permalink' hook. 2253 * 2254 * @return string $link The activity comment permalink. 2051 2255 */ 2052 2256 function bp_get_activity_comment_permalink() { … … 2059 2263 2060 2264 /** 2061 * Echoes the activity favorite link2265 * Output the activity favorite link. 2062 2266 * 2063 2267 * @since BuddyPress (1.2) … … 2070 2274 2071 2275 /** 2072 * Gets the activity favorite link2276 * Return the activity favorite link. 2073 2277 * 2074 2278 * @since BuddyPress (1.2) … … 2080 2284 * @uses apply_filters() To call the 'bp_get_activity_favorite_link' hook 2081 2285 * 2082 * @return string The activity favorite link 2286 * @return string The activity favorite link. 2083 2287 */ 2084 2288 function bp_get_activity_favorite_link() { … … 2088 2292 2089 2293 /** 2090 * Echoes the activity unfavorite link2294 * Output the activity unfavorite link. 2091 2295 * 2092 2296 * @since BuddyPress (1.2) … … 2099 2303 2100 2304 /** 2101 * Gets the activity unfavorite link2305 * Return the activity unfavorite link. 2102 2306 * 2103 2307 * @since BuddyPress (1.2) … … 2107 2311 * @uses home_url() 2108 2312 * @uses bp_get_activity_root_slug() 2109 * @uses apply_filters() To call the 'bp_get_activity_unfavorite_link' hook 2110 * 2111 * @return string The activity unfavorite link 2313 * @uses apply_filters() To call the 'bp_get_activity_unfavorite_link' hook. 2314 * 2315 * @return string The activity unfavorite link. 2112 2316 */ 2113 2317 function bp_get_activity_unfavorite_link() { … … 2117 2321 2118 2322 /** 2119 * Echoes the activity CSS class2323 * Output the activity CSS class. 2120 2324 * 2121 2325 * @since BuddyPress (1.0) … … 2128 2332 2129 2333 /** 2130 * Gets the activity CSS class2334 * Return the current activity item's CSS class. 2131 2335 * 2132 2336 * @since BuddyPress (1.0) 2133 2337 * 2134 2338 * @global object $activities_template {@link BP_Activity_Template} 2135 * @uses apply_filters() To call the 'bp_activity_mini_activity_types' hook 2339 * @uses apply_filters() To call the 'bp_activity_mini_activity_types' hook. 2136 2340 * @uses bp_activity_get_comment_count() 2137 2341 * @uses bp_activity_can_comment() 2138 * @uses apply_filters() To call the 'bp_get_activity_css_class' hook 2139 * 2140 * @return string The activity css class2342 * @uses apply_filters() To call the 'bp_get_activity_css_class' hook. 2343 * 2344 * @return string The activity item's CSS class. 2141 2345 */ 2142 2346 function bp_get_activity_css_class() { … … 2164 2368 2165 2369 /** 2166 * Displaythe activity delete link.2370 * Output the activity delete link. 2167 2371 * 2168 2372 * @since BuddyPress (1.1) … … 2187 2391 * @uses wp_get_referer() 2188 2392 * @uses wp_nonce_url() 2189 * @uses apply_filters() To call the 'bp_get_activity_delete_link' hook 2190 * 2191 * @return string $link Activity delete link. Contains $redirect_to arg if on single activity page. 2393 * @uses apply_filters() To call the 'bp_get_activity_delete_link' hook. 2394 * 2395 * @return string $link Activity delete link. Contains $redirect_to arg 2396 * if on single activity page. 2192 2397 */ 2193 2398 function bp_get_activity_delete_link() { … … 2208 2413 2209 2414 /** 2210 * Display the activity latest update link. 2211 * 2212 * @since BuddyPress (1.2) 2213 * 2214 * @param int $user_id Defaults to 0 2215 * 2415 * Output the activity latest update link. 2416 * 2417 * @since BuddyPress (1.2) 2418 * 2419 * @see bp_get_activity_latest_update() for description of parameters. 2216 2420 * @uses bp_get_activity_latest_update() 2421 * 2422 * @param int $user_id See {@link bp_get_activity_latest_update()} for description. 2217 2423 */ 2218 2424 function bp_activity_latest_update( $user_id = 0 ) { … … 2224 2430 * 2225 2431 * @since BuddyPress (1.2) 2226 *2227 * @param int $user_id Defaults to 02228 2432 * 2229 2433 * @uses bp_is_user_inactive() … … 2236 2440 * @uses apply_filters() To call the 'bp_get_activity_latest_update' hook 2237 2441 * 2238 * @return string|bool $latest_update The activity latest update link. False on failure 2442 * @param int $user_id If empty, will fall back on displayed user. 2443 * @return string|bool $latest_update The activity latest update link. 2444 * False on failure 2239 2445 */ 2240 2446 function bp_get_activity_latest_update( $user_id = 0 ) { … … 2256 2462 2257 2463 /** 2258 * Displaythe activity filter links.2464 * Output the activity filter links. 2259 2465 * 2260 2466 * @since BuddyPress (1.1) 2261 2467 * 2262 * @param array $args Defaults to false 2263 * 2468 * @see bp_get_activity_filter_links() for description of parameters. 2264 2469 * @uses bp_get_activity_filter_links() 2470 * 2471 * @param array $args See {@link bp_get_activity_filter_links()} for description. 2265 2472 */ 2266 2473 function bp_activity_filter_links( $args = false ) { … … 2272 2479 * 2273 2480 * @since BuddyPress (1.1) 2274 *2275 * @param array $args Defaults to false2276 2481 * 2277 2482 * @uses wp_parse_args() … … 2280 2485 * @uses add_query_arg() 2281 2486 * @uses remove_query_arg() 2282 * @uses apply_filters() To call the 'bp_get_activity_filter_link_href' hook 2283 * @uses apply_filters() To call the 'bp_get_activity_filter_links' hook 2284 * 2285 * @return string|bool $component_links The activity filter links. False on failure 2487 * @uses apply_filters() To call the 'bp_get_activity_filter_link_href' hook. 2488 * @uses apply_filters() To call the 'bp_get_activity_filter_links' hook. 2489 * 2490 * @param array $args { 2491 * @type string $style The type of markup to use for the links. 2492 * 'list', 'paragraph', or 'span'. Default: 'list'. 2493 * } 2494 * @return string|bool $component_links The activity filter links. 2495 * False on failure. 2286 2496 */ 2287 2497 function bp_get_activity_filter_links( $args = false ) { … … 2350 2560 2351 2561 /** 2352 * Determine if a comment can be made on an activity item 2562 * Determine if a comment can be made on an activity item. 2353 2563 * 2354 2564 * @since BuddyPress (1.2) … … 2356 2566 * @global object $activities_template {@link BP_Activity_Template} 2357 2567 * @uses bp_get_activity_action_name() 2358 * @uses apply_filters() To call the 'bp_activity_can_comment' hook 2359 * 2360 * @return bool $can_comment Defaults to true2568 * @uses apply_filters() To call the 'bp_activity_can_comment' hook. 2569 * 2570 * @return bool $can_comment True if item can receive comments. 2361 2571 */ 2362 2572 function bp_activity_can_comment() { … … 2377 2587 2378 2588 /** 2379 * Determine if a comment can be made on an activity reply item 2589 * Determine if a comment can be made on an activity reply item. 2590 * 2591 * Defaults to true, but can be modified by plugins. 2380 2592 * 2381 2593 * @since BuddyPress (1.5) 2382 2594 * 2383 * @param object $comment Activity comment2384 *2385 2595 * @uses apply_filters() To call the 'bp_activity_can_comment_reply' hook 2386 2596 * 2387 * @return bool $can_comment Defaults to true 2597 * @param object $comment Activity comment. 2598 * @return bool $can_comment True if comment can receive comments. 2388 2599 */ 2389 2600 function bp_activity_can_comment_reply( $comment ) { … … 2394 2605 2395 2606 /** 2396 * Determine if an favorites are allowed 2607 * Determine if an favorites are allowed. 2608 * 2609 * Defaults to true, but can be modified by plugins. 2397 2610 * 2398 2611 * @since BuddyPress (1.5) 2399 2612 * 2400 * @uses apply_filters() To call the 'bp_activity_can_favorite' hook 2401 * 2402 * @return bool $can_favorite Defaults to true2613 * @uses apply_filters() To call the 'bp_activity_can_favorite' hook. 2614 * 2615 * @return bool $can_favorite True if comment can receive comments. 2403 2616 */ 2404 2617 function bp_activity_can_favorite() { … … 2409 2622 2410 2623 /** 2411 * Echoes the total favorite count for a specified user 2412 * 2413 * @since BuddyPress (1.2) 2414 * 2415 * @param int $user_id Defaults to 0 2416 * 2624 * Output the total favorite count for a specified user. 2625 * 2626 * @since BuddyPress (1.2) 2627 * 2628 * @see bp_get_total_favorite_count_for_user() for description of parameters. 2417 2629 * @uses bp_get_total_favorite_count_for_user() 2630 * 2631 * @param int $user_id See {@link bp_get_total_favorite_count_for_user()}. 2418 2632 */ 2419 2633 function bp_total_favorite_count_for_user( $user_id = 0 ) { … … 2422 2636 2423 2637 /** 2424 * Returns the total favorite count for a specified user 2425 * 2426 * @since BuddyPress (1.2) 2427 * 2428 * @param int $user_id Defaults to 0 2638 * Return the total favorite count for a specified user. 2639 * 2640 * @since BuddyPress (1.2) 2429 2641 * 2430 2642 * @uses bp_activity_total_favorites_for_user() 2431 2643 * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook 2432 2644 * 2433 * @return int The total favorite count for a specified user 2645 * @param int $user_id ID of user being queried. Default: displayed user ID. 2646 * @return int The total favorite count for the specified user. 2434 2647 */ 2435 2648 function bp_get_total_favorite_count_for_user( $user_id = 0 ) { … … 2442 2655 2443 2656 /** 2444 * Echoes the total mention count for a specified user 2445 * 2446 * @since BuddyPress (1.2) 2447 * 2448 * @param int $user_id Defaults to 0 2449 * 2657 * Output the total mention count for a specified user. 2658 * 2659 * @since BuddyPress (1.2) 2660 * 2661 * @see bp_get_total_mention_count_for_user() for description of parameters. 2450 2662 * @uses bp_get_total_favorite_count_for_user() 2663 * 2664 * @param int $user_id See {@link bp_get_total_mention_count_for_user()}. 2451 2665 */ 2452 2666 function bp_total_mention_count_for_user( $user_id = 0 ) { … … 2455 2669 2456 2670 /** 2457 * Returns the total mention count for a specified user 2458 * 2459 * @since BuddyPress (1.2) 2460 * 2461 * @param int $user_id Defaults to 0 2671 * Return the total mention count for a specified user. 2672 * 2673 * @since BuddyPress (1.2) 2674 * 2462 2675 * @uses bp_get_user_meta() 2463 * @uses apply_filters() To call the 'bp_get_total_mention_count_for_user' hook 2464 * @return int The total mention count for a specified user 2676 * @uses apply_filters() To call the 'bp_get_total_mention_count_for_user' hook. 2677 * 2678 * @param int $user_id ID of user being queried. Default: displayed user ID. 2679 * @return int The total mention count for the specified user. 2465 2680 */ 2466 2681 function bp_get_total_mention_count_for_user( $user_id = 0 ) { … … 2473 2688 2474 2689 /** 2475 * Echoes the public message link for displayed user2690 * Output the public message link for displayed user. 2476 2691 * 2477 2692 * @since BuddyPress (1.2) … … 2484 2699 2485 2700 /** 2486 * Return s the public message link for displayed user2701 * Return the public message link for the displayed user. 2487 2702 * 2488 2703 * @since BuddyPress (1.2) … … 2497 2712 * @uses apply_filters() To call the 'bp_get_send_public_message_link' hook 2498 2713 * 2499 * @return string The public message link for displayed user2714 * @return string The public message link for the displayed user. 2500 2715 */ 2501 2716 function bp_get_send_public_message_link() { … … 2509 2724 2510 2725 /** 2511 * Echoes the mentioned user display name 2512 * 2513 * @since BuddyPress (1.2) 2514 * 2515 * @param int|string User id or username 2516 * 2726 * Output the mentioned user display name. 2727 * 2728 * @since BuddyPress (1.2) 2729 * 2730 * @see bp_get_mentioned_user_display_name() for description of parameters. 2517 2731 * @uses bp_get_mentioned_user_display_name() 2732 * 2733 * @param int|string $user_id_or_username See {@link bp_get_mentioned_user_display_name()}. 2518 2734 */ 2519 2735 function bp_mentioned_user_display_name( $user_id_or_username ) { … … 2526 2742 * @since BuddyPress (1.2) 2527 2743 * 2528 * @param int|string User id or username2529 *2530 2744 * @uses bp_core_get_user_displayname() 2531 * @uses apply_filters() To call the 'bp_get_mentioned_user_display_name' hook 2532 * 2533 * @return string The mentioned user display name 2745 * @uses apply_filters() To call the 'bp_get_mentioned_user_display_name' hook. 2746 * 2747 * @param int|string User ID or username. 2748 * @return string The mentioned user's display name. 2534 2749 */ 2535 2750 function bp_get_mentioned_user_display_name( $user_id_or_username ) { … … 2541 2756 2542 2757 /** 2543 * Output button for sending a public message 2544 * 2545 * @since BuddyPress (1.2) 2546 * 2547 * @param array $args Optional 2548 * 2758 * Output button for sending a public message (an @-mention). 2759 * 2760 * @since BuddyPress (1.2) 2761 * 2762 * @see bp_get_send_public_message_button() for description of parameters. 2549 2763 * @uses bp_get_send_public_message_button() 2764 * 2765 * @param array $args See {@link bp_get_send_public_message_button()}. 2550 2766 */ 2551 2767 function bp_send_public_message_button( $args = '' ) { … … 2554 2770 2555 2771 /** 2556 * Return button for sending a public message 2557 * 2558 * @since BuddyPress (1.2) 2559 * 2560 * @param array $args Optional 2772 * Return button for sending a public message (an @-mention). 2773 * 2774 * @since BuddyPress (1.2) 2561 2775 * 2562 2776 * @uses bp_get_send_public_message_link() 2563 2777 * @uses wp_parse_args() 2564 2778 * @uses bp_get_button() 2565 * @uses apply_filters() To call the 'bp_get_send_public_message_button' hook 2566 * 2567 * @return string The button for sending a public message 2779 * @uses apply_filters() To call the 'bp_get_send_public_message_button' hook. 2780 * 2781 * @param array $args { 2782 * All arguments are optional. See {@link BP_Button} for complete 2783 * descriptions. 2784 * @type string $id Default: 'public_message'. 2785 * @type string $component Default: 'activity'. 2786 * @type bool $must_be_logged_in Default: true. 2787 * @type bool $block_self Default: true. 2788 * @type string $wrapper_id Default: 'post-mention'. 2789 * @type string $link_href Default: the public message link for 2790 * the current member in the loop. 2791 * @type string $link_title Default: 'Send a public message on your 2792 * activity stream.'. 2793 * @type string $link_text Default: 'Public Message'. 2794 * @type string $link_class Default: 'activity-button mention'. 2795 * } 2796 * @return string The button for sending a public message. 2568 2797 */ 2569 2798 function bp_get_send_public_message_button( $args = '' ) { … … 2587 2816 2588 2817 /** 2589 * Output s the activity post form action2818 * Output the activity post form action. 2590 2819 * 2591 2820 * @since BuddyPress (1.2) … … 2598 2827 2599 2828 /** 2600 * Return s the activity post form action2829 * Return the activity post form action. 2601 2830 * 2602 2831 * @since BuddyPress (1.2) … … 2604 2833 * @uses home_url() 2605 2834 * @uses bp_get_activity_root_slug() 2606 * @uses apply_filters() To call the 'bp_get_activity_post_form_action' hook 2607 * 2608 * @return string The activity post form action 2835 * @uses apply_filters() To call the 'bp_get_activity_post_form_action' hook. 2836 * 2837 * @return string The activity post form action. 2609 2838 */ 2610 2839 function bp_get_activity_post_form_action() { … … 2613 2842 2614 2843 /** 2615 * Looks at all the activity comments on the current activity item, and prints the comments' authors's avatar wrapped in <LI> tags.2844 * Echo a list of linked avatars of users who have commented on the current activity item. 2616 2845 * 2617 2846 * Use this function to easily output activity comment authors' avatars. 2618 2847 * 2619 * @param array $args See {@link bp_core_fetch_avatar} for accepted values 2848 * Avatars are wrapped in <li> elements, but you've got to provide your own 2849 * <ul> or <ol> wrapper markup. 2850 * 2620 2851 * @since BuddyPress (1.7) 2852 * 2853 * @see bp_core_fetch_avatar() for a description of arguments. 2854 * 2855 * @param array $args See {@link bp_core_fetch_avatar()}. 2621 2856 */ 2622 2857 function bp_activity_comments_user_avatars( $args = array() ) { … … 2646 2881 2647 2882 /** 2648 * Returns the user IDs of everyone who's written an activity comment on the current activity item. 2649 * 2650 * @return bool|array Returns false if there is no current activity items 2883 * Return the IDs of every user who's left a comment on the current activity item. 2884 * 2651 2885 * @since BuddyPress (1.7) 2886 * 2887 * @return bool|array An array of IDs, or false if none are found. 2652 2888 */ 2653 2889 function bp_activity_get_comments_user_ids() { … … 2662 2898 * Recurse through all activity comments and collect the IDs of the users who wrote them. 2663 2899 * 2664 * @param array $comments Array of {@link BP_Activity_Activity} items2665 * @return array Array of user IDs2666 2900 * @since BuddyPress (1.7) 2901 * 2902 * @param array $comments Array of {@link BP_Activity_Activity} items. 2903 * @return array Array of user IDs. 2667 2904 */ 2668 2905 function bp_activity_recurse_comments_user_ids( array $comments ) { … … 2686 2923 2687 2924 /** 2688 * Renders a list of all the registered activity types for use in a <select> element, or as <input type="checkbox">. 2689 * 2690 * @param string $output Optional. Either 'select' or 'checkbox'. Defaults to select. 2691 * @param string|array $args Optional extra arguments: 2692 * checkbox_name - Used when type=checkbox. Sets the item's name property. 2693 * selected - Array of strings of activity types to mark as selected/checked. 2925 * Echo a list of all registered activity types for use in dropdowns or checkbox lists. 2926 * 2694 2927 * @since BuddyPress (1.7) 2928 * 2929 * @param string $output Optional. Either 'select' or 'checkbox'. Default: 'select'. 2930 * @param array $args { 2931 * Optional extra arguments. 2932 * @type string $checkbox_name When returning checkboxes, sets the 'name' 2933 * attribute. 2934 * @type array|string $selected A list of types that should be checked/ 2935 * selected. 2936 * } 2695 2937 */ 2696 2938 function bp_activity_types_list( $output = 'select', $args = '' ) { … … 2730 2972 2731 2973 /** 2732 * Output s the sitewide activity feed link2974 * Output the sitewide activity feed link. 2733 2975 * 2734 2976 * @since BuddyPress (1.0) … … 2741 2983 2742 2984 /** 2743 * Returns the sitewide activity feed link 2985 * Returns the sitewide activity feed link. 2744 2986 * 2745 2987 * @since BuddyPress (1.0) … … 2747 2989 * @uses home_url() 2748 2990 * @uses bp_get_activity_root_slug() 2749 * @uses apply_filters() To call the 'bp_get_sitewide_activity_feed_link' hook 2750 * 2751 * @return string The sitewide activity feed link 2991 * @uses apply_filters() To call the 'bp_get_sitewide_activity_feed_link' hook. 2992 * 2993 * @return string The sitewide activity feed link. 2752 2994 */ 2753 2995 function bp_get_sitewide_activity_feed_link() { … … 2756 2998 2757 2999 /** 2758 * Output s the member activity feed link3000 * Output the member activity feed link. 2759 3001 * 2760 3002 * @since BuddyPress (1.2) … … 2767 3009 2768 3010 /** 2769 * Output s the member activity feed link3011 * Output the member activity feed link. 2770 3012 * 2771 3013 * @since BuddyPress (1.0) 2772 3014 * @deprecated BuddyPress (1.2) 2773 3015 * 2774 * @todo properly deprecate d in favor of bp_member_activity_feed_link()3016 * @todo properly deprecate in favor of bp_member_activity_feed_link(). 2775 3017 * 2776 3018 * @uses bp_get_member_activity_feed_link() … … 2779 3021 2780 3022 /** 2781 * Return s the member activity feed link3023 * Return the member activity feed link. 2782 3024 * 2783 3025 * @since BuddyPress (1.2) … … 2790 3032 * @uses bp_get_friends_slug() 2791 3033 * @uses bp_get_groups_slug() 2792 * @uses apply_filters() To call the 'bp_get_activities_member_rss_link' hook 2793 * 2794 * @return string $link The member activity feed link 3034 * @uses apply_filters() To call the 'bp_get_activities_member_rss_link' hook. 3035 * 3036 * @return string $link The member activity feed link. 2795 3037 */ 2796 3038 function bp_get_member_activity_feed_link() { … … 2813 3055 2814 3056 /** 2815 * Return s the member activity feed link3057 * Return the member activity feed link. 2816 3058 * 2817 3059 * @since BuddyPress (1.0) 2818 3060 * @deprecated BuddyPress (1.2) 2819 3061 * 2820 * @todo properly deprecate d in favor of bp_get_member_activity_feed_link()3062 * @todo properly deprecate in favor of bp_get_member_activity_feed_link(). 2821 3063 * 2822 3064 * @uses bp_get_member_activity_feed_link() 2823 3065 * 2824 * @return string The member activity feed link 3066 * @return string The member activity feed link. 2825 3067 */ 2826 3068 function bp_get_activities_member_rss_link() { return bp_get_member_activity_feed_link(); } … … 2830 3072 2831 3073 /** 2832 * Outputs the activity feed item guid 3074 * Outputs the activity feed item guid. 2833 3075 * 2834 3076 * @since BuddyPress (1.0) … … 2841 3083 2842 3084 /** 2843 * Returns the activity feed item guid 2844 * 2845 * @since BuddyPress (1.2) 2846 * 2847 * @global object $activities_template {@link BP_Activity_Template} 2848 * @uses apply_filters() To call the 'bp_get_activity_feed_item_guid' hook 2849 * 2850 * @return string The activity feed item guid 3085 * Returns the activity feed item guid. 3086 * 3087 * @since BuddyPress (1.2) 3088 * 3089 * @global object $activities_template {@link BP_Activity_Template} 3090 * @uses apply_filters() To call the 'bp_get_activity_feed_item_guid' hook. 3091 * 3092 * @return string The activity feed item guid. 2851 3093 */ 2852 3094 function bp_get_activity_feed_item_guid() { … … 2857 3099 2858 3100 /** 2859 * Output s the activity feed item title3101 * Output the activity feed item title. 2860 3102 * 2861 3103 * @since BuddyPress (1.0) … … 2868 3110 2869 3111 /** 2870 * Return s the activity feed item title3112 * Return the activity feed item title. 2871 3113 * 2872 3114 * @since BuddyPress (1.0) … … 2876 3118 * @uses convert_chars() 2877 3119 * @uses bp_create_excerpt() 2878 * @uses apply_filters() To call the 'bp_get_activity_feed_item_title' hook 2879 * 2880 * @return string $title The activity feed item title 3120 * @uses apply_filters() To call the 'bp_get_activity_feed_item_title' hook. 3121 * 3122 * @return string $title The activity feed item title. 2881 3123 */ 2882 3124 function bp_get_activity_feed_item_title() { … … 2901 3143 2902 3144 /** 2903 * Output sthe activity feed item link3145 * Output the activity feed item link 2904 3146 * 2905 3147 * @since BuddyPress (1.0) … … 2912 3154 2913 3155 /** 2914 * Return sthe activity feed item link3156 * Return the activity feed item link 2915 3157 * 2916 3158 * @since BuddyPress (1.0) 2917 3159 * 2918 3160 * @global object $activities_template {@link BP_Activity_Template} 2919 * @uses apply_filters() To call the 'bp_get_activity_feed_item_link' hook 2920 * 2921 * @return string The activity feed item link 3161 * @uses apply_filters() To call the 'bp_get_activity_feed_item_link' hook. 3162 * 3163 * @return string The activity feed item link. 2922 3164 */ 2923 3165 function bp_get_activity_feed_item_link() { … … 2928 3170 2929 3171 /** 2930 * Output s the activity feed item date3172 * Output the activity feed item date. 2931 3173 * 2932 3174 * @since BuddyPress (1.0) … … 2939 3181 2940 3182 /** 2941 * Return s the activity feed item date3183 * Return the activity feed item date. 2942 3184 * 2943 3185 * @since BuddyPress (1.0) 2944 3186 * 2945 3187 * @global object $activities_template {@link BP_Activity_Template} 2946 * @uses apply_filters() To call the 'bp_get_activity_feed_item_date' hook 2947 * 2948 * @return string The activity feed item date 3188 * @uses apply_filters() To call the 'bp_get_activity_feed_item_date' hook. 3189 * 3190 * @return string The activity feed item date. 2949 3191 */ 2950 3192 function bp_get_activity_feed_item_date() { … … 2955 3197 2956 3198 /** 2957 * Output s the activity feed item description3199 * Output the activity feed item description. 2958 3200 * 2959 3201 * @since BuddyPress (1.0) … … 2966 3208 2967 3209 /** 2968 * Return s the activity feed item description3210 * Return the activity feed item description. 2969 3211 * 2970 3212 * @since BuddyPress (1.0) … … 2973 3215 * @uses ent2ncr() 2974 3216 * @uses convert_chars() 2975 * @uses apply_filters() To call the 'bp_get_activity_feed_item_description' hook 2976 * 2977 * @return string The activity feed item description 3217 * @uses apply_filters() To call the 'bp_get_activity_feed_item_description' hook. 3218 * 3219 * @return string The activity feed item description. 2978 3220 */ 2979 3221 function bp_get_activity_feed_item_description() { … … 2988 3230 2989 3231 /** 2990 * Template tag so we can hook activity feed to <head> 3232 * Template tag so we can hook activity feed to <head>. 2991 3233 * 2992 3234 * @since BuddyPress (1.5)
Note: See TracChangeset
for help on using the changeset viewer.