Changeset 7228
- Timestamp:
- 06/19/2013 09:41:08 PM (11 years ago)
- Location:
- trunk
- Files:
-
- 50 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/bp-activity/bp-activity-classes.php
r7207 r7228 304 304 * AND keyword from the 'where' clause). 305 305 * 306 * @since 1.8306 * @since BuddyPress (1.8) 307 307 * 308 308 * @param array $meta_query An array of meta_query filters. See the … … 785 785 * Constructor. 786 786 * 787 * @param $args Array787 * @param array $args Optional 788 788 */ 789 789 public function __construct( $args = array() ) { -
trunk/bp-activity/bp-activity-filters.php
r7193 r7228 126 126 * @since BuddyPress (1.6) 127 127 * @param BP_Activity_Activity $activity 128 * @return If activity type is not an update or comment129 128 */ 130 129 function bp_activity_check_moderation_keys( $activity ) { … … 145 144 * @since BuddyPress (1.6) 146 145 * @param BP_Activity_Activity $activity 147 * @return If activity type is not an update or comment148 146 */ 149 147 function bp_activity_check_blacklist_keys( $activity ) { … … 238 236 * @since BuddyPress (1.5) 239 237 * 240 * @param obj$activity238 * @param BP_Activity_Activity $activity 241 239 * 242 240 * @uses bp_activity_find_mentions() … … 276 274 * @since BuddyPress (1.7) 277 275 * 278 * @param obj$activity The BP_Activity_Activity object276 * @param BP_Activity_Activity $activity The BP_Activity_Activity object 279 277 * 280 278 * @uses bp_activity_at_message_notification() … … 342 340 * @since BuddyPress (1.5) 343 341 * 344 * @param $text The original activity entry text342 * @param string $text The original activity entry text 345 343 * 346 344 * @uses bp_is_single_activity() -
trunk/bp-activity/bp-activity-template.php
r7193 r7228 683 683 * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook 684 684 * 685 * @return unknown_type685 * @return string 686 686 */ 687 687 function bp_get_activities_no_activity() { -
trunk/bp-blogs/bp-blogs-activity.php
r7222 r7228 102 102 * @global BuddyPress $bp 103 103 * @param array $args 104 * @return If activity is not active105 104 */ 106 105 function bp_blogs_delete_activity( $args = true ) { -
trunk/bp-blogs/bp-blogs-cache.php
r6342 r7228 34 34 * @package BuddyPress 35 35 * @subpackage BlogsCache 36 * @param B log $recorded_blog_obj36 * @param BP_Blogs_Blog $recorded_blog_obj 37 37 */ 38 38 function bp_blogs_format_clear_blog_cache( $recorded_blog_obj ) { -
trunk/bp-blogs/bp-blogs-functions.php
r7170 r7228 136 136 * @param int $blog_id 137 137 * @param int $user_id 138 * @param $bool $no_activity ; optional.138 * @param bool $no_activity Optional; defaults to false 139 139 * @uses BP_Blogs_Blog 140 140 */ -
trunk/bp-blogs/bp-blogs-template.php
r6480 r7228 706 706 * 707 707 * @since BuddyPress (1.6) 708 * @return str The base URL - eg, 'example.com' for site_url() example.com or www.example.com708 * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com 709 709 */ 710 710 function bp_blogs_get_subdomain_base() { -
trunk/bp-core/admin/bp-core-components.php
r6842 r7228 222 222 * @since BuddyPress (1.6) 223 223 * @todo Use settings API when it supports saving network settings 224 * @return If not time to save settings225 224 */ 226 225 function bp_core_admin_components_settings_handler() { -
trunk/bp-core/admin/bp-core-functions.php
r7213 r7228 309 309 * @uses add_query_arg() To help build the URL to redirect to 310 310 * @uses admin_url() To get the admin URL to index.php 311 *312 * @return If no transient, or is bulk activation313 311 */ 314 312 function bp_do_activation_redirect() { -
trunk/bp-core/admin/bp-core-slugs.php
r6558 r7228 195 195 * @since BuddyPress (1.6) 196 196 * @todo Use settings API 197 * @return False if referer does not check out198 197 */ 199 198 function bp_core_admin_slugs_setup_handler() { -
trunk/bp-core/bp-core-adminbar.php
r6946 r7228 18 18 * @since BuddyPress 1.6 19 19 * @global WP_Admin_Bar $wp_admin_bar 20 * @return If doing ajax21 20 */ 22 21 function bp_admin_bar_my_account_root() { -
trunk/bp-core/bp-core-avatars.php
r6964 r7228 702 702 * @param string $default URL to a default image to use if no avatar is available 703 703 * @param string $alt Alternate text to use in image tag. Defaults to blank 704 * @return <type>704 * @return string 705 705 */ 706 706 function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '' ) { … … 924 924 * @since BuddyPress (1.5) 925 925 * 926 * @param str $type 'thumb' for thumbs, otherwise full927 * @param str $h_or_w 'height' for height, otherwise width926 * @param string $type 'thumb' for thumbs, otherwise full 927 * @param string $h_or_w 'height' for height, otherwise width 928 928 * @return int $dim The dimension 929 929 */ -
trunk/bp-core/bp-core-buddybar.php
r7171 r7228 355 355 * @since BuddyPress (1.5) 356 356 * 357 * @param str $nav_item The id of the top-level nav item whose nav items you're checking357 * @param string $nav_item The id of the top-level nav item whose nav items you're checking 358 358 * @return bool $has_subnav True if the nav item is found and has subnav items; false otherwise 359 359 */ … … 403 403 * 404 404 * @package BuddyPress Core 405 * @param $parent_id The id of the parent navigation item.406 * @param $slug The slug of the sub navigation item.405 * @param string $parent_id The id of the parent navigation item. 406 * @param string $slug The slug of the sub navigation item. 407 407 */ 408 408 function bp_core_remove_subnav_item( $parent_id, $slug ) { … … 428 428 * 429 429 * @package BuddyPress Core 430 * @param $parent_id The id of the parent navigation item.430 * @param string $parent_id The id of the parent navigation item. 431 431 * @global BuddyPress $bp The one true BuddyPress instance 432 432 */ -
trunk/bp-core/bp-core-caps.php
r6844 r7228 152 152 * @uses current_user_can() 153 153 * @uses WP_User::set_role() 154 *155 * @return If user is not spam/deleted or is already capable156 154 */ 157 155 function bp_set_current_user_default_role() { -
trunk/bp-core/bp-core-catchuri.php
r6654 r7228 341 341 * 342 342 * @package BuddyPress Core 343 * @param $username strUsername to check.344 * @return false|intThe user ID of the matched user, or false.343 * @param string $username Username to check. 344 * @return int|bool The user ID of the matched user, or false. 345 345 */ 346 346 function bp_core_load_template( $templates ) { -
trunk/bp-core/bp-core-classes.php
r7141 r7228 1370 1370 * @global wpdb $wpdb WordPress database object 1371 1371 * @param integer $user_id User ID 1372 * @param str $status 'is_new' or 'all'1372 * @param string $status 'is_new' or 'all' 1373 1373 * @return array Associative array 1374 1374 * @static -
trunk/bp-core/bp-core-component.php
r6953 r7228 120 120 * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug' 121 121 * 122 * @param arr $args Used to122 * @param array $args Optional 123 123 */ 124 124 public function setup_globals( $args = array() ) { -
trunk/bp-core/bp-core-filters.php
r7024 r7228 106 106 * @package BuddyPress Core 107 107 * @uses bp_get_option() fetches the value for a meta_key in the wp_X_options table 108 * @return The blog name for the root blog108 * @return string The blog name for the root blog 109 109 */ 110 110 function bp_core_email_from_name_filter() { … … 159 159 * @param string $redirect_to The URL to be redirected to, sanitized in wp-login.php 160 160 * @param string $redirect_to_raw The unsanitized redirect_to URL ($_REQUEST['redirect_to']) 161 * @param obj$user The WP_User object corresponding to a successfully logged-in user. Otherwise161 * @param WP_User $user The WP_User object corresponding to a successfully logged-in user. Otherwise 162 162 * a WP_Error object 163 163 * @return string The redirect URL -
trunk/bp-core/bp-core-functions.php
r7204 r7228 88 88 * Format numbers the BuddyPress way 89 89 * 90 * @param str$number90 * @param int $number 91 91 * @param bool $decimals 92 * @return str 92 * @return string 93 93 */ 94 94 function bp_core_number_format( $number, $decimals = false ) { … … 245 245 * @since BuddyPress (1.5) 246 246 * 247 * @return obj $pagesPage names, IDs, and slugs247 * @return object Page names, IDs, and slugs 248 248 */ 249 249 function bp_core_get_directory_pages() { … … 394 394 * @since BuddyPress (1.5) 395 395 * 396 * @param str $root_slug The root slug, which comes from $bp->pages->[component]->slug397 * @return str $slug The short slug for use in the middle of URLs396 * @param string $root_slug The root slug, which comes from $bp->pages->[component]->slug 397 * @return string The short slug for use in the middle of URLs 398 398 */ 399 399 function bp_core_component_slug_from_root_slug( $root_slug ) { … … 410 410 * 411 411 * @global $bp BuddyPress global settings 412 * @param $slug strThe slug of the component412 * @param string $slug The slug of the component 413 413 */ 414 414 function bp_core_add_root_component( $slug ) { … … 470 470 * @package BuddyPress Core 471 471 * @uses get_blog_option() WordPress function to fetch blog meta. 472 * @return $domainThe domain URL for the blog.472 * @return string The domain URL for the blog. 473 473 */ 474 474 function bp_core_get_root_domain() { … … 505 505 * 506 506 * @package BuddyPress Core 507 * @return The referrer URL507 * @return string The referrer URL 508 508 */ 509 509 function bp_core_referrer() { … … 578 578 * @uses apply_filters() Filter 'bp_core_time_since_pre' to bypass BP's calculations 579 579 * @uses apply_filters() Filter 'bp_core_time_since' to modify BP's calculations 580 * @param $older_date intUnix timestamp of date you want to calculate the time since for581 * @param $newer_date intUnix timestamp of date to compare older date to. Default false (current time).582 * @return str The time since.580 * @param int $older_date Unix timestamp of date you want to calculate the time since for 581 * @param int $newer_date Unix timestamp of date to compare older date to. Default false (current time). 582 * @return string The time since. 583 583 */ 584 584 function bp_core_time_since( $older_date, $newer_date = false ) { … … 734 734 * 735 735 * @global BuddyPress $bp The one true BuddyPress instance 736 * @param str $message Feedback to give to user737 * @param str $type updated|success|error|warning736 * @param string $message Feedback to give to user 737 * @param string $type updated|success|error|warning 738 738 */ 739 739 function bp_core_add_message( $message, $type = '' ) { … … 855 855 * 856 856 * @package BuddyPress Core 857 * @param last_activity_date The date of last activity. 858 * @param $before The text to prepend to the activity time since figure. 859 * @param $after The text to append to the activity time since figure. 857 * @param string $last_activity_date The date of last activity. 858 * @param string $string 860 859 * @uses bp_core_time_since() This function will return an English representation of the time elapsed. 861 860 */ … … 889 888 * 890 889 * @uses apply_filters() Filter bp_get_user_meta_key to modify keys individually 891 * @param str $key892 * @return str $key890 * @param string $key 891 * @return string $key 893 892 */ 894 893 function bp_get_user_meta_key( $key = false ) { … … 1212 1211 * @global BuddyPress $bp The one true BuddyPress instance 1213 1212 * @param bool $is_directory 1214 * @param str $component1213 * @param string $component 1215 1214 */ 1216 1215 function bp_update_is_directory( $is_directory = false, $component = '' ) { … … 1228 1227 * @global BuddyPress $bp The one true BuddyPress instance 1229 1228 * @param bool $is_item_admin 1230 * @param str $component1229 * @param string $component 1231 1230 */ 1232 1231 function bp_update_is_item_admin( $is_item_admin = false, $component = '' ) { … … 1244 1243 * @global BuddyPress $bp The one true BuddyPress instance 1245 1244 * @param bool $is_item_mod 1246 * @param str $component1245 * @param string $component 1247 1246 */ 1248 1247 function bp_update_is_item_mod( $is_item_mod = false, $component = '' ) { -
trunk/bp-core/bp-core-options.php
r7139 r7228 198 198 * 199 199 * @uses bp_get_root_blog_id() 200 * @param str $option_name The option to be retrieved201 * @param str $default Optional. Default value to be returned if the option isn't set200 * @param string $option_name The option to be retrieved 201 * @param string $default Optional. Default value to be returned if the option isn't set 202 202 * @return mixed The value for the option 203 203 */ … … 218 218 * 219 219 * @uses bp_get_root_blog_id() 220 * @param str $option_name The option key to be set221 * @param str $value The value to be set220 * @param string $option_name The option key to be set 221 * @param string $value The value to be set 222 222 */ 223 223 function bp_update_option( $option_name, $value ) { … … 235 235 * 236 236 * @uses bp_get_root_blog_id() 237 * @param str $option_name The option key to be set237 * @param string $option_name The option key to be set 238 238 */ 239 239 function bp_delete_option( $option_name ) { … … 378 378 * @since BuddyPress (1.6) 379 379 * 380 * @param $default boolOptional.Default value true380 * @param bool $default Optional.Default value true 381 381 * 382 382 * @uses bp_get_option() To get the profile sync option … … 392 392 * @since BuddyPress (1.6) 393 393 * 394 * @param $default boolOptional.Default value true394 * @param bool $default Optional.Default value true 395 395 * 396 396 * @uses bp_get_option() To get the logged out Toolbar option … … 406 406 * @since BuddyPress (1.6) 407 407 * 408 * @param $default boolOptional. Default value true408 * @param bool $default Optional. Default value true 409 409 * 410 410 * @uses bp_get_option() To get the avatar uploads option … … 420 420 * @since BuddyPress (1.6) 421 421 * 422 * @param $default boolOptional. Default value422 * @param bool $default Optional. Default value 423 423 * 424 424 * @uses bp_get_option() To get the account deletion option … … 434 434 * @since BuddyPress (1.6) 435 435 * 436 * @param $default boolOptional. Default value false436 * @param bool $default Optional. Default value false 437 437 * @todo split and move into blog and forum components 438 438 * @uses bp_get_option() To get the blog/forum comments option … … 448 448 * @since BuddyPress (1.6) 449 449 * 450 * @param $default boolOptional. Default value true450 * @param bool $default Optional. Default value true 451 451 * 452 452 * @todo Move into groups component … … 463 463 * @since BuddyPress (1.6) 464 464 * 465 * @param $default boolOptional. Default value true465 * @param bool $default Optional. Default value true 466 466 * 467 467 * @todo Move into groups component … … 478 478 * @since BuddyPress (1.6) 479 479 * 480 * @param $default boolOptional. Default value480 * @param bool $default Optional. Default value 481 481 */ 482 482 function bp_group_forums_root_id( $default = '0' ) { … … 488 488 * @since BuddyPress (1.6) 489 489 * 490 * @param $default boolOptional. Default value 0490 * @param bool $default Optional. Default value 0 491 491 * 492 492 * @uses bp_get_option() To get the maximum title length … … 502 502 * @since BuddyPress (1.6) 503 503 * 504 * @param $default boolOptional. Default value true504 * @param bool $default Optional. Default value true 505 505 * 506 506 * @uses bp_get_option() To get the group forums option … … 516 516 * @since BuddyPress (1.6) 517 517 * 518 * @param $default boolOptional. Default value true518 * @param bool $default Optional. Default value true 519 519 * 520 520 * @uses bp_get_option() To get the Akismet option … … 530 530 * @since BuddyPress (1.7) 531 531 * 532 * @param $default stringOptional. Default value 'default'532 * @param string $default Optional. Default value 'default' 533 533 * @uses get_option() To get the subtheme option 534 534 * @return string ID of the subtheme -
trunk/bp-core/bp-core-template.php
r7224 r7228 623 623 * 624 624 * @param int $position The key of the action_variables array that you want 625 * @return str $action_variable The value of that position in the array625 * @return string $action_variable The value of that position in the array 626 626 */ 627 627 function bp_action_variable( $position = 0 ) { … … 712 712 * @since BuddyPress (1.5) 713 713 * @global BuddyPress $bp The one true BuddyPress instance 714 * @param str $root_slug Needle to our active component haystack714 * @param string $root_slug Needle to our active component haystack 715 715 * @return mixed False if none found, component name if found 716 716 */ … … 884 884 * @since BuddyPress (1.5) 885 885 * 886 * @param str $action The action being tested against886 * @param string $action The action being tested against 887 887 * @return bool True if the current action matches $action 888 888 */ … … 908 908 * @since BuddyPress (1.5) 909 909 * 910 * @param str $action_variable The action_variable being tested against910 * @param string $action_variable The action_variable being tested against 911 911 * @param int $position The array key you're testing against. If you don't provide a $position, 912 912 * the function will return true if the $action_variable is found *anywhere* in the action … … 985 985 * 986 986 * @package BuddyPress Core 987 * @return true if root component, else false.987 * @return bool True if root component, else false. 988 988 */ 989 989 function bp_is_root_component( $component_name ) { -
trunk/bp-core/bp-core-theme-compatibility.php
r7137 r7228 531 531 * @since BuddyPress (1.7) 532 532 * @param string $content 533 * @return type533 * @return string 534 534 */ 535 535 function bp_replace_the_content( $content = '' ) { -
trunk/bp-core/bp-core-update.php
r6873 r7228 254 254 * 255 255 * @uses set_transient() To drop the activation transient for 30 seconds 256 *257 * @return If bulk activation258 256 */ 259 257 function bp_add_activation_redirect() { -
trunk/bp-core/bp-core-wpabstraction.php
r6342 r7228 128 128 /** 129 129 * Fallback implementation of mb_strpos, hardcoded to UTF-8. 130 * @param $haystack String131 * @param $needle String132 * @param $offset String: optional start position133 * @param $encoding String: optional encoding; ignored130 * @param string $haystack 131 * @param string $needle 132 * @param int $offset optional; start position. 133 * @param string $encoding optional; not used. 134 134 * @return int 135 135 */ … … 151 151 /** 152 152 * Fallback implementation of mb_strrpos, hardcoded to UTF-8. 153 * @param $haystack String154 * @param $needle String155 * @param $offset String: optional start position156 * @param $encoding String: optional encoding; ignored153 * @param string $haystack 154 * @param string $needle 155 * @param int $offset optional; start position. 156 * @param string $encoding optional; not used. 157 157 * @return int 158 158 */ -
trunk/bp-core/deprecated/1.5.php
r6589 r7228 455 455 * @deprecated BuddyPress (1.5) 456 456 * @deprecated bp_is_root_component() 457 * @return true if root component, else false.457 * @return bool True if root component, else false. 458 458 */ 459 459 function bp_core_is_root_component( $component_name ) { … … 498 498 * @deprecated BuddyPress (1.5) 499 499 * @deprecated No longer required. 500 * @param $string $oldvalue Previous value of get_option( 'page_on_front' )501 * @param $string $oldvalue New value of get_option( 'page_on_front' )500 * @param string $oldvalue Previous value of get_option( 'page_on_front' ) 501 * @param string $oldvalue New value of get_option( 'page_on_front' ) 502 502 * @return string 503 503 * @since BuddyPress (1.2) -
trunk/bp-core/deprecated/1.6.php
r6583 r7228 194 194 * 195 195 * @deprecated BuddyPress (1.6) 196 * @return noreply@sitedomainemail address196 * @return string email address 197 197 */ 198 198 function bp_core_email_from_address_filter() { -
trunk/bp-forums/bp-forums-bbpress-sa.php
r6342 r7228 222 222 * the bbPress stand-alone tables without loading a conflicting WP Admin. 223 223 * 224 * @param unknown_type$queries225 * @param unknown_type $execute226 * @return unknown224 * @param array $queries 225 * @param bool $execute Optional; defaults to true. 226 * @return array 227 227 */ 228 228 function bp_bb_dbDelta($queries, $execute = true) { -
trunk/bp-forums/bp-forums-functions.php
r6779 r7228 320 320 * @since BuddyPress (1.6) 321 321 * 322 * @param str $text The text of the comment322 * @param string $text The text of the comment 323 323 * @param int $topic_id The topic id 324 324 * @param int $user_id The user id … … 371 371 * 372 372 * @param int $user_id ID of the user being queried. Falls back on displayed user, then loggedin 373 * @param str $type The current filter/sort type. 'active', 'popular', 'unreplied'373 * @param string $type The current filter/sort type. 'active', 'popular', 'unreplied' 374 374 * @return int $count The topic count 375 375 */ -
trunk/bp-forums/bp-forums-template.php
r6342 r7228 894 894 * 895 895 * @uses apply_filters() Filter bp_get_forum_topic_new_reply_link to modify 896 * @return str The URL for the New Reply link896 * @return string The URL for the New Reply link 897 897 */ 898 898 function bp_get_forum_topic_new_reply_link() { … … 1396 1396 * @since BuddyPress (1.5) 1397 1397 * 1398 * @param str $format 'string' returns comma-separated string; otherwise returns array1398 * @param string $format 'string' returns comma-separated string; otherwise returns array 1399 1399 * @return mixed $tags 1400 1400 */ -
trunk/bp-friends/bp-friends-activity.php
r6342 r7228 70 70 * @package BuddyPress 71 71 * 72 * @param str $action The kind of notification being rendered72 * @param string $action The kind of notification being rendered 73 73 * @param int $item_id The primary item id 74 74 * @param int $secondary_item_id The secondary item id 75 75 * @param int $total_items The total number of messaging-related notifications waiting for the user 76 * @param str $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar76 * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar 77 77 */ 78 78 function friends_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) { -
trunk/bp-friends/bp-friends-template.php
r6342 r7228 213 213 * 214 214 * @uses bp_get_potential_friend_id() 215 * @param <type> $user_id215 * @param int $user_id Optional 216 216 */ 217 217 function bp_potential_friend_id( $user_id = 0 ) { -
trunk/bp-groups/bp-groups-admin.php
r7197 r7228 705 705 * Members metabox 706 706 * 707 * @param obj$item The BP_Groups_Group object707 * @param BP_Groups_Group $item The BP_Groups_Group object 708 708 * 709 709 * @since BuddyPress (1.7) -
trunk/bp-groups/bp-groups-buddybar.php
r6342 r7228 16 16 * @since BuddyPress (1.0) 17 17 * @global BuddyPress $bp 18 * @return False if no menu19 18 */ 20 19 function bp_groups_adminbar_admin_menu() { -
trunk/bp-groups/bp-groups-classes.php
r7182 r7228 885 885 * @since BuddyPress (1.5) 886 886 * 887 * @param str $status 'public', 'private', 'hidden', 'all' Which group types to count887 * @param string $status 'public', 'private', 'hidden', 'all' Which group types to count 888 888 * @return int The topic count 889 889 */ … … 2180 2180 * Call the create_screen() method, if we're on the right page 2181 2181 * 2182 * @since 1.82182 * @since BuddyPress (1.8) 2183 2183 */ 2184 2184 public function maybe_create_screen() { … … 2198 2198 * Call the create_screen_save() method, if we're on the right page 2199 2199 * 2200 * @since 1.82200 * @since BuddyPress (1.8) 2201 2201 */ 2202 2202 public function maybe_create_screen_save() { … … 2346 2346 * 2347 2347 * @since BuddyPress (1.8) 2348 * @param $screen The markup to check2348 * @param string $screen The markup to check 2349 2349 * @return bool 2350 2350 */ -
trunk/bp-groups/bp-groups-forums.php
r6342 r7228 399 399 * @since BuddyPress (1.5) 400 400 * 401 * @param str $status 'public', 'private', 'hidden', 'all' Which group types to count401 * @param string $status 'public', 'private', 'hidden', 'all' Which group types to count 402 402 * @return int The topic count 403 403 */ -
trunk/bp-groups/bp-groups-functions.php
r7182 r7228 37 37 * support and pass through the groups_get_group filter. 38 38 * 39 * @param $args The load_users parameter is deprecated and does nothing.40 * @return obj$group The group object39 * @param string $args The load_users parameter is deprecated and does nothing. 40 * @return BP_Groups_Group $group The group object 41 41 */ 42 42 function groups_get_group( $args = '' ) { … … 524 524 * @since BuddyPress (1.5) 525 525 * 526 * @return objThe current group object526 * @return BP_Groups_Group The current group object 527 527 */ 528 528 function groups_get_current_group() { … … 782 782 * @param int $user_id Potential group member 783 783 * @param int $group_id Potential group 784 * @param str $type Optional. Use 'sent' to check for sent invites, 'all' to check for all784 * @param string $type Optional. Use 'sent' to check for sent invites, 'all' to check for all 785 785 * @return bool Returns true if an invitation is found 786 786 */ -
trunk/bp-groups/bp-groups-template.php
r7141 r7228 812 812 * @since BuddyPress (1.5) 813 813 * 814 * @param obj$group (optional) The group being queried. Defaults to the current group in the loop815 * @param str $format 'string' to get a comma-separated string, 'array' to get an array814 * @param BP_Groups_Group $group (optional) The group being queried. Defaults to the current group in the loop 815 * @param string $format 'string' to get a comma-separated string, 'array' to get an array 816 816 * @return mixed $admin_ids A string or array of user_ids 817 817 */ … … 842 842 * @since BuddyPress (1.5) 843 843 * 844 * @param obj$group (optional) The group being queried. Defaults to the current group in the loop845 * @param str $format 'string' to get a comma-separated string, 'array' to get an array844 * @param BP_Groups_Group $group (optional) The group being queried. Defaults to the current group in the loop 845 * @param string $format 'string' to get a comma-separated string, 'array' to get an array 846 846 * @return mixed $mod_ids A string or array of user_ids 847 847 */ … … 1082 1082 * @since BuddyPress (1.5) 1083 1083 * 1084 * @param str $setting The setting you want to check against ('members', 'mods', or 'admins')1085 * @param obj$group (optional) The group whose status you want to check1084 * @param string $setting The setting you want to check against ('members', 'mods', or 'admins') 1085 * @param BP_Groups_Group $group (optional) The group whose status you want to check 1086 1086 */ 1087 1087 function bp_group_show_invite_status_setting( $setting, $group = false ) { … … 1673 1673 * @since BuddyPress (1.2.7) 1674 1674 * 1675 * @param obj|bool $group The BP Groups_Group object if passed, boolean false if not passed.1675 * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, boolean false if not passed. 1676 1676 * @uses bp_get_group_new_topic_button() Returns the 'New Topic' button 1677 1677 */ … … 1684 1684 * @since BuddyPress (1.2.7) 1685 1685 * 1686 * @param obj|bool $group The BP Groups_Group object if passed, boolean false if not passed.1686 * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, boolean false if not passed. 1687 1687 * @uses is_user_logged_in() Is there a user logged in? 1688 1688 * @uses bp_group_is_user_banned() Is the current user banned from the current group? … … 1690 1690 * @uses bp_is_group_forum_topic() Are we on a group topic page? 1691 1691 * @uses bp_get_button() Renders a button 1692 * @return HTML code for the button1692 * @return string HTML code for the button 1693 1693 */ 1694 1694 function bp_get_group_new_topic_button( $group = false ) { … … 2417 2417 * 2418 2418 * @uses apply_filters() Filter bp_get_groups_current_create_step to modify 2419 * @return str $current_create_step2419 * @return string $current_create_step 2420 2420 */ 2421 2421 function bp_get_groups_current_create_step() { … … 2583 2583 * 2584 2584 * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value 2585 * @return str $tab The current tab's slug2585 * @return string $tab The current tab's slug 2586 2586 */ 2587 2587 function bp_get_group_current_admin_tab() { … … 3041 3041 * @uses apply_filters() Filter bp_get_current_group_slug to modify this output 3042 3042 * 3043 * @return str $current_group_slug The slug of the current group, if there is one3043 * @return string $current_group_slug The slug of the current group, if there is one 3044 3044 */ 3045 3045 function bp_get_current_group_slug() { … … 3066 3066 * @uses apply_filters() Filter bp_get_current_group_name to modify this output 3067 3067 * 3068 * @return str The name of the current group, if there is one3068 * @return string The name of the current group, if there is one 3069 3069 */ 3070 3070 function bp_get_current_group_name() { -
trunk/bp-loader.php
r7215 r7228 130 130 * @see buddypress() 131 131 * 132 * @return The one true BuddyPress132 * @return BuddyPress The one true BuddyPress 133 133 */ 134 134 public static function instance() { … … 582 582 * Example: <?php $bp = buddypress(); ?> 583 583 * 584 * @return The one true BuddyPress Instance584 * @return BuddyPress The one true BuddyPress Instance 585 585 */ 586 586 function buddypress() { 587 return buddypress::instance();587 return BuddyPress::instance(); 588 588 } 589 589 -
trunk/bp-members/bp-members-actions.php
r6342 r7228 99 99 * 100 100 * @package BuddyPress Core 101 * @param $username str Username to check. 102 * @return false on no match 103 * @return int the user ID of the matched user. 101 * @param string $username Username to check. 102 * @since BuddyPress (1.0) 104 103 */ 105 104 function bp_core_get_random_member() { -
trunk/bp-members/bp-members-functions.php
r7163 r7228 121 121 * @package BuddyPress Core 122 122 * @global $current_user WordPress global variable containing current logged in user information 123 * @param user_id The ID of the user.123 * @param int $user_id The ID of the user. 124 124 */ 125 125 function bp_core_get_user_domain( $user_id, $user_nicename = false, $user_login = false ) { … … 151 151 * 152 152 * @package BuddyPress Core 153 * @param user_id The ID of the user.153 * @param int $user_id The ID of the user. 154 154 * @uses BP_Core_User::get_core_userdata() Performs the query. 155 155 */ … … 171 171 * @package BuddyPress Core 172 172 * @uses bp_core_get_userid_from_user_login() Returns the user id for the username passed 173 * @return The user id for the user that is currently being displayed, return zero if this is not a user home and just a normal blog.173 * @return int The user id for the user that is currently being displayed, return zero if this is not a user home and just a normal blog. 174 174 */ 175 175 function bp_core_get_displayed_userid( $user_login ) { … … 181 181 * 182 182 * @package BuddyPress Core 183 * @param $username strUsername to check.183 * @param string $username Username to check. 184 184 * @global $wpdb WordPress DB access object. 185 * @return false on no match 186 * @return int the user ID of the matched user. 185 * @return int|bool The ID of the matched user, or false. 187 186 */ 188 187 function bp_core_get_userid( $username ) { … … 199 198 * 200 199 * @package BuddyPress Core 201 * @param $username strUsername to check.200 * @param string $username Username to check. 202 201 * @global $wpdb WordPress DB access object. 203 * @return false on no match 204 * @return int the user ID of the matched user. 202 * @return int|bool The ID of the matched user, or false. 205 203 */ 206 204 function bp_core_get_userid_from_nicename( $user_nicename ) { … … 217 215 * 218 216 * @package BuddyPress Core 219 * @param $uid intUser ID to check.217 * @param int $uid User ID to check. 220 218 * @global $userdata WordPress user data for the current logged in user. 221 219 * @uses get_userdata() WordPress function to fetch the userdata for a user ID 222 * @return false on no match 223 * @return str the username of the matched user. 220 * @return string|bool The username of the matched user, or false. 224 221 */ 225 222 function bp_core_get_username( $user_id, $user_nicename = false, $user_login = false ) { … … 291 288 * 292 289 * @package BuddyPress Core 293 * @param $uid intUser ID to check.290 * @param int $uid User ID to check. 294 291 * @global $userdata WordPress user data for the current logged in user. 295 292 * @uses get_userdata() WordPress function to fetch the userdata for a user ID 296 * @return false on no match 297 * @return str the username of the matched user. 293 * @return string|bool The username of the matched user, or false. 298 294 */ 299 295 function bp_members_get_user_nicename( $user_id ) { … … 344 340 * 345 341 * @package BuddyPress Core 346 * @param $uid intUser ID to check.342 * @param int $uid User ID to check. 347 343 * @uses get_userdata() WordPress function to fetch the userdata for a user ID 348 * @return false on no match 349 * @return str The email for the matched user. 344 * @return string The email for the matched user. Empty string if no user matched the $uid. 350 345 */ 351 346 function bp_core_get_user_email( $uid ) { … … 372 367 * 373 368 * @param int $user_id User ID to check. 374 * @param $no_anchor bool Disable URL and HTML and just return full name. Default false. 375 * @param $just_link bool Disable full name and HTML and just return the URL text. Default false. 376 * @return false on no match 377 * @return str The link text based on passed parameters. 369 * @param bool $no_anchor Disable URL and HTML and just return full name. Default false. 370 * @param bool $just_link Disable full name and HTML and just return the URL text. Default false. 371 * @return string|bool The link text based on passed parameters, or false on no match. 378 372 * @todo This function needs to be cleaned up or split into separate functions 379 373 */ … … 407 401 * @uses xprofile_set_field_data() Will update the field data for a user based on field name and user id. 408 402 * @uses wp_cache_set() Adds a value to the cache. 409 * @return str The display name for the user in question.403 * @return string|bool The display name for the user in question, or false if user not found. 410 404 */ 411 405 function bp_core_get_user_displayname( $user_id_or_username ) { … … 463 457 * 464 458 * @package BuddyPress Core 465 * @param $email strThe email address for the user.459 * @param string $email The email address for the user. 466 460 * @uses bp_core_get_userlink() BuddyPress function to get a userlink by user ID. 467 461 * @uses get_user_by() WordPress function to get userdata via an email address 468 * @return str The link to the users home base. False on no match.462 * @return string The link to the users home base. False on no match. 469 463 */ 470 464 function bp_core_get_userlink_by_email( $email ) { … … 476 470 * Returns the user link for the user based on the supplied identifier 477 471 * 478 * @param $username strIf BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set, this will be user_login, otherwise it will be user_nicename.479 * @return str The link to the users home base. False on no match.472 * @param string $username If BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set, this will be user_login, otherwise it will be user_nicename. 473 * @return string|bool The link to the users home base, false on no match. 480 474 */ 481 475 function bp_core_get_userlink_by_username( $username ) { … … 918 912 * redirect them to the home page and stop them from logging in. 919 913 * 920 * @param obj$user Either the WP_User object or the WP_Error object921 * @return objIf the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.914 * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error object 915 * @return WP_User|WP_Error If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object. 922 916 * 923 917 * @since BuddyPress (1.1.2) … … 942 936 * 943 937 * @package BuddyPress Core 944 * @param $user_id The user id for the user to delete usermeta for938 * @param int $user_id The user id for the user to delete usermeta for 945 939 * @uses bp_delete_user_meta() deletes a row from the wp_usermeta table based on meta_key 946 940 */ … … 1099 1093 * @see bp_core_validate_email_address() 1100 1094 * 1101 * @param obj$errors WP_Error object1095 * @param WP_Error $errors WP_Error object 1102 1096 * @param array $validation_results The return value of a validation function 1103 1097 * like bp_core_validate_email_address() … … 1414 1408 * See {@link wpmu_signup_user()} and {@link wpmu_validate_user_signup()}. 1415 1409 * 1416 * @param obj$user Either the WP_User object or the WP_Error object1417 * @return objIf the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.1410 * @param WP_User|WP_Error $user Either the WP_User object or the WP_Error object 1411 * @return WP_User|WP_Error If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object. 1418 1412 * 1419 1413 * @since BuddyPress (1.2.2) -
trunk/bp-members/bp-members-template.php
r6941 r7228 556 556 * 557 557 * @uses apply_filters() Filter bp_get_the_member_name() to alter the function's output 558 * @return str The user's fullname for display558 * @return string The user's fullname for display 559 559 */ 560 560 function bp_get_member_name() { -
trunk/bp-messages/bp-messages-functions.php
r6342 r7228 234 234 * @package BuddyPress 235 235 * 236 * @param str $action The kind of notification being rendered236 * @param string $action The kind of notification being rendered 237 237 * @param int $item_id The primary item id 238 238 * @param int $secondary_item_id The secondary item id 239 239 * @param int $total_items The total number of messaging-related notifications waiting for the user 240 * @param str $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar240 * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar 241 241 */ 242 242 function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) { -
trunk/bp-messages/bp-messages-template.php
r6943 r7228 384 384 * @package BuddyPress 385 385 * 386 * @return str The form action386 * @return string The form action 387 387 */ 388 388 function bp_get_messages_form_action() { -
trunk/bp-settings/bp-settings-actions.php
r6361 r7228 24 24 * 25 25 * @global BuddyPress $bp 26 * @return If no reason to proceed27 26 */ 28 27 function bp_settings_action_general() { … … 215 214 /** 216 215 * Handles the changing and saving of user notification settings 217 *218 * @return If no reason to proceed219 216 */ 220 217 function bp_settings_action_notifications() { … … 261 258 /** 262 259 * Handles the setting of user capabilities, spamming, hamming, role, etc... 263 *264 * @return If no reason to proceed265 260 */ 266 261 function bp_settings_action_capabilities() { … … 310 305 /** 311 306 * Handles the deleting of a user 312 *313 * @return If no reason to proceed314 307 */ 315 308 function bp_settings_action_delete_account() { -
trunk/bp-settings/bp-settings-screens.php
r6317 r7228 15 15 * 16 16 * @since BuddyPress (1.5) 17 *18 * @return If we shouldn't be here19 17 */ 20 18 function bp_settings_screen_general() { … … 32 30 * 33 31 * @since BuddyPress (1.5) 34 *35 * @return If we shouldn't be here36 32 */ 37 33 function bp_settings_screen_notification() { … … 49 45 * 50 46 * @since BuddyPress (1.5) 51 *52 * @return If we shouldn't be here53 47 */ 54 48 function bp_settings_screen_delete_account() { … … 67 61 * 68 62 * @since BuddyPress (1.6) 69 *70 * @return If we shouldn't be here71 63 */ 72 64 function bp_settings_screen_capabilities() { -
trunk/bp-templates/bp-legacy/buddypress-functions.php
r7205 r7228 887 887 * Invites a friend to join a group via a POST request. 888 888 * 889 * @return unknown890 889 * @since BuddyPress (1.2) 891 890 * @todo Audit return types -
trunk/bp-themes/bp-default/_inc/ajax.php
r7116 r7228 550 550 * Invites a friend to join a group via a POST request. 551 551 * 552 * @return unknown553 552 * @since BuddyPress (1.2) 554 553 * @todo Audit return types -
trunk/bp-themes/bp-default/functions.php
r7193 r7228 521 521 * Return the ID of a page set as the home page. 522 522 * 523 * @return false|intID of page set as the home page523 * @return int|bool ID of page set as the home page 524 524 * @since BuddyPress (1.2) 525 525 */ -
trunk/bp-xprofile/bp-xprofile-activity.php
r6692 r7228 32 32 * @package BuddyPress 33 33 * @subpackage XProfileActivity 34 * @param $args Arraycontaining all variables used after extract() call34 * @param string $args String containing all variables used after extract() call 35 35 * @global $bp The global BuddyPress settings variable created in bp_core_current_times() 36 36 * @uses bp_activity_add() Adds an entry to the activity component tables for a specific activity … … 78 78 * 79 79 * @package BuddyPress XProfile 80 * @param $args Array containing all variables used after extract() call80 * @param string $args Containing all variables used after extract() call 81 81 * @global BuddyPress $bp The one true BuddyPress instance 82 82 * @uses bp_activity_delete() Deletes an entry to the activity component tables for a specific activity -
trunk/bp-xprofile/bp-xprofile-functions.php
r6659 r7228 195 195 * 196 196 * @package BuddyPress Core 197 * @param $field The ID of the field, or the $name of the field.198 * @param $user_id The ID of the user199 * @param $valueThe value for the field you want to set for the user.197 * @param int|string $field The ID of the field, or the $name of the field. 198 * @param int|$user_id The ID of the user 199 * @param mixed The value for the field you want to set for the user. 200 200 * @global BuddyPress $bp The one true BuddyPress instance 201 201 * @uses xprofile_get_field_id_from_name() Gets the ID for the field based on the name. 202 * @return true on success, false on failure.202 * @return bool True on success, false on failure. 203 203 */ 204 204 function xprofile_set_field_data( $field, $user_id, $value, $is_required = false ) { … … 322 322 * 323 323 * @package BuddyPress Core 324 * @param $field_name The name of the field to get the ID for.324 * @param string $field_name The name of the field to get the ID for. 325 325 * @return int $field_id on success, false on failure. 326 326 */ … … 333 333 * 334 334 * @package BuddyPress Core 335 * @param $user_id User ID of the user to get random data for336 * @param $exclude_fullname whether or not to exclude the full name field as random data.335 * @param int $user_id User ID of the user to get random data for 336 * @param bool $exclude_fullname Optional; whether or not to exclude the full name field as random data. Defaults to true. 337 337 * @global BuddyPress $bp The one true BuddyPress instance 338 338 * @global $wpdb WordPress DB access object. 339 339 * @global $current_user WordPress global variable containing current logged in user information 340 340 * @uses xprofile_format_profile_field() Formats profile field data so it is suitable for display. 341 * @return $field_data The fetched random data for the user.341 * @return string|bool The fetched random data for the user, or false if no data or no match. 342 342 */ 343 343 function xprofile_get_random_profile_data( $user_id, $exclude_fullname = true ) { … … 359 359 * 360 360 * @package BuddyPress Core 361 * @param $field_type The type of field: datebox, selectbox, textbox etc362 * @param $field_value The actual value361 * @param string $field_type The type of field: datebox, selectbox, textbox etc 362 * @param string $field_value The actual value 363 363 * @uses bp_format_time() Formats a time value based on the WordPress date format setting 364 * @return $field_value The formatted value364 * @return string|bool The formatted value, or false if value is empty 365 365 */ 366 366 function xprofile_format_profile_field( $field_type, $field_value ) { … … 388 388 * 389 389 * @package BuddyPress Core 390 * @param $directory The root directory name391 * @param $user_id The user ID.390 * @param string $directory The root directory name. Optional. 391 * @param int $user_id The user ID. Optional. 392 392 * @return array() containing the path and URL plus some other settings. 393 393 */ … … 485 485 * 486 486 * @package BuddyPress XProfile 487 * @param $user_id The ID of the deleted user487 * @param int $user_id The ID of the deleted user 488 488 */ 489 489 function xprofile_remove_data( $user_id ) { … … 630 630 * @since BuddyPress (1.5) 631 631 * 632 * @return str The field name632 * @return string The field name 633 633 */ 634 634 function bp_xprofile_fullname_field_name() {
Note: See TracChangeset
for help on using the changeset viewer.