Skip to:
Content

BuddyPress.org

Changeset 10108


Ignore:
Timestamp:
09/13/2015 02:02:56 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Core component.

See #6576.

Location:
trunk/src/bp-core
Files:
53 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/admin/bp-core-admin-actions.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Admin Actions.
     
    1918 */
    2019
    21 // Exit if accessed directly
     20// Exit if accessed directly.
    2221defined( 'ABSPATH' ) || exit;
    2322
     
    6362 * routine on that site.
    6463 *
    65  * @since BuddyPress (1.7.0)
     64 * @since 1.7.0
    6665 *
    6766 * @param int    $blog_id
     
    8483     * Fires the activation routine for a new site created in a multisite installation.
    8584     *
    86      * @since BuddyPress (1.7.0)
     85     * @since 1.7.0
    8786     *
    8887     * @param int    $blog_id ID of the blog being installed to.
     
    104103 * Piggy back admin_init action.
    105104 *
    106  * @since BuddyPress (1.7.0)
     105 * @since 1.7.0
    107106 * @uses do_action() Calls 'bp_admin_init'.
    108107 */
     
    112111     * Fires inside the bp_admin_init function.
    113112     *
    114      * @since BuddyPress (1.6.0)
     113     * @since 1.6.0
    115114     */
    116115    do_action( 'bp_admin_init' );
     
    120119 * Piggy back admin_menu action.
    121120 *
    122  * @since BuddyPress (1.7.0)
     121 * @since 1.7.0
    123122 * @uses do_action() Calls 'bp_admin_menu'.
    124123 */
     
    128127     * Fires inside the bp_admin_menu function.
    129128     *
    130      * @since BuddyPress (1.7.0)
     129     * @since 1.7.0
    131130     */
    132131    do_action( 'bp_admin_menu' );
     
    136135 * Piggy back admin_head action.
    137136 *
    138  * @since BuddyPress (1.7.0)
     137 * @since 1.7.0
    139138 * @uses do_action() Calls 'bp_admin_head'.
    140139 */
     
    144143     * Fires inside the bp_admin_head function.
    145144     *
    146      * @since BuddyPress (1.6.0)
     145     * @since 1.6.0
    147146     */
    148147    do_action( 'bp_admin_head' );
     
    152151 * Piggy back admin_notices action.
    153152 *
    154  * @since BuddyPress (1.7.0)
     153 * @since 1.7.0
    155154 * @uses do_action() Calls 'bp_admin_notices'.
    156155 */
     
    160159     * Fires inside the bp_admin_notices function.
    161160     *
    162      * @since BuddyPress (1.5.0)
     161     * @since 1.5.0
    163162     */
    164163    do_action( 'bp_admin_notices' );
     
    168167 * Piggy back admin_enqueue_scripts action.
    169168 *
    170  * @since BuddyPress (1.7.0)
     169 * @since 1.7.0
    171170 *
    172171 * @uses do_action() Calls 'bp_admin_enqueue_scripts''.
     
    180179     * Fires inside the bp_admin_enqueue_scripts function.
    181180     *
    182      * @since BuddyPress (1.7.0)
     181     * @since 1.7.0
    183182     *
    184183     * @param string $hook_suffix The current admin page, passed to admin_enqueue_scripts.
     
    190189 * Dedicated action to register BuddyPress importers.
    191190 *
    192  * @since BuddyPress (1.7.0)
     191 * @since 1.7.0
    193192 * @uses do_action() Calls 'bp_admin_notices'.
    194193 */
     
    200199     * Used to register a BuddyPress importer.
    201200     *
    202      * @since BuddyPress (1.7.0)
     201     * @since 1.7.0
    203202     */
    204203    do_action( 'bp_register_importers' );
     
    208207 * Dedicated action to register admin styles.
    209208 *
    210  * @since BuddyPress (1.7.0)
     209 * @since 1.7.0
    211210 * @uses do_action() Calls 'bp_admin_notices'.
    212211 */
     
    216215     * Fires inside the bp_register_admin_style function.
    217216     *
    218      * @since BuddyPress (1.7.0)
     217     * @since 1.7.0
    219218     */
    220219    do_action( 'bp_register_admin_style' );
     
    224223 * Dedicated action to register admin settings.
    225224 *
    226  * @since BuddyPress (1.7.0)
     225 * @since 1.7.0
    227226 * @uses do_action() Calls 'bp_register_admin_settings'.
    228227 */
     
    232231     * Fires inside the bp_register_admin_settings function.
    233232     *
    234      * @since BuddyPress (1.6.0)
     233     * @since 1.6.0
    235234     */
    236235    do_action( 'bp_register_admin_settings' );
  • trunk/src/bp-core/admin/bp-core-admin-components.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Admin Component Functions.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1514 *
    1615 * @package BuddyPress
    17  * @since BuddyPress (1.6.0)
     16 * @since 1.6.0
    1817 * @uses bp_core_admin_component_options()
    1918 */
     
    4544 *
    4645 * @package BuddyPress
    47  * @since BuddyPress (1.6.0)
     46 * @since 1.6.0
    4847 * @todo Use settings API
    4948 */
     
    5655     * Filters the array of available components.
    5756     *
    58      * @since BuddyPress (1.5.0)
     57     * @since 1.5.0
    5958     *
    6059     * @param mixed $value Active components.
     
    238237 * Handle saving the Component settings.
    239238 *
    240  * @since BuddyPress (1.6.0)
     239 * @since 1.6.0
    241240 * @todo Use settings API when it supports saving network settings
    242241 */
     
    297296 *   ones.
    298297 *
    299  * @since BuddyPress (1.7.0)
     298 * @since 1.7.0
    300299 *
    301300 * @param array $submitted This is the array of component settings coming from the POST
     
    343342 * well as to do some processing on settings data submitted from those screens.
    344343 *
    345  * @since BuddyPress (1.7.0)
     344 * @since 1.7.0
    346345 *
    347346 * @param string $type 'all', 'optional', 'retired', 'required'.
     
    437436     * Filters the list of component information.
    438437     *
    439      * @since BuddyPress (2.0.0)
     438     * @since 2.0.0
    440439     *
    441440     * @param array  $components Array of component information.
  • trunk/src/bp-core/admin/bp-core-admin-functions.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Common Admin Functions.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    3332 * @global array $_registered_pages
    3433 * @global array $submenu
    35  * @since BuddyPress (1.6.0)
     34 * @since 1.6.0
    3635 */
    3736function bp_core_admin_backpat_menu() {
     
    7271 * @global string $plugin_page
    7372 * @global array $submenu
    74  * @since BuddyPress (1.6.0)
     73 * @since 1.6.0
    7574 */
    7675function bp_core_modify_admin_menu_highlight() {
     
    9493 *
    9594 * @see bp_core_admin_backpat_menu()
    96  * @since BuddyPress (1.6.0)
     95 * @since 1.6.0
    9796 * @todo Add convenience links into the markup once new positions are finalised.
    9897 */
     
    120119 * boxes.
    121120 *
    122  * @since BuddyPress (1.5.0)
     121 * @since 1.5.0
    123122 *
    124123 * @uses bp_current_user_can() to check current user permissions before showing the notices.
     
    165164 * loaded in time.
    166165 *
    167  * @since BuddyPress (1.5.0)
     166 * @since 1.5.0
    168167 *
    169168 * @param string $notice The notice you are adding to the queue.
     
    200199 * @global WPDB $wpdb WordPress DB object
    201200 * @global WP_Rewrite $wp_rewrite
    202  * @since BuddyPress (1.2.0)
     201 * @since 1.2.0
    203202 */
    204203function bp_core_activation_notice() {
     
    330329 * Redirect user to BuddyPress's What's New page on activation.
    331330 *
    332  * @since BuddyPress (1.7.0)
     331 * @since 1.7.0
    333332 *
    334333 * @internal Used internally to redirect BuddyPress to the about page on activation.
     
    371370 * Output the tabs in the admin area.
    372371 *
    373  * @since BuddyPress (1.5.0)
     372 * @since 1.5.0
    374373 *
    375374 * @param string $active_tab Name of the tab that is active. Optional.
     
    383382     * Filters the admin tabs to be displayed.
    384383     *
    385      * @since BuddyPress (1.9.0)
     384     * @since 1.9.0
    386385     *
    387386     * @param array $value Array of tabs to output to the admin area.
     
    401400     * Fires after the output of tabs for the admin area.
    402401     *
    403      * @since BuddyPress (1.5.0)
     402     * @since 1.5.0
    404403     */
    405404    do_action( 'bp_admin_tabs' );
     
    409408 * Get the data for the tabs in the admin area.
    410409 *
    411  * @since BuddyPress (2.2.0)
     410 * @since 2.2.0
    412411 *
    413412 * @param string $active_tab Name of the tab that is active. Optional.
     
    447446     * Filters the tab data used in our wp-admin screens.
    448447     *
    449      * @since BuddyPress (2.2.0)
     448     * @since 2.2.0
    450449     *
    451450     * @param array $tabs Tab data.
     
    459458 * adds contextual help to BuddyPress admin pages.
    460459 *
    461  * @since BuddyPress (1.7.0)
     460 * @since 1.7.0
    462461 * @todo Make this part of the BP_Component class and split into each component
    463462 *
     
    551550 * renders contextual help content to contextual help tabs.
    552551 *
    553  * @since BuddyPress (1.7.0)
     552 * @since 1.7.0
    554553 *
    555554 * @param string $tab
     
    594593 * Add a separator to the WordPress admin menus.
    595594 *
    596  * @since BuddyPress (1.7.0)
     595 * @since 1.7.0
    597596 *
    598597 * @uses bp_current_user_can() To check users capability on root blog.
     
    629628 * Tell WordPress we have a custom menu order.
    630629 *
    631  * @since BuddyPress (1.7.0)
     630 * @since 1.7.0
    632631 * @uses bp_current_user_can() To check users capability on root blog.
    633632 *
     
    649648 * Move our custom separator above our custom post types.
    650649 *
    651  * @since BuddyPress (1.7.0)
     650 * @since 1.7.0
    652651 * @uses bp_current_user_can() To check users capability on root blog.
    653652 *
     
    672671     * Filters the custom admin menus.
    673672     *
    674      * @since BuddyPress (1.7.0)
     673     * @since 1.7.0
    675674     *
    676675     * @param array $value Empty array.
     
    721720 * reconciles the two values and returns a single action being performed.
    722721 *
    723  * @since BuddyPress (1.7.0)
     722 * @since 1.7.0
    724723 *
    725724 * @return string
     
    742741 * Register meta box and associated JS for BuddyPress WP Nav Menu.
    743742 *
    744  * @since BuddyPress (1.9.0)
     743 * @since 1.9.0
    745744 */
    746745function bp_admin_wp_nav_menu_meta_box() {
     
    757756 * Build and populate the BuddyPress accordion on Appearance > Menus.
    758757 *
    759  * @since BuddyPress (1.9.0)
     758 * @since 1.9.0
    760759 *
    761760 * @global $nav_menu_selected_id
     
    823822 * Note: These restrictions are only enforced if JavaScript is enabled.
    824823 *
    825  * @since BuddyPress (1.9.0)
     824 * @since 1.9.0
    826825 */
    827826function bp_admin_wp_nav_menu_restrict_items() {
     
    844843 * Add "Mark as Spam/Ham" button to user row actions.
    845844 *
    846  * @since BuddyPress (2.0.0)
     845 * @since 2.0.0
    847846 *
    848847 * @param array  $actions     User row action links.
     
    890889 * Catch requests to mark individual users as spam/ham from users.php.
    891890 *
    892  * @since BuddyPress (2.0.0)
     891 * @since 2.0.0
    893892 */
    894893function bp_core_admin_user_manage_spammers() {
     
    945944 * Inline script that adds the 'site-spammed' class to spammed users.
    946945 *
    947  * @since BuddyPress (2.0.0)
     946 * @since 2.0.0
    948947 */
    949948function bp_core_admin_user_spammed_js() {
  • trunk/src/bp-core/admin/bp-core-admin-schema.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress DB schema.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Get the DB schema to use for BuddyPress components.
    1514 *
    16  * @since BuddyPress (1.1.0)
     15 * @since 1.1.0
    1716 *
    1817 * @global $wpdb $wpdb
     
    3332 * routines on, typically the first time a component is activated in Settings.
    3433 *
    35  * @since BuddyPress (1.0.0)
     34 * @since 1.0.0
    3635 *
    3736 * @param array|bool $active_components Components to install.
     
    8887 * Install database tables for the Notifications component.
    8988 *
    90  * @since BuddyPress (1.0.0)
     89 * @since 1.0.0
    9190 *
    9291 * @uses bp_core_set_charset()
     
    132131 * Install database tables for the Activity component.
    133132 *
    134  * @since BuddyPress (1.0.0)
     133 * @since 1.0.0
    135134 *
    136135 * @uses bp_core_set_charset()
     
    185184 * Install database tables for the Notifications component.
    186185 *
    187  * @since BuddyPress (1.0.0)
     186 * @since 1.0.0
    188187 *
    189188 * @uses bp_core_set_charset()
     
    213212 * Install database tables for the Groups component.
    214213 *
    215  * @since BuddyPress (1.0.0)
     214 * @since 1.0.0
    216215 *
    217216 * @uses bp_core_set_charset()
     
    273272 * Install database tables for the Messages component.
    274273 *
    275  * @since BuddyPress (1.0.0)
     274 * @since 1.0.0
    276275 *
    277276 * @uses bp_core_set_charset()
     
    333332 * Install database tables for the Profiles component.
    334333 *
    335  * @since BuddyPress (1.0.0)
     334 * @since 1.0.0
    336335 *
    337336 * @uses bp_core_set_charset()
     
    423422 * Install database tables for the Sites component.
    424423 *
    425  * @since BuddyPress (1.0.0)
     424 * @since 1.0.0
    426425 *
    427426 * @uses bp_core_set_charset()
     
    459458 * Install the signups table.
    460459 *
    461  * @since BuddyPress (2.0.0)
     460 * @since 2.0.0
    462461 *
    463462 * @global $wpdb
     
    503502 * own sign-ups table; Eg: Gravity Forms User Registration Add On.
    504503 *
    505  * @since BuddyPress (2.0.1)
     504 * @since 2.0.1
    506505 *
    507506 * @see pre_schema_upgrade()
  • trunk/src/bp-core/admin/bp-core-admin-settings.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Admin Settings.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Main settings section description for the settings page.
    1514 *
    16  * @since BuddyPress (1.6.0)
     15 * @since 1.6.0
    1716 */
    1817function bp_admin_setting_callback_main_section() { }
     
    2120 * Admin bar for logged out users setting field.
    2221 *
    23  * @since BuddyPress (1.6.0)
     22 * @since 1.6.0
    2423 *
    2524 * @uses bp_form_option() To output the option value.
     
    3736 * Allow members to delete their accounts setting field.
    3837 *
    39  * @since BuddyPress (1.6.0)
     38 * @since 1.6.0
    4039 *
    4140 * @uses checked() To display the checked attribute.
     
    5554 * Groups settings section description for the settings page.
    5655 *
    57  * @since BuddyPress (1.6.0)
     56 * @since 1.6.0
    5857 */
    5958function bp_admin_setting_callback_activity_section() { }
     
    6261 * Allow Akismet setting field.
    6362 *
    64  * @since BuddyPress (1.6.0)
     63 * @since 1.6.0
    6564 *
    6665 * @uses checked() To display the checked attribute.
     
    7877 * Allow activity comments on blog posts and forum posts.
    7978 *
    80  * @since BuddyPress (1.6.0)
     79 * @since 1.6.0
    8180 */
    8281function bp_admin_setting_callback_blogforum_comments() {
     
    9291 * Allow Heartbeat to refresh activity stream.
    9392 *
    94  * @since BuddyPress (2.0.0)
     93 * @since 2.0.0
    9594 */
    9695function bp_admin_setting_callback_heartbeat() {
     
    110109 * function to flip the boolean before saving the intval.
    111110 *
    112  * @since BuddyPress (1.6.0)
     111 * @since 1.6.0
    113112 *
    114113 * @param bool $value
     
    125124 * Profile settings section description for the settings page.
    126125 *
    127  * @since BuddyPress (1.6.0)
     126 * @since 1.6.0
    128127 */
    129128function bp_admin_setting_callback_xprofile_section() { }
     
    132131 * Enable BP->WP profile syncing field.
    133132 *
    134  * @since BuddyPress (1.6.0)
     133 * @since 1.6.0
    135134 *
    136135 * @uses bp_form_option() To output the option value.
     
    148147 * Allow members to upload avatars field.
    149148 *
    150  * @since BuddyPress (1.6.0)
     149 * @since 1.6.0
    151150 *
    152151 * @uses checked() To display the checked attribute.
     
    166165 * Groups settings section description for the settings page.
    167166 *
    168  * @since BuddyPress (1.6.0)
     167 * @since 1.6.0
    169168 */
    170169function bp_admin_setting_callback_groups_section() { }
     
    173172 * Allow all users to create groups field.
    174173 *
    175  * @since BuddyPress (1.6.0)
     174 * @since 1.6.0
    176175 *
    177176 * @uses checked() To display the checked attribute.
     
    190189 * 'Enable group avatars' field markup.
    191190 *
    192  * @since BuddyPress (2.3.0)
     191 * @since 2.3.0
    193192 */
    194193function bp_admin_setting_callback_group_avatar_uploads() {
     
    204203 * Forums settings section description for the settings page.
    205204 *
    206  * @since BuddyPress (1.6.0)
     205 * @since 1.6.0
    207206 */
    208207function bp_admin_setting_callback_bbpress_section() { }
     
    211210 * bb-config.php location field.
    212211 *
    213  * @since BuddyPress (1.6.0)
     212 * @since 1.6.0
    214213 * @uses checked() To display the checked attribute.
    215214 * @uses bp_get_option() To get the config location.
     
    240239 * The main settings page
    241240 *
    242  * @since BuddyPress (1.6.0)
     241 * @since 1.6.0
    243242 *
    244243 * @uses screen_icon() To display the screen icon.
     
    277276 * Save our settings.
    278277 *
    279  * @since BuddyPress (1.6.0)
     278 * @since 1.6.0
    280279 */
    281280function bp_core_admin_settings_save() {
     
    324323 * Output settings API option.
    325324 *
    326  * @since BuddyPress (1.6.0)
     325 * @since 1.6.0
    327326 *
    328327 * @uses bp_get_bp_form_option()
     
    338337     * Return settings API option
    339338     *
    340      * @since BuddyPress (1.6.0)
     339     * @since 1.6.0
    341340     *
    342341     * @uses bp_get_option()
     
    361360             * Filters the slug value in the form field.
    362361             *
    363              * @since BuddyPress (1.6.0)
     362             * @since 1.6.0
    364363             *
    365364             * @param string $value Value being returned for the requested option.
     
    377376         * Filters the settings API option.
    378377         *
    379          * @since BuddyPress (1.6.0)
     378         * @since 1.6.0
    380379         *
    381380         * @param string $value  Value being returned for the requested option.
  • trunk/src/bp-core/admin/bp-core-admin-slugs.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Admin Slug Functions.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Renders the page mapping admin panel.
    1514 *
    16  * @since BuddyPress (1.6.0)
     15 * @since 1.6.0
    1716 * @todo Use settings API
    1817 * @uses bp_core_admin_component_options()
     
    4544 *
    4645 * @package BuddyPress
    47  * @since BuddyPress (1.6.0)
     46 * @since 1.6.0
    4847 * @todo Use settings API
    4948 */
     
    7675     * Filters the loaded components needing directory page association to a WordPress page.
    7776     *
    78      * @since BuddyPress (1.5.0)
     77     * @since 1.5.0
    7978     *
    8079     * @param array $directory_pages Array of available components to set associations for.
     
    130129                 * Allows plugins to add their own directory associations.
    131130                 *
    132                  * @since BuddyPress (1.5.0)
     131                 * @since 1.5.0
    133132                 */
    134133                do_action( 'bp_active_external_directories' ); ?>
     
    152151     * Filters the default static pages for BuddyPress setup.
    153152     *
    154      * @since BuddyPress (1.6.0)
     153     * @since 1.6.0
    155154     *
    156155     * @param array $static_pages Array of static default static pages.
     
    203202                 * Fires after the display of default static pages for BuddyPress setup.
    204203                 *
    205                  * @since BuddyPress (1.5.0)
     204                 * @since 1.5.0
    206205                 */
    207206                do_action( 'bp_active_external_pages' ); ?>
     
    217216 * Handle saving of the BuddyPress slugs.
    218217 *
    219  * @since BuddyPress (1.6.0)
     218 * @since 1.6.0
    220219 * @todo Use settings API
    221220 */
  • trunk/src/bp-core/admin/bp-core-admin-tools.php

    r10024 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Tools panel.
    54 *
    6  * @since BuddyPress (2.0.0)
    7  */
     5 * @since 2.0.0
     6 *
     7 * @package BuddyPress
     8 * @subpackage Core
     9 */
     10
     11// Exit if accessed directly.
     12defined( 'ABSPATH' ) || exit;
    813
    914/**
    1015 * Render the BuddyPress Tools page.
    1116 *
    12  * @since BuddyPress (2.0.0)
     17 * @since 2.0.0
    1318 */
    1419function bp_core_admin_tools() {
     
    5863 * Handle the processing and feedback of the admin tools page.
    5964 *
    60  * @since BuddyPress (2.0.0)
     65 * @since 2.0.0
    6166 */
    6267function bp_admin_repair_handler() {
     
    148153     * Filters the array of the repair list.
    149154     *
    150      * @since BuddyPress (2.0.0)
     155     * @since 2.0.0
    151156     *
    152157     * @param array $repair_list Array of values for the Repair list options.
     
    158163 * Recalculate friend counts for each user.
    159164 *
    160  * @since BuddyPress (2.0.0)
     165 * @since 2.0.0
    161166 *
    162167 * @return array
     
    216221 * Recalculate group counts for each user.
    217222 *
    218  * @since BuddyPress (2.0.0)
     223 * @since 2.0.0
    219224 *
    220225 * @return array
     
    263268 * Recalculate user-to-blog relationships and useful blog meta data.
    264269 *
    265  * @since BuddyPress (2.1.0)
     270 * @since 2.1.0
    266271 *
    267272 * @return array
     
    295300 * Recalculate the total number of active site members.
    296301 *
    297  * @since BuddyPress (2.0.0)
     302 * @since 2.0.0
    298303 */
    299304function bp_admin_repair_count_members() {
     
    309314 * Re-runs the migration from usermeta introduced in BP 2.0.
    310315 *
    311  * @since BuddyPress (2.0.0)
     316 * @since 2.0.0
    312317 */
    313318function bp_admin_repair_last_activity() {
     
    320325 * Assemble admin notices relating success/failure of repair processes.
    321326 *
    322  * @since BuddyPress (2.0.0)
     327 * @since 2.0.0
    323328 *
    324329 * @param string      $message Feedback message.
     
    367372 * BuddyPress tools. This displays the default content.
    368373 *
    369  * @since BuddyPress (2.0.0)
     374 * @since 2.0.0
    370375 */
    371376function bp_core_admin_available_tools_page() {
     
    379384         * Fires inside the markup used to display the Available Tools page.
    380385         *
    381          * @since BuddyPress (2.0.0)
     386         * @since 2.0.0
    382387         */
    383388        do_action( 'bp_network_tool_box' ); ?>
     
    390395 * Render an introduction of BuddyPress tools on Available Tools page.
    391396 *
    392  * @since BuddyPress (2.0.0)
     397 * @since 2.0.0
    393398 */
    394399function bp_core_admin_available_tools_intro() {
  • trunk/src/bp-core/bp-core-admin.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * Main BuddyPress Admin Class.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    1312if ( !class_exists( 'BP_Admin' ) ) :
     13
    1414/**
    1515 * Load BuddyPress plugin admin area.
     
    1919 * @todo Break this apart into each applicable Component
    2020 *
    21  * @since BuddyPress (1.6.0)
     21 * @since 1.6.0
    2222 */
    2323class BP_Admin {
     
    7676     * The main BuddyPress admin loader.
    7777     *
    78      * @since BuddyPress (1.6.0)
     78     * @since 1.6.0
    7979     *
    8080     * @uses BP_Admin::setup_globals() Setup the globals needed.
     
    9292     *
    9393     * @access private
    94      * @since BuddyPress (1.6.0)
     94     * @since 1.6.0
    9595     */
    9696    private function setup_globals() {
     
    114114     * Include required files.
    115115     *
    116      * @since BuddyPress (1.6.0)
     116     * @since 1.6.0
    117117     * @access private
    118118     */
     
    130130     *
    131131     * @access private
    132      * @since BuddyPress (1.6.0)
     132     * @since 1.6.0
    133133     *
    134134     * @uses add_action() To add various actions.
     
    180180     * Add the navigational menu elements.
    181181     *
    182      * @since BuddyPress (1.6.0)
     182     * @since 1.6.0
    183183     *
    184184     * @uses add_management_page() To add the Recount page in Tools section.
     
    305305     * Register the settings.
    306306     *
    307      * @since BuddyPress (1.6.0)
     307     * @since 1.6.0
    308308     *
    309309     * @uses add_settings_section() To add our own settings section.
     
    401401     * Add a link to BuddyPress About page to the admin bar.
    402402     *
    403      * @since BuddyPress (1.9.0)
     403     * @since 1.9.0
    404404     *
    405405     * @param WP_Admin_Bar $wp_admin_bar As passed to 'admin_bar_menu'.
     
    419419     * Add Settings link to plugins area.
    420420     *
    421      * @since BuddyPress (1.6.0)
     421     * @since 1.6.0
    422422     *
    423423     * @param array  $links Links array in which we would prepend our link.
     
    443443     * Add some general styling to the admin area.
    444444     *
    445      * @since BuddyPress (1.6.0)
     445     * @since 1.6.0
    446446     */
    447447    public function admin_head() {
     
    462462     * Add some general styling to the admin area.
    463463     *
    464      * @since BuddyPress (1.6.0)
     464     * @since 1.6.0
    465465     */
    466466    public function enqueue_scripts() {
     
    472472         * Filters the BuddyPress Core Admin CSS file path.
    473473         *
    474          * @since BuddyPress (1.6.0)
     474         * @since 1.6.0
    475475         *
    476476         * @param string $file File path for the admin CSS.
     
    490490     * Output the about screen.
    491491     *
    492      * @since BuddyPress (1.7.0)
     492     * @since 1.7.0
    493493     */
    494494    public function about_screen() {
     
    628628     * want to leverage api.wordpress.org eventually.
    629629     *
    630      * @since BuddyPress (1.7.0)
     630     * @since 1.7.0
    631631     */
    632632    public function credits_screen() {
     
    778778     * Output welcome text and badge for What's New and Credits pages.
    779779     *
    780      * @since BuddyPress (2.2.0)
     780     * @since 2.2.0
    781781     */
    782782    public static function welcome_text() {
     
    802802     * Output tab navigation for `What's New` and `Credits` pages.
    803803     *
    804      * @since BuddyPress (2.2.0)
     804     * @since 2.2.0
    805805     * @param string $tab
    806806     */
     
    826826     * @see bp_do_activation_redirect()
    827827     *
    828      * @since BuddyPress (2.2.0)
     828     * @since 2.2.0
    829829     *
    830830     * @return bool
     
    837837     * Return a user-friendly version-number string, for use in translations.
    838838     *
    839      * @since BuddyPress (2.2.0)
     839     * @since 2.2.0
    840840     *
    841841     * @return string
     
    870870 * Setup BuddyPress Admin.
    871871 *
    872  * @since BuddyPress (1.6.0)
     872 * @since 1.6.0
    873873 *
    874874 * @uses BP_Admin
  • trunk/src/bp-core/bp-core-adminbar.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Core Toolbar.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Add the secondary BuddyPress area to the my-account menu.
    1716 *
    18  * @since BuddyPress (1.6.0)
     17 * @since 1.6.0
    1918 *
    2019 * @global WP_Admin_Bar $wp_admin_bar
     
    5352 * Handle the Toolbar/BuddyBar business.
    5453 *
    55  * @since BuddyPress (1.2.0)
     54 * @since 1.2.0
    5655 *
    5756 * @global string $wp_version
     
    103102 * the `bp_init` action in `bp-core-actions.php`.
    104103 *
    105  * @since BuddyPress (1.5.0)
     104 * @since 1.5.0
    106105 */
    107106function bp_core_load_admin_bar_css() {
     
    113112 * Enqueue supplemental WordPress Toolbar styling.
    114113 *
    115  * @since BuddyPress (2.1.0)
     114 * @since 2.1.0
    116115 *
    117116 * @see bp_core_register_common_styles()
  • trunk/src/bp-core/bp-core-attachments.php

    r10091 r10108  
    1717 * match with our needs.
    1818 *
    19  * @since  BuddyPress (2.3.0)
     19 * @since  2.3.0
    2020 *
    2121 * @return bool True if WordPress is 3.9+, false otherwise.
     
    2828 * Get the BuddyPress Plupload settings.
    2929 *
    30  * @since  BuddyPress (2.3.0)
     30 * @since  2.3.0
    3131 *
    3232 * @return array list of BuddyPress Plupload settings.
     
    8686 * Builds localization strings for the BuddyPress Uploader scripts.
    8787 *
    88  * @since  BuddyPress (2.3.0)
     88 * @since  2.3.0
    8989 *
    9090 * @return array Plupload default localization strings.
     
    125125 * to set specific script data.
    126126 *
    127  * @since  BuddyPress (2.3.0)
     127 * @since  2.3.0
    128128 *
    129129 * @param  string $class name of the class extending BP_Attachment (eg: BP_Attachment_Avatar).
     
    244244         * Use this filter to add a navigation to a custom tool to set the object's avatar.
    245245         *
    246          * @since BuddyPress (2.3.0)
     246         * @since 2.3.0
    247247         *
    248248         * @param array $avatar_nav An associative array of available nav items where each item is an array organized this way:
     
    300300     * to avoid the scripts to be loaded more than once.
    301301     *
    302      * @since BuddyPress (2.3.0)
     302     * @since 2.3.0
    303303     */
    304304    do_action( 'bp_attachments_enqueue_scripts' );
     
    308308 * Check the current user's capability to edit an avatar for a given object.
    309309 *
    310  * @since  BuddyPress (2.3.0)
     310 * @since  2.3.0
    311311 *
    312312 * @param  string $capability The capability to check.
     
    353353 * Send a JSON response back to an Ajax upload request.
    354354 *
    355  * @since  BuddyPress (2.3.0)
     355 * @since  2.3.0
    356356 *
    357357 * @param  bool  $success  True for a success, false otherwise.
     
    385385 * Get an Attachment template part.
    386386 *
    387  * @since BuddyPress (2.3.0)
     387 * @since 2.3.0
    388388 *
    389389 * @param string $slug Template part slug. eg 'uploader' for 'uploader.php'.
  • trunk/src/bp-core/bp-core-avatars.php

    r10041 r10108  
    44 *
    55 * @package BuddyPress
     6 * @subpackage Core
    67 */
    78
     
    5051 * Set up global variables related to avatars.
    5152 *
    52  * @since BuddyPress (1.5.0)
     53 * @since 1.5.0
    5354 */
    5455function bp_core_set_avatar_globals() {
     
    9293     * Fires at the end of the core avatar globals setup.
    9394     *
    94      * @since BuddyPress (1.5.0)
     95     * @since 1.5.0
    9596     */
    9697    do_action( 'bp_core_set_avatar_globals' );
     
    237238         * Filters the ID of the item being requested.
    238239         *
    239          * @since BuddyPress (1.1.0)
     240         * @since 1.1.0
    240241         *
    241242         * @param string $value  ID of avatar item being requested.
     
    278279         * Filters the avatar directory to use.
    279280         *
    280          * @since BuddyPress (1.1.0)
     281         * @since 1.1.0
    281282         *
    282283         * @param string $value  Name of the subdirectory where the requested avatar should be found.
     
    314315         * Filters the alt attribute value to be applied to avatar.
    315316         *
    316          * @since BuddyPress (1.5.0)
     317         * @since 1.5.0
    317318         *
    318319         * @param string $value  alt to be applied to avatar.
     
    339340     * Filters the title attribute value to be applied to avatar.
    340341     *
    341      * @since BuddyPress (1.5.0)
     342     * @since 1.5.0
    342343     *
    343344     * @param string $value  Title to be applied to avatar.
     
    358359     * Filters the ID attribute to be applied to avatar.
    359360     *
    360      * @since BuddyPress (2.2.0)
     361     * @since 2.2.0
    361362     *
    362363     * @param string $value  ID to be applied to avatar.
     
    394395     * Filters the classes to be applied to the avatar.
    395396     *
    396      * @since BuddyPress (1.6.0)
     397     * @since 1.6.0
    397398     *
    398399     * @param array|string $value  Class(es) to be applied to the avatar.
     
    431432     * Filters the avatar folder directory URL.
    432433     *
    433      * @since BuddyPress (1.1.0)
     434     * @since 1.1.0
    434435     *
    435436     * @param string $value Path to the avatar folder URL.
     
    443444     * Filters the avatar folder directory path.
    444445     *
    445      * @since BuddyPress (1.1.0)
     446     * @since 1.1.0
    446447     *
    447448     * @param string $value Path to the avatar folder directory.
     
    518519                 * Filters an avatar URL wrapped in an <img> element.
    519520                 *
    520                  * @since BuddyPress (1.1.0)
     521                 * @since 1.1.0
    521522                 *
    522523                 * @param string $value             Full <img> element for an avatar.
     
    538539                 * Filters a locally uploaded avatar URL.
    539540                 *
    540                  * @since BuddyPress (1.2.5)
     541                 * @since 1.2.5
    541542                 *
    542543                 * @param string $avatar_url URL for a locally uploaded avatar.
     
    551552     * Filters whether or not to skip Gravatar check.
    552553     *
    553      * @since BuddyPress (1.5.0)
     554     * @since 1.5.0
    554555     *
    555556     * @param bool  $value  Whether or not to skip Gravatar.
     
    566567             * Filters the Mystery person avatar src value.
    567568             *
    568              * @since BuddyPress (1.2.0)
     569             * @since 1.2.0
    569570             *
    570571             * @param string $value Avatar value.
     
    590591         * Filters the Gravatar email to use.
    591592         *
    592          * @since BuddyPress (1.1.0)
     593         * @since 1.1.0
    593594         *
    594595         * @param string $value Email to use in Gravatar request.
     
    601602         * Filters the Gravatar URL path.
    602603         *
    603          * @since BuddyPress (1.0.2)
     604         * @since 1.0.2
    604605         *
    605606         * @param string $value Gravatar URL path.
     
    621622         * This is a variable filter dependent on the avatar type being requested.
    622623         *
    623          * @since BuddyPress (1.5.0)
     624         * @since 1.5.0
    624625         *
    625626         * @param string $value  Default avatar for non-gravatar requests.
     
    714715     * Fires after deleting an existing avatar.
    715716     *
    716      * @since BuddyPress (1.1.0)
     717     * @since 1.1.0
    717718     *
    718719     * @param array $args Array of arguments used for avatar deletion.
     
    726727 * Ajax delete an avatar for a given object and item id.
    727728 *
    728  * @since BuddyPress (2.3.0)
     729 * @since 2.3.0
    729730 *
    730731 * @return string|null A json object containing success data if the avatar was deleted
     
    802803     * If you want to override this function, make sure you return false.
    803804     *
    804      * @since BuddyPress (1.2.4)
     805     * @since 1.2.4
    805806     *
    806807     * @param bool   $value             Whether or not to crop.
     
    860861 * Ajax upload an avatar.
    861862 *
    862  * @since BuddyPress (2.3.0)
     863 * @since 2.3.0
    863864 *
    864865 * @return  string|null A json object containing success data if the upload succeeded
     
    928929         * Filter here to deal with other components.
    929930         *
    930          * @since BuddyPress (2.3.0)
     931         * @since 2.3.0
    931932         *
    932933         * @var array $bp_params the BuddyPress Ajax parameters.
     
    10091010  * Handle avatar webcam capture.
    10101011  *
    1011   * @since BuddyPress (2.3.0)
     1012  * @since 2.3.0
    10121013  *
    10131014  * @param string $data    Base64 encoded image.
     
    10331034     * Filters the Avatar folder directory.
    10341035     *
    1035      * @since BuddyPress (2.3.0)
     1036     * @since 2.3.0
    10361037     *
    10371038     * @param string $avatar_dir Directory for storing avatars.
     
    10601061         * Fires if the new avatar was successfully captured.
    10611062         *
    1062          * @since BuddyPress (2.3.0)
     1063         * @since 2.3.0
    10631064         */
    10641065        do_action( 'xprofile_avatar_uploaded' );
     
    11211122     * If you want to override this function, make sure you return false.
    11221123     *
    1123      * @since BuddyPress (1.2.4)
     1124     * @since 1.2.4
    11241125     *
    11251126     * @param bool  $value Whether or not to crop.
     
    11451146 * Ajax set an avatar for a given object and item id.
    11461147 *
    1147  * @since BuddyPress (2.3.0)
     1148 * @since 2.3.0
    11481149 *
    11491150 * @return  string|null A json object containing success data if the crop/capture succeeded
     
    13561357 * Get allowed avatar types.
    13571358 *
    1358  * @since BuddyPress (2.3.0)
     1359 * @since 2.3.0
    13591360 */
    13601361function bp_core_get_allowed_avatar_types() {
     
    13641365     * Filters the list of allowed image types.
    13651366     *
    1366      * @since BuddyPress (2.3.0)
     1367     * @since 2.3.0
    13671368     *
    13681369     * @param array $allowed_types List of image types.
     
    13821383 * Get allowed avatar mime types.
    13831384 *
    1384  * @since BuddyPress (2.3.0)
     1385 * @since 2.3.0
    13851386 */
    13861387function bp_core_get_allowed_avatar_mimes() {
     
    14221423 * Fetch data from the BP root blog's upload directory.
    14231424 *
    1424  * @since BuddyPress (1.8.0)
     1425 * @since 1.8.0
    14251426 *
    14261427 * @param string $type The variable we want to return from the $bp->avatars object.
     
    15091510     * Filters the absolute upload path for the WP installation.
    15101511     *
    1511      * @since BuddyPress (1.2.0)
     1512     * @since 1.2.0
    15121513     *
    15131514     * @param string $value Absolute upload path for the WP installation.
     
    15281529     * Filters the raw base URL for root site upload location.
    15291530     *
    1530      * @since BuddyPress (1.2.0)
     1531     * @since 1.2.0
    15311532     *
    15321533     * @param string $value Raw base URL for the root site upload location.
     
    15381539 * Check if a given user ID has an uploaded avatar.
    15391540 *
    1540  * @since BuddyPress (1.0.0)
     1541 * @since 1.0.0
    15411542 *
    15421543 * @param int $user_id ID of the user whose avatar is being checked.
     
    15561557     * Filters whether or not a user has an uploaded avatar.
    15571558     *
    1558      * @since BuddyPress (1.6.0)
     1559     * @since 1.6.0
    15591560     *
    15601561     * @param bool $retval  Whether or not a user has an uploaded avatar.
     
    15671568 * Utility function for fetching an avatar dimension setting.
    15681569 *
    1569  * @since BuddyPress (1.5.0)
     1570 * @since 1.5.0
    15701571 *
    15711572 * @param string $type   Dimension type you're fetching dimensions for. 'thumb'
     
    15831584     * Filters the avatar dimension setting.
    15841585     *
    1585      * @since BuddyPress (1.5.0)
     1586     * @since 1.5.0
    15861587     *
    15871588     * @param int|bool $dim    Dimension setting for the type.
     
    15951596 * Get the 'thumb' avatar width setting.
    15961597 *
    1597  * @since BuddyPress (1.5.0)
     1598 * @since 1.5.0
    15981599 *
    15991600 * @return int The 'thumb' width.
     
    16041605     * Filters the 'thumb' avatar width setting.
    16051606     *
    1606      * @since BuddyPress (1.5.0)
     1607     * @since 1.5.0
    16071608     *
    16081609     * @param int $value Value for the 'thumb' avatar width setting.
     
    16141615 * Get the 'thumb' avatar height setting.
    16151616 *
    1616  * @since BuddyPress (1.5.0)
     1617 * @since 1.5.0
    16171618 *
    16181619 * @return int The 'thumb' height.
     
    16231624     * Filters the 'thumb' avatar height setting.
    16241625     *
    1625      * @since BuddyPress (1.5.0)
     1626     * @since 1.5.0
    16261627     *
    16271628     * @param int $value Value for the 'thumb' avatar height setting.
     
    16331634 * Get the 'full' avatar width setting.
    16341635 *
    1635  * @since BuddyPress (1.5.0)
     1636 * @since 1.5.0
    16361637 *
    16371638 * @return int The 'full' width.
     
    16421643     * Filters the 'full' avatar width setting.
    16431644     *
    1644      * @since BuddyPress (1.5.0)
     1645     * @since 1.5.0
    16451646     *
    16461647     * @param int $value Value for the 'full' avatar width setting.
     
    16521653 * Get the 'full' avatar height setting.
    16531654 *
    1654  * @since BuddyPress (1.5.0)
     1655 * @since 1.5.0
    16551656 *
    16561657 * @return int The 'full' height.
     
    16611662     * Filters the 'full' avatar height setting.
    16621663     *
    1663      * @since BuddyPress (1.5.0)
     1664     * @since 1.5.0
    16641665     *
    16651666     * @param int $value Value for the 'full' avatar height setting.
     
    16711672 * Get the max width for original avatar uploads.
    16721673 *
    1673  * @since BuddyPress (1.5.0)
     1674 * @since 1.5.0
    16741675 *
    16751676 * @return int The max width for original avatar uploads.
     
    16801681     * Filters the max width for original avatar uploads.
    16811682     *
    1682      * @since BuddyPress (1.5.0)
     1683     * @since 1.5.0
    16831684     *
    16841685     * @param int $value Value for the max width.
     
    16901691 * Get the max filesize for original avatar uploads.
    16911692 *
    1692  * @since BuddyPress (1.5.0)
     1693 * @since 1.5.0
    16931694 *
    16941695 * @return int The max filesize for original avatar uploads.
     
    16991700     * Filters the max filesize for original avatar uploads.
    17001701     *
    1701      * @since BuddyPress (1.5.0)
     1702     * @since 1.5.0
    17021703     *
    17031704     * @param int $value Value for the max filesize.
     
    17091710 * Get the URL of the 'full' default avatar.
    17101711 *
    1711  * @since BuddyPress (1.5.0)
     1712 * @since 1.5.0
    17121713 *
    17131714 * @param string $type 'local' if the fallback should be the locally-hosted version
     
    17341735     * Filters the URL of the 'full' default avatar.
    17351736     *
    1736      * @since BuddyPress (1.5.0)
     1737     * @since 1.5.0
    17371738     *
    17381739     * @param string $avatar URL of the default avatar.
     
    17471748 * defined.
    17481749 *
    1749  * @since BuddyPress (1.5.0)
     1750 * @since 1.5.0
    17501751 *
    17511752 * @param string $type 'local' if the fallback should be the locally-hosted version
     
    17721773     * Filters the URL of the 'thumb' default avatar.
    17731774     *
    1774      * @since BuddyPress (1.5.0)
     1775     * @since 1.5.0
    17751776     *
    17761777     * @param string $avatar URL of the default avatar.
     
    17861787 * notices, we need to make sure this 'week' query var is reset to 0.
    17871788 *
    1788  * @since  BuddyPress (2.2.0)
     1789 * @since  2.2.0
    17891790 *
    17901791 * @param  WP_Query|null $posts_query the main query object.
     
    18261827 * Checks whether Avatar UI should be loaded.
    18271828 *
    1828  * @since  BuddyPress (2.3.0)
     1829 * @since  2.3.0
    18291830 *
    18301831 * @return bool True if Avatar UI should load, false otherwise.
     
    18581859     * - Completely disable the avatar UI introduced in 2.3 (eg: __return_false())
    18591860     *
    1860      * @since  BuddyPress (2.3.0)
     1861     * @since  2.3.0
    18611862     *
    18621863     * @param bool whether to load the Avatar UI.
     
    18681869 * Checks whether the Webcam Avatar UI part should be loaded.
    18691870 *
    1870  * @since  BuddyPress (2.3.0)
     1871 * @since  2.3.0
    18711872 *
    18721873 * @global $is_safari
     
    18981899     * by returning false.
    18991900     *
    1900      * @since BuddyPress (2.3.0)
     1901     * @since 2.3.0
    19011902     *
    19021903     * @param bool whether to load Webcam Avatar UI part.
     
    19081909 * Template function to load the Avatar UI javascript templates.
    19091910 *
    1910  * @since  BuddyPress (2.3.0)
     1911 * @since  2.3.0
    19111912 */
    19121913function bp_avatar_get_templates() {
     
    19241925 * help users to get the avatar UI.
    19251926 *
    1926  * @since  BuddyPress (2.3.0)
     1927 * @since  2.3.0
    19271928 */
    19281929function bp_avatar_template_check() {
  • trunk/src/bp-core/bp-core-buddybar.php

    r10039 r10108  
    11<?php
    2 
    32/**
    43 * Core BuddyPress Navigational Functions.
     
    98 */
    109
    11 // Exit if accessed directly
     10// Exit if accessed directly.
    1211defined( 'ABSPATH' ) || exit;
    1312
     
    6665     * should be used.
    6766     *
    68      * @since BuddyPress (1.5.0)
     67     * @since 1.5.0
    6968     *
    7069     * @param array $r        Parsed arguments for the nav item.
     
    7877 * Add a link to the main BuddyPress navigation array.
    7978 *
    80  * @since BuddyPress (2.4.0)
     79 * @since 2.4.0
    8180 *
    8281 * @param array|string $args {
     
    150149     * Fires after a link is added to the main BuddyPress navigation array.
    151150     *
    152      * @since BuddyPress (2.4.0)
     151     * @since 2.4.0
    153152     *
    154153     * @param array $r        Parsed arguments for the nav item.
     
    162161 * Register a screen function for an item in the main nav array.
    163162 *
    164  * @since BuddyPress (2.4.0)
     163 * @since 2.4.0
    165164 *
    166165 * @param array|string $args {
     
    248247                 * Filters the default component subnav item.
    249248                 *
    250                  * @since BuddyPress (1.5.0)
     249                 * @since 1.5.0
    251250                 *
    252251                 * @param string $value The slug of the default subnav item
     
    263262     * navigation is registered.
    264263     *
    265      * @since BuddyPress (2.4.0)
     264     * @since 2.4.0
    266265     *
    267266     * @param array $r        Parsed arguments for the nav item.
     
    591590 * For a given subnav item, either hook the screen function or generate redirect arguments, as necessary.
    592591 *
    593  * @since BuddyPress (2.1.0)
     592 * @since 2.1.0
    594593 *
    595594 * @param array $subnav_item The subnav array added to bp_options_nav in `bp_core_new_subnav_item()`.
     
    723722 * Check whether a given nav item has subnav items.
    724723 *
    725  * @since BuddyPress (1.5.0)
     724 * @since 1.5.0
    726725 *
    727726 * @param string $nav_item The slug of the top-level nav item whose subnav items you're checking.
     
    741740     * Filters whether or not a given nav item has subnav items.
    742741     *
    743      * @since BuddyPress (1.5.0)
     742     * @since 1.5.0
    744743     *
    745744     * @param bool   $has_subnav Whether or not there is any subnav items.
     
    822821 * This is a direct copy of WP's private _get_admin_bar_pref()
    823822 *
    824  * @since BuddyPress (1.5.0)
     823 * @since 1.5.0
    825824 *
    826825 * @uses get_user_option()
  • trunk/src/bp-core/bp-core-cache.php

    r10039 r10108  
    99 */
    1010
    11 // Exit if accessed directly
     11// Exit if accessed directly.
    1212defined( 'ABSPATH' ) || exit;
    1313
     
    3030         * Fires before the pruning of WP Super Cache.
    3131         *
    32          * @since BuddyPress (1.0.0)
     32         * @since 1.0.0
    3333         */
    3434        do_action( 'bp_core_clear_cache' );
     
    6262 * Clear the directory_pages cache when one of the pages is updated.
    6363 *
    64  * @since BuddyPress (2.0.0)
     64 * @since 2.0.0
    6565 *
    6666 * @param int $post_id ID of the page that was saved.
     
    8989 * Clear the directory_pages cache when the bp-pages option is updated.
    9090 *
    91  * @since BuddyPress (2.0.0)
     91 * @since 2.0.0
    9292 *
    9393 * @param string $option Option name.
     
    103103 * Clear the root_blog_options cache when any of its options are updated.
    104104 *
    105  * @since BuddyPress (2.0.0)
     105 * @since 2.0.0
    106106 *
    107107 * @param string $option Option name.
     
    130130 * Determine which items from a list do not have cached values.
    131131 *
    132  * @since BuddyPress (2.0.0)
     132 * @since 2.0.0
    133133 *
    134134 * @param array  $item_ids    ID list.
     
    159159 * in the context of template loops.
    160160 *
    161  * @since BuddyPress (1.6.0)
     161 * @since 1.6.0
    162162 *
    163163 * @global object $wpdb WordPress database object for queries..
  • trunk/src/bp-core/bp-core-caps.php

    r10052 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Capabilities.
     
    1918 * WordPress's RBAC, so should our capability functions here.
    2019 *
    21  * @since BuddyPress (2.1.0)
     20 * @since 2.1.0
    2221 *
    2322 * @return array
     
    3433     * Filters the list of editable roles.
    3534     *
    36      * @since BuddyPress (2.1.0)
     35     * @since 2.1.0
    3736     *
    3837     * @param array $roles List of roles.
     
    4342     * Filters the array of roles from the currently loaded blog.
    4443     *
    45      * @since BuddyPress (2.1.0)
     44     * @since 2.1.0
    4645     *
    4746     * @param array    $roles    Available roles.
     
    5655 * This is called on plugin activation.
    5756 *
    58  * @since BuddyPress (1.6.0)
     57 * @since 1.6.0
    5958 *
    6059 * @uses get_role() To get the administrator, default and moderator roles.
     
    8281     * This is called on plugin activation.
    8382     *
    84      * @since BuddyPress (1.6.0)
     83     * @since 1.6.0
    8584     */
    8685    do_action( 'bp_add_caps' );
     
    9291 * This is called on plugin deactivation.
    9392 *
    94  * @since BuddyPress (1.6.0)
     93 * @since 1.6.0
    9594 *
    9695 * @uses get_role() To get the administrator and default roles.
     
    118117     * This is called on plugin deactivation.
    119118     *
    120      * @since BuddyPress (1.6.0)
     119     * @since 1.6.0
    121120     */
    122121    do_action( 'bp_remove_caps' );
     
    126125 * Map community caps to built in WordPress caps.
    127126 *
    128  * @since BuddyPress (1.6.0)
     127 * @since 1.6.0
    129128 *
    130129 * @see WP_User::has_cap() for description of the arguments passed to the
     
    145144     * Filters the community caps mapping to be built in WordPress caps.
    146145     *
    147      * @since BuddyPress (1.6.0)
     146     * @since 1.6.0
    148147     *
    149148     * @param array  $caps    Returns the user's actual capabilities.
     
    158157 * Return community capabilities.
    159158 *
    160  * @since BuddyPress (1.6.0)
     159 * @since 1.6.0
    161160 *
    162161 * @uses apply_filters() Calls 'bp_get_community_caps' with the capabilities.
     
    172171     * Filters community capabilities.
    173172     *
    174      * @since BuddyPress (1.6.0)
     173     * @since 1.6.0
    175174     *
    176175     * @param array $caps Array of capabilities to add. Empty by default.
     
    182181 * Return an array of capabilities based on the role that is being requested.
    183182 *
    184  * @since BuddyPress (1.6.0)
     183 * @since 1.6.0
    185184 *
    186185 * @uses apply_filters() Allow return value to be filtered.
     
    217216     * Filters the array of capabilities based on the role that is being requested.
    218217     *
    219      * @since BuddyPress (1.6.0)
     218     * @since 1.6.0
    220219     *
    221220     * @param array  $caps Array of capabilities to return.
     
    231230 * already have a role or capability on.
    232231 *
    233  * @since BuddyPress (1.6.0)
     232 * @since 1.6.0
    234233 *
    235234 * @global BuddyPress $bp Global BuddyPress settings object.
     
    266265 * Check whether the current user has a given capability.
    267266 *
    268  * @since BuddyPress (1.6.0)
    269  * @since BuddyPress (2.4.0) Second argument modified to accept an array, rather than `$blog_id`.
     267 * @since 1.6.0
     268 * @since 2.4.0 Second argument modified to accept an array, rather than `$blog_id`.
    270269 *
    271270 * @param string    $capability Capability or role name.
     
    304303     * Filters whether or not the current user has a given capability.
    305304     *
    306      * @since BuddyPress (1.6.0)
    307      * @since BuddyPress (2.4.0) Pass `$args` variable.
     305     * @since 1.6.0
     306     * @since 2.4.0 Pass `$args` variable.
    308307     *
    309308     * @param bool   $retval     Whether or not the current user has the capability.
     
    334333 *
    335334 * @access private
    336  * @since BuddyPress (1.6.0)
     335 * @since 1.6.0
    337336 *
    338337 * @see WP_User::has_cap()
     
    374373 * This is called on plugin activation.
    375374 *
    376  * @since BuddyPress (1.6.0)
     375 * @since 1.6.0
    377376 * @deprecated 1.7.0
    378377 */
     
    386385 * This is called on plugin deactivation.
    387386 *
    388  * @since BuddyPress (1.6.0)
     387 * @since 1.6.0
    389388 * @deprecated 1.7.0
    390389 */
     
    400399 * sites that have global communities enabled.
    401400 *
    402  * @since BuddyPress (1.6)
     401 * @since 1.6.0
    403402 * @deprecated 1.7.0
    404403 */
     
    410409 * The moderator role for BuddyPress users.
    411410 *
    412  * @since BuddyPress (1.6.0)
     411 * @since 1.6.0
    413412 * @deprecated 1.7.0
    414413 */
  • trunk/src/bp-core/bp-core-catchuri.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress URI catcher.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    3130 *    - $bp->action_variables: array ['group', 5]
    3231 *
    33  * @since BuddyPress (1.0.0)
     32 * @since 1.0.0
    3433 */
    3534function bp_core_set_uri_globals() {
     
    5958     * Filters the BuddyPress global URI path.
    6059     *
    61      * @since BuddyPress (1.0.0)
     60     * @since 1.0.0
    6261     *
    6362     * @param string $path Path to set.
     
    340339 * Are root profiles enabled and allowed?
    341340 *
    342  * @since BuddyPress (1.6.0)
     341 * @since 1.6.0
    343342 *
    344343 * @return bool True if yes, false if no.
     
    354353     * Filters whether or not root profiles are enabled and allowed.
    355354     *
    356      * @since BuddyPress (1.6.0)
     355     * @since 1.6.0
    357356     *
    358357     * @param bool $retval Whether or not root profiles are available.
     
    407406     * Allows plugins to alter where the template files are located.
    408407     *
    409      * @since BuddyPress (1.1.0)
     408     * @since 1.1.0
    410409     *
    411410     * @param string $template           Located template path.
     
    423422         * Fires before the loading of a located template file.
    424423         *
    425          * @since BuddyPress (1.6.0)
     424         * @since 1.6.0
    426425         *
    427426         * @param string $located_template Template found to be loaded.
     
    432431         * Filters the selected template right before loading.
    433432         *
    434          * @since BuddyPress (1.1.0)
     433         * @since 1.1.0
    435434         *
    436435         * @param string $located_template Template found to be loaded.
     
    441440         * Fires after the loading of a located template file.
    442441         *
    443          * @since BuddyPress (1.6.0)
     442         * @since 1.6.0
    444443         *
    445444         * @param string $located_template Template found that was loaded.
     
    466465         * Fires if there are no found templates to load and theme compat is needed.
    467466         *
    468          * @since BuddyPress (1.7.0)
     467         * @since 1.7.0
    469468         */
    470469        do_action( 'bp_setup_theme_compat' );
     
    481480         * Filters the path to redirect users to if XProfile is not enabled.
    482481         *
    483          * @since BuddyPress (1.0.0)
     482         * @since 1.0.0
    484483         *
    485484         * @param string $value Path to redirect users to.
     
    492491 * Catch unauthorized access to certain BuddyPress pages and redirect accordingly.
    493492 *
    494  * @since BuddyPress (1.5.0)
     493 * @since 1.5.0
    495494 */
    496495function bp_core_catch_no_access() {
     
    517516 * If authenticated, redirects user back to requested content by default.
    518517 *
    519  * @since BuddyPress (1.5.0)
     518 * @since 1.5.0
    520519 *
    521520 * @param array|string $args {
     
    550549     * Filters the arguments used for user redirecting when visiting access controlled areas.
    551550     *
    552      * @since BuddyPress (1.6.0)
     551     * @since 1.6.0
    553552     *
    554553     * @param array $r Array of parsed arguments for redirect determination.
     
    604603 * Hooks into the "bpnoaccess" action defined in bp_core_no_access().
    605604 *
    606  * @since BuddyPress (1.5.0)
     605 * @since 1.5.0
    607606 *
    608607 * @global string $error Error message to pass to wp-login.php.
     
    614613     * Filters the error message for wp-login.php when needing to log in before accessing.
    615614     *
    616      * @since BuddyPress (1.5.0)
     615     * @since 1.5.0
    617616     *
    618617     * @param string $value Error message to display.
     
    635634 * example.com/groups/mygroup/home/.
    636635 *
    637  * @since BuddyPress (1.6.0)
     636 * @since 1.6.0
    638637 *
    639638 * @see BP_Members_Component::setup_globals() where
     
    648647     * Filters whether or not to do canonical redirects on BuddyPress URLs.
    649648     *
    650      * @since BuddyPress (1.6.0)
     649     * @since 1.6.0
    651650     *
    652651     * @param bool $value Whether or not to do canonical redirects. Default true.
     
    697696 * Output rel=canonical header tag for BuddyPress content.
    698697 *
    699  * @since BuddyPress (1.6.0)
     698 * @since 1.6.0
    700699 */
    701700function bp_rel_canonical() {
     
    709708 * Get the canonical URL of the current page.
    710709 *
    711  * @since BuddyPress (1.6.0)
     710 * @since 1.6.0
    712711 *
    713712 * @uses apply_filters() Filter bp_get_canonical_url to modify return value.
     
    757756             * Filters the logged in register page redirect URL.
    758757             *
    759              * @since BuddyPress (1.5.1)
     758             * @since 1.5.1
    760759             *
    761760             * @param string $value URL to redirect logged in members to.
     
    805804     * Filters the canonical url of the current page.
    806805     *
    807      * @since BuddyPress (1.6.0)
     806     * @since 1.6.0
    808807     *
    809808     * @param string $canonical_url Canonical URL of the current page.
     
    816815 * Return the URL as requested on the current page load by the user agent.
    817816 *
    818  * @since BuddyPress (1.6.0)
     817 * @since 1.6.0
    819818 *
    820819 * @return string Requested URL string.
     
    831830     * Filters the URL as requested on the current page load by the user agent.
    832831     *
    833      * @since BuddyPress (1.7.0)
     832     * @since 1.7.0
    834833     *
    835834     * @param string $value Requested URL string.
     
    847846 * notice in future versions of BuddyPress.
    848847 *
    849  * @since BuddyPress (1.6.0)
     848 * @since 1.6.0
    850849 *
    851850 * @uses bp_is_blog_page()
     
    879878 * (and plugin authors!) should ignore it.
    880879 *
    881  * @since BuddyPress (1.6.1)
     880 * @since 1.6.1
    882881 *
    883882 * @link https://buddypress.trac.wordpress.org/ticket/4329
     
    898897 * notice in future versions of BuddyPress.
    899898 *
    900  * @since BuddyPress (1.6.0)
     899 * @since 1.6.0
    901900 */
    902901function _bp_maybe_remove_rel_canonical() {
  • trunk/src/bp-core/bp-core-component.php

    r10052 r10108  
    2323 * @subpackage Component
    2424 *
    25  * @since BuddyPress (1.5.0)
     25 * @since 1.5.0
    2626 */
    2727class BP_Component {
     
    9696     * Placeholder text for component directory search box.
    9797     *
    98      * @since BuddyPress (1.5.0)
     98     * @since 1.5.0
    9999     * @var string $search_string
    100100     */
     
    104104     * Root slug for the component.
    105105     *
    106      * @since BuddyPress (1.5.0)
     106     * @since 1.5.0
    107107     * @var string $root_slug
    108108     */
     
    112112     * Metadata tables for the component (if applicable).
    113113     *
    114      * @since BuddyPress (2.0.0)
     114     * @since 2.0.0
    115115     *
    116116     * @var array
     
    121121     * Global tables for the component (if applicable).
    122122     *
    123      * @since BuddyPress (2.0.0)
     123     * @since 2.0.0
    124124     *
    125125     * @var array
     
    132132     * Component loader.
    133133     *
    134      * @since BuddyPress (1.5.0)
    135      * @since BuddyPress (1.9.0) Added $params as a parameter.
    136      * @since BuddyPress (2.3.0) Added $params['features'] as a configurable value.
     134     * @since 1.5.0
     135     * @since 1.9.0 Added $params as a parameter.
     136     * @since 2.3.0 Added $params['features'] as a configurable value.
    137137     *
    138138     * @param string $id   Unique ID. Letters, numbers, and underscores only.
     
    185185     * Set up component global variables.
    186186     *
    187      * @since BuddyPress (1.5)
     187     * @since 1.5.0
    188188     *
    189189     * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id'.
     
    228228         * Filters the slug to be used for the permalink URI chunk after root.
    229229         *
    230          * @since BuddyPress (1.5.0)
     230         * @since 1.5.0
    231231         *
    232232         * @param string $value Slug to use in permalink URI chunk.
     
    237237         * Filters the slug used for root directory.
    238238         *
    239          * @since BuddyPress (1.5.0)
     239         * @since 1.5.0
    240240         *
    241241         * @param string $value Root directory slug.
     
    246246         * Filters the component's top-level directory if available.
    247247         *
    248          * @since BuddyPress (1.5.0)
     248         * @since 1.5.0
    249249         *
    250250         * @param bool $value Whether or not there is a top-level directory.
     
    255255         * Filters the component's directory title.
    256256         *
    257          * @since BuddyPress (2.0.0)
     257         * @since 2.0.0
    258258         *
    259259         * @param string $value Title to use for the directory.
     
    264264         * Filters the placeholder text for search inputs for component.
    265265         *
    266          * @since BuddyPress (1.5.0)
     266         * @since 1.5.0
    267267         *
    268268         * @param string $value Name to use in search input placeholders.
     
    273273         * Filters the callable function that formats the component's notifications.
    274274         *
    275          * @since BuddyPress (1.5.0)
     275         * @since 1.5.0
    276276         *
    277277         * @param string $value Function callback.
     
    299299         * This is a dynamic hook that is based on the component string ID.
    300300         *
    301          * @since BuddyPress (1.5.0)
     301         * @since 1.5.0
    302302         */
    303303        do_action( 'bp_' . $this->id . '_setup_globals' );
     
    327327     *   - ./bp-my_component/bp-my_component-actions.php
    328328     *
    329      * @since BuddyPress (1.5.0)
     329     * @since 1.5.0
    330330     *
    331331     * @uses do_action() Calls 'bp_{@link bp_Component::name}includes'.
     
    370370         * This is a dynamic hook that is based on the component string ID.
    371371         *
    372          * @since BuddyPress (1.5.0)
     372         * @since 1.5.0
    373373         */
    374374        do_action( 'bp_' . $this->id . '_includes' );
     
    378378     * Set up the actions.
    379379     *
    380      * @since BuddyPress (1.5.0)
     380     * @since 1.5.0
    381381     *
    382382     * @uses add_action() To add various actions.
     
    436436         * This is a dynamic hook that is based on the component string ID.
    437437         *
    438          * @since BuddyPress (1.5.0)
     438         * @since 1.5.0
    439439         */
    440440        do_action( 'bp_' . $this->id . '_setup_actions' );
     
    444444     * Set up the canonical URL stack for this component.
    445445     *
    446      * @since BuddyPress (2.1.0)
     446     * @since 2.1.0
    447447     */
    448448    public function setup_canonical_stack() {}
     
    481481         * This is a dynamic hook that is based on the component string ID.
    482482         *
    483          * @since BuddyPress (1.5.0)
     483         * @since 1.5.0
    484484         */
    485485        do_action( 'bp_' . $this->id . '_setup_nav' );
     
    515515         * This is a dynamic hook that is based on the component string ID.
    516516         *
    517          * @since BuddyPress (1.9.0)
     517         * @since 1.9.0
    518518         *
    519519         * @param array $wp_admin_nav Array of navigation items to add.
     
    541541         * This is a dynamic hook that is based on the component string ID.
    542542         *
    543          * @since BuddyPress (1.5.0)
     543         * @since 1.5.0
    544544         */
    545545        do_action( 'bp_' . $this->id . '_setup_admin_bar' );
     
    549549     * Set up the component title.
    550550     *
    551      * @since BuddyPress (1.5.0)
     551     * @since 1.5.0
    552552     *
    553553     * @uses do_action() Calls 'bp_{@link bp_Component::name}_setup_title'.
     
    560560         * This is a dynamic hook that is based on the component string ID.
    561561         *
    562          * @since BuddyPress (1.5.0)
     562         * @since 1.5.0
    563563         */
    564564        do_action(  'bp_' . $this->id . '_setup_title' );
     
    568568     * Setup component-specific cache groups.
    569569     *
    570      * @since BuddyPress (2.2.0)
     570     * @since 2.2.0
    571571     *
    572572     * @uses do_action() Calls 'bp_setup_{@link bp_Component::name}_cache_groups'.
     
    579579         * This is a dynamic hook that is based on the component string ID.
    580580         *
    581          * @since BuddyPress (2.2.0)
     581         * @since 2.2.0
    582582         */
    583583        do_action( 'bp_' . $this->id . '_setup_cache_groups' );
     
    587587     * Register global tables for the component, so that it may use WordPress's database API.
    588588     *
    589      * @since BuddyPress (2.0.0)
     589     * @since 2.0.0
    590590     *
    591591     * @param array $tables Table names to register.
     
    600600         * *all* tables, use the 'bp_core_get_table_prefix' filter instead.
    601601         *
    602          * @since BuddyPress (1.6.0)
     602         * @since 1.6.0
    603603         */
    604604        $tables = apply_filters( 'bp_' . $this->id . '_global_tables', $tables );
     
    619619         * This is a dynamic hook that is based on the component string ID.
    620620         *
    621          * @since BuddyPress (2.0.0)
     621         * @since 2.0.0
    622622         */
    623623        do_action( 'bp_' . $this->id . '_register_global_tables' );
     
    630630     * compatibility with the WordPress metadata API.
    631631     *
    632      * @since BuddyPress (2.0.0)
     632     * @since 2.0.0
    633633     *
    634634     * @param array $tables Table names to register.
     
    644644         * *all* tables, use the 'bp_core_get_table_prefix' filter instead.
    645645         *
    646          * @since BuddyPress (2.0.0)
     646         * @since 2.0.0
    647647         */
    648648        $tables = apply_filters( 'bp_' . $this->id . '_meta_tables', $tables );
     
    666666         * This is a dynamic hook that is based on the component string ID.
    667667         *
    668          * @since BuddyPress (2.0.0)
     668         * @since 2.0.0
    669669         */
    670670        do_action( 'bp_' . $this->id . '_register_meta_tables' );
     
    674674     * Set up the component post types.
    675675     *
    676      * @since BuddyPress (1.5.0)
     676     * @since 1.5.0
    677677     *
    678678     * @uses do_action() Calls 'bp_{@link bp_Component::name}_register_post_types'.
     
    685685         * This is a dynamic hook that is based on the component string ID.
    686686         *
    687          * @since BuddyPress (1.5.0)
     687         * @since 1.5.0
    688688         */
    689689        do_action( 'bp_' . $this->id . '_register_post_types' );
     
    693693     * Register component-specific taxonomies.
    694694     *
    695      * @since BuddyPress (1.5.0)
     695     * @since 1.5.0
    696696     *
    697697     * @uses do_action() Calls 'bp_{@link bp_Component::name}_register_taxonomies'.
     
    704704         * This is a dynamic hook that is based on the component string ID.
    705705         *
    706          * @since BuddyPress (1.5.0)
     706         * @since 1.5.0
    707707         */
    708708        do_action( 'bp_' . $this->id . '_register_taxonomies' );
     
    712712     * Add any additional rewrite tags.
    713713     *
    714      * @since BuddyPress (1.5.0)
     714     * @since 1.5.0
    715715     *
    716716     * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_rewrite_tags'.
     
    723723         * This is a dynamic hook that is based on the component string ID.
    724724         *
    725          * @since BuddyPress (1.5.0)
     725         * @since 1.5.0
    726726         */
    727727        do_action( 'bp_' . $this->id . '_add_rewrite_tags' );
     
    731731     * Add any additional rewrite rules.
    732732     *
    733      * @since BuddyPress (1.9.0)
     733     * @since 1.9.0
    734734     *
    735735     * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_rewrite_rules'.
     
    742742         * This is a dynamic hook that is based on the component string ID.
    743743         *
    744          * @since BuddyPress (1.9.0)
     744         * @since 1.9.0
    745745         */
    746746        do_action( 'bp_' . $this->id . '_add_rewrite_rules' );
     
    750750     * Add any permalink structures.
    751751     *
    752      * @since BuddyPress (1.9)
     752     * @since 1.9.0
    753753     *
    754754     * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'.
     
    761761         * This is a dynamic hook that is based on the component string ID.
    762762         *
    763          * @since BuddyPress (1.9.0)
     763         * @since 1.9.0
    764764         */
    765765        do_action( 'bp_' . $this->id . '_add_permastructs' );
     
    769769     * Allow components to parse the main query.
    770770     *
    771      * @since BuddyPress (1.9)
     771     * @since 1.9.0
    772772     *
    773773     * @uses do_action() Calls 'bp_{@link bp_Component::name}_parse_query'.
     
    782782         * This is a dynamic hook that is based on the component string ID.
    783783         *
    784          * @since BuddyPress (1.9.0)
     784         * @since 1.9.0
    785785         *
    786786         * @param object $query Main WP_Query object. Passed by reference.
     
    792792     * Generate any additional rewrite rules.
    793793     *
    794      * @since BuddyPress (1.5)
     794     * @since 1.5.0
    795795     *
    796796     * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'.
     
    803803         * This is a dynamic hook that is based on the component string ID.
    804804         *
    805          * @since BuddyPress (1.5.0)
     805         * @since 1.5.0
    806806         */
    807807        do_action( 'bp_' . $this->id . '_generate_rewrite_rules' );
  • trunk/src/bp-core/bp-core-cssjs.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * Register scripts commonly used by BuddyPress.
    1414 *
    15  * @since BuddyPress (2.1.0)
     15 * @since 2.1.0
    1616 */
    1717function bp_core_register_common_scripts() {
     
    2222     * Filters the BuddyPress Core javascript files to register.
    2323     *
    24      * @since BuddyPress (2.1.0)
     24     * @since 2.1.0
    2525     *
    2626     * @param array $value Array of javascript file information to register.
     
    5757 * Register styles commonly used by BuddyPress.
    5858 *
    59  * @since BuddyPress (2.1.0)
     59 * @since 2.1.0
    6060 */
    6161function bp_core_register_common_styles() {
     
    6666     * Filters the URL for the Admin Bar stylesheet.
    6767     *
    68      * @since BuddyPress (1.1.0)
     68     * @since 1.1.0
    6969     *
    7070     * @param string $value URL for the Admin Bar stylesheet.
     
    7575     * Filters the BuddyPress Core stylesheet files to register.
    7676     *
    77      * @since BuddyPress (2.1.0)
     77     * @since 2.1.0
    7878     *
    7979     * @param array $value Array of stylesheet file information to register.
     
    123123 * Enqueues the css and js required by the Avatar UI.
    124124 *
    125  * @since  BuddyPress (2.3.0)
     125 * @since  2.3.0
    126126 */
    127127function bp_core_avatar_scripts() {
     
    158158     * Filters the return value of getimagesize to determine if an image was uploaded.
    159159     *
    160      * @since BuddyPress (1.1.0)
     160     * @since 1.1.0
    161161     *
    162162     * @param array $value Array of data found by getimagesize.
     
    278278 * Define the 'ajaxurl' JS variable, used by themes as an AJAX endpoint.
    279279 *
    280  * @since BuddyPress (1.1.0)
     280 * @since 1.1.0
    281281 */
    282282function bp_core_add_ajax_url_js() {
     
    295295 * configurations.
    296296 *
    297  * @since BuddyPress (1.7.0)
     297 * @since 1.7.0
    298298 *
    299299 * @return string AJAX endpoint URL.
     
    304304     * Filters the proper value for BuddyPress' ajaxurl.
    305305     *
    306      * @since BuddyPress (1.7.0)
     306     * @since 1.7.0
    307307     *
    308308     * @param string $value Proper ajaxurl value for BuddyPress.
     
    314314 * Get the JavaScript dependencies for buddypress.js.
    315315 *
    316  * @since BuddyPress (2.0.0)
     316 * @since 2.0.0
    317317 *
    318318 * @uses apply_filters() to allow other component to load extra dependencies.
     
    325325     * Filters the javascript dependencies for buddypress.js.
    326326     *
    327      * @since BuddyPress (2.0.0)
     327     * @since 2.0.0
    328328     *
    329329     * @param array $value Array of javascript dependencies for buddypress.js.
  • trunk/src/bp-core/bp-core-dependency.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * Plugin Dependency Action Hooks.
     
    1615 *
    1716 * @todo use anonymous functions when PHP minimum requirement allows (5.3)
     17 *
     18 * @package BuddyPress
     19 * @subpackage Core
    1820 */
    1921
     
    2628     * Fires inside the 'bp_include' function, where plugins should include files.
    2729     *
    28      * @since BuddyPress (1.2.5)
     30     * @since 1.2.5
    2931     */
    3032    do_action( 'bp_include' );
     
    3941     * Fires inside the 'bp_setup_components' function, where plugins should initialize components.
    4042     *
    41      * @since BuddyPress (1.6.0)
     43     * @since 1.6.0
    4244     */
    4345    do_action( 'bp_setup_components' );
     
    5254     * Fires inside the 'bp_setup_canonical_stack' function, where plugins should set up their canonical URL.
    5355     *
    54      * @since BuddyPress (2.1.0)
     56     * @since 2.1.0
    5557     */
    5658    do_action( 'bp_setup_canonical_stack' );
     
    6062 * Fire the 'bp_register_taxonomies' action, where plugins should register taxonomies.
    6163 *
    62  * @since BuddyPress (2.2.0)
     64 * @since 2.2.0
    6365 */
    6466function bp_register_taxonomies() {
     
    6769     * Fires inside the 'bp_register_taxonomies' function, where plugins should register taxonomies.
    6870     *
    69      * @since BuddyPress (2.2.0)
     71     * @since 2.2.0
    7072     */
    7173    do_action( 'bp_register_taxonomies' );
     
    8082     * Fires inside the 'bp_setup_globals' function, where plugins should initialize global settings.
    8183     *
    82      * @since BuddyPress (1.2.0)
     84     * @since 1.2.0
    8385     */
    8486    do_action( 'bp_setup_globals' );
     
    9395     * Fires inside the 'bp_setup_nav' function, where plugins should register their navigation items.
    9496     *
    95      * @since BuddyPress (1.2.0)
     97     * @since 1.2.0
    9698     */
    9799    do_action( 'bp_setup_nav' );
     
    109111         * This hook will only fire if bp_use_wp_admin_bar() returns true.
    110112         *
    111          * @since BuddyPress (1.5.0)
     113         * @since 1.5.0
    112114         */
    113115        do_action( 'bp_setup_admin_bar' );
     
    123125     * Fires inside the 'bp_setup_title' function, where plugins should modify the page title.
    124126     *
    125      * @since BuddyPress (1.5.0)
     127     * @since 1.5.0
    126128     */
    127129    do_action( 'bp_setup_title' );
     
    136138     * Fires inside the 'bp_register_widgets' function, where plugins should register widgets.
    137139     *
    138      * @since BuddyPress (1.2.0)
     140     * @since 1.2.0
    139141     */
    140142    do_action( 'bp_register_widgets' );
     
    144146 * Fire the 'bp_register_member_types' action, where plugins should register member types.
    145147 *
    146  * @since BuddyPress (2.3.0)
     148 * @since 2.3.0
    147149 */
    148150function bp_register_member_types() {
     
    151153     * Fires inside bp_register_member_types(), so plugins can register member types.
    152154     *
    153      * @since BuddyPress (2.3.0)
     155     * @since 2.3.0
    154156     */
    155157    do_action( 'bp_register_member_types' );
     
    159161 * Fire the 'bp_setup_cache_groups' action, where cache groups are registered.
    160162 *
    161  * @since BuddyPress (2.2.0)
     163 * @since 2.2.0
    162164 */
    163165function bp_setup_cache_groups() {
     
    166168     * Fires inside the 'bp_setup_cache_groups' function, where cache groups are registered.
    167169     *
    168      * @since BuddyPress (2.2.0)
     170     * @since 2.2.0
    169171     */
    170172    do_action( 'bp_setup_cache_groups' );
     
    193195     * Fires to set up the current user setup process.
    194196     *
    195      * @since BuddyPress (1.7.0)
     197     * @since 1.7.0
    196198     */
    197199    do_action( 'bp_setup_current_user' );
     
    206208     * Fires inside the 'bp_init' function, BuddyPress' main initialization hook.
    207209     *
    208      * @since BuddyPress (1.2.0)
     210     * @since 1.2.0
    209211     */
    210212    do_action( 'bp_init' );
     
    221223     * Fires inside the 'bp_loaded' function, which fires after BP's core plugin files have been loaded.
    222224     *
    223      * @since BuddyPress (1.2.5)
     225     * @since 1.2.5
    224226     */
    225227    do_action( 'bp_loaded' );
     
    236238     * Fires inside the 'bp_ready' function, which runs after BP is set up and the page is about to render.
    237239     *
    238      * @since BuddyPress (1.6.0)
     240     * @since 1.6.0
    239241     */
    240242    do_action( 'bp_ready' );
     
    252254     * Fires inside the 'bp_actions' function, which runs just before rendering.
    253255     *
    254      * @since BuddyPress (1.5.0)
     256     * @since 1.5.0
    255257     */
    256258    do_action( 'bp_actions' );
     
    270272     * Runs just after 'bp_actions'. Use this hook to attach your template loaders.
    271273     *
    272      * @since BuddyPress (1.5.0)
     274     * @since 1.5.0
    273275     */
    274276    do_action( 'bp_screens' );
     
    287289     * Hooked to 'widgets_init'.
    288290     *
    289      * @since BuddyPress (1.6.0)
     291     * @since 1.6.0
    290292     */
    291293    do_action ( 'bp_widgets_init' );
     
    310312 * who do not have the proper permission to access certain content.
    311313 *
    312  * @since BuddyPress (1.6.0)
     314 * @since 1.6.0
    313315 *
    314316 * @uses do_action()
     
    319321     * Fires inside the 'bp_template_redirect' function.
    320322     *
    321      * @since BuddyPress (1.6.0)
     323     * @since 1.6.0
    322324     */
    323325    do_action( 'bp_template_redirect' );
     
    331333 * The main action used registering theme directories.
    332334 *
    333  * @since BuddyPress (1.5.0)
     335 * @since 1.5.0
    334336 *
    335337 * @uses do_action()
     
    342344     * The main action used registering theme directories.
    343345     *
    344      * @since BuddyPress (1.7.0)
     346     * @since 1.7.0
    345347     */
    346348    do_action( 'bp_register_theme_directory' );
     
    352354 * The main action used registering theme packages.
    353355 *
    354  * @since BuddyPress (1.7.0)
     356 * @since 1.7.0
    355357 *
    356358 * @uses do_action()
     
    361363     * Fires inside the 'bp_register_theme_packages' function.
    362364     *
    363      * @since BuddyPress (1.7.0)
     365     * @since 1.7.0
    364366     */
    365367    do_action( 'bp_register_theme_packages' );
     
    369371 * Fire the 'bp_enqueue_scripts' action, where BP enqueues its CSS and JS.
    370372 *
    371  * @since BuddyPress (1.6.0)
     373 * @since 1.6.0
    372374 *
    373375 * @uses do_action() Calls 'bp_enqueue_scripts'.
     
    378380     * Fires inside the 'bp_enqueue_scripts' function, where BP enqueues its CSS and JS.
    379381     *
    380      * @since BuddyPress (1.6.0)
     382     * @since 1.6.0
    381383     */
    382384    do_action ( 'bp_enqueue_scripts' );
     
    386388 * Fire the 'bp_add_rewrite_tag' action, where BP adds its custom rewrite tags.
    387389 *
    388  * @since BuddyPress (1.8.0)
     390 * @since 1.8.0
    389391 *
    390392 * @uses do_action() Calls 'bp_add_rewrite_tags'.
     
    395397     * Fires inside the 'bp_add_rewrite_tags' function, where BP adds its custom rewrite tags.
    396398     *
    397      * @since BuddyPress (1.8.0)
     399     * @since 1.8.0
    398400     */
    399401    do_action( 'bp_add_rewrite_tags' );
     
    403405 * Fire the 'bp_add_rewrite_rules' action, where BP adds its custom rewrite rules.
    404406 *
    405  * @since BuddyPress (1.9.0)
     407 * @since 1.9.0
    406408 *
    407409 * @uses do_action() Calls 'bp_add_rewrite_rules'.
     
    412414     * Fires inside the 'bp_add_rewrite_rules' function, where BP adds its custom rewrite rules.
    413415     *
    414      * @since BuddyPress (1.9.0)
     416     * @since 1.9.0
    415417     */
    416418    do_action( 'bp_add_rewrite_rules' );
     
    420422 * Fire the 'bp_add_permastructs' action, where BP adds its BP-specific permalink structure.
    421423 *
    422  * @since BuddyPress (1.9.0)
     424 * @since 1.9.0
    423425 *
    424426 * @uses do_action() Calls 'bp_add_permastructs'.
     
    429431     * Fires inside the 'bp_add_permastructs' function, where BP adds its BP-specific permalink structure.
    430432     *
    431      * @since BuddyPress (1.9.0)
     433     * @since 1.9.0
    432434     */
    433435    do_action( 'bp_add_permastructs' );
     
    440442 * BuddyPress-specific functionality.
    441443 *
    442  * @since BuddyPress (1.6.0)
     444 * @since 1.6.0
    443445 *
    444446 * @uses do_action() Calls 'bp_setup_theme'.
     
    449451     * Fires inside the 'bp_setup_theme' function.
    450452     *
    451      * @since BuddyPress (1.6.0)
     453     * @since 1.6.0
    452454     */
    453455    do_action ( 'bp_setup_theme' );
     
    464466 * before our theme compatibility layer kicks in.
    465467 *
    466  * @since BuddyPress (1.6.0)
     468 * @since 1.6.0
    467469 *
    468470 * @uses do_action() Calls 'bp_after_setup_theme'.
     
    473475     * Fires inside the 'bp_after_setup_theme' function.
    474476     *
    475      * @since BuddyPress (1.7.0)
     477     * @since 1.7.0
    476478     */
    477479    do_action ( 'bp_after_setup_theme' );
     
    483485 * Fire the 'bp_request' filter, a piggy-back of WP's 'request'.
    484486 *
    485  * @since BuddyPress (1.7.0)
     487 * @since 1.7.0
    486488 *
    487489 * @see WP::parse_request() for a description of parameters.
     
    496498     * Filters the query_vars for the current request.
    497499     *
    498      * @since BuddyPress (1.7.0)
     500     * @since 1.7.0
    499501     *
    500502     * @param array $query_vars Array of query variables.
     
    506508 * Fire the 'bp_login_redirect' filter, a piggy-back of WP's 'login_redirect'.
    507509 *
    508  * @since BuddyPress (1.7.0)
     510 * @since 1.7.0
    509511 *
    510512 * @param string $redirect_to     See 'login_redirect'.
     
    520522     * Filters the URL to redirect to after login.
    521523     *
    522      * @since BuddyPress (1.7.0)
     524     * @since 1.7.0
    523525     *
    524526     * @param string           $redirect_to     The redirect destination URL.
     
    534536 * Hooked to 'template_include'.
    535537 *
    536  * @since BuddyPress (1.6.0)
     538 * @since 1.6.0
    537539 *
    538540 * @uses apply_filters()
     
    547549     * Filters the template to use with template_include.
    548550     *
    549      * @since BuddyPress (1.6.0)
     551     * @since 1.6.0
    550552     *
    551553     * @param string $template The path of the template to include.
     
    557559 * Fire the 'bp_generate_rewrite_rules' action, where BP generates its rewrite rules.
    558560 *
    559  * @since BuddyPress (1.7.0)
     561 * @since 1.7.0
    560562 *
    561563 * @uses do_action() Calls 'bp_generate_rewrite_rules' with {@link WP_Rewrite}.
     
    568570     * Fires inside the 'bp_generate_rewrite_rules' function.
    569571     *
    570      * @since BuddyPress (1.7.0)
     572     * @since 1.7.0
    571573     *
    572574     * @param WP_Rewrite $wp_rewrite WP_Rewrite object. Passed by reference.
     
    580582 * Filter the allowed themes list for BuddyPress-specific themes.
    581583 *
    582  * @since BuddyPress (1.7.0)
     584 * @since 1.7.0
    583585 *
    584586 * @uses apply_filters() Calls 'bp_allowed_themes' with the allowed themes list.
     
    593595     * Filters the allowed themes list for BuddyPress-specific themes.
    594596     *
    595      * @since BuddyPress (1.7.0)
     597     * @since 1.7.0
    596598     *
    597599     * @param string $template The path of the template to include.
     
    605607 * The main action used for handling theme-side POST requests.
    606608 *
    607  * @since BuddyPress (1.9.0)
     609 * @since 1.9.0
    608610 * @uses do_action()
    609611 */
     
    629631     * the scope of the 'action' without needing to check it in your function.
    630632     *
    631      * @since BuddyPress (1.9.0)
     633     * @since 1.9.0
    632634     */
    633635    do_action( 'bp_post_request_' . $action );
     
    638640     * Use this static action if you don't mind checking the 'action' yourself.
    639641     *
    640      * @since BuddyPress (1.9.0)
     642     * @since 1.9.0
    641643     *
    642644     * @param string $action The action being run.
     
    648650 * The main action used for handling theme-side GET requests.
    649651 *
    650  * @since BuddyPress (1.9.0)
     652 * @since 1.9.0
    651653 * @uses do_action()
    652654 */
     
    672674     * the scope of the 'action' without needing to check it in your function.
    673675     *
    674      * @since BuddyPress (1.9.0)
     676     * @since 1.9.0
    675677     */
    676678    do_action( 'bp_get_request_' . $action );
     
    681683     * Use this static action if you don't mind checking the 'action' yourself.
    682684     *
    683      * @since BuddyPress (1.9.0)
     685     * @since 1.9.0
    684686     *
    685687     * @param string $action The action being run.
  • trunk/src/bp-core/bp-core-filters.php

    r10029 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Filters.
     
    2120 */
    2221
    23 // Exit if accessed directly
     22// Exit if accessed directly.
    2423defined( 'ABSPATH' ) || exit;
    2524
     
    9998     * Filters specific pages that shouldn't show up on page listings.
    10099     *
    101      * @since BuddyPress (1.5.0)
     100     * @since 1.5.0
    102101     *
    103102     * @param array $pages Array of pages to exclude.
     
    110109 * Prevent specific pages (eg 'Activate') from showing in the Pages meta box of the Menu Administration screen.
    111110 *
    112  * @since BuddyPress (2.0.0)
     111 * @since 2.0.0
    113112 *
    114113 * @uses bp_is_root_blog() checks if current blog is root blog.
     
    157156 * should highlight the WP page.
    158157 *
    159  * @since BuddyPress (2.2.0)
     158 * @since 2.2.0
    160159 *
    161160 * @param array   $retval CSS classes for the current menu page in the menu.
     
    215214 * current BP parent page during nav menu generation.
    216215 *
    217  * @since BuddyPress (2.2.0)
     216 * @since 2.2.0
    218217 *
    219218 * @param array   $retval CSS classes for the current nav menu item in the menu.
     
    250249     * Filters the "From" name in outgoing email to the site name.
    251250     *
    252      * @since BuddyPress (1.2.0)
     251     * @since 1.2.0
    253252     *
    254253     * @param string $value Value to set the "From" name to.
     
    326325     * Allows plugins to have finer grained control of redirect upon login.
    327326     *
    328      * @since BuddyPress (1.6.0)
     327     * @since 1.6.0
    329328     *
    330329  * @param bool    $value           Whether or not to redirect.
     
    353352     * Filters the URL to redirect users to upon successful login.
    354353     *
    355      * @since BuddyPress (1.9.0)
     354     * @since 1.9.0
    356355     *
    357356     * @param string $value URL to redirect to.
     
    460459     * Filters the email that the notification is going to upon successful registration with blog.
    461460     *
    462      * @since BuddyPress (1.2.0)
     461     * @since 1.2.0
    463462     *
    464463     * @param string $user_email The user's email address.
     
    476475     * Filters the subject that the notification uses upon successful registration with blog.
    477476     *
    478      * @since BuddyPress (1.2.0)
     477     * @since 1.2.0
    479478     *
    480479     * @param string $subject    The subject to use.
     
    492491     * Filters the message that the notification uses upon successful registration with blog.
    493492     *
    494      * @since BuddyPress (1.2.0)
     493     * @since 1.2.0
    495494     *
    496495     * @param string $message    The message to use.
     
    514513     * Fires after the sending of the notification to new users for successful registration with blog.
    515514     *
    516      * @since BuddyPress (1.5.0)
     515     * @since 1.5.0
    517516     *
    518517     * @param string $admin_email Admin Email address for the site.
     
    585584     * Filters the email that the notification is going to upon successful registration without blog.
    586585     *
    587      * @since BuddyPress (1.2.0)
     586     * @since 1.2.0
    588587     *
    589588     * @param string $user_email The user's email address.
     
    598597     * Filters the subject that the notification uses upon successful registration without blog.
    599598     *
    600      * @since BuddyPress (1.2.0)
     599     * @since 1.2.0
    601600     *
    602601     * @param string $subject    The subject to use.
     
    611610     * Filters the message that the notification uses upon successful registration without blog.
    612611     *
    613      * @since BuddyPress (1.2.0)
     612     * @since 1.2.0
    614613     *
    615614     * @param string $message    The message to use.
     
    630629     * Fires after the sending of the notification to new users for successful registration without blog.
    631630     *
    632      * @since BuddyPress (1.5.0)
     631     * @since 1.5.0
    633632     *
    634633     * @param string $admin_email Admin Email address for the site.
     
    650649 * Filter the page title for BuddyPress pages.
    651650 *
    652  * @since BuddyPress (1.5.0)
     651 * @since 1.5.0
    653652 *
    654653 * @see wp_title()
     
    813812     * Filters the page title for BuddyPress pages.
    814813     *
    815      * @since  BuddyPress (1.5.0)
     814     * @since  1.5.0
    816815     *
    817816     * @param  string $new_title   The BuddyPress page title.
     
    849848 * Add BuddyPress-specific items to the wp_nav_menu.
    850849 *
    851  * @since BuddyPress (1.9.0)
     850 * @since 1.9.0
    852851 *
    853852 * @param WP_Post $menu_item The menu item.
     
    939938 * Populate BuddyPress user nav items for the customizer
    940939 *
    941  * @since  BuddyPress (2.3.3)
     940 * @since  2.3.3
    942941 *
    943942 * @param  array   $items  The array of menu items
     
    976975 * Set BuddyPress item navs for the customizer
    977976 *
    978  * @since  BuddyPress (2.3.3)
    979  *
    980  * @param  array $item_types an associative array structured for the customizer
     977 * @since  2.3.3
     978 *
     979 * @param  array $item_types An associative array structured for the customizer.
     980 * @return array $item_types An associative array structured for the customizer.
    981981 */
    982982function bp_customizer_nav_menus_set_item_types( $item_types = array() ) {
     
    10071007 * 'meta_id' with 'id.
    10081008 *
    1009  * @since BuddyPress (2.0.0)
     1009 * @since 2.0.0
    10101010 *
    10111011 * @access private Do not use.
     
    10401040 * Filter the edit post link to avoid its display in BuddyPress pages.
    10411041 *
    1042  * @since BuddyPress (2.1.0)
     1042 * @since 2.1.0
    10431043 *
    10441044 * @param  string $edit_link The edit link.
     
    10601060 * mentions suggestions?
    10611061 *
    1062  * @since BuddyPress (2.2.0)
     1062 * @since 2.2.0
    10631063 *
    10641064 * @param bool $load_mentions    True to load mentions assets, false otherwise.
  • trunk/src/bp-core/bp-core-functions.php

    r10046 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Common Functions.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1615 * Output the BuddyPress version.
    1716 *
    18  * @since BuddyPress (1.6.0)
     17 * @since 1.6.0
    1918 *
    2019 * @uses bp_get_version() To get the BuddyPress version.
     
    2625     * Return the BuddyPress version.
    2726     *
    28      * @since BuddyPress (1.6.0)
     27     * @since 1.6.0
    2928     *
    3029     * @return string The BuddyPress version.
     
    3736 * Output the BuddyPress database version.
    3837 *
    39  * @since BuddyPress (1.6.0)
     38 * @since 1.6.0
    4039 *
    4140 * @uses bp_get_db_version() To get the BuddyPress database version.
     
    4746     * Return the BuddyPress database version.
    4847     *
    49      * @since BuddyPress (1.6.0)
     48     * @since 1.6.0
    5049     * @return string The BuddyPress database version.
    5150     */
     
    5756 * Output the BuddyPress database version.
    5857 *
    59  * @since BuddyPress (1.6.0)
     58 * @since 1.6.0
    6059 *
    6160 * @uses bp_get_db_version_raw() To get the current database BuddyPress version.
     
    6766     * Return the BuddyPress database version.
    6867     *
    69      * @since BuddyPress (1.6)
     68     * @since 1.6.0
    7069     *
    7170     * @return string The BuddyPress version direct from the database.
     
    9594     * Intended primarily for use in multinetwork installations.
    9695     *
    97      * @since BuddyPress (1.2.6)
     96     * @since 1.2.6
    9897     *
    9998     * @param string $base_prefix Base prefix to use.
     
    108107 * your own awkward callback function for usort().
    109108 *
    110  * @since BuddyPress (2.2.0)
     109 * @since 2.2.0
    111110 *
    112111 * @param  array      $items The items to be sorted. Its constituent items can be either associative arrays or objects.
     
    157156 *     $sorted_posts = bp_alpha_sort_by_key( $posts, 'post_name' );
    158157 *
    159  * @since BuddyPress (1.9.0)
     158 * @since 1.9.0
    160159 *
    161160 * @param  array      $items The items to be sorted. Its constituent items can be either associative arrays or objects.
     
    185184     * Filters the BuddyPress formatted number.
    186185     *
    187      * @since BuddyPress (1.2.4)
     186     * @since 1.2.4
    188187     *
    189188     * @param string $value    BuddyPress formatted value.
     
    224223 * For the second argument, $func_args, you should just pass the value of func_get_args().
    225224 *
    226  * @since BuddyPress (1.6)
     225 * @since 1.6.0
    227226 *
    228227 * @param array $old_args_keys Old argument indexs, keyed to their positions.
     
    252251 * are applied.
    253252 *
    254  * @since BuddyPress (r7704)
     253 * @since r7704
    255254 *
    256255 * @param string|array $args       Value to merge with $defaults.
     
    279278         * This is a dynamic filter dependent on the specified key.
    280279         *
    281          * @since BuddyPress (2.0.0)
     280         * @since 2.0.0
    282281         *
    283282         * @param array $r Array of arguments to use.
     
    299298         * This is a dynamic filter dependent on the specified key.
    300299         *
    301          * @since BuddyPress (2.0.0)
     300         * @since 2.0.0
    302301         *
    303302         * @param array $r Array of parsed arguments.
     
    315314 * responsible for limiting the resultset of a template loop.
    316315 *
    317  * @since BuddyPress (2.2.0)
     316 * @since 2.2.0
    318317 *
    319318 * @param  string $page_arg The $_REQUEST argument to look for.
     
    346345 * Everything else becomes 'ASC'.
    347346 *
    348  * @since BuddyPress (1.8.0)
     347 * @since 1.8.0
    349348 *
    350349 * @param string $order The 'order' string, as passed to the SQL constructor.
     
    365364 * logic of the replacement, wpdb::esc_like().
    366365 *
    367  * @since BuddyPress (2.1.0)
     366 * @since 2.1.0
    368367 *
    369368 * @see wpdb::esc_like() for more details on proper use.
     
    387386 * Are we running username compatibility mode?
    388387 *
    389  * @since BuddyPress (1.5.0)
     388 * @since 1.5.0
    390389 *
    391390 * @uses apply_filters() Filter 'bp_is_username_compatibility_mode' to alter.
     
    400399     * Filters whether or not to use username compatibility mode.
    401400     *
    402      * @since BuddyPress (1.5.0)
     401     * @since 1.5.0
    403402     *
    404403     * @param bool $value Whether or not username compatibility mode should be used.
     
    413412 * of BP 1.5. For BP 1.6, the WP Toolbar is the default.
    414413 *
    415  * @since BuddyPress (1.5.0)
     414 * @since 1.5.0
    416415 *
    417416 * @uses apply_filters() Filter 'bp_use_wp_admin_bar' to alter.
     
    436435     * Filters whether or not to use the admin bar.
    437436     *
    438      * @since BuddyPress (1.5.0)
     437     * @since 1.5.0
    439438     *
    440439     * @param bool $use_admin_bar Whether or not to use the admin bar.
     
    448447 * Returns an array of core component IDs.
    449448 *
    450  * @since BuddyPress (2.1.0)
     449 * @since 2.1.0
    451450 *
    452451 * @return array
     
    477476 * Fetch a list of BP directory pages from the appropriate meta table.
    478477 *
    479  * @since BuddyPress (1.5.0)
     478 * @since 1.5.0
    480479 *
    481480 * @param string $status 'active' to return only pages associated with active components, 'all' to return all saved
     
    517516     * Filters the list of BP directory pages from the appropriate meta table.
    518517     *
    519      * @since BuddyPress (1.5.0)
     518     * @since 1.5.0
    520519     *
    521520     * @param array $page_ids Array of directory pages.
     
    531530 * bp_get_root_blog_id() and go through the setup process again.
    532531 *
    533  * @since BuddyPress (1.5.0)
     532 * @since 1.5.0
    534533 *
    535534 * @param array $blog_page_ids The IDs of the WP pages corresponding to BP
     
    543542 * Get names and slugs for BuddyPress component directory pages.
    544543 *
    545  * @since BuddyPress (1.5.0).
     544 * @since 1.5.0
    546545 *
    547546 * @return object Page names, IDs, and slugs.
     
    601600     * Filters the names and slugs for BuddyPress component directory pages.
    602601     *
    603      * @since BuddyPress (1.5.0)
     602     * @since 1.5.0
    604603     *
    605604     * @param object $pages Object holding page names and slugs.
     
    614613 * content (eg, the 'groups' page created by BP).
    615614 *
    616  * @since BuddyPress (1.7.0)
     615 * @since 1.7.0
    617616 *
    618617 * @param array  $components Components to create pages for.
     
    714713 * @link https://buddypress.trac.wordpress.org/ticket/6226
    715714 *
    716  * @since BuddyPress (2.2.0)
     715 * @since 2.2.0
    717716 *
    718717 * @param int $post_id Post ID.
     
    754753 * BP_MEMBERS_SLUG) to override specific component slugs.
    755754 *
    756  * @since BuddyPress (1.5.0)
     755 * @since 1.5.0
    757756 *
    758757 * @param string $root_slug The root slug, which comes from $bp->pages->[component]->slug.
     
    767766     * Filters the default component slug from a WP page root_slug.
    768767     *
    769      * @since BuddyPress (1.5.0)
     768     * @since 1.5.0
    770769     *
    771770     * @param string $slug      Short slug for use in the middle of URLs.
     
    858857 * Determine whether BuddyPress should register the bp-themes directory.
    859858 *
    860  * @since BuddyPress (1.9.0)
     859 * @since 1.9.0
    861860 *
    862861 * @return bool True if bp-themes should be registered, false otherwise.
     
    885884     * Filters whether BuddyPress should register the bp-themes directory.
    886885     *
    887      * @since BuddyPress (1.9.0)
     886     * @since 1.9.0
    888887     *
    889888     * @param bool $register If bp-themes should be registered.
     
    910909     * Filters the domain for the root blog.
    911910     *
    912      * @since BuddyPress (1.0.1)
     911     * @since 1.0.1
    913912     *
    914913     * @param string $domain The domain URL for the blog.
     
    950949 * reduced to '/foo/'.
    951950 *
    952  * @since BuddyPress (2.3.0)
     951 * @since 2.3.0
    953952 *
    954953 * @return bool|string Returns false on error, a URL path on success.
     
    10011000     * Filters the path of the current site.
    10021001     *
    1003      * @since BuddyPress (1.2.0)
     1002     * @since 1.2.0
    10041003     *
    10051004     * @param string $site_path URL to the current site.
     
    10131012 * Get the current GMT time to save into the DB.
    10141013 *
    1015  * @since BuddyPress (1.2.6)
     1014 * @since 1.2.6
    10161015 *
    10171016 * @param bool   $gmt  True to use GMT (rather than local) time. Default: true.
     
    10261025     * Filters the current GMT time to save into the DB.
    10271026     *
    1028      * @since BuddyPress (1.2.6)
     1027     * @since 1.2.6
    10291028     *
    10301029     * @param string $value Current GMT time.
     
    10651064     * Filters whether or not to bypass BuddyPress' time_since calculations.
    10661065     *
    1067      * @since BuddyPress (1.7.0)
     1066     * @since 1.7.0
    10681067     *
    10691068     * @param bool   $value      Whether or not to bypass.
     
    10791078     * Filters the value to use if the time since is unknown.
    10801079     *
    1081      * @since BuddyPress (1.5.0)
     1080     * @since 1.5.0
    10821081     *
    10831082     * @param string $value String representing the time since the older date.
     
    10881087     * Filters the value to use if the time since is right now.
    10891088     *
    1090      * @since BuddyPress (1.5.0)
     1089     * @since 1.5.0
    10911090     *
    10921091     * @param string $value String representing the time since the older date.
     
    10971096     * Filters the value to use if the time since is some time ago.
    10981097     *
    1099      * @since BuddyPress (1.5.0)
     1098     * @since 1.5.0
    11001099     *
    11011100     * @param string $value String representing the time since the older date.
     
    12341233     * Filters the English-language representation of the time elapsed since a given date.
    12351234     *
    1236      * @since BuddyPress (1.7.0)
     1235     * @since 1.7.0
    12371236     *
    12381237     * @param string $output     Final 'time since' string.
     
    13281327         * Filters the 'template_notices' feedback message content.
    13291328         *
    1330          * @since BuddyPress (1.5.5)
     1329         * @since 1.5.5
    13311330         *
    13321331         * @param string $template_message Feedback message content.
     
    13471346         * Fires after the display of any template_notices feedback messages.
    13481347         *
    1349          * @since BuddyPress (1.1.0)
     1348         * @since 1.1.0
    13501349         */
    13511350        do_action( 'bp_core_render_message' );
     
    14031402         * Use this action to detect the very first activity for a given member.
    14041403         *
    1405          * @since BuddyPress (1.6.0)
     1404         * @since 1.6.0
    14061405         *
    14071406         * @param int $user_id ID of the user whose activity is recorded.
     
    14431442     * Filters last activity string based on time since date given.
    14441443     *
    1445      * @since BuddyPress (1.2.0)
     1444     * @since 1.2.0
    14461445     *
    14471446     * @param string $last_active        Last activity string based on time since date given.
     
    14701469 * If using the WP functions, do not not hardcode your meta keys.
    14711470 *
    1472  * @since BuddyPress (1.5.0)
     1471 * @since 1.5.0
    14731472 *
    14741473 * @uses apply_filters() Filter 'bp_get_user_meta_key' to modify keys individually.
     
    14831482     * Filters the meta_key for a given piece of user metadata.
    14841483     *
    1485      * @since BuddyPress (1.5.0)
     1484     * @since 1.5.0
    14861485     *
    14871486     * @param string $key The usermeta meta key.
     
    14971496 * BP setups.
    14981497 *
    1499  * @since BuddyPress (1.5.0)
     1498 * @since 1.5.0
    15001499 *
    15011500 * @see get_user_meta() For complete details about parameters and return values.
     
    15201519 * BP setups.
    15211520 *
    1522  * @since BuddyPress (1.5.0)
     1521 * @since 1.5.0
    15231522 *
    15241523 * @see update_user_meta() For complete details about parameters and return values.
     
    15431542 * BP setups.
    15441543 *
    1545  * @since BuddyPress (1.5.0)
     1544 * @since 1.5.0
    15461545 *
    15471546 * @see delete_user_meta() For complete details about parameters and return values.
     
    15631562 * Initializes {@link BP_Embed} after everything is loaded.
    15641563 *
    1565  * @since BuddyPress (1.5.0)
     1564 * @since 1.5.0
    15661565 */
    15671566function bp_embed_init() {
     
    15791578 * Are oembeds allowed in activity items?
    15801579 *
    1581  * @since BuddyPress (1.5.0)
     1580 * @since 1.5.0
    15821581 *
    15831582 * @return bool False when activity embed support is disabled; true when
     
    15891588     * Filters whether or not oEmbeds are allowed in activity items.
    15901589     *
    1591      * @since BuddyPress (1.5.0)
     1590     * @since 1.5.0
    15921591     *
    15931592     * @param bool $value Whether or not oEmbeds are allowed.
     
    15991598 * Are oembeds allowed in activity replies?
    16001599 *
    1601  * @since BuddyPress (1.5.0)
     1600 * @since 1.5.0
    16021601 *
    16031602 * @return bool False when activity replies embed support is disabled; true
     
    16091608     * Filters whether or not oEmbeds are allowed in activity replies.
    16101609     *
    1611      * @since BuddyPress (1.5.0)
     1610     * @since 1.5.0
    16121611     *
    16131612     * @param bool $value Whether or not oEmbeds are allowed.
     
    16191618 * Are oembeds allowed in forum posts?
    16201619 *
    1621  * @since BuddyPress (1.5.0)
     1620 * @since 1.5.0
    16221621 *
    16231622 * @return bool False when forum post embed support is disabled; true when
     
    16291628     * Filters whether or not oEmbeds are allowed in forum posts.
    16301629     *
    1631      * @since BuddyPress (1.5.0)
     1630     * @since 1.5.0
    16321631     *
    16331632     * @param bool $value Whether or not oEmbeds are allowed.
     
    16391638 * Are oembeds allowed in private messages?
    16401639 *
    1641  * @since BuddyPress (1.5.0)
     1640 * @since 1.5.0
    16421641 *
    16431642 * @return bool False when private message embed support is disabled; true when
     
    16491648     * Filters whether or not oEmbeds are allowed in private messages.
    16501649     *
    1651      * @since BuddyPress (1.5.0)
     1650     * @since 1.5.0
    16521651     *
    16531652     * @param bool $value Whether or not oEmbeds are allowed.
     
    16611660 * Output the correct admin URL based on BuddyPress and WordPress configuration.
    16621661 *
    1663  * @since BuddyPress (1.5.0)
     1662 * @since 1.5.0
    16641663 *
    16651664 * @see bp_get_admin_url() For description of parameters.
     
    16741673     * Return the correct admin URL based on BuddyPress and WordPress configuration.
    16751674     *
    1676      * @since BuddyPress (1.5.0)
     1675     * @since 1.5.0
    16771676     *
    16781677     * @uses bp_core_do_network_admin()
     
    17091708 * to hook into certain areas of WordPress's admin.
    17101709 *
    1711  * @since BuddyPress (1.5.0)
     1710 * @since 1.5.0
    17121711 *
    17131712 * @uses bp_is_network_activated()
     
    17291728     * Filters whether or not BuddyPress should appear in network admin.
    17301729     *
    1731      * @since BuddyPress (1.5.0)
     1730     * @since 1.5.0
    17321731     *
    17331732     * @param bool $retval Whether or not BuddyPress should be in the network admin.
     
    17541753     * Filters the action name that BuddyPress nav setup callbacks should be hooked to.
    17551754     *
    1756      * @since BuddyPress (1.5.0)
     1755     * @since 1.5.0
    17571756     *
    17581757     * @param string $hook Action name to be attached to.
     
    17661765 * Is this the root blog?
    17671766 *
    1768  * @since BuddyPress (1.5.0)
     1767 * @since 1.5.0
    17691768 *
    17701769 * @param int $blog_id Optional. Default: the ID of the current blog.
     
    17901789     * Filters whether or not we're on the root blog.
    17911790     *
    1792      * @since BuddyPress (1.5.0)
     1791     * @since 1.5.0
    17931792     *
    17941793     * @param bool $is_root_blog Whether or not we're on the root blog.
     
    18041803 * etc.).
    18051804 *
    1806  * @since BuddyPress (1.5.0)
     1805 * @since 1.5.0
    18071806 *
    18081807 * @return int The root site ID.
     
    18131812     * Filters the ID for the root blog.
    18141813     *
    1815      * @since BuddyPress (1.5.0)
     1814     * @since 1.5.0
    18161815     *
    18171816     * @param int $root_blog_id ID for the root blog.
     
    18431842 * down this road unless you specifically need to.
    18441843 *
    1845  * @since BuddyPress (1.5.0)
     1844 * @since 1.5.0
    18461845 *
    18471846 * @uses apply_filters() Filter 'bp_is_multiblog_mode' to alter.
     
    18701869     * Filters whether or not we're running in multiblog mode.
    18711870     *
    1872      * @since BuddyPress (1.5.0)
     1871     * @since 1.5.0
    18731872     *
    18741873     * @param bool $retval Whether or not we're running multiblog mode.
     
    18851884 * 'bp_is_network_activated' and override the auto-determined value.
    18861885 *
    1887  * @since BuddyPress (1.7.0)
     1886 * @since 1.7.0
    18881887 *
    18891888 * @return bool True if BuddyPress is network activated.
     
    19061905     * Filters whether or not we're active at the network level.
    19071906     *
    1908      * @since BuddyPress (1.7.0)
     1907     * @since 1.7.0
    19091908     *
    19101909     * @param bool $retval Whether or not we're network activated.
     
    19311930     * Filters the "is_directory" global value.
    19321931     *
    1933      * @since BuddyPress (1.5.0)
     1932     * @since 1.5.0
    19341933     *
    19351934     * @param bool   $is_directory Whether or not we're "is_directory".
     
    19551954     * Filters the "is_item_admin" global value.
    19561955     *
    1957      * @since BuddyPress (1.5.0)
     1956     * @since 1.5.0
    19581957     *
    19591958     * @param bool   $is_item_admin Whether or not we're "is_item_admin".
     
    19791978     * Filters the "is_item_mod" global value.
    19801979     *
    1981      * @since BuddyPress (1.5.0)
     1980     * @since 1.5.0
    19821981     *
    19831982     * @param bool   $is_item_mod Whether or not we're "is_item_mod".
     
    19901989 * Trigger a 404.
    19911990 *
    1992  * @since BuddyPress (1.5.0)
     1991 * @since 1.5.0
    19931992 *
    19941993 * @global WP_Query $wp_query WordPress query object.
     
    20032002     * Fires inside the triggering of a 404.
    20042003     *
    2005      * @since BuddyPress (1.5.0)
     2004     * @since 1.5.0
    20062005     *
    20072006     * @param string $redirect Redirect type used to determine if redirect_canonical
     
    20262025 * To avoid security exploits within the theme.
    20272026 *
    2028  * @since BuddyPress (1.6.0)
     2027 * @since 1.6.0
    20292028 *
    20302029 * @uses do_action() Calls 'bp_verify_nonce_request' on $action.
     
    20732072     * Useful for configurations like reverse proxying.
    20742073     *
    2075      * @since BuddyPress (1.9.0)
     2074     * @since 1.9.0
    20762075     *
    20772076     * @param string $requested_url The requested URL.
     
    20902089     * Fires at the end of the nonce verification check.
    20912090     *
    2092      * @since BuddyPress (1.6.0)
     2091     * @since 1.6.0
    20932092     *
    20942093     * @param string $action Action nonce.
     
    21052104 * Return true|false if this is a POST request.
    21062105 *
    2107  * @since BuddyPress (1.9.0)
     2106 * @since 1.9.0
    21082107 * @return bool
    21092108 */
     
    21152114 * Return true|false if this is a GET request.
    21162115 *
    2117  * @since BuddyPress (1.9.0)
     2116 * @since 1.9.0
    21182117 * @return bool
    21192118 */
     
    21382137     * Filters the locale to be loaded for the language files.
    21392138     *
    2140      * @since BuddyPress (1.0.2)
     2139     * @since 1.0.2
    21412140     *
    21422141     * @param string $value Current locale for the install.
     
    21472146     * Filters the locations to load language files from.
    21482147     *
    2149      * @since BuddyPress (2.2.0)
     2148     * @since 2.2.0
    21502149     *
    21512150     * @param array $value Array of directories to check for language files in.
     
    22332232     * Filters the constructed url for use with site searching.
    22342233     *
    2235      * @since BuddyPress (1.0.0)
     2234     * @since 1.0.0
    22362235     *
    22372236     * @param string $value        URL for use with site searching.
     
    22622261 * prevents additional, unnecessary queries from running.
    22632262 *
    2264  * @since BuddyPress (2.1.0)
     2263 * @since 2.1.0
    22652264 */
    22662265function bp_remove_adjacent_posts_rel_link() {
     
    22892288 * logged-in user.
    22902289 *
    2291  * @since BuddyPress (1.9.0)
     2290 * @since 1.9.0
    22922291 *
    22932292 * @return mixed A URL or an array of dummy pages.
     
    23592358 * menu.
    23602359 *
    2361  * @since BuddyPress (1.9.0)
     2360 * @since 1.9.0
    23622361 *
    23632362 * @return mixed A URL or an array of dummy pages.
     
    24302429 * proper URL for a given nav item slug (such as 'login' or 'messages').
    24312430 *
    2432  * @since BuddyPress (1.9.0)
     2431 * @since 1.9.0
    24332432 *
    24342433 * @param string $slug The slug of the nav item: login, register, or one of the
     
    24562455 * for similar kinds of future requirements, or those implemented by third-party developers.
    24572456 *
    2458  * @since BuddyPress (2.1.0)
     2457 * @since 2.1.0
    24592458 *
    24602459 * @param array $args
     
    24862485         * if you've built a custom suggestions service.
    24872486         *
    2488          * @since BuddyPress (2.1.0)
     2487         * @since 2.1.0
    24892488         *
    24902489         * @param string $value Custom class to use. Default: none.
     
    25112510     * Filters the available type of at-mentions.
    25122511     *
    2513      * @since BuddyPress (2.1.0)
     2512     * @since 2.1.0
    25142513     *
    25152514     * @param array|WP_Error $retval Array of results or WP_Error object.
     
    25282527 * once to get what we need.
    25292528 *
    2530  * @since BuddyPress (2.3.0)
     2529 * @since 2.3.0
    25312530 *
    25322531 * @uses  is_multisite()
  • trunk/src/bp-core/bp-core-loader.php

    r9936 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Core Loader.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1817     * Start the members component creation process.
    1918     *
    20      * @since BuddyPress (1.5.0)
     19     * @since 1.5.0
    2120     *
    2221     * @uses BP_Core::bootstrap()
     
    3837     * and optional components.
    3938     *
    40      * @since BuddyPress (1.5.0)
     39     * @since 1.5.0
    4140     */
    4241    private function bootstrap() {
     
    4847         * Allows plugins to run code ahead of the other components.
    4948         *
    50          * @since BuddyPress (1.2.0)
     49         * @since 1.2.0
    5150         */
    5251        do_action( 'bp_core_loaded' );
     
    5756         * Filters the included and optional components.
    5857         *
    59          * @since BuddyPress (1.5.0)
     58         * @since 1.5.0
    6059         *
    6160         * @param array $value Array of included and optional components.
     
    6665         * Filters the required components.
    6766         *
    68          * @since BuddyPress (1.5.0)
     67         * @since 1.5.0
    6968         *
    7069         * @param array $value Array of required components.
     
    8180             * Filters the deactivated components.
    8281             *
    83              * @since BuddyPress (1.0.0)
     82             * @since 1.0.0
    8483             *
    8584             * @param array $value Array of deactivated components.
     
    137136         * Fires after the loading of individual components.
    138137         *
    139          * @since BuddyPress (2.0.0)
     138         * @since 2.0.0
    140139         */
    141140        do_action( 'bp_core_components_included' );
     
    168167     * amount of processing, meaning they cannot be set in the BuddyPress class.
    169168     *
    170      * @since BuddyPress (1.5.0)
     169     * @since 1.5.0
    171170     *
    172171     * @see BP_Component::setup_globals() for description of parameters.
     
    216215         * Filters the default user Gravatar.
    217216         *
    218          * @since BuddyPress (1.1.0)
     217         * @since 1.1.0
    219218         *
    220219         * @param string $value Default user Gravatar.
     
    225224         * Filters the default group Gravatar.
    226225         *
    227          * @since BuddyPress (1.1.0)
     226         * @since 1.1.0
    228227         *
    229228         * @param string $value Default group Gravatar.
     
    234233         * Filters the default blog Gravatar.
    235234         *
    236          * @since BuddyPress (1.1.0)
     235         * @since 1.1.0
    237236         *
    238237         * @param string $value Default blog Gravatar.
     
    260259         * Fires at the end of the setup of bp-core globals setting.
    261260         *
    262          * @since BuddyPress (1.1.0)
     261         * @since 1.1.0
    263262         */
    264263        do_action( 'bp_core_setup_globals' );
     
    268267     * Setup cache groups
    269268     *
    270      * @since BuddyPress (2.2.0)
     269     * @since 2.2.0
    271270     */
    272271    public function setup_cache_groups() {
     
    284283 * Set up the BuddyPress Core component.
    285284 *
    286  * @since BuddyPress (1.6.0)
     285 * @since 1.6.0
    287286 *
    288287 * @global BuddyPress $bp BuddyPress global settings object.
  • trunk/src/bp-core/bp-core-moderation.php

    r10012 r10108  
    55 * @package BuddyPress
    66 * @subpackage Core
    7  * @since BuddyPress (1.6.0)
    8  */
    9 
    10 // Exit if accessed directly
     7 * @since 1.6.0
     8 */
     9
     10// Exit if accessed directly.
    1111defined( 'ABSPATH' ) || exit;
    1212
     
    1919 * of time.
    2020 *
    21  * @since BuddyPress (1.6.0)
     21 * @since 1.6.0
    2222 *
    2323 * @uses current_user_can() To check if the current user can throttle.
     
    5353 * Check for moderation keys and too many links.
    5454 *
    55  * @since BuddyPress (1.6.0)
     55 * @since 1.6.0
    5656 *
    5757 * @uses bp_current_author_ip() To get current user IP address.
     
    7070     * Filters whether or not to bypass checking for moderation keys and too many links.
    7171     *
    72      * @since BuddyPress (2.2.0)
     72     * @since 2.2.0
    7373     *
    7474     * @param bool   $value   Whether or not to bypass checking. Default false.
     
    127127             * Filters the maximum amount of links allowed to include the user's URL.
    128128             *
    129              * @since BuddyPress (1.6.0)
     129             * @since 1.6.0
    130130             *
    131131             * @param string $num_links How many links found.
     
    188188 * Check for blocked keys.
    189189 *
    190  * @since BuddyPress (1.6.0)
     190 * @since 1.6.0
    191191 *
    192192 * @uses bp_current_author_ip() To get current user IP address.
     
    205205     * Filters whether or not to bypass checking for blocked keys.
    206206     *
    207      * @since BuddyPress (2.2.0)
     207     * @since 2.2.0
    208208     *
    209209     * @param bool   $value   Whether or not to bypass checking. Default false.
     
    296296 * Get the current user's IP address.
    297297 *
    298  * @since BuddyPress (1.6.0)
     298 * @since 1.6.0
    299299 *
    300300 * @return string IP address.
     
    306306     * Filters the current user's IP address.
    307307     *
    308      * @since BuddyPress (1.6.0)
     308     * @since 1.6.0
    309309     *
    310310     * @param string $retval Current user's IP Address.
     
    316316 * Get the current user's user-agent.
    317317 *
    318  * @since BuddyPress (1.6.0)
     318 * @since 1.6.0
    319319 *
    320320 * @return string User agent string.
     
    332332     * Filters the current user's user-agent.
    333333     *
    334      * @since BuddyPress (1.6.0)
     334     * @since 1.6.0
    335335     *
    336336     * @param string $retval Current user's user-agent.
  • trunk/src/bp-core/bp-core-options.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Options.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Get the default site options and their values.
    1514 *
    16  * @since BuddyPress (1.6.0)
     15 * @since 1.6.0
    1716 *
    1817 * @return array Filtered option names and values.
     
    107106     * Filters the default options to be set upon activation.
    108107     *
    109      * @since BuddyPress (1.6.0)
     108     * @since 1.6.0
    110109     *
    111110     * @param array $options Array of default options to set.
     
    120119 * Non-destructive, so existing settings will not be overridden.
    121120 *
    122  * @since BuddyPress (1.6.0)
     121 * @since 1.6.0
    123122 *
    124123 * @uses bp_get_default_options() To get default options.
     
    141140     * Allows previously activated plugins to append their own options.
    142141     *
    143      * @since BuddyPress (1.6.0)
     142     * @since 1.6.0
    144143     */
    145144    do_action( 'bp_add_options' );
     
    154153 * Currently unused.
    155154 *
    156  * @since BuddyPress (1.6.0)
     155 * @since 1.6.0
    157156 *
    158157 * @uses bp_get_default_options() To get default options.
     
    175174     * Allows previously activated plugins to append their own options.
    176175     *
    177      * @since BuddyPress (1.6.0)
     176     * @since 1.6.0
    178177     */
    179178    do_action( 'bp_delete_options' );
     
    185184 * Currently unused.
    186185 *
    187  * @since BuddyPress (1.6.0)
     186 * @since 1.6.0
    188187 *
    189188 * @uses bp_get_default_options() To get default options.
     
    206205     * Allows previously activated plugins to append their own options.
    207206     *
    208      * @since BuddyPress (1.6.0)
     207     * @since 1.6.0
    209208     */
    210209    do_action( 'bp_setup_option_filters' );
     
    216215 * Currently unused.
    217216 *
    218  * @since BuddyPress (1.6.0)
     217 * @since 1.6.0
    219218 *
    220219 * @param bool $value Optional. Default value false.
     
    248247 * The 'bp_get_option' filter is primarily for backward-compatibility.
    249248 *
    250  * @since BuddyPress (1.2.0)
     249 * @since 1.2.0
    251250 *
    252251 * @uses bp_get_root_blog_id()
     
    264263     * Filters the option value for the requested option.
    265264     *
    266      * @since BuddyPress (1.2.0)
     265     * @since 1.2.0
    267266     *
    268267     * @param mixed $value The value for the option.
     
    277276 * settings data on the appropriate blog, given your current setup.
    278277 *
    279  * @since BuddyPress (2.0.0)
     278 * @since 2.0.0
    280279 *
    281280 * @param string $option_name The option key to be set.
     
    295294 * setup.
    296295 *
    297  * @since BuddyPress (1.5.0)
     296 * @since 1.5.0
    298297 *
    299298 * @uses bp_get_root_blog_id()
     
    315314 * setup.
    316315 *
    317  * @since BuddyPress (1.5.0)
     316 * @since 1.5.0
    318317 *
    319318 * @uses bp_get_root_blog_id()
     
    404403             * Filters multisite options retrieved from sitemeta.
    405404             *
    406              * @since BuddyPress (1.5.0)
     405             * @since 1.5.0
    407406             *
    408407             * @param array $value Array of multisite options from sitemeta table.
     
    487486     * Filters the global BP options.
    488487     *
    489      * @since BuddyPress (1.5.0)
     488     * @since 1.5.0
    490489     *
    491490     * @param array $root_blog_options_meta Array of global BP options.
     
    501500 * See {@see bp_core_get_root_options()}.
    502501 *
    503  * @since BuddyPress (2.3.0)
     502 * @since 2.3.0
    504503 *
    505504 * @param  string $option Name of the option key.
     
    527526 * Is profile syncing disabled?
    528527 *
    529  * @since BuddyPress (1.6.0)
     528 * @since 1.6.0
    530529 *
    531530 * @uses bp_get_option() To get the profile sync option.
     
    541540     * Filters whether or not profile syncing is disabled.
    542541     *
    543      * @since BuddyPress (1.6.0)
     542     * @since 1.6.0
    544543     *
    545544     * @param bool $value Whether or not syncing is disabled.
     
    551550 * Is the Toolbar hidden for logged out users?
    552551 *
    553  * @since BuddyPress (1.6.0)
     552 * @since 1.6.0
    554553 *
    555554 * @uses bp_get_option() To get the logged out Toolbar option.
     
    566565     * Filters whether or not the toolbar is hidden for logged out users.
    567566     *
    568      * @since BuddyPress (1.6.0)
     567     * @since 1.6.0
    569568     *
    570569     * @param bool $value Whether or not the toolbar is hidden.
     
    576575 * Are members able to upload their own avatars?
    577576 *
    578  * @since BuddyPress (1.6.0)
     577 * @since 1.6.0
    579578 *
    580579 * @uses bp_get_option() To get the avatar uploads option.
     
    590589     * Filters whether or not members are able to upload their own avatars.
    591590     *
    592      * @since BuddyPress (1.6.0)
     591     * @since 1.6.0
    593592     *
    594593     * @param bool $value Whether or not members are able to upload their own avatars.
     
    603602 * found in the database.
    604603 *
    605  * @since BuddyPress (2.3.0)
     604 * @since 2.3.0
    606605 *
    607606 * @param bool|null $default Optional. Fallback value if not found in the database.
     
    624623     * Filters whether or not members are able to upload group avatars.
    625624     *
    626      * @since BuddyPress (2.3.0)
     625     * @since 2.3.0
    627626     *
    628627     * @param bool $disabled Whether or not members are able to upload their groups avatars.
     
    635634 * Are members able to delete their own accounts?
    636635 *
    637  * @since BuddyPress (1.6.0)
     636 * @since 1.6.0
    638637 *
    639638 * @uses bp_get_option() To get the account deletion option.
     
    650649     * Filters whether or not members are able to delete their own accounts.
    651650     *
    652      * @since BuddyPress (1.6.0)
     651     * @since 1.6.0
    653652     *
    654653     * @param bool $value Whether or not members are able to delete their own accounts.
     
    660659 * Are blog and forum activity stream comments disabled?
    661660 *
    662  * @since BuddyPress (1.6.0)
     661 * @since 1.6.0
    663662 *
    664663 * @todo split and move into blog and forum components.
     
    676675     * Filters whether or not blog and forum activity stream comments are disabled.
    677676     *
    678      * @since BuddyPress (1.6.0)
     677     * @since 1.6.0
    679678     *
    680679     * @param bool $value Whether or not blog and forum activity stream comments are disabled.
     
    686685 * Is group creation turned off?
    687686 *
    688  * @since BuddyPress (1.6.0)
     687 * @since 1.6.0
    689688 *
    690689 * @todo Move into groups component.
     
    701700     * Filters whether or not group creation is turned off.
    702701     *
    703      * @since BuddyPress (1.6.0)
     702     * @since 1.6.0
    704703     *
    705704     * @param bool $value Whether or not group creation is turned off.
     
    711710 * Should the old BuddyBar be forced in place of the WP admin bar?
    712711 *
    713  * @since BuddyPress (1.6.0)
     712 * @since 1.6.0
    714713 *
    715714 * @uses bp_get_option() To get the BuddyBar option.
     
    725724     * Filters whether or not BuddyBar should be forced in place of WP Admin Bar.
    726725     *
    727      * @since BuddyPress (1.6.0)
     726     * @since 1.6.0
    728727     *
    729728     * @param bool $value Whether or not BuddyBar should be forced in place of WP Admin Bar.
     
    735734 * Output the group forums root parent forum id.
    736735 *
    737  * @since BuddyPress (1.6.0)
     736 * @since 1.6.0
    738737 *
    739738 * @param bool|string $default Optional. Default: '0'.
     
    745744     * Return the group forums root parent forum id.
    746745     *
    747      * @since BuddyPress (1.6.0)
     746     * @since 1.6.0
    748747     *
    749748     * @uses bp_get_option() To get the root forum ID from the database.
     
    758757         * Filters the group forums root parent forum id.
    759758         *
    760          * @since BuddyPress (1.6.0)
     759         * @since 1.6.0
    761760         *
    762761         * @param int $value The group forums root parent forum id.
     
    768767 * Check whether BuddyPress Group Forums are enabled.
    769768 *
    770  * @since BuddyPress (1.6.0)
     769 * @since 1.6.0
    771770 *
    772771 * @uses bp_get_option() To get the group forums option.
     
    782781     * Filters whether or not BuddyPress Group Forums are enabled.
    783782     *
    784      * @since BuddyPress (1.6.0)
     783     * @since 1.6.0
    785784     *
    786785     * @param bool $value Whether or not BuddyPress Group Forums are enabled.
     
    792791 * Check whether Akismet is enabled.
    793792 *
    794  * @since BuddyPress (1.6.0)
     793 * @since 1.6.0
    795794 *
    796795 * @uses bp_get_option() To get the Akismet option.
     
    806805     * Filters whether or not Akismet is enabled.
    807806     *
    808      * @since BuddyPress (1.6.0)
     807     * @since 1.6.0
    809808     *
    810809     * @param bool $value Whether or not Akismet is enabled.
     
    816815 * Check whether Activity Heartbeat refresh is enabled.
    817816 *
    818  * @since BuddyPress (2.0.0)
     817 * @since 2.0.0
    819818 *
    820819 * @uses bp_get_option() To get the Heartbeat option.
     
    830829     * Filters whether or not Activity Heartbeat refresh is enabled.
    831830     *
    832      * @since BuddyPress (2.0.0)
     831     * @since 2.0.0
    833832     *
    834833     * @param bool $value Whether or not Activity Heartbeat refresh is enabled.
     
    840839 * Get the current theme package ID.
    841840 *
    842  * @since BuddyPress (1.7.0)
     841 * @since 1.7.0
    843842 *
    844843 * @uses get_option() To get the theme package option.
     
    854853     * Filters the current theme package ID.
    855854     *
    856      * @since BuddyPress (1.7.0)
     855     * @since 1.7.0
    857856     *
    858857     * @param string $value The current theme package ID.
  • trunk/src/bp-core/bp-core-taxonomy.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress taxonomy functions.
     
    87 * must switch to the root blog before using the WP functions.
    98 *
    10  * @since BuddyPress (2.2.0)
     9 * @since 2.2.0
     10 *
     11 * @package BuddyPress
     12 * @subpackage Core
    1113 */
     14
     15// Exit if accessed directly.
     16defined( 'ABSPATH' ) || exit;
    1217
    1318/**
    1419 * Register our default taxonomies.
    1520 *
    16  * @since BuddyPress (2.2.0)
     21 * @since 2.2.0
    1722 */
    1823function bp_register_default_taxonomies() {
     
    2732 * Set taxonomy terms on a BuddyPress object.
    2833 *
    29  * @since BuddyPress (2.2.0)
     34 * @since 2.2.0
    3035 *
    3136 * @see wp_set_object_terms() for a full description of function and parameters.
     
    5762 * Get taxonomy terms for a BuddyPress object.
    5863 *
    59  * @since BuddyPress (2.2.0)
     64 * @since 2.2.0
    6065 *
    6166 * @see wp_get_object_terms() for a full description of function and parameters.
     
    8691 * Remove taxonomy terms on a BuddyPress object.
    8792 *
    88  * @since BuddyPress (2.3.0)
     93 * @since 2.3.0
    8994 *
    9095 * @see wp_remove_object_terms() for a full description of function and parameters.
  • trunk/src/bp-core/bp-core-template-loader.php

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Template Functions.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    1817 * Get a BuddyPress template part for display in a theme.
    1918 *
    20  * @since BuddyPress (1.7.0)
     19 * @since 1.7.0
    2120 *
    2221 * @uses bp_locate_template()
     
    3837     * This is a variable hook that is dependent on the slug passed in.
    3938     *
    40      * @since BuddyPress (1.7.0)
     39     * @since 1.7.0
    4140     *
    4241     * @param string $slug Template part slug requested.
     
    5554     * Filters the template parts to be loaded.
    5655     *
    57      * @since BuddyPress (1.7.0)
     56     * @since 1.7.0
    5857     *
    5958     * @param array  $templates Array of templates located.
     
    7473 * not found in either of those, it looks in the theme-compat folder last.
    7574 *
    76  * @since BuddyPress (1.7.0)
     75 * @since 1.7.0
    7776 *
    7877 * @param string|array $template_names Template file(s) to search for, in order.
     
    143142 * with bp_locate_template(), this allows for easy template overrides.
    144143 *
    145  * @since BuddyPress (1.7.0)
     144 * @since 1.7.0
    146145 *
    147146 * @param string $location_callback Callback function that returns the stack location.
     
    165164 * Deregister a previously registered template stack location.
    166165 *
    167  * @since BuddyPress (1.7.0)
     166 * @since 1.7.0
    168167 *
    169168 * @see bp_register_template_stack()
     
    194193 * @see bp_register_template_stack()
    195194 *
    196  * @since BuddyPress (1.7.0)
     195 * @since 1.7.0
    197196 *
    198197 * @global array $wp_filter         Stores all of the filters.
     
    241240     * Filters the "template stack" list of registered directories where templates can be found.
    242241     *
    243      * @since BuddyPress (1.7.0)
     242     * @since 1.7.0
    244243     *
    245244     * @param array $stack Array of registered directories for template locations.
     
    251250 * Put a template part into an output buffer, and return it.
    252251 *
    253  * @since BuddyPress (1.7.0)
     252 * @since 1.7.0
    254253 *
    255254 * @see bp_get_template_part() for a description of $slug and $name params.
     
    292291 * locations without the use of the other get_*_template() functions.
    293292 *
    294  * @since BuddyPress (1.7.0)
     293 * @since 1.7.0
    295294 *
    296295 * @uses bp_set_theme_compat_templates()
     
    316315     * bp_get_query_template.
    317316     *
    318      * @since BuddyPress (1.7.0)
     317     * @since 1.7.0
    319318     *
    320319     * @param array $templates Array of template files already prepared.
     
    334333     * bp_get_query_template.
    335334     *
    336      * @since BuddyPress (1.7.0)
     335     * @since 1.7.0
    337336     *
    338337     * @param string $template Path to the most appropriate found template file.
     
    344343 * Get the possible subdirectories to check for templates in.
    345344 *
    346  * @since BuddyPress (1.7.0)
     345 * @since 1.7.0
    347346 *
    348347 * @param array $templates Templates we are looking for.
     
    360359     * Filters the possible subdirectories to check for templates in.
    361360     *
    362      * @since BuddyPress (1.7.0)
     361     * @since 1.7.0
    363362     *
    364363     * @param array $locations Array of subfolders to look in.
     
    371370 * Add template locations to template files being searched for.
    372371 *
    373  * @since BuddyPress (1.7.0)
     372 * @since 1.7.0
    374373 *
    375374 * @param array $stacks Array of template locations.
     
    393392     * Filters the template locations to template files being searched for.
    394393     *
    395      * @since BuddyPress (1.7.0)
     394     * @since 1.7.0
    396395     *
    397396     * @param array $value  Array of all template locations registered so far.
     
    404403 * Add checks for BuddyPress conditions to 'parse_query' action.
    405404 *
    406  * @since BuddyPress (1.7.0)
     405 * @since 1.7.0
    407406 *
    408407 * @param WP_Query $posts_query
     
    430429     * Allow BuddyPress components to parse the main query.
    431430     *
    432      * @since BuddyPress (1.7.0)
     431     * @since 1.7.0
    433432     *
    434433     * @param WP_Query $posts_query WP_Query instance. Passed by reference.
     
    447446 * from being stomped on accident.
    448447 *
    449  * @since BuddyPress (1.7.0)
     448 * @since 1.7.0
    450449 *
    451450 * @param string $template
     
    458457     * Filters whether or not to override the template being loaded in parent/child themes.
    459458     *
    460      * @since BuddyPress (1.7.0)
     459     * @since 1.7.0
    461460     *
    462461     * @param bool   $value    Whether or not there is a file override. Default false.
     
    474473     * Filters the final template being loaded in parent/child themes.
    475474     *
    476      * @since BuddyPress (1.7.0)
     475     * @since 1.7.0
    477476     *
    478477     * @param string $template The path to the template file that is being used.
     
    484483 * Set the included template.
    485484 *
    486  * @since BuddyPress (1.8.0)
     485 * @since 1.8.0
    487486 *
    488487 * @param mixed $template Default: false.
     
    499498 * Is a BuddyPress template being included?
    500499 *
    501  * @since BuddyPress (1.8.0)
     500 * @since 1.8.0
    502501 *
    503502 * @return bool True if yes, false if no.
     
    510509 * Attempt to load a custom BP functions file, similar to each themes functions.php file.
    511510 *
    512  * @since BuddyPress (1.7.0)
     511 * @since 1.7.0
    513512 *
    514513 * @global string $pagenow
     
    545544 * Get the templates to use as the endpoint for BuddyPress template parts.
    546545 *
    547  * @since BuddyPress (1.7.0)
     546 * @since 1.7.0
    548547 *
    549548 * @return array Array of possible root level wrapper template files.
  • trunk/src/bp-core/bp-core-template.php

    r10039 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    8181         * This is a dynamic filter that is dependent on the provided css_id value.
    8282         *
    83          * @since BuddyPress (1.1.0)
     83         * @since 1.1.0
    8484         *
    8585         * @param string $value         HTML list item for the submenu item.
     
    113113 * page.
    114114 *
    115  * @since BuddyPress (2.0.0)
     115 * @since 2.0.0
    116116 *
    117117 * @param string $component
     
    134134     * Filters the directory title for a component.
    135135     *
    136      * @since BuddyPress (2.0.0)
     136     * @since 2.0.0
    137137     *
    138138     * @param string $title     Text to be used in <title> tag.
     
    228228         * Filters the current avatar upload step.
    229229         *
    230          * @since BuddyPress (1.1.0)
     230         * @since 1.1.0
    231231         *
    232232         * @param string $step The current avatar upload step.
     
    255255         * Filters the URL of the avatar to crop.
    256256         *
    257          * @since BuddyPress (1.1.0)
     257         * @since 1.1.0
    258258         *
    259259         * @param string $url URL for the avatar.
     
    282282         * Filters the relative file path to the avatar to crop.
    283283         *
    284          * @since BuddyPress (1.1.0)
     284         * @since 1.1.0
    285285         *
    286286         * @param string $src Relative file path for the avatar.
     
    311311     * Returns the name of the BP site. Used in RSS headers.
    312312     *
    313      * @since BuddyPress (1.6.0)
     313     * @since 1.6.0
    314314     */
    315315    function bp_get_site_name() {
     
    318318         * Filters the name of the BP site. Used in RSS headers.
    319319         *
    320          * @since BuddyPress (1.0.0)
     320         * @since 1.0.0
    321321         *
    322322         * @param string $value Current BP site name.
     
    339339 * and times together with timezone offsets and i18n.
    340340 *
    341  * @since BuddyPress (1.1.0)
     341 * @since 1.1.0
    342342 *
    343343 * @param int|string  $time         The UNIX timestamp to be formatted.
     
    399399     * Filters the date based on a UNIX timestamp.
    400400     *
    401      * @since BuddyPress (1.0.0)
     401     * @since 1.0.0
    402402     *
    403403     * @param string $formatted_date Formatted date from the timestamp.
     
    437437             * Filters the text used based on context of own profile or someone else's profile.
    438438             *
    439              * @since BuddyPress (1.0.0)
     439             * @since 1.0.0
    440440             *
    441441             * @param string $youtext Context-determined string to display.
     
    487487     * Filters the "action" attribute for search forms.
    488488     *
    489      * @since BuddyPress (1.0.0)
     489     * @since 1.0.0
    490490     *
    491491     * @param string $value Search form action url.
     
    497497 * Generate the basic search form as used in BP-Default's header.
    498498 *
    499  * @since BuddyPress (1.0.0)
     499 * @since 1.0.0
    500500 *
    501501 * @return string HTML <select> element.
     
    530530     * Filters all of the component options available for search scope.
    531531     *
    532      * @since BuddyPress (1.5.0)
     532     * @since 1.5.0
    533533     *
    534534     * @param array $options Array of options to add to select field.
     
    544544     * Filters the complete <select> input used for search scope.
    545545     *
    546      * @since BuddyPress (1.0.0)
     546     * @since 1.0.0
    547547     *
    548548     * @param string $selection_box <select> input for selecting search scope.
     
    554554 * Output the default text for the search box for a given component.
    555555 *
    556  * @since BuddyPress (1.5.0)
     556 * @since 1.5.0
    557557 *
    558558 * @see bp_get_search_default_text()
     
    566566     * Return the default text for the search box for a given component.
    567567     *
    568      * @since BuddyPress (1.5.0)
     568     * @since 1.5.0
    569569     *
    570570     * @param string $component Component name. Default: current component.
     
    601601         * Filters the default text for the search box for a given component.
    602602         *
    603          * @since BuddyPress (1.5.0)
     603         * @since 1.5.0
    604604         *
    605605         * @param string $default_text Default text for search box.
     
    634634 * Output the attributes for a form field.
    635635 *
    636  * @since BuddyPress (2.2.0)
     636 * @since 2.2.0
    637637 *
    638638 * @param string $name       The field name to output attributes for.
     
    649649     * manipulation.
    650650     *
    651      * @since BuddyPress (2.2.0)
     651     * @since 2.2.0
    652652     *
    653653     * @param string $name       The field name to get attributes for.
     
    691691         * Filter the attributes for a field before rendering output.
    692692         *
    693          * @since BuddyPress (2.2.0)
     693         * @since 2.2.0
    694694         *
    695695         * @param array  $attributes The field attributes.
     
    729729         * Filters the requested button output.
    730730         *
    731          * @since BuddyPress (1.2.6)
     731         * @since 1.2.6
    732732         *
    733733         * @param string    $contents  Button context to be used.
     
    788788     * Filters the excerpt length to trim text to.
    789789     *
    790      * @since BuddyPress (1.5.0)
     790     * @since 1.5.0
    791791     *
    792792     * @param int $length Length of returned string, including ellipsis.
     
    797797     * Filters the excerpt appended text value.
    798798     *
    799      * @since BuddyPress (1.5.0)
     799     * @since 1.5.0
    800800     *
    801801     * @param string $value Text to append to the end of the excerpt.
     
    950950     * Filters the final generated excerpt.
    951951     *
    952      * @since BuddyPress (1.1.0)
     952     * @since 1.1.0
    953953     *
    954954     * @param string $truncate      Generated excerpt.
     
    987987         * Filters the total member count in your BP instance.
    988988         *
    989          * @since BuddyPress (1.2.0)
     989         * @since 1.2.0
    990990         *
    991991         * @param int $value Member count.
     
    10541054     * Filters whether registrations require activation on this installation.
    10551055     *
    1056      * @since BuddyPress (1.2.0)
     1056     * @since 1.2.0
    10571057     *
    10581058     * @param bool $value Whether registrations require activation. Default true.
     
    10671067 * sanitize_option, we want to reverse this for the plain text arena of emails.
    10681068 *
    1069  * @since BuddyPress (1.7.0)
     1069 * @since 1.7.0
    10701070 *
    10711071 * @see https://buddypress.trac.wordpress.org/ticket/4401
     
    10981098     * Filters a client friendly version of the root blog name.
    10991099     *
    1100      * @since BuddyPress (1.7.0)
     1100     * @since 1.7.0
    11011101     *
    11021102     * @param string $subject Client friendy version of the root blog name.
     
    11321132     * Allows templates to pass parameters into the template loops via AJAX.
    11331133     *