Skip to:
Content

BuddyPress.org

Changeset 5926


Ignore:
Timestamp:
03/16/2012 12:52:24 AM (13 years ago)
Author:
johnjamesjacoby
Message:

Replace ambiguous 'object' phpdoc references with more accurate descriptions for the $bp global

Location:
trunk
Files:
16 edited

Legend:

Unmodified
Added
Removed

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

    r5920 r5926  
    404404     * Get activity comments that are associated with a specific activity ID
    405405     *
    406      * @global object $bp Global BuddyPress settings object
     406     * @global BuddyPress $bp The one true BuddyPress instance
    407407     * @global wpdb $wpdb WordPress database object
    408408     * @param int $activity_id Activity ID to fetch comments for

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

    r5899 r5926  
    88 * @since 1.5
    99 *
    10  * @global object $bp Global BuddyPress settings object
     10 * @global BuddyPress $bp The one true BuddyPress instance
    1111 * @return bool True if set, False if empty
    1212 */

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

    r5885 r5926  
    131131 * @since 1.5
    132132 *
    133  * @global object $bp Global BuddyPress settings object
     133 * @global BuddyPress $bp The one true BuddyPress instance
    134134 * @uses bp_current_user_can() to check current user permissions before showing the notices
    135135 * @uses bp_is_root_blog()
    … …  
    171171 * @since 1.5
    172172 *
    173  * @global object $bp Global BuddyPress settings object
     173 * @global BuddyPress $bp The one true BuddyPress instance
    174174 * @param string $notice The notice you are adding to the queue
    175175 */

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

    r5897 r5926  
    7878 * default, but can be extended to include your own custom components too.
    7979 *
    80  * @global object $bp Global BuddyPress settings object
     80 * @global BuddyPress $bp The one true BuddyPress instance
    8181 * @global $current_blog WordPress global containing information and settings for the current blog being viewed.
    8282 * @param array $args Determine the output of this function

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

    r5923 r5926  
    1616 *
    1717 * @package BuddyPress Core
    18  * @global object $bp Global BuddyPress settings object
     18 * @global BuddyPress $bp The one true BuddyPress instance
    1919 */
    2020function bp_core_new_nav_item( $args = '' ) {
    … …  
    121121 *
    122122 * @package BuddyPress Core
    123  * @global object $bp Global BuddyPress settings object
     123 * @global BuddyPress $bp The one true BuddyPress instance
    124124 */
    125125function bp_core_new_nav_default( $args = '' ) {
    … …  
    191191 *
    192192 * @package BuddyPress Core
    193  * @global object $bp Global BuddyPress settings object
     193 * @global BuddyPress $bp The one true BuddyPress instance
    194194 */
    195195function bp_core_sort_nav_items() {
    … …  
    224224 *
    225225 * @package BuddyPress Core
    226  * @global object $bp Global BuddyPress settings object
     226 * @global BuddyPress $bp The one true BuddyPress instance
    227227 */
    228228function bp_core_new_subnav_item( $args = '' ) {
    … …  
    452452 * @package BuddyPress Core
    453453 * @param $parent_id The id of the parent navigation item.
    454  * @global object $bp Global BuddyPress settings object
     454 * @global BuddyPress $bp The one true BuddyPress instance
    455455 */
    456456function bp_core_reset_subnav_items( $parent_slug ) {

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

    r5906 r5926  
    374374     * Fetches the user details for all the users who username starts with the letter given.
    375375     *
    376      * @global object $bp Global BuddyPress settings object
     376     * @global BuddyPress $bp The one true BuddyPress instance
    377377     * @global wpdb $wpdb WordPress database object
    378378     * @param string $letter The letter the users names are to start with.
    … …  
    482482     * Find users who match on the value of an xprofile data.
    483483     *
    484      * @global object $bp Global BuddyPress settings object
     484     * @global BuddyPress $bp The one true BuddyPress instance
    485485     * @global wpdb $wpdb WordPress database object
    486486     * @param string $search_terms The terms to search the profile table value column for.
    … …  
    526526     * Accepts multiple user IDs to fetch data for.
    527527     *
    528      * @global object $bp Global BuddyPress settings object
     528     * @global BuddyPress $bp The one true BuddyPress instance
    529529     * @global wpdb $wpdb WordPress database object
    530530     * @param array $paged_users an array of stdClass containing the users
    … …  
    707707     * Update or insert notification details into the database.
    708708     *
    709      * @global object $bp Global BuddyPress settings object
     709     * @global BuddyPress $bp The one true BuddyPress instance
    710710     * @global wpdb $wpdb WordPress database object
    711711     * @return bool Success or failure
    … …  
    736736     * Fetches the notification data from the database.
    737737     *
    738      * @global object $bp Global BuddyPress settings object
     738     * @global BuddyPress $bp The one true BuddyPress instance
    739739     * @global wpdb $wpdb WordPress database object
    740740     */
    … …  
    764764     * Fetches all the notifications in the database for a specific user.
    765765     *
    766      * @global object $bp Global BuddyPress settings object
     766     * @global BuddyPress $bp The one true BuddyPress instance
    767767     * @global wpdb $wpdb WordPress database object
    768768     * @param integer $user_id User ID
    … …  
    782782     * Delete all the notifications for a user based on the component name and action.
    783783     *
    784      * @global object $bp Global BuddyPress settings object
     784     * @global BuddyPress $bp The one true BuddyPress instance
    785785     * @global wpdb $wpdb WordPress database object
    786786     * @param integer $user_id
    … …  
    798798     * Delete all the notifications that have a specific item id, component name and action.
    799799     *
    800      * @global object $bp Global BuddyPress settings object
     800     * @global BuddyPress $bp The one true BuddyPress instance
    801801     * @global wpdb $wpdb WordPress database object
    802802     * @param integer $user_id The ID of the user who the notifications are for.
    … …  
    818818     * Deletes all the notifications sent by a specific user, by component and action.
    819819     *
    820      * @global object $bp Global BuddyPress settings object
     820     * @global BuddyPress $bp The one true BuddyPress instance
    821821     * @global wpdb $wpdb WordPress database object
    822822     * @param integer $user_id The ID of the user whose sent notifications we wish to delete.
    … …  
    834834     * Deletes all the notifications for all users by item id, and optional secondary item id, and component name and action.
    835835     *
    836      * @global object $bp Global BuddyPress settings object
     836     * @global BuddyPress $bp The one true BuddyPress instance
    837837     * @global wpdb $wpdb WordPress database object
    838838     * @param string $item_id The item id that they notifications are to be for.

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

    r5925 r5926  
    323323 *
    324324 * @package BuddyPress Core
    325  * @global object $bp Global BuddyPress settings object
     325 * @global BuddyPress $bp The one true BuddyPress instance
    326326 */
    327327function bp_core_render_message() {
    … …  
    11061106 * Trigger a 404
    11071107 *
    1108  * @global object $bp Global BuddyPress settings object
     1108 * @global BuddyPress $bp The one true BuddyPress instance
    11091109 * @global WP_Query $wp_query WordPress query object
    11101110 * @param string $redirect If 'remove_canonical_direct', remove WordPress' "helpful" redirect_canonical action.

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

    r5822 r5926  
    1515 *
    1616 * @package BuddyPress Core
    17  * @global object $bp Global BuddyPress settings object
     17 * @global BuddyPress $bp The one true BuddyPress instance
    1818 * @uses bp_get_user_nav() Renders the navigation for a profile of a currently viewed user.
    1919 */
    … …  
    7575 *
    7676 * @package BuddyPress Core
    77  * @global object $bp Global BuddyPress settings object
     77 * @global BuddyPress $bp The one true BuddyPress instance
    7878 */
    7979function bp_has_options_avatar() {
    … …  
    650650     * @since 1.5
    651651     *
    652      * @global object $bp Global BuddyPress settings object
     652     * @global BuddyPress $bp The one true BuddyPress instance
    653653     * @param string $component Optional. Defaults to the current component
    654654     * @return string $root_slug The root slug
    … …  
    686686 *
    687687 * @since BuddyPress {r3923}
    688  * @global object $bp Global BuddyPress settings object
     688 * @global BuddyPress $bp The one true BuddyPress instance
    689689 * @param str $root_slug Needle to our active component haystack
    690690 * @return mixed False if none found, component name if found
    … …  
    954954 * page in wp-admin's Settings > Reading screen.
    955955 *
    956  * @global object $bp Global BuddyPress settings object
     956 * @global BuddyPress $bp The one true BuddyPress instance
    957957 * @global $current_blog WordPress global for the current blog
    958958 * @param string $component Optional; Name of the component to check for.

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

    r5918 r5926  
    4646 * @since 1.5
    4747 *
    48  * @global object $bp Global BuddyPress settings object
     48 * @global BuddyPress $bp The one true BuddyPress instance
    4949 * @return bool True if set, False if empty
    5050 */

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

    r5878 r5926  
    2121 * @since 1.5
    2222 *
    23  * @global object $bp Global BuddyPress settings object
     23 * @global BuddyPress $bp The one true BuddyPress instance
    2424 * @return bool True if set, False if empty
    2525 */

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

    r5840 r5926  
    1818 * @since 1.5
    1919 *
    20  * @global object $bp Global BuddyPress settings object
     20 * @global BuddyPress $bp The one true BuddyPress instance
    2121 * @return bool True if set, False if empty
    2222 */
    … …  
    3535 *
    3636 * @package BuddyPress Core Core
    37  * @global object $bp Global BuddyPress settings object
     37 * @global BuddyPress $bp The one true BuddyPress instance
    3838 */
    3939function bp_core_define_slugs() {
    … …  
    382382 *
    383383 * @package BuddyPress Core
    384  * @global object $bp Global BuddyPress settings object
     384 * @global BuddyPress $bp The one true BuddyPress instance
    385385 * @uses wp_cache_get() Will try and fetch the value from the cache, rather than querying the DB again.
    386386 * @uses get_userdata() Fetches the WP userdata for a specific user.

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

    r5922 r5926  
    693693 * @todo Move to a back-compat file?
    694694 * @deprecated Does not seem to be called anywhere in the core
    695  * @global object $bp Global BuddyPress settings object
     695 * @global BuddyPress $bp The one true BuddyPress instance
    696696 */
    697697function bp_get_loggedin_user_nav() {
    … …  
    739739 *
    740740 * @package BuddyPress Core
    741  * @global object $bp Global BuddyPress settings object
     741 * @global BuddyPress $bp The one true BuddyPress instance
    742742 */
    743743function bp_get_displayed_user_nav() {

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

    r5876 r5926  
    5858 * functions.php file.
    5959 *
    60  * @global object $bp Global BuddyPress settings object
     60 * @global BuddyPress $bp The one true BuddyPress instance
    6161 * @since 1.5
    6262 */

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

    r5699 r5926  
    7979 * @package BuddyPress XProfile
    8080 * @param $args Array containing all variables used after extract() call
    81  * @global object $bp Global BuddyPress settings object
     81 * @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
    8383 */
    … …  
    113113 *
    114114 * @package BuddyPress XProfile
    115  * @global object $bp Global BuddyPress settings object
     115 * @global BuddyPress $bp The one true BuddyPress instance
    116116 * @uses bp_activity_add() Adds an entry to the activity component tables for a specific activity
    117117 */

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

    r5837 r5926  
    9797     *
    9898     * @global $wpdb WordPress DB access object.
    99      * @global object $bp Global BuddyPress settings object
     99     * @global BuddyPress $bp The one true BuddyPress instance
    100100     *
    101101     * @param array $args Takes an array of parameters:

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

    r5821 r5926  
    192192 * @param $user_id The ID of the user
    193193 * @param $value The value for the field you want to set for the user.
    194  * @global object $bp Global BuddyPress settings object
     194 * @global BuddyPress $bp The one true BuddyPress instance
    195195 * @uses xprofile_get_field_id_from_name() Gets the ID for the field based on the name.
    196196 * @return true on success, false on failure.
    … …  
    329329 * @param $user_id User ID of the user to get random data for
    330330 * @param $exclude_fullname whether or not to exclude the full name field as random data.
    331  * @global object $bp Global BuddyPress settings object
     331 * @global BuddyPress $bp The one true BuddyPress instance
    332332 * @global $wpdb WordPress DB access object.
    333333 * @global $current_user WordPress global variable containing current logged in user information
Note: See TracChangeset for help on using the changeset viewer.