Skip to:
Content

BuddyPress.org

Changeset 7228


Ignore:
Timestamp:
06/19/2013 09:41:08 PM (11 years ago)
Author:
djpaul
Message:

Quick audit of existing phpDoc @param, @return, and @since parameters. Fixes #5031

Location:
trunk
Files:
50 edited

Legend:

Unmodified
Added
Removed

  • trunk/bp-activity/bp-activity-classes.php

    r7207 r7228  
    304304     * AND keyword from the 'where' clause).
    305305     *
    306      * @since 1.8
     306     * @since BuddyPress (1.8)
    307307     *
    308308     * @param array $meta_query An array of meta_query filters. See the
    … …  
    785785     * Constructor.
    786786     *
    787      * @param $args Array
     787     * @param array $args Optional
    788788     */
    789789    public function __construct( $args = array() ) {

  • trunk/bp-activity/bp-activity-filters.php

    r7193 r7228  
    126126 * @since BuddyPress (1.6)
    127127 * @param BP_Activity_Activity $activity
    128  * @return If activity type is not an update or comment
    129128 */
    130129function bp_activity_check_moderation_keys( $activity ) {
    … …  
    145144 * @since BuddyPress (1.6)
    146145 * @param BP_Activity_Activity $activity
    147  * @return If activity type is not an update or comment
    148146 */
    149147function bp_activity_check_blacklist_keys( $activity ) {
    … …  
    238236 * @since BuddyPress (1.5)
    239237 *
    240  * @param obj $activity
     238 * @param BP_Activity_Activity $activity
    241239 *
    242240 * @uses bp_activity_find_mentions()
    … …  
    276274 * @since BuddyPress (1.7)
    277275 *
    278  * @param obj $activity The BP_Activity_Activity object
     276 * @param BP_Activity_Activity $activity The BP_Activity_Activity object
    279277 *
    280278 * @uses bp_activity_at_message_notification()
    … …  
    342340 * @since BuddyPress (1.5)
    343341 *
    344  * @param $text The original activity entry text
     342 * @param string $text The original activity entry text
    345343 *
    346344 * @uses bp_is_single_activity()

  • trunk/bp-activity/bp-activity-template.php

    r7193 r7228  
    683683     * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook
    684684     *
    685      * @return unknown_type
     685     * @return string
    686686     */
    687687    function bp_get_activities_no_activity() {

  • trunk/bp-blogs/bp-blogs-activity.php

    r7222 r7228  
    102102 * @global BuddyPress $bp
    103103 * @param array $args
    104  * @return If activity is not active
    105104 */
    106105function bp_blogs_delete_activity( $args = true ) {

  • trunk/bp-blogs/bp-blogs-cache.php

    r6342 r7228  
    3434 * @package BuddyPress
    3535 * @subpackage BlogsCache
    36  * @param Blog $recorded_blog_obj
     36 * @param BP_Blogs_Blog $recorded_blog_obj
    3737 */
    3838function bp_blogs_format_clear_blog_cache( $recorded_blog_obj ) {

  • trunk/bp-blogs/bp-blogs-functions.php

    r7170 r7228  
    136136 * @param int $blog_id
    137137 * @param int $user_id
    138  * @param $bool $no_activity ; optional.
     138 * @param bool $no_activity Optional; defaults to false
    139139 * @uses BP_Blogs_Blog
    140140 */

  • trunk/bp-blogs/bp-blogs-template.php

    r6480 r7228  
    706706     *
    707707     * @since BuddyPress (1.6)
    708      * @return str The base URL - eg, 'example.com' for site_url() example.com or www.example.com
     708     * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com
    709709     */
    710710    function bp_blogs_get_subdomain_base() {

  • trunk/bp-core/admin/bp-core-components.php

    r6842 r7228  
    222222 * @since BuddyPress (1.6)
    223223 * @todo Use settings API when it supports saving network settings
    224  * @return If not time to save settings
    225224 */
    226225function bp_core_admin_components_settings_handler() {

  • trunk/bp-core/admin/bp-core-functions.php

    r7213 r7228  
    309309 * @uses add_query_arg() To help build the URL to redirect to
    310310 * @uses admin_url() To get the admin URL to index.php
    311  *
    312  * @return If no transient, or is bulk activation
    313311 */
    314312function bp_do_activation_redirect() {

  • trunk/bp-core/admin/bp-core-slugs.php

    r6558 r7228  
    195195 * @since BuddyPress (1.6)
    196196 * @todo Use settings API
    197  * @return False if referer does not check out
    198197 */
    199198function bp_core_admin_slugs_setup_handler() {

  • trunk/bp-core/bp-core-adminbar.php

    r6946 r7228  
    1818 * @since BuddyPress 1.6
    1919 * @global WP_Admin_Bar $wp_admin_bar
    20  * @return If doing ajax
    2120 */
    2221function bp_admin_bar_my_account_root() {

  • trunk/bp-core/bp-core-avatars.php

    r6964 r7228  
    702702 * @param string $default URL to a default image to use if no avatar is available
    703703 * @param string $alt Alternate text to use in image tag. Defaults to blank
    704  * @return <type>
     704 * @return string
    705705 */
    706706function bp_core_fetch_avatar_filter( $avatar, $user, $size, $default, $alt = '' ) {
    … …  
    924924 * @since BuddyPress (1.5)
    925925 *
    926  * @param str $type 'thumb' for thumbs, otherwise full
    927  * @param str $h_or_w 'height' for height, otherwise width
     926 * @param string $type 'thumb' for thumbs, otherwise full
     927 * @param string $h_or_w 'height' for height, otherwise width
    928928 * @return int $dim The dimension
    929929 */

  • trunk/bp-core/bp-core-buddybar.php

    r7171 r7228  
    355355 * @since BuddyPress (1.5)
    356356 *
    357  * @param str $nav_item The id of the top-level nav item whose nav items you're checking
     357 * @param string $nav_item The id of the top-level nav item whose nav items you're checking
    358358 * @return bool $has_subnav True if the nav item is found and has subnav items; false otherwise
    359359 */
    … …  
    403403 *
    404404 * @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.
    407407 */
    408408function bp_core_remove_subnav_item( $parent_id, $slug ) {
    … …  
    428428 *
    429429 * @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.
    431431 * @global BuddyPress $bp The one true BuddyPress instance
    432432 */

  • trunk/bp-core/bp-core-caps.php

    r6844 r7228  
    152152 * @uses current_user_can()
    153153 * @uses WP_User::set_role()
    154  *
    155  * @return If user is not spam/deleted or is already capable
    156154 */
    157155function bp_set_current_user_default_role() {

  • trunk/bp-core/bp-core-catchuri.php

    r6654 r7228  
    341341 *
    342342 * @package BuddyPress Core
    343  * @param $username str Username to check.
    344  * @return false|int The 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.
    345345 */
    346346function bp_core_load_template( $templates ) {

  • trunk/bp-core/bp-core-classes.php

    r7141 r7228  
    13701370     * @global wpdb $wpdb WordPress database object
    13711371     * @param integer $user_id User ID
    1372      * @param str $status 'is_new' or 'all'
     1372     * @param string $status 'is_new' or 'all'
    13731373     * @return array Associative array
    13741374     * @static

  • trunk/bp-core/bp-core-component.php

    r6953 r7228  
    120120     * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug'
    121121     *
    122      * @param arr $args Used to
     122     * @param array $args Optional
    123123     */
    124124    public function setup_globals( $args = array() ) {

  • trunk/bp-core/bp-core-filters.php

    r7024 r7228  
    106106 * @package BuddyPress Core
    107107 * @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 blog
     108 * @return string The blog name for the root blog
    109109 */
    110110function bp_core_email_from_name_filter() {
    … …  
    159159 * @param string $redirect_to The URL to be redirected to, sanitized in wp-login.php
    160160 * @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. Otherwise
     161 * @param WP_User $user The WP_User object corresponding to a successfully logged-in user. Otherwise
    162162 *   a WP_Error object
    163163 * @return string The redirect URL

  • trunk/bp-core/bp-core-functions.php

    r7204 r7228  
    8888 * Format numbers the BuddyPress way
    8989 *
    90  * @param str $number
     90 * @param int $number
    9191 * @param bool $decimals
    92  * @return str
     92 * @return string
    9393 */
    9494function bp_core_number_format( $number, $decimals = false ) {
    … …  
    245245 * @since BuddyPress (1.5)
    246246 *
    247  * @return obj $pages Page names, IDs, and slugs
     247 * @return object Page names, IDs, and slugs
    248248 */
    249249function bp_core_get_directory_pages() {
    … …  
    394394 * @since BuddyPress (1.5)
    395395 *
    396  * @param str $root_slug The root slug, which comes from $bp->pages->[component]->slug
    397  * @return str $slug The short slug for use in the middle of URLs
     396 * @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
    398398 */
    399399function bp_core_component_slug_from_root_slug( $root_slug ) {
    … …  
    410410 *
    411411 * @global $bp BuddyPress global settings
    412  * @param $slug str The slug of the component
     412 * @param string $slug The slug of the component
    413413 */
    414414function bp_core_add_root_component( $slug ) {
    … …  
    470470 * @package BuddyPress Core
    471471 * @uses get_blog_option() WordPress function to fetch blog meta.
    472  * @return $domain The domain URL for the blog.
     472 * @return string The domain URL for the blog.
    473473 */
    474474function bp_core_get_root_domain() {
    … …  
    505505 *
    506506 * @package BuddyPress Core
    507  * @return The referrer URL
     507 * @return string The referrer URL
    508508 */
    509509function bp_core_referrer() {
    … …  
    578578 * @uses apply_filters() Filter 'bp_core_time_since_pre' to bypass BP's calculations
    579579 * @uses apply_filters() Filter 'bp_core_time_since' to modify BP's calculations
    580  * @param $older_date int Unix timestamp of date you want to calculate the time since for
    581  * @param $newer_date int Unix 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.
    583583 */
    584584function bp_core_time_since( $older_date, $newer_date = false ) {
    … …  
    734734 *
    735735 * @global BuddyPress $bp The one true BuddyPress instance
    736  * @param str $message Feedback to give to user
    737  * @param str $type updated|success|error|warning
     736 * @param string $message Feedback to give to user
     737 * @param string $type updated|success|error|warning
    738738 */
    739739function bp_core_add_message( $message, $type = '' ) {
    … …  
    855855 *
    856856 * @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
    860859 * @uses bp_core_time_since() This function will return an English representation of the time elapsed.
    861860 */
    … …  
    889888 *
    890889 * @uses apply_filters() Filter bp_get_user_meta_key to modify keys individually
    891  * @param str $key
    892  * @return str $key
     890 * @param string $key
     891 * @return string $key
    893892 */
    894893function bp_get_user_meta_key( $key = false ) {
    … …  
    12121211 * @global BuddyPress $bp The one true BuddyPress instance
    12131212 * @param bool $is_directory
    1214  * @param str $component
     1213 * @param string $component
    12151214 */
    12161215function bp_update_is_directory( $is_directory = false, $component = '' ) {
    … …  
    12281227 * @global BuddyPress $bp The one true BuddyPress instance
    12291228 * @param bool $is_item_admin
    1230  * @param str $component
     1229 * @param string $component
    12311230 */
    12321231function bp_update_is_item_admin( $is_item_admin = false, $component = '' ) {
    … …  
    12441243 * @global BuddyPress $bp The one true BuddyPress instance
    12451244 * @param bool $is_item_mod
    1246  * @param str $component
     1245 * @param string $component
    12471246 */
    12481247function bp_update_is_item_mod( $is_item_mod = false, $component = '' ) {

  • trunk/bp-core/bp-core-options.php

    r7139 r7228  
    198198 *
    199199 * @uses bp_get_root_blog_id()
    200  * @param str $option_name The option to be retrieved
    201  * @param str $default Optional. Default value to be returned if the option isn't set
     200 * @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
    202202 * @return mixed The value for the option
    203203 */
    … …  
    218218 *
    219219 * @uses bp_get_root_blog_id()
    220  * @param str $option_name The option key to be set
    221  * @param str $value The value to be set
     220 * @param string $option_name The option key to be set
     221 * @param string $value The value to be set
    222222 */
    223223function bp_update_option( $option_name, $value ) {
    … …  
    235235 *
    236236 * @uses bp_get_root_blog_id()
    237  * @param str $option_name The option key to be set
     237 * @param string $option_name The option key to be set
    238238 */
    239239function bp_delete_option( $option_name ) {
    … …  
    378378 * @since BuddyPress (1.6)
    379379 *
    380  * @param $default bool Optional.Default value true
     380 * @param bool $default Optional.Default value true
    381381 *
    382382 * @uses bp_get_option() To get the profile sync option
    … …  
    392392 * @since BuddyPress (1.6)
    393393 *
    394  * @param $default bool Optional.Default value true
     394 * @param bool $default Optional.Default value true
    395395 *
    396396 * @uses bp_get_option() To get the logged out Toolbar option
    … …  
    406406 * @since BuddyPress (1.6)
    407407 *
    408  * @param $default bool Optional. Default value true
     408 * @param bool $default Optional. Default value true
    409409 *
    410410 * @uses bp_get_option() To get the avatar uploads option
    … …  
    420420 * @since BuddyPress (1.6)
    421421 *
    422  * @param $default bool Optional. Default value
     422 * @param bool $default Optional. Default value
    423423 *
    424424 * @uses bp_get_option() To get the account deletion option
    … …  
    434434 * @since BuddyPress (1.6)
    435435 *
    436  * @param $default bool Optional. Default value false
     436 * @param bool $default Optional. Default value false
    437437 * @todo split and move into blog and forum components
    438438 * @uses bp_get_option() To get the blog/forum comments option
    … …  
    448448 * @since BuddyPress (1.6)
    449449 *
    450  * @param $default bool Optional. Default value true
     450 * @param bool $default Optional. Default value true
    451451 *
    452452 * @todo Move into groups component
    … …  
    463463 * @since BuddyPress (1.6)
    464464 *
    465  * @param $default bool Optional. Default value true
     465 * @param bool $default Optional. Default value true
    466466 *
    467467 * @todo Move into groups component
    … …  
    478478 * @since BuddyPress (1.6)
    479479 *
    480  * @param $default bool Optional. Default value
     480 * @param bool $default Optional. Default value
    481481 */
    482482function bp_group_forums_root_id( $default = '0' ) {
    … …  
    488488     * @since BuddyPress (1.6)
    489489     *
    490      * @param $default bool Optional. Default value 0
     490     * @param bool $default Optional. Default value 0
    491491     *
    492492     * @uses bp_get_option() To get the maximum title length
    … …  
    502502 * @since BuddyPress (1.6)
    503503 *
    504  * @param $default bool Optional. Default value true
     504 * @param bool $default Optional. Default value true
    505505 *
    506506 * @uses bp_get_option() To get the group forums option
    … …  
    516516 * @since BuddyPress (1.6)
    517517 *
    518  * @param $default bool Optional. Default value true
     518 * @param bool $default Optional. Default value true
    519519 *
    520520 * @uses bp_get_option() To get the Akismet option
    … …  
    530530 * @since BuddyPress (1.7)
    531531 *
    532  * @param $default string Optional. Default value 'default'
     532 * @param string $default Optional. Default value 'default'
    533533 * @uses get_option() To get the subtheme option
    534534 * @return string ID of the subtheme

  • trunk/bp-core/bp-core-template.php

    r7224 r7228  
    623623 *
    624624 * @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 array
     625 * @return string $action_variable The value of that position in the array
    626626 */
    627627function bp_action_variable( $position = 0 ) {
    … …  
    712712 * @since BuddyPress (1.5)
    713713 * @global BuddyPress $bp The one true BuddyPress instance
    714  * @param str $root_slug Needle to our active component haystack
     714 * @param string $root_slug Needle to our active component haystack
    715715 * @return mixed False if none found, component name if found
    716716 */
    … …  
    884884 * @since BuddyPress (1.5)
    885885 *
    886  * @param str $action The action being tested against
     886 * @param string $action The action being tested against
    887887 * @return bool True if the current action matches $action
    888888 */
    … …  
    908908 * @since BuddyPress (1.5)
    909909 *
    910  * @param str $action_variable The action_variable being tested against
     910 * @param string $action_variable The action_variable being tested against
    911911 * @param int $position The array key you're testing against. If you don't provide a $position,
    912912 *   the function will return true if the $action_variable is found *anywhere* in the action
    … …  
    985985 *
    986986 * @package BuddyPress Core
    987  * @return true if root component, else false.
     987 * @return bool True if root component, else false.
    988988 */
    989989function bp_is_root_component( $component_name ) {

  • trunk/bp-core/bp-core-theme-compatibility.php

    r7137 r7228  
    531531 * @since BuddyPress (1.7)
    532532 * @param string $content
    533  * @return type
     533 * @return string
    534534 */
    535535function bp_replace_the_content( $content = '' ) {

  • trunk/bp-core/bp-core-update.php

    r6873 r7228  
    254254 *
    255255 * @uses set_transient() To drop the activation transient for 30 seconds
    256  *
    257  * @return If bulk activation
    258256 */
    259257function bp_add_activation_redirect() {

  • trunk/bp-core/bp-core-wpabstraction.php

    r6342 r7228  
    128128    /**
    129129     * Fallback implementation of mb_strpos, hardcoded to UTF-8.
    130      * @param $haystack String
    131      * @param $needle String
    132      * @param $offset String: optional start position
    133      * @param $encoding String: optional encoding; ignored
     130     * @param string $haystack
     131     * @param string $needle
     132     * @param int $offset optional; start position.
     133     * @param string $encoding optional; not used.
    134134     * @return int
    135135     */
    … …  
    151151    /**
    152152     * Fallback implementation of mb_strrpos, hardcoded to UTF-8.
    153      * @param $haystack String
    154      * @param $needle String
    155      * @param $offset String: optional start position
    156      * @param $encoding String: optional encoding; ignored
     153     * @param string $haystack
     154     * @param string $needle
     155     * @param int $offset optional; start position.
     156     * @param string $encoding optional; not used.
    157157     * @return int
    158158     */

  • trunk/bp-core/deprecated/1.5.php

    r6589 r7228  
    455455 * @deprecated BuddyPress (1.5)
    456456 * @deprecated bp_is_root_component()
    457  * @return true if root component, else false.
     457 * @return bool True if root component, else false.
    458458 */
    459459function bp_core_is_root_component( $component_name ) {
    … …  
    498498     * @deprecated BuddyPress (1.5)
    499499     * @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' )
    502502     * @return string
    503503     * @since BuddyPress (1.2)

  • trunk/bp-core/deprecated/1.6.php

    r6583 r7228  
    194194 *
    195195 * @deprecated BuddyPress (1.6)
    196  * @return noreply@sitedomain email address
     196 * @return string email address
    197197 */
    198198function bp_core_email_from_address_filter() {

  • trunk/bp-forums/bp-forums-bbpress-sa.php

    r6342 r7228  
    222222 * the bbPress stand-alone tables without loading a conflicting WP Admin.
    223223 *
    224  * @param unknown_type $queries
    225  * @param unknown_type $execute
    226  * @return unknown
     224 * @param array $queries
     225 * @param bool $execute Optional; defaults to true.
     226 * @return array
    227227 */
    228228function bp_bb_dbDelta($queries, $execute = true) {

  • trunk/bp-forums/bp-forums-functions.php

    r6779 r7228  
    320320 * @since BuddyPress (1.6)
    321321 *
    322  * @param str $text The text of the comment
     322 * @param string $text The text of the comment
    323323 * @param int $topic_id The topic id
    324324 * @param int $user_id The user id
    … …  
    371371 *
    372372 * @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'
    374374 * @return int $count The topic count
    375375 */

  • trunk/bp-forums/bp-forums-template.php

    r6342 r7228  
    894894     *
    895895     * @uses apply_filters() Filter bp_get_forum_topic_new_reply_link to modify
    896      * @return str The URL for the New Reply link
     896     * @return string The URL for the New Reply link
    897897     */
    898898    function bp_get_forum_topic_new_reply_link() {
    … …  
    13961396     * @since BuddyPress (1.5)
    13971397     *
    1398      * @param str $format 'string' returns comma-separated string; otherwise returns array
     1398     * @param string $format 'string' returns comma-separated string; otherwise returns array
    13991399     * @return mixed $tags
    14001400     */

  • trunk/bp-friends/bp-friends-activity.php

    r6342 r7228  
    7070 * @package BuddyPress
    7171 *
    72  * @param str $action The kind of notification being rendered
     72 * @param string $action The kind of notification being rendered
    7373 * @param int $item_id The primary item id
    7474 * @param int $secondary_item_id The secondary item id
    7575 * @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 Toolbar
     76 * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
    7777 */
    7878function friends_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {

  • trunk/bp-friends/bp-friends-template.php

    r6342 r7228  
    213213 *
    214214 * @uses bp_get_potential_friend_id()
    215  * @param <type> $user_id
     215 * @param int $user_id Optional
    216216 */
    217217function bp_potential_friend_id( $user_id = 0 ) {

  • trunk/bp-groups/bp-groups-admin.php

    r7197 r7228  
    705705 * Members metabox
    706706 *
    707  * @param obj $item The BP_Groups_Group object
     707 * @param BP_Groups_Group $item The BP_Groups_Group object
    708708 *
    709709 * @since BuddyPress (1.7)

  • trunk/bp-groups/bp-groups-buddybar.php

    r6342 r7228  
    1616 * @since BuddyPress (1.0)
    1717 * @global BuddyPress $bp
    18  * @return False if no menu
    1918 */
    2019function bp_groups_adminbar_admin_menu() {

  • trunk/bp-groups/bp-groups-classes.php

    r7182 r7228  
    885885     * @since BuddyPress (1.5)
    886886     *
    887      * @param str $status 'public', 'private', 'hidden', 'all' Which group types to count
     887     * @param string $status 'public', 'private', 'hidden', 'all' Which group types to count
    888888     * @return int The topic count
    889889     */
    … …  
    21802180     * Call the create_screen() method, if we're on the right page
    21812181     *
    2182      * @since 1.8
     2182     * @since BuddyPress (1.8)
    21832183     */
    21842184    public function maybe_create_screen() {
    … …  
    21982198     * Call the create_screen_save() method, if we're on the right page
    21992199     *
    2200      * @since 1.8
     2200     * @since BuddyPress (1.8)
    22012201     */
    22022202    public function maybe_create_screen_save() {
    … …  
    23462346     *
    23472347     * @since BuddyPress (1.8)
    2348      * @param $screen The markup to check
     2348     * @param string $screen The markup to check
    23492349     * @return bool
    23502350     */

  • trunk/bp-groups/bp-groups-forums.php

    r6342 r7228  
    399399 * @since BuddyPress (1.5)
    400400 *
    401  * @param str $status 'public', 'private', 'hidden', 'all' Which group types to count
     401 * @param string $status 'public', 'private', 'hidden', 'all' Which group types to count
    402402 * @return int The topic count
    403403 */

  • trunk/bp-groups/bp-groups-functions.php

    r7182 r7228  
    3737 * support and pass through the groups_get_group filter.
    3838 *
    39  * @param $args The load_users parameter is deprecated and does nothing.
    40  * @return obj $group The group object
     39 * @param string $args The load_users parameter is deprecated and does nothing.
     40 * @return BP_Groups_Group $group The group object
    4141 */
    4242function groups_get_group( $args = '' ) {
    … …  
    524524 * @since BuddyPress (1.5)
    525525 *
    526  * @return obj The current group object
     526 * @return BP_Groups_Group The current group object
    527527 */
    528528function groups_get_current_group() {
    … …  
    782782 * @param int $user_id Potential group member
    783783 * @param int $group_id Potential group
    784  * @param str $type Optional. Use 'sent' to check for sent invites, 'all' to check for all
     784 * @param string $type Optional. Use 'sent' to check for sent invites, 'all' to check for all
    785785 * @return bool Returns true if an invitation is found
    786786 */

  • trunk/bp-groups/bp-groups-template.php

    r7141 r7228  
    812812 * @since BuddyPress (1.5)
    813813 *
    814  * @param obj $group (optional) The group being queried. Defaults to the current group in the loop
    815  * @param str $format 'string' to get a comma-separated string, 'array' to get an array
     814 * @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
    816816 * @return mixed $admin_ids A string or array of user_ids
    817817 */
    … …  
    842842 * @since BuddyPress (1.5)
    843843 *
    844  * @param obj $group (optional) The group being queried. Defaults to the current group in the loop
    845  * @param str $format 'string' to get a comma-separated string, 'array' to get an array
     844 * @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
    846846 * @return mixed $mod_ids A string or array of user_ids
    847847 */
    … …  
    10821082 * @since BuddyPress (1.5)
    10831083 *
    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 check
     1084 * @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
    10861086 */
    10871087function bp_group_show_invite_status_setting( $setting, $group = false ) {
    … …  
    16731673 * @since BuddyPress (1.2.7)
    16741674 *
    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.
    16761676 * @uses bp_get_group_new_topic_button() Returns the 'New Topic' button
    16771677 */
    … …  
    16841684     * @since BuddyPress (1.2.7)
    16851685     *
    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.
    16871687     * @uses is_user_logged_in() Is there a user logged in?
    16881688     * @uses bp_group_is_user_banned() Is the current user banned from the current group?
    … …  
    16901690     * @uses bp_is_group_forum_topic() Are we on a group topic page?
    16911691     * @uses bp_get_button() Renders a button
    1692      * @return HTML code for the button
     1692     * @return string HTML code for the button
    16931693     */
    16941694    function bp_get_group_new_topic_button( $group = false ) {
    … …  
    24172417     *
    24182418     * @uses apply_filters() Filter bp_get_groups_current_create_step to modify
    2419      * @return str $current_create_step
     2419     * @return string $current_create_step
    24202420     */
    24212421    function bp_get_groups_current_create_step() {
    … …  
    25832583     *
    25842584     * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value
    2585      * @return str $tab The current tab's slug
     2585     * @return string $tab The current tab's slug
    25862586     */
    25872587    function bp_get_group_current_admin_tab() {
    … …  
    30413041     * @uses apply_filters() Filter bp_get_current_group_slug to modify this output
    30423042     *
    3043      * @return str $current_group_slug The slug of the current group, if there is one
     3043     * @return string $current_group_slug The slug of the current group, if there is one
    30443044     */
    30453045    function bp_get_current_group_slug() {
    … …  
    30663066     * @uses apply_filters() Filter bp_get_current_group_name to modify this output
    30673067     *
    3068      * @return str The name of the current group, if there is one
     3068     * @return string The name of the current group, if there is one
    30693069     */
    30703070    function bp_get_current_group_name() {

  • trunk/bp-loader.php

    r7215 r7228  
    130130     * @see buddypress()
    131131     *
    132      * @return The one true BuddyPress
     132     * @return BuddyPress The one true BuddyPress
    133133     */
    134134    public static function instance() {
    … …  
    582582 * Example: <?php $bp = buddypress(); ?>
    583583 *
    584  * @return The one true BuddyPress Instance
     584 * @return BuddyPress The one true BuddyPress Instance
    585585 */
    586586function buddypress() {
    587     return buddypress::instance();
     587    return BuddyPress::instance();
    588588}
    589589

  • trunk/bp-members/bp-members-actions.php

    r6342 r7228  
    9999 *
    100100 * @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)
    104103 */
    105104function bp_core_get_random_member() {

  • trunk/bp-members/bp-members-functions.php

    r7163 r7228  
    121121 * @package BuddyPress Core
    122122 * @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.
    124124 */
    125125function bp_core_get_user_domain( $user_id, $user_nicename = false, $user_login = false ) {
    … …  
    151151 *
    152152 * @package BuddyPress Core
    153  * @param user_id The ID of the user.
     153 * @param int $user_id The ID of the user.
    154154 * @uses BP_Core_User::get_core_userdata() Performs the query.
    155155 */
    … …  
    171171 * @package BuddyPress Core
    172172 * @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.
    174174 */
    175175function bp_core_get_displayed_userid( $user_login ) {
    … …  
    181181 *
    182182 * @package BuddyPress Core
    183  * @param $username str Username to check.
     183 * @param string $username Username to check.
    184184 * @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.
    187186 */
    188187function bp_core_get_userid( $username ) {
    … …  
    199198 *
    200199 * @package BuddyPress Core
    201  * @param $username str Username to check.
     200 * @param string $username Username to check.
    202201 * @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.
    205203 */
    206204function bp_core_get_userid_from_nicename( $user_nicename ) {
    … …  
    217215 *
    218216 * @package BuddyPress Core
    219  * @param $uid int User ID to check.
     217 * @param int $uid User ID to check.
    220218 * @global $userdata WordPress user data for the current logged in user.
    221219 * @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.
    224221 */
    225222function bp_core_get_username( $user_id, $user_nicename = false, $user_login = false ) {
    … …  
    291288 *
    292289 * @package BuddyPress Core
    293  * @param $uid int User ID to check.
     290 * @param int $uid User ID to check.
    294291 * @global $userdata WordPress user data for the current logged in user.
    295292 * @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.
    298294 */
    299295function bp_members_get_user_nicename( $user_id ) {
    … …  
    344340 *
    345341 * @package BuddyPress Core
    346  * @param $uid int User ID to check.
     342 * @param int $uid User ID to check.
    347343 * @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.
    350345 */
    351346function bp_core_get_user_email( $uid ) {
    … …  
    372367 *
    373368 * @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.
    378372 * @todo This function needs to be cleaned up or split into separate functions
    379373 */
    … …  
    407401 * @uses xprofile_set_field_data() Will update the field data for a user based on field name and user id.
    408402 * @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.
    410404 */
    411405function bp_core_get_user_displayname( $user_id_or_username ) {
    … …  
    463457 *
    464458 * @package BuddyPress Core
    465  * @param $email str The email address for the user.
     459 * @param string $email The email address for the user.
    466460 * @uses bp_core_get_userlink() BuddyPress function to get a userlink by user ID.
    467461 * @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.
    469463 */
    470464function bp_core_get_userlink_by_email( $email ) {
    … …  
    476470 * Returns the user link for the user based on the supplied identifier
    477471 *
    478  * @param $username str If 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.
    480474 */
    481475function bp_core_get_userlink_by_username( $username ) {
    … …  
    918912 * redirect them to the home page and stop them from logging in.
    919913 *
    920  * @param obj $user Either the WP_User object or the WP_Error object
    921  * @return obj If 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.
    922916 *
    923917 * @since BuddyPress (1.1.2)
    … …  
    942936 *
    943937 * @package BuddyPress Core
    944  * @param $user_id The user id for the user to delete usermeta for
     938 * @param int $user_id The user id for the user to delete usermeta for
    945939 * @uses bp_delete_user_meta() deletes a row from the wp_usermeta table based on meta_key
    946940 */
    … …  
    10991093 * @see bp_core_validate_email_address()
    11001094 *
    1101  * @param obj $errors WP_Error object
     1095 * @param WP_Error $errors WP_Error object
    11021096 * @param array $validation_results The return value of a validation function
    11031097 *   like bp_core_validate_email_address()
    … …  
    14141408 * See {@link wpmu_signup_user()} and {@link wpmu_validate_user_signup()}.
    14151409 *
    1416  * @param obj $user Either the WP_User object or the WP_Error object
    1417  * @return obj If 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.
    14181412 *
    14191413 * @since BuddyPress (1.2.2)

  • trunk/bp-members/bp-members-template.php

    r6941 r7228  
    556556     *
    557557     * @uses apply_filters() Filter bp_get_the_member_name() to alter the function's output
    558      * @return str The user's fullname for display
     558     * @return string The user's fullname for display
    559559     */
    560560    function bp_get_member_name() {

  • trunk/bp-messages/bp-messages-functions.php

    r6342 r7228  
    234234 * @package BuddyPress
    235235 *
    236  * @param str $action The kind of notification being rendered
     236 * @param string $action The kind of notification being rendered
    237237 * @param int $item_id The primary item id
    238238 * @param int $secondary_item_id The secondary item id
    239239 * @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 Toolbar
     240 * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
    241241 */
    242242function messages_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {

  • trunk/bp-messages/bp-messages-template.php

    r6943 r7228  
    384384     * @package BuddyPress
    385385     *
    386      * @return str The form action
     386     * @return string The form action
    387387     */
    388388    function bp_get_messages_form_action() {

  • trunk/bp-settings/bp-settings-actions.php

    r6361 r7228  
    2424 *
    2525 * @global BuddyPress $bp
    26  * @return If no reason to proceed
    2726 */
    2827function bp_settings_action_general() {
    … …  
    215214/**
    216215 * Handles the changing and saving of user notification settings
    217  *
    218  * @return If no reason to proceed
    219216 */
    220217function bp_settings_action_notifications() {
    … …  
    261258/**
    262259 * Handles the setting of user capabilities, spamming, hamming, role, etc...
    263  *
    264  * @return If no reason to proceed
    265260 */
    266261function bp_settings_action_capabilities() {
    … …  
    310305/**
    311306 * Handles the deleting of a user
    312  *
    313  * @return If no reason to proceed
    314307 */
    315308function bp_settings_action_delete_account() {

  • trunk/bp-settings/bp-settings-screens.php

    r6317 r7228  
    1515 *
    1616 * @since BuddyPress (1.5)
    17  *
    18  * @return If we shouldn't be here
    1917 */
    2018function bp_settings_screen_general() {
    … …  
    3230 *
    3331 * @since BuddyPress (1.5)
    34  *
    35  * @return If we shouldn't be here
    3632 */
    3733function bp_settings_screen_notification() {
    … …  
    4945 *
    5046 * @since BuddyPress (1.5)
    51  *
    52  * @return If we shouldn't be here
    5347 */
    5448function bp_settings_screen_delete_account() {
    … …  
    6761 *
    6862 * @since BuddyPress (1.6)
    69  *
    70  * @return If we shouldn't be here
    7163 */
    7264function bp_settings_screen_capabilities() {

  • trunk/bp-templates/bp-legacy/buddypress-functions.php

    r7205 r7228  
    887887 * Invites a friend to join a group via a POST request.
    888888 *
    889  * @return unknown
    890889 * @since BuddyPress (1.2)
    891890 * @todo Audit return types

  • trunk/bp-themes/bp-default/_inc/ajax.php

    r7116 r7228  
    550550 * Invites a friend to join a group via a POST request.
    551551 *
    552  * @return unknown
    553552 * @since BuddyPress (1.2)
    554553 * @todo Audit return types

  • trunk/bp-themes/bp-default/functions.php

    r7193 r7228  
    521521 * Return the ID of a page set as the home page.
    522522 *
    523  * @return false|int ID of page set as the home page
     523 * @return int|bool ID of page set as the home page
    524524 * @since BuddyPress (1.2)
    525525 */

  • trunk/bp-xprofile/bp-xprofile-activity.php

    r6692 r7228  
    3232 * @package BuddyPress
    3333 * @subpackage XProfileActivity
    34  * @param $args Array containing all variables used after extract() call
     34 * @param string $args String containing all variables used after extract() call
    3535 * @global $bp The global BuddyPress settings variable created in bp_core_current_times()
    3636 * @uses bp_activity_add() Adds an entry to the activity component tables for a specific activity
    … …  
    7878 *
    7979 * @package BuddyPress XProfile
    80  * @param $args Array containing all variables used after extract() call
     80 * @param string $args Containing all variables used after extract() call
    8181 * @global BuddyPress $bp The one true BuddyPress instance
    8282 * @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  
    195195 *
    196196 * @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 user
    199  * @param $value The 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.
    200200 * @global BuddyPress $bp The one true BuddyPress instance
    201201 * @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.
    203203 */
    204204function xprofile_set_field_data( $field, $user_id, $value, $is_required = false ) {
    … …  
    322322 *
    323323 * @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.
    325325 * @return int $field_id on success, false on failure.
    326326 */
    … …  
    333333 *
    334334 * @package BuddyPress Core
    335  * @param $user_id User ID of the user to get random data for
    336  * @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.
    337337 * @global BuddyPress $bp The one true BuddyPress instance
    338338 * @global $wpdb WordPress DB access object.
    339339 * @global $current_user WordPress global variable containing current logged in user information
    340340 * @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.
    342342 */
    343343function xprofile_get_random_profile_data( $user_id, $exclude_fullname = true ) {
    … …  
    359359 *
    360360 * @package BuddyPress Core
    361  * @param $field_type The type of field: datebox, selectbox, textbox etc
    362  * @param $field_value The actual value
     361 * @param string $field_type The type of field: datebox, selectbox, textbox etc
     362 * @param string $field_value The actual value
    363363 * @uses bp_format_time() Formats a time value based on the WordPress date format setting
    364  * @return $field_value The formatted value
     364 * @return string|bool The formatted value, or false if value is empty
    365365 */
    366366function xprofile_format_profile_field( $field_type, $field_value ) {
    … …  
    388388 *
    389389 * @package BuddyPress Core
    390  * @param $directory The root directory name
    391  * @param $user_id The user ID.
     390 * @param string $directory The root directory name. Optional.
     391 * @param int $user_id The user ID. Optional.
    392392 * @return array() containing the path and URL plus some other settings.
    393393 */
    … …  
    485485 *
    486486 * @package BuddyPress XProfile
    487  * @param $user_id The ID of the deleted user
     487 * @param int $user_id The ID of the deleted user
    488488 */
    489489function xprofile_remove_data( $user_id ) {
    … …  
    630630 * @since BuddyPress (1.5)
    631631 *
    632  * @return str The field name
     632 * @return string The field name
    633633 */
    634634function bp_xprofile_fullname_field_name() {
Note: See TracChangeset for help on using the changeset viewer.