Skip to:
Content

BuddyPress.org

Changeset 4400


Ignore:
Timestamp:
05/20/2011 07:33:20 PM (14 years ago)
Author:
djpaul
Message:

Correct phpdoc for $bp global

Location:
trunk
Files:
17 edited

Legend:

Unmodified
Added
Removed

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

    r4378 r4400  
    208208 * Based on the $args passed, bp_has_activities() populates the $activities_template global.
    209209 *
    210  * @package BuddyPress Activity
    211  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
    212  *
     210 * @global BP_Activity_Template $activities_template
     211 * @global object $bp Global BuddyPress settings object
    213212 * @param mixed $args Arguments for limiting the contents of the activity loop. Can be passed as an associative array or as a URL argument string
    214213 * @return bool Returns true when activities are found
    215214 */
    216215function bp_has_activities( $args = '' ) {
    217     global $bp, $activities_template;
     216    global $activities_template, $bp;
    218217
    219218    /***

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

    r4391 r4400  
    11731173 *
    11741174 * @package BuddyPress Core
    1175  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     1175 * @global object $bp Global BuddyPress settings object
    11761176 * @global $wpdb WordPress DB access object.
    11771177 * @uses add_submenu_page() WP function to add a submenu item

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

    r4387 r4400  
    5555 * default, but can be extended to include your own custom components too.
    5656 *
    57  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     57 * @global object $bp Global BuddyPress settings object
    5858 * @global $current_blog WordPress global containing information and settings for the current blog being viewed.
    5959 * @param array $args Determine the output of this function

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

    r4240 r4400  
    55 *
    66 * @package BuddyPress Core
    7  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     7 * @global object $bp Global BuddyPress settings object
    88 */
    99function bp_core_new_nav_item( $args = '' ) {
    … …  
    8787 *
    8888 * @package BuddyPress Core
    89  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     89 * @global object $bp Global BuddyPress settings object
    9090 */
    9191function bp_core_new_nav_default( $args = '' ) {
    … …  
    126126 *
    127127 * @package BuddyPress Core
    128  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     128 * @global object $bp Global BuddyPress settings object
    129129 */
    130130function bp_core_sort_nav_items() {
    … …  
    157157 *
    158158 * @package BuddyPress Core
    159  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     159 * @global object $bp Global BuddyPress settings object
    160160 */
    161161function bp_core_new_subnav_item( $args = '' ) {
    … …  
    306306 * @package BuddyPress Core
    307307 * @param $parent_id The id of the parent navigation item.
    308  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     308 * @global object $bp Global BuddyPress settings object
    309309 */
    310310function bp_core_reset_subnav_items( $parent_slug ) {

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

    r4378 r4400  
    178178 *
    179179 * @package BuddyPress Core
    180  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     180 * @global object $bp Global BuddyPress settings object
    181181 * @uses is_super_admin() returns true if the current user is a site admin, false if not
    182182 * @uses add_submenu_page() WP function to add a submenu item
    … …  
    214214 * @since 1.3
    215215 *
    216  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     216 * @global object $bp Global BuddyPress settings object
    217217 * @uses is_super_admin() to check current user permissions before showing the notices
    218218 * @uses bp_is_root_blog()
    … …  
    253253 * @since 1.3
    254254 *
    255  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     255 * @global object $bp Global BuddyPress settings object
    256256 * @param string $notice The notice you are adding to the queue
    257257 */
    … …  
    506506 *
    507507 * @package BuddyPress Core
    508  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     508 * @global object $bp Global BuddyPress settings object
    509509 */
    510510function bp_core_render_message() {
    … …  
    753753 *
    754754 * @package BuddyPress Core
    755  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     755 * @global object $bp Global BuddyPress settings object
    756756 * @param string $slug The slug to redirect to for searching.
    757757 */

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

    r4356 r4400  
    1212 *
    1313 * @package BuddyPress Core
    14  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     14 * @global object $bp Global BuddyPress settings object
    1515 * @uses bp_get_user_nav() Renders the navigation for a profile of a currently viewed user.
    1616 */
    … …  
    6969 *
    7070 * @package BuddyPress Core
    71  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     71 * @global object $bp Global BuddyPress settings object
    7272 */
    7373function bp_has_options_avatar() {
    … …  
    637637     * @since 1.3
    638638     *
    639      * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     639     * @global object $bp Global BuddyPress settings object
    640640     * @param string $component Optional. Defaults to the current component
    641641     * @return string $root_slug The root slug
    … …  
    670670 *
    671671 * @since BuddyPress {r3923}
    672  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     672 * @global object $bp Global BuddyPress settings object
    673673 * @param str $root_slug Needle to our active component haystack
    674674 * @return mixed False if none found, component name if found
    … …  
    845845 * page in wp-admin's Settings > Reading screen.
    846846 *
    847  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     847 * @global object $bp Global BuddyPress settings object
    848848 * @global $current_blog WordPress global for the current blog
    849849 * @param string $component Optional; Name of the component to check for.

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

    r4148 r4400  
    1515 * by the site admin.
    1616 *
    17  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     17 * @global object $bp Global BuddyPress settings object
    1818 * @return bool True if forum is disabled
    1919 * @since 1.3

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

    r4397 r4400  
    1313 *
    1414 * @package BuddyPress Core
    15  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     15 * @global object $bp Global BuddyPress settings object
    1616 * @uses wp_enqueue_script() Loads a JS script into the header of the page.
    1717 * @uses bp_core_load_template() Loads a specific template file.
    … …  
    2323 *
    2424 * @package BuddyPress Core
    25  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     25 * @global object $bp Global BuddyPress settings object
    2626 */
    2727function bp_members_action_set_spammer_status() {
    … …  
    8787 *
    8888 * @package BuddyPress Core
    89  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     89 * @global object $bp Global BuddyPress settings object
    9090 */
    9191function bp_members_action_delete_user() {

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

    r4386 r4400  
    1919 *
    2020 * @package BuddyPress Core Core
    21  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     21 * @global object $bp Global BuddyPress settings object
    2222 */
    2323function bp_core_define_slugs() {
    … …  
    376376 *
    377377 * @package BuddyPress Core
    378  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     378 * @global object $bp Global BuddyPress settings object
    379379 * @uses wp_cache_get() Will try and fetch the value from the cache, rather than querying the DB again.
    380380 * @uses get_userdata() Fetches the WP userdata for a specific user.
    … …  
    513513 *
    514514 * @package BuddyPress Core
    515  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     515 * @global object $bp Global BuddyPress settings object
    516516 * @global $wpdb WordPress user data for the current logged in user.
    517517 * @return array of post ids.
    … …  
    530530 *
    531531 * @package BuddyPress Core
    532  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     532 * @global object $bp Global BuddyPress settings object
    533533 * @uses is_super_admin() Checks to see if the user is a site administrator.
    534534 * @uses wpmu_delete_user() Deletes a user from the system on multisite installs.

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

    r4372 r4400  
    620620 * @todo Move to a back-compat file?
    621621 * @deprecated Does not seem to be called anywhere in the core
    622  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     622 * @global object $bp Global BuddyPress settings object
    623623 */
    624624function bp_get_loggedin_user_nav() {
    … …  
    662662 *
    663663 * @package BuddyPress Core
    664  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     664 * @global object $bp Global BuddyPress settings object
    665665 */
    666666function bp_get_displayed_user_nav() {

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

    r4372 r4400  
    598598 * AJAX handler for autocomplete. Displays friends only, unless BP_MESSAGES_AUTOCOMPLETE_ALL is defined
    599599 *
    600  * @global object $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     600 * @global object object $bp Global BuddyPress settings object
    601601 * @return none
    602602 */

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

    r4328 r4400  
    5555 * functions.php file.
    5656 *
    57  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     57 * @global object $bp Global BuddyPress settings object
    5858 * @since 1.3
    5959 */
    … …  
    133133 * Enqueue theme javascript safely
    134134 *
    135  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     135 * @global object $bp Global BuddyPress settings object
    136136 * @see http://codex.wordpress.org/Function_Reference/wp_enqueue_script
    137137 * @since 1.3
    … …  
    529529 * Used when the custom menus haven't been configured.
    530530 *
    531  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     531 * @global object $bp Global BuddyPress settings object
    532532 * @param array Menu arguments from wp_nav_menu()
    533533 * @see wp_nav_menu()

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

    r4046 r4400  
    1414 *
    1515 * @package BuddyPress Xprofile
    16  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     16 * @global object $bp Global BuddyPress settings object
    1717 * @uses bp_core_delete_avatar() Deletes the active avatar for the logged in user.
    1818 * @uses add_action() Runs a specific function for an action when it fires.

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

    r4288 r4400  
    3030 * @package BuddyPress XProfile
    3131 * @param $args Array containing all variables used after extract() call
    32  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     32 * @global $bp The global BuddyPress settings variable created in bp_core_current_times()
    3333 * @uses bp_activity_record() Adds an entry to the activity component tables for a specific activity
    3434 */
    … …  
    7575 * @package BuddyPress XProfile
    7676 * @param $args Array containing all variables used after extract() call
    77  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     77 * @global object $bp Global BuddyPress settings object
    7878 * @uses bp_activity_delete() Deletes an entry to the activity component tables for a specific activity
    7979 */
    … …  
    108108 *
    109109 * @package BuddyPress XProfile
    110  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     110 * @global object $bp Global BuddyPress settings object
    111111 * @uses bp_activity_add() Adds an entry to the activity component tables for a specific activity
    112112 */

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

    r4045 r4400  
    66 *
    77 * @package BuddyPress XProfile
    8  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     8 * @global object $bp Global BuddyPress settings object
    99 * @global $wpdb WordPress DB access object.
    1010 * @uses is_super_admin() returns true if the current user is a site admin, false if not

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

    r4398 r4400  
    9292     *
    9393     * @global $wpdb WordPress DB access object.
    94      * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     94     * @global object $bp Global BuddyPress settings object
    9595     *
    9696     * @param array $args Takes an array of parameters:

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

    r4398 r4400  
    145145 * @param mixed $field The ID of the field, or the $name of the field.
    146146 * @param int $user_id The ID of the user
    147  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     147 * @global object $bp Global BuddyPress settings object
    148148 * @uses BP_XProfile_ProfileData::get_value_byid() Fetches the value based on the params passed.
    149149 * @return mixed The profile field data.
    … …  
    187187 * @param $user_id The ID of the user
    188188 * @param $value The value for the field you want to set for the user.
    189  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     189 * @global object $bp Global BuddyPress settings object
    190190 * @uses xprofile_get_field_id_from_name() Gets the ID for the field based on the name.
    191191 * @return true on success, false on failure.
    … …  
    283283 * @param $user_id User ID of the user to get random data for
    284284 * @param $exclude_fullname whether or not to exclude the full name field as random data.
    285  * @global $bp The global BuddyPress settings variable created in bp_core_setup_globals()
     285 * @global object $bp Global BuddyPress settings object
    286286 * @global $wpdb WordPress DB access object.
    287287 * @global $current_user WordPress global variable containing current logged in user information
Note: See TracChangeset for help on using the changeset viewer.