Skip to:
Content

BuddyPress.org

Changeset 10108


Ignore:
Timestamp:
09/13/2015 02:02:56 AM (10 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     *
    1134      * @since BuddyPress (1.2.0)
     1134     * @since 1.2.0
    11351135     *
    11361136     * @param string $ajax_querystring Current query string.
    … …  
    11561156     * Filters the name of the current component.
    11571157     *
    1158      * @since BuddyPress (1.0.0)
     1158     * @since 1.0.0
    11591159     *
    11601160     * @param string|bool $current_component Current component if available or false.
    … …  
    11771177     * Filters the name of the current action.
    11781178     *
    1179      * @since BuddyPress (1.0.0)
     1179     * @since 1.0.0
    11801180     *
    11811181     * @param string $current_action Current action.
    … …  
    11981198     * Filters the name of the current item.
    11991199     *
    1200      * @since BuddyPress (1.1.0)
     1200     * @since 1.1.0
    12011201     *
    12021202     * @param string|bool $current_item Current item if available or false.
    … …  
    12201220     * Filters the value of $bp->action_variables.
    12211221     *
    1222      * @since BuddyPress (1.0.0)
     1222     * @since 1.0.0
    12231223     *
    12241224     * @param array|bool $action_variables Available action variables.
    … …  
    12301230 * Return the value of a given action variable.
    12311231 *
    1232  * @since BuddyPress (1.5.0)
     1232 * @since 1.5.0
    12331233 *
    12341234 * @param int $position The key of the action_variables array that you want.
    … …  
    12461246     * Filters the value of a given action variable.
    12471247     *
    1248      * @since BuddyPress (1.5.0)
     1248     * @since 1.5.0
    12491249     *
    12501250     * @param string|bool $action_variable Requested action variable based on position.
    … …  
    12781278         * Filters the "root domain", the URL of the BP root blog.
    12791279         *
    1280          * @since BuddyPress (1.2.4)
     1280         * @since 1.2.4
    12811281         *
    12821282         * @param string $domain URL of the BP root blog.
    … …  
    12881288 * Output the root slug for a given component.
    12891289 *
    1290  * @since BuddyPress (1.5.0)
     1290 * @since 1.5.0
    12911291 *
    12921292 * @param string $component The component name.
    … …  
    13201320     * from $bp->groups->root_slug.
    13211321     *
    1322      * @since BuddyPress (1.5.0)
     1322     * @since 1.5.0
    13231323     *
    13241324     * @param string $component Optional. Defaults to the current component.
    … …  
    13581358         * Filters the root slug for given component.
    13591359         *
    1360          * @since BuddyPress (1.5.0)
     1360         * @since 1.5.0
    13611361         *
    13621362         * @param string $root_slug Root slug for given component.
    … …  
    13691369 * Return the component name based on a root slug.
    13701370 *
    1371  * @since BuddyPress (1.5.0)
     1371 * @since 1.5.0
    13721372 *
    13731373 * @param string $root_slug Needle to our active component haystack.
    … …  
    14041404     * Filters whether or not a user has access.
    14051405     *
    1406      * @since BuddyPress (1.2.4)
     1406     * @since 1.2.4
    14071407     *
    14081408     * @param bool $has_access Whether or not user has access.
    … …  
    14141414 * Output the search slug.
    14151415 *
    1416  * @since BuddyPress (1.5.0)
     1416 * @since 1.5.0
    14171417 *
    14181418 * @uses bp_get_search_slug()
    … …  
    14241424     * Return the search slug.
    14251425     *
    1426      * @since BuddyPress (1.5.0)
     1426     * @since 1.5.0
    14271427     *
    14281428     * @return string The search slug. Default: 'search'.
    … …  
    14331433         * Filters the search slug.
    14341434         *
    1435          * @since BuddyPress (1.5.0)
     1435         * @since 1.5.0
    14361436         *
    14371437         * @const string BP_SEARCH_SLUG The search slug. Default "search".
    … …  
    14561456     * Filters the ID of the currently displayed user.
    14571457     *
    1458      * @since BuddyPress (1.0.0)
     1458     * @since 1.0.0
    14591459     *
    14601460     * @param int $id ID of the currently displayed user.
    … …  
    14791479     * Filters the ID of the currently logged-in user.
    14801480     *
    1481      * @since BuddyPress (1.0.0)
     1481     * @since 1.0.0
    14821482     *
    14831483     * @param int $id ID of the currently logged-in user.
    … …  
    14971497 * - the component's id, or 'canonical' name.
    14981498 *
    1499  * @since BuddyPress (1.5.0)
     1499 * @since 1.5.0
    15001500 *
    15011501 * @param string $component Name of the component being checked.
    … …  
    15661566     * Filters whether the current page belongs to the specified component.
    15671567     *
    1568      * @since BuddyPress (1.5.0)
     1568     * @since 1.5.0
    15691569     *
    15701570     * @param bool   $is_current_component Whether or not the current page belongs to specified component.
    … …  
    15861586 * the current_action is 'members'.
    15871587 *
    1588  * @since BuddyPress (1.5.0)
     1588 * @since 1.5.0
    15891589 *
    15901590 * @param string $action The action being tested against.
    … …  
    16081608 * $action_variables[0] is 'group-settings'.
    16091609 *
    1610  * @since BuddyPress (1.5.0)
     1610 * @since 1.5.0
    16111611 *
    16121612 * @param string   $action_variable The action_variable being tested against.
    … …  
    16371637     * Filters whether the current page matches a given action_variable.
    16381638     *
    1639      * @since BuddyPress (1.5.0)
     1639     * @since 1.5.0
    16401640     *
    16411641     * @param bool   $is_action_variable Whether the current page matches a given action_variable.
    … …  
    16591659     * Filters whether or not an item is the current item.
    16601660     *
    1661      * @since BuddyPress (2.1.0)
     1661     * @since 2.1.0
    16621662     *
    16631663     * @param bool   $retval Whether or not an item is the current item.
    … …  
    16831683     * Filters whether or not an item is the a single item. (group, user, etc)
    16841684     *
    1685      * @since BuddyPress (2.1.0)
     1685     * @since 2.1.0
    16861686     *
    16871687     * @param bool $retval Whether or not an item is a single item.
    … …  
    17071707     * Filters whether or not the logged-in user is an admin for the current item.
    17081708     *
    1709      * @since BuddyPress (2.1.0)
     1709     * @since 2.1.0
    17101710     *
    17111711     * @param bool $retval Whether or not the logged-in user is an admin.
    … …  
    17311731     * Filters whether or not the logged-in user is a mod for the current item.
    17321732     *
    1733      * @since BuddyPress (2.1.0)
     1733     * @since 2.1.0
    17341734     *
    17351735     * @param bool $retval Whether or not the logged-in user is a mod.
    … …  
    17541754     * Filters whether or not user is on a component directory page.
    17551755     *
    1756      * @since BuddyPress (2.1.0)
     1756     * @since 2.1.0
    17571757     *
    17581758     * @param bool $retval Whether or not user is on a component directory page.
    … …  
    17961796     * Filters whether or not a component's URL should be in the root, not under a member page.
    17971797     *
    1798      * @since BuddyPress (2.1.0)
     1798     * @since 2.1.0
    17991799     *
    18001800     * @param bool $retval Whether or not URL should be in the root.
    … …  
    18081808 * Corresponds to the setting in wp-admin's Settings > Reading screen.
    18091809 *
    1810  * @since BuddyPress (1.5.0)
     1810 * @since 1.5.0
    18111811 *
    18121812 * @global int $current_blog WordPress global for the current blog.
    … …  
    18441844     * Filters whether or not the specified BuddyPress component directory is set to be the front page.
    18451845     *
    1846      * @since BuddyPress (1.5.0)
     1846     * @since 1.5.0
    18471847     *
    18481848     * @param bool   $value     Whether or not the specified component directory is set as front page.
    … …  
    18741874     * Filters whether or not current page is a blog page or not.
    18751875     *
    1876      * @since BuddyPress (1.5.0)
     1876     * @since 1.5.0
    18771877     *
    18781878     * @param bool $is_blog_page Whether or not current page is a blog page.
    … …  
    18911891 * is unset. Thus the addition of the bp_is_user() check.
    18921892 *
    1893  * @since BuddyPress (1.7.0)
     1893 * @since 1.7.0
    18941894 *
    18951895 * @return bool True if it's a BuddyPress page, false otherwise.
    … …  
    19011901     * Filters whether or not this is a BuddyPress component.
    19021902     *
    1903      * @since BuddyPress (1.7.0)
     1903     * @since 1.7.0
    19041904     *
    19051905     * @param bool $retval Whether or not this is a BuddyPress component.
    … …  
    19131913 * Check whether a given component (or feature of a component) is active.
    19141914 *
    1915  * @since BuddyPress (1.2.0) See r2539.
    1916  * @since BuddyPress (2.3.0) Added $feature as a parameter.
     1915 * @since 1.2.0 See r2539.
     1916 * @since 2.3.0 Added $feature as a parameter.
    19171917 *
    19181918 * @param string $component The component name.
    … …  
    19451945             * that you are checking of active status of.
    19461946             *
    1947              * @since BuddyPress (2.3.0)
     1947             * @since 2.3.0
    19481948             *
    19491949             * @param bool $retval
    … …  
    19561956     * Filters whether or not a given component has been activated by the admin.
    19571957     *
    1958      * @since BuddyPress (2.1.0)
     1958     * @since 2.1.0
    19591959     *
    19601960     * @param bool   $retval    Whether or not a given component has been activated by the admin.
    … …  
    20392039 * Check whether the current page is part of the Notifications component.
    20402040 *
    2041  * @since BuddyPress (1.9.0)
     2041 * @since 1.9.0
    20422042 *
    20432043 * @return bool True if the current page is part of the Notifications component.
    … …  
    20862086 * Is the current page the activity directory?
    20872087 *
    2088  * @since BuddyPress (2.0.0)
     2088 * @since 2.0.0
    20892089 *
    20902090 * @return True if the current page is the activity directory.
    … …  
    21122112 * Is the current page the members directory?
    21132113 *
    2114  * @since BuddyPress (2.0.0)
     2114 * @since 2.0.0
    21152115 *
    21162116 * @return True if the current page is the members directory.
    … …  
    21422142     * Filters whether or not current page is part of the profile for the logged-in user.
    21432143     *
    2144      * @since BuddyPress (1.2.4)
     2144     * @since 1.2.4
    21452145     *
    21462146     * @param bool $my_profile Whether or not current page is part of the profile for the logged-in user.
    … …  
    22722272 * Eg http://example.com/members/joe/forums/topics/.
    22732273 *
    2274  * @since BuddyPress (1.5.0)
     2274 * @since 1.5.0
    22752275 *
    22762276 * @return bool True if the current page is a user's Topics Started page.
    … …  
    22852285 * Eg http://example.com/members/joe/forums/replies/.
    22862286 *
    2287  * @since BuddyPress (1.5.0)
     2287 * @since 1.5.0
    22882288 *
    22892289 * @return bool True if the current page is a user's Replied To forums page.
    … …  
    23642364 * Eg http://example.com/members/joe/notifications/ (or a subpage thereof).
    23652365 *
    2366  * @since BuddyPress (1.9.0)
     2366 * @since 1.9.0
    23672367 *
    23682368 * @return bool True if the current page is a user's Notifications page.
    … …  
    23882388 * Eg http://example.com/members/joe/settings/general/.
    23892389 *
    2390  * @since BuddyPress (1.5.0)
     2390 * @since 1.5.0
    23912391 *
    23922392 * @return bool True if the current page is a user's General Settings page.
    … …  
    24012401 * Eg http://example.com/members/joe/settings/notifications/.
    24022402 *
    2403  * @since BuddyPress (1.5.0)
     2403 * @since 1.5.0
    24042404 *
    24052405 * @return bool True if the current page is a user's Notification Settings page.
    … …  
    24142414 * Eg http://example.com/members/joe/settings/delete-account/.
    24152415 *
    2416  * @since BuddyPress (1.5.0)
     2416 * @since 1.5.0
    24172417 *
    24182418 * @return bool True if the current page is a user's Delete Account page.
    … …  
    24272427 * Eg http://example.com/members/joe/settings/profile/.
    24282428 *
    2429  * @since BuddyPress (2.0.0)
     2429 * @since 2.0.0
    24302430 *
    24312431 * @return bool True if the current page is a user's Profile Settings page.
    … …  
    24402440 * Is the current page the groups directory ?
    24412441 *
    2442  * @since BuddyPress (2.0.0)
     2442 * @since 2.0.0
    24432443 *
    24442444 * @return True if the current page is the groups directory.
    … …  
    26292629 * Is the current page the blogs directory ?
    26302630 *
    2631  * @since BuddyPress (2.0.0)
     2631 * @since 2.0.0
    26322632 *
    26332633 * @return True if the current page is the blogs directory.
    … …  
    29772977         * Filters the BuddyPress classes to be added to body_class()
    29782978         *
    2979          * @since BuddyPress (1.1.0)
     2979         * @since 1.1.0
    29802980         *
    29812981         * @param array $classes        Array of body classes to add.
    … …  
    29932993 * Hooked to the 'post_class' filter.
    29942994 *
    2995  * @since BuddyPress (2.1.0)
     2995 * @since 2.1.0
    29962996 *
    29972997 * @param array $wp_classes The post classes coming from WordPress.
    … …  
    30573057 *
    30583058 * @access private
    3059  * @since BuddyPress (1.7.0)
     3059 * @since 1.7.0
    30603060 *
    30613061 * @param array $a First item.
    … …  
    30793079 * Get the items registered in the primary and secondary BuddyPress navigation menus.
    30803080 *
    3081  * @since BuddyPress (1.7.0)
     3081 * @since 1.7.0
    30823082 *
    30833083 * @return array A multidimensional array of all navigation items.
    … …  
    31583158     * Filters the items registered in the primary and secondary BuddyPress navigation menus.
    31593159     *
    3160      * @since BuddyPress (1.7.0)
     3160     * @since 1.7.0
    31613161     *
    31623162     * @param array $menus Array of items registered in the primary and secondary BuddyPress navigation.
    … …  
    31683168 * Display a navigation menu.
    31693169 *
    3170  * @since BuddyPress (1.7.0)
     3170 * @since 1.7.0
    31713171 *
    31723172 * @param string|array $args {
    … …  
    32273227     * Filters the parsed bp_nav_menu arguments.
    32283228     *
    3229      * @since BuddyPress (1.7.0)
     3229     * @since 1.7.0
    32303230     *
    32313231     * @param array $args Array of parsed arguments.
    … …  
    32523252         * Filters the allowed tags for the wp_nav_menu_container.
    32533253         *
    3254          * @since BuddyPress (1.7.0)
     3254         * @since 1.7.0
    32553255         *
    32563256         * @param array $value Array of allowed tags. Default 'div' and 'nav'.
    … …  
    32703270     * Filters the BuddyPress menu objects.
    32713271     *
    3272      * @since BuddyPress (1.7.0)
     3272     * @since 1.7.0
    32733273     *
    32743274     * @param array $value Array of nav menu objects.
    … …  
    33023302     * Allow plugins to hook into the menu to add their own <li>'s
    33033303     *
    3304      * @since BuddyPress (1.7.0)
     3304     * @since 1.7.0
    33053305     *
    33063306     * @param array $items Array of nav menu items.
    … …  
    33223322     * Filters the final BuddyPress menu output.
    33233323     *
    3324      * @since BuddyPress (1.7.0)
     3324     * @since 1.7.0
    33253325     *
    33263326     * @param string $nav_menu Final nav menu output.

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

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Core Theme Compatibility.
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    … …  
    3231 * extending this class.
    3332 *
    34  * @since BuddyPress (1.7.0)
     33 * @since 1.7.0
    3534 *
    3635 * @todo We should probably do something similar to BP_Component::start().
    … …  
    6059     * Pass the $properties to the object on creation.
    6160     *
    62      * @since BuddyPress (1.7.0)
     61     * @since 1.7.0
    6362     *
    6463     * @param array $properties Array of properties for BP_Theme_Compat.
    … …  
    7372     * Themes should use this method in their constructor.
    7473     *
    75      * @since BuddyPress (1.7.0)
     74     * @since 1.7.0
    7675     */
    7776    protected function start() {
    … …  
    9291     * {@link BP_Legacy::setup_globals()} for an example.
    9392     *
    94      * @since BuddyPress (1.7.0)
     93     * @since 1.7.0
    9594     */
    9695    protected function setup_globals() {}
    … …  
    102101     * {@link BP_Legacy::setup_actions()} for an example.
    103102     *
    104      * @since BuddyPress (1.7.0)
     103     * @since 1.7.0
    105104     */
    106105    protected function setup_actions() {}
    … …  
    109108     * Set a theme's property.
    110109     *
    111      * @since BuddyPress (1.7.0)
     110     * @since 1.7.0
    112111     *
    113112     * @param string $property Property name.
    … …  
    123122     * Get a theme's property.
    124123     *
    125      * @since BuddyPress (1.7.0)
     124     * @since 1.7.0
    126125     *
    127126     * @param string $property Property name.
    … …  
    140139 * Set up the default theme compat theme.
    141140 *
    142  * @since BuddyPress (1.7.0)
     141 * @since 1.7.0
    143142 *
    144143 * @param string $theme Optional. The unique ID identifier of a theme package.
    … …  
    162161 * default and include their own BuddyPress compatibility layers for their themes.
    163162 *
    164  * @since BuddyPress (1.7.0)
     163 * @since 1.7.0
    165164 *
    166165 * @uses apply_filters()
    … …  
    173172     * Filters the ID of the theme package being used.
    174173     *
    175      * @since BuddyPress (1.7.0)
     174     * @since 1.7.0
    176175     *
    177176     * @param string $id ID of the theme package in use.
    … …  
    186185 * default and include their own BuddyPress compatibility layers for their themes.
    187186 *
    188  * @since BuddyPress (1.7.0)
     187 * @since 1.7.0
    189188 *
    190189 * @uses apply_filters()
    … …  
    197196     * Filters the name of the theme package being used.
    198197     *
    199      * @since BuddyPress (1.7.0)
     198     * @since 1.7.0
    200199     *
    201200     * @param string $name Name of the theme package in use.
    … …  
    210209 * default and include their own BuddyPress compatibility layers for their themes.
    211210 *
    212  * @since BuddyPress (1.7.0)
     211 * @since 1.7.0
    213212 *
    214213 * @uses apply_filters()
    … …  
    221220     * Filters the version of the theme package being used.
    222221     *
    223      * @since BuddyPress (1.7.0)
     222     * @since 1.7.0
    224223     *
    225224     * @param string $version The version string of the theme package in use.
    … …  
    234233 * their own BuddyPress compatibility layers for their themes.
    235234 *
    236  * @since BuddyPress (1.7.0)
     235 * @since 1.7.0
    237236 *
    238237 * @uses apply_filters()
    … …  
    245244     * Filters the absolute path of the theme package being used.
    246245     *
    247      * @since BuddyPress (1.7.0)
     246     * @since 1.7.0
    248247     *
    249248     * @param string $dir The absolute path of the theme package in use.
    … …  
    259258 * themes.
    260259 *
    261  * @since BuddyPress (1.7.0)
     260 * @since 1.7.0
    262261 *
    263262 * @uses apply_filters()
    … …  
    270269     * Filters the URL of the theme package being used.
    271270     *
    272      * @since BuddyPress (1.7.0)
     271     * @since 1.7.0
    273272     *
    274273     * @param string $url URL of the theme package in use.
    … …  
    283282 * do so using bp_detect_theme_compat_with_current_theme().
    284283 *
    285  * @since BuddyPress (1.9.0)
     284 * @since 1.9.0
    286285 *
    287286 * @uses bp_detect_theme_compat_with_current_theme()
    … …  
    297296     * Filters whether or not to use theme compat for the active theme.
    298297     *
    299      * @since BuddyPress (1.9.0)
     298     * @since 1.9.0
    300299     *
    301300     * @param bool $use_with_current_theme True if the current theme needs theme compatibility.
    … …  
    316315 *    presence as an indicator that theme compatibility is not required
    317316 *
    318  * @since BuddyPress (1.9.0)
     317 * @since 1.9.0
    319318 *
    320319 * @return bool True if the current theme needs theme compatibility.
    … …  
    354353 * Is the current page using theme compatibility?
    355354 *
    356  * @since BuddyPress (1.7.0)
     355 * @since 1.7.0
    357356 *
    358357 * @return bool True if the current page uses theme compatibility.
    … …  
    371370 * Set the flag that tells whether the current page is using theme compatibility.
    372371 *
    373  * @since BuddyPress (1.7.0)
     372 * @since 1.7.0
    374373 *
    375374 * @param bool $set True to set the flag to true, false to set it to false.
    … …  
    389388 * to override them, or see what files are being scanned for inclusion.
    390389 *
    391  * @since BuddyPress (1.7.0)
     390 * @since 1.7.0
    392391 *
    393392 * @param array $templates The template stack.
    … …  
    407406 * to override it, or see what file is being included.
    408407 *
    409  * @since BuddyPress (1.7.0)
     408 * @since 1.7.0
    410409 *
    411410 * @param string $template The template currently in use.
    … …  
    425424 * if BuddyPress was able to find a more appropriate template.
    426425 *
    427  * @since BuddyPress (1.7.0)
     426 * @since 1.7.0
    428427 *
    429428 * @param string $template The template originally selected by WP.
    … …  
    440439 * Check whether a given template is the one that WP originally selected to display current page.
    441440 *
    442  * @since BuddyPress (1.7.0)
     441 * @since 1.7.0
    443442 *
    444443 * @param string $template The template name to check.
    … …  
    463462 * {@link BuddyPress::register_theme_packages()}.
    464463 *
    465  * @since BuddyPress (1.7.0)
     464 * @since 1.7.0
    466465 *
    467466 * @see BP_Theme_Compat for a description of the $theme parameter arguments.
    … …  
    501500 * that template functions - things like is_page() - don't throw errors.
    502501 *
    503  * @since BuddyPress (1.7.0)
     502 * @since 1.7.0
    504503 *
    505504 * @global WP_Query $wp_query WordPress database access object.
    … …  
    623622 * Reset main query vars and filter 'the_content' to output a BuddyPress template part as needed.
    624623 *
    625  * @since BuddyPress (1.7.0)
     624 * @since 1.7.0
    626625 *
    627626 * @uses bp_is_single_user() To check if page is single user.
    … …  
    661660     * with some other template part.
    662661     *
    663      * @since BuddyPress (1.7.0)
     662     * @since 1.7.0
    664663     */
    665664    do_action( 'bp_template_include_reset_dummy_post_data' );
    … …  
    701700     * Filters the template name to include.
    702701     *
    703      * @since BuddyPress (1.7.0)
     702     * @since 1.7.0
    704703     *
    705704     * @param string $template Template name.
    … …  
    715714 * exist in the currently active theme.
    716715 *
    717  * @since BuddyPress (1.7.0)
     716 * @since 1.7.0
    718717 *
    719718 * @param string $content Original post content.
    … …  
    735734     * Filters the content to replace in the post.
    736735     *
    737      * @since BuddyPress (1.7.0)
     736     * @since 1.7.0
    738737     *
    739738     * @param string $content Original post content.
    … …  
    761760 * Are we currently replacing the_content?
    762761 *
    763  * @since BuddyPress (1.8.0)
     762 * @since 1.8.0
    764763 *
    765764 * @return bool True if the_content is currently in the process of being
    … …  
    778777 * restored later.
    779778 *
    780  * @since BuddyPress (1.7.0)
     779 * @since 1.7.0
    781780 *
    782781 * @global WP_filter $wp_filter
    … …  
    834833 * Restore filters that were removed using bp_remove_all_filters().
    835834 *
    836  * @since BuddyPress (1.7.0)
     835 * @since 1.7.0
    837836 *
    838837 * @global WP_filter $wp_filter
    … …  
    890889 * Force comments_status to 'closed' for BuddyPress post types.
    891890 *
    892  * @since BuddyPress (1.7.0)
     891 * @since 1.7.0
    893892 *
    894893 * @param bool $open    True if open, false if closed.
    … …  
    904903     * Filters whether or not to force comments_status to closed for BuddyPress post types.
    905904     *
    906      * @since BuddyPress (1.7.0)
     905     * @since 1.7.0
    907906     *
    908907     * @param bool $retval  Whether or not we are on a BuddyPress post type.
    … …  
    927926 * wonkiness.
    928927 *
    929  * @since BuddyPress (1.9.2)
     928 * @since 1.9.2
    930929 *
    931930 * @param string $retval The current post content.
    … …  
    948947 * Restores the 'is_single' and 'is_page' flags if toggled by BuddyPress.
    949948 *
    950  * @since BuddyPress (1.9.2)
     949 * @since 1.9.2
    951950 *
    952951 * @see bp_theme_compat_toggle_is_page()

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

    r10012 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Updater.
    … …  
    1615 * If there is no raw DB version, we infer that this is the first installation.
    1716 *
    18  * @since BuddyPress (1.7.0)
     17 * @since 1.7.0
    1918 *
    2019 * @uses get_option()
    … …  
    2423 */
    2524function bp_is_install() {
    26     return ! bp_get_db_version_raw();
     25    return ! bp_get_db_version_raw();
    2726}
    2827
    … …  
    3433 * an update.
    3534 *
    36  * @since BuddyPress (1.6.0)
     35 * @since 1.6.0
    3736 *
    3837 * @uses get_option()
    … …  
    4342function bp_is_update() {
    4443
    45     // Current DB version of this site (per site in a multisite network)
    46     $current_db   = bp_get_option( '_bp_db_version' );
    47     $current_live = bp_get_db_version();
    48 
    49     // Compare versions (cast as int and bool to be safe)
    50     $is_update = (bool) ( (int) $current_db < (int) $current_live );
    51 
    52     // Return the product of version comparison
    53     return $is_update;
     44    // Current DB version of this site (per site in a multisite network)
     45    $current_db   = bp_get_option( '_bp_db_version' );
     46    $current_live = bp_get_db_version();
     47
     48    // Compare versions (cast as int and bool to be safe)
     49    $is_update = (bool) ( (int) $current_db < (int) $current_live );
     50
     51    // Return the product of version comparison
     52    return $is_update;
    5453}
    5554
    … …  
    5756 * Determine whether BuddyPress is in the process of being activated.
    5857 *
    59  * @since BuddyPress (1.6.0)
     58 * @since 1.6.0
    6059 *
    6160 * @uses buddypress()
    … …  
    6665 */
    6766function bp_is_activation( $basename = '' ) {
    68     $bp     = buddypress();
    69     $action = false;
    70 
    71     if ( ! empty( $_REQUEST['action'] ) && ( '-1' != $_REQUEST['action'] ) ) {
    72         $action = $_REQUEST['action'];
    73     } elseif ( ! empty( $_REQUEST['action2'] ) && ( '-1' != $_REQUEST['action2'] ) ) {
    74         $action = $_REQUEST['action2'];
    75     }
    76 
    77     // Bail if not activating
    78     if ( empty( $action ) || !in_array( $action, array( 'activate', 'activate-selected' ) ) ) {
    79         return false;
    80     }
    81 
    82     // The plugin(s) being activated
    83     if ( $action == 'activate' ) {
    84         $plugins = isset( $_GET['plugin'] ) ? array( $_GET['plugin'] ) : array();
    85     } else {
    86         $plugins = isset( $_POST['checked'] ) ? (array) $_POST['checked'] : array();
    87     }
    88 
    89     // Set basename if empty
    90     if ( empty( $basename ) && !empty( $bp->basename ) ) {
    91         $basename = $bp->basename;
    92     }
    93 
    94     // Bail if no basename
    95     if ( empty( $basename ) ) {
    96         return false;
    97     }
    98 
    99     // Is BuddyPress being activated?
    100     return in_array( $basename, $plugins );
     67    $bp     = buddypress();
     68    $action = false;
     69
     70    if ( ! empty( $_REQUEST['action'] ) && ( '-1' != $_REQUEST['action'] ) ) {
     71        $action = $_REQUEST['action'];
     72    } elseif ( ! empty( $_REQUEST['action2'] ) && ( '-1' != $_REQUEST['action2'] ) ) {
     73        $action = $_REQUEST['action2'];
     74    }
     75
     76    // Bail if not activating
     77    if ( empty( $action ) || !in_array( $action, array( 'activate', 'activate-selected' ) ) ) {
     78        return false;
     79    }
     80
     81    // The plugin(s) being activated
     82    if ( $action == 'activate' ) {
     83        $plugins = isset( $_GET['plugin'] ) ? array( $_GET['plugin'] ) : array();
     84    } else {
     85        $plugins = isset( $_POST['checked'] ) ? (array) $_POST['checked'] : array();
     86    }
     87
     88    // Set basename if empty
     89    if ( empty( $basename ) && !empty( $bp->basename ) ) {
     90        $basename = $bp->basename;
     91    }
     92
     93    // Bail if no basename
     94    if ( empty( $basename ) ) {
     95        return false;
     96    }
     97
     98    // Is BuddyPress being activated?
     99    return in_array( $basename, $plugins );
    101100}
    102101
    … …  
    104103 * Determine whether BuddyPress is in the process of being deactivated.
    105104 *
    106  * @since BuddyPress (1.6.0)
     105 * @since 1.6.0
    107106 *
    108107 * @uses buddypress()
    … …  
    113112 */
    114113function bp_is_deactivation( $basename = '' ) {
    115     $bp     = buddypress();
    116     $action = false;
    117 
    118     if ( ! empty( $_REQUEST['action'] ) && ( '-1' != $_REQUEST['action'] ) ) {
    119         $action = $_REQUEST['action'];
    120     } elseif ( ! empty( $_REQUEST['action2'] ) && ( '-1' != $_REQUEST['action2'] ) ) {
    121         $action = $_REQUEST['action2'];
    122     }
    123 
    124     // Bail if not deactivating
    125     if ( empty( $action ) || !in_array( $action, array( 'deactivate', 'deactivate-selected' ) ) ) {
    126         return false;
    127     }
    128 
    129     // The plugin(s) being deactivated
    130     if ( 'deactivate' == $action ) {
    131         $plugins = isset( $_GET['plugin'] ) ? array( $_GET['plugin'] ) : array();
    132     } else {
    133         $plugins = isset( $_POST['checked'] ) ? (array) $_POST['checked'] : array();
    134     }
    135 
    136     // Set basename if empty
    137     if ( empty( $basename ) && !empty( $bp->basename ) ) {
    138         $basename = $bp->basename;
    139     }
    140 
    141     // Bail if no basename
    142     if ( empty( $basename ) ) {
    143         return false;
    144     }
    145 
    146     // Is bbPress being deactivated?
    147     return in_array( $basename, $plugins );
     114    $bp     = buddypress();
     115    $action = false;
     116
     117    if ( ! empty( $_REQUEST['action'] ) && ( '-1' != $_REQUEST['action'] ) ) {
     118        $action = $_REQUEST['action'];
     119    } elseif ( ! empty( $_REQUEST['action2'] ) && ( '-1' != $_REQUEST['action2'] ) ) {
     120        $action = $_REQUEST['action2'];
     121    }
     122
     123    // Bail if not deactivating
     124    if ( empty( $action ) || !in_array( $action, array( 'deactivate', 'deactivate-selected' ) ) ) {
     125        return false;
     126    }
     127
     128    // The plugin(s) being deactivated
     129    if ( 'deactivate' == $action ) {
     130        $plugins = isset( $_GET['plugin'] ) ? array( $_GET['plugin'] ) : array();
     131    } else {
     132        $plugins = isset( $_POST['checked'] ) ? (array) $_POST['checked'] : array();
     133    }
     134
     135    // Set basename if empty
     136    if ( empty( $basename ) && !empty( $bp->basename ) ) {
     137        $basename = $bp->basename;
     138    }
     139
     140    // Bail if no basename
     141    if ( empty( $basename ) ) {
     142        return false;
     143    }
     144
     145    // Is bbPress being deactivated?
     146    return in_array( $basename, $plugins );
    148147}
    149148
    … …  
    151150 * Update the BP version stored in the database to the current version.
    152151 *
    153  * @since BuddyPress (1.6.0)
     152 * @since 1.6.0
    154153 *
    155154 * @uses bp_get_db_version() To get BuddyPress's database version.
    … …  
    157156 */
    158157function bp_version_bump() {
    159     bp_update_option( '_bp_db_version', bp_get_db_version() );
     158    bp_update_option( '_bp_db_version', bp_get_db_version() );
    160159}
    161160
    … …  
    163162 * Set up the BuddyPress updater.
    164163 *
    165  * @since BuddyPress (1.6.0)
     164 * @since 1.6.0
    166165 */
    167166function bp_setup_updater() {
    168167
    169     // Are we running an outdated version of BuddyPress?
    170     if ( ! bp_is_update() ) {
    171         return;
    172     }
    173 
    174     bp_version_updater();
     168    // Are we running an outdated version of BuddyPress?
     169    if ( ! bp_is_update() ) {
     170        return;
     171    }
     172
     173    bp_version_updater();
    175174}
    176175
    … …  
    185184 * to correct issues with BuddyPress metadata silently on software update.
    186185 *
    187  * @since BuddyPress (1.7.0)
     186 * @since 1.7.0
    188187 */
    189188function bp_version_updater() {
    190189
    191     // Get the raw database version
    192     $raw_db_version = (int) bp_get_db_version_raw();
    193 
    194     /**
    195     * Filters the default components to activate for a new install.
    196     *
    197      * @since BuddyPress (1.7.0)
    198     *
    199     * @param array $value Array of default components to activate.
    200     */
    201     $default_components = apply_filters( 'bp_new_install_default_components', array(
    202         'activity'      => 1,
    203         'members'       => 1,
    204         'settings'      => 1,
    205         'xprofile'      => 1,
    206         'notifications' => 1,
    207     ) );
    208 
    209     require_once( buddypress()->plugin_dir . '/bp-core/admin/bp-core-admin-schema.php' );
    210 
    211     // Install BP schema and activate only Activity and XProfile
    212     if ( bp_is_install() ) {
    213 
    214         // Apply schema and set Activity and XProfile components as active
    215         bp_core_install( $default_components );
    216         bp_update_option( 'bp-active-components', $default_components );
    217         bp_core_add_page_mappings( $default_components, 'delete' );
    218 
    219     // Upgrades
    220     } else {
    221 
    222         // Run the schema install to update tables
    223         bp_core_install();
    224 
    225         // 1.5.0
    226         if ( $raw_db_version < 1801 ) {
    227             bp_update_to_1_5();
    228             bp_core_add_page_mappings( $default_components, 'delete' );
    229         }
    230 
    231         // 1.6.0
    232         if ( $raw_db_version < 6067 ) {
    233             bp_update_to_1_6();
    234         }
    235 
    236         // 1.9.0
    237         if ( $raw_db_version < 7553 ) {
    238             bp_update_to_1_9();
    239         }
    240 
    241         // 1.9.2
    242         if ( $raw_db_version < 7731 ) {
    243             bp_update_to_1_9_2();
    244         }
    245 
    246         // 2.0.0
    247         if ( $raw_db_version < 7892 ) {
    248             bp_update_to_2_0();
    249         }
    250 
    251         // 2.0.1
    252         if ( $raw_db_version < 8311 ) {
    253             bp_update_to_2_0_1();
    254         }
    255 
    256         // 2.2.0
    257         if ( $raw_db_version < 9181 ) {
    258             bp_update_to_2_2();
    259         }
    260 
    261         // 2.3.0
    262         if ( $raw_db_version < 9615 ) {
    263             bp_update_to_2_3();
    264         }
    265     }
    266 
    267     /** All done! *************************************************************/
    268 
    269     // Bump the version
    270     bp_version_bump();
     190    // Get the raw database version
     191    $raw_db_version = (int) bp_get_db_version_raw();
     192
     193    /**
     194    * Filters the default components to activate for a new install.
     195    *
     196     * @since 1.7.0
     197    *
     198    * @param array $value Array of default components to activate.
     199    */
     200    $default_components = apply_filters( 'bp_new_install_default_components', array(
     201        'activity'      => 1,
     202        'members'       => 1,
     203        'settings'      => 1,
     204        'xprofile'      => 1,
     205        'notifications' => 1,
     206    ) );
     207
     208    require_once( buddypress()->plugin_dir . '/bp-core/admin/bp-core-admin-schema.php' );
     209
     210    // Install BP schema and activate only Activity and XProfile
     211    if ( bp_is_install() ) {
     212
     213        // Apply schema and set Activity and XProfile components as active
     214        bp_core_install( $default_components );
     215        bp_update_option( 'bp-active-components', $default_components );
     216        bp_core_add_page_mappings( $default_components, 'delete' );
     217
     218    // Upgrades
     219    } else {
     220
     221        // Run the schema install to update tables
     222        bp_core_install();
     223
     224        // 1.5.0
     225        if ( $raw_db_version < 1801 ) {
     226            bp_update_to_1_5();
     227            bp_core_add_page_mappings( $default_components, 'delete' );
     228        }
     229
     230        // 1.6.0
     231        if ( $raw_db_version < 6067 ) {
     232            bp_update_to_1_6();
     233        }
     234
     235        // 1.9.0
     236        if ( $raw_db_version < 7553 ) {
     237            bp_update_to_1_9();
     238        }
     239
     240        // 1.9.2
     241        if ( $raw_db_version < 7731 ) {
     242            bp_update_to_1_9_2();
     243        }
     244
     245        // 2.0.0
     246        if ( $raw_db_version < 7892 ) {
     247            bp_update_to_2_0();
     248        }
     249
     250        // 2.0.1
     251        if ( $raw_db_version < 8311 ) {
     252            bp_update_to_2_0_1();
     253        }
     254
     255        // 2.2.0
     256        if ( $raw_db_version < 9181 ) {
     257            bp_update_to_2_2();
     258        }
     259
     260        // 2.3.0
     261        if ( $raw_db_version < 9615 ) {
     262            bp_update_to_2_3();
     263        }
     264    }
     265
     266    /** All done! *************************************************************/
     267
     268    // Bump the version
     269    bp_version_bump();
    271270}
    272271
    … …  
    276275 * `dbDelta()` cannot handle certain operations - like changing indexes - so we do it here instead.
    277276 *
    278  * @since BuddyPress (2.3.0)
     277 * @since 2.3.0
    279278 */
    280279function bp_pre_schema_upgrade() {
    281     global $wpdb;
    282 
    283     $raw_db_version = (int) bp_get_db_version_raw();
    284     $bp_prefix      = bp_core_get_table_prefix();
    285 
    286     // 2.3.0: Change index lengths to account for utf8mb4.
    287     if ( $raw_db_version < 9695 ) {
    288         // table_name => columns.
    289         $tables = array(
    290             $bp_prefix . 'bp_activity_meta'       => array( 'meta_key' ),
    291             $bp_prefix . 'bp_groups_groupmeta'    => array( 'meta_key' ),
    292             $bp_prefix . 'bp_messages_meta'       => array( 'meta_key' ),
    293             $bp_prefix . 'bp_notifications_meta'  => array( 'meta_key' ),
    294             $bp_prefix . 'bp_user_blogs_blogmeta' => array( 'meta_key' ),
    295             $bp_prefix . 'bp_xprofile_meta'       => array( 'meta_key' ),
    296         );
    297 
    298         foreach ( $tables as $table_name => $indexes ) {
    299             foreach ( $indexes as $index ) {
    300                 if ( $wpdb->query( $wpdb->prepare( "SHOW TABLES LIKE %s", bp_esc_like( $table_name ) ) ) ) {
    301                     $wpdb->query( "ALTER TABLE {$table_name} DROP INDEX {$index}" );
    302                 }
    303             }
    304         }
    305     }
     280    global $wpdb;
     281
     282    $raw_db_version = (int) bp_get_db_version_raw();
     283    $bp_prefix      = bp_core_get_table_prefix();
     284
     285    // 2.3.0: Change index lengths to account for utf8mb4.
     286    if ( $raw_db_version < 9695 ) {
     287        // table_name => columns.
     288        $tables = array(
     289            $bp_prefix . 'bp_activity_meta'       => array( 'meta_key' ),
     290            $bp_prefix . 'bp_groups_groupmeta'    => array( 'meta_key' ),
     291            $bp_prefix . 'bp_messages_meta'       => array( 'meta_key' ),
     292            $bp_prefix . 'bp_notifications_meta'  => array( 'meta_key' ),
     293            $bp_prefix . 'bp_user_blogs_blogmeta' => array( 'meta_key' ),
     294            $bp_prefix . 'bp_xprofile_meta'       => array( 'meta_key' ),
     295        );
     296
     297        foreach ( $tables as $table_name => $indexes ) {
     298            foreach ( $indexes as $index ) {
     299                if ( $wpdb->query( $wpdb->prepare( "SHOW TABLES LIKE %s", bp_esc_like( $table_name ) ) ) ) {
     300                    $wpdb->query( "ALTER TABLE {$table_name} DROP INDEX {$index}" );
     301                }
     302            }
     303        }
     304    }
    306305}
    307306
    … …  
    313312 * Database update methods based on version numbers.
    314313 *
    315  * @since BuddyPress (1.7.0)
     314 * @since 1.7.0
    316315 */
    317316function bp_update_to_1_5() {
    318317
    319     // Delete old database version options
    320     delete_site_option( 'bp-activity-db-version' );
    321     delete_site_option( 'bp-blogs-db-version'    );
    322     delete_site_option( 'bp-friends-db-version'  );
    323     delete_site_option( 'bp-groups-db-version'   );
    324     delete_site_option( 'bp-messages-db-version' );
    325     delete_site_option( 'bp-xprofile-db-version' );
     318    // Delete old database version options
     319    delete_site_option( 'bp-activity-db-version' );
     320    delete_site_option( 'bp-blogs-db-version'    );
     321    delete_site_option( 'bp-friends-db-version'  );
     322    delete_site_option( 'bp-groups-db-version'   );
     323    delete_site_option( 'bp-messages-db-version' );
     324    delete_site_option( 'bp-xprofile-db-version' );
    326325}
    327326
    … …  
    331330 * Database update methods based on version numbers.
    332331 *
    333  * @since BuddyPress (1.7.0)
     332 * @since 1.7.0
    334333 */
    335334function bp_update_to_1_6() {
    336335
    337     // Delete possible site options
    338     delete_site_option( 'bp-db-version'       );
    339     delete_site_option( '_bp_db_version'      );
    340     delete_site_option( 'bp-core-db-version'  );
    341     delete_site_option( '_bp-core-db-version' );
    342 
    343     // Delete possible blog options
    344     delete_blog_option( bp_get_root_blog_id(), 'bp-db-version'       );
    345     delete_blog_option( bp_get_root_blog_id(), 'bp-core-db-version'  );
    346     delete_site_option( bp_get_root_blog_id(), '_bp-core-db-version' );
    347     delete_site_option( bp_get_root_blog_id(), '_bp_db_version'      );
     336    // Delete possible site options
     337    delete_site_option( 'bp-db-version'       );
     338    delete_site_option( '_bp_db_version'      );
     339    delete_site_option( 'bp-core-db-version'  );
     340    delete_site_option( '_bp-core-db-version' );
     341
     342    // Delete possible blog options
     343    delete_blog_option( bp_get_root_blog_id(), 'bp-db-version'       );
     344    delete_blog_option( bp_get_root_blog_id(), 'bp-core-db-version'  );
     345    delete_site_option( bp_get_root_blog_id(), '_bp-core-db-version' );
     346    delete_site_option( bp_get_root_blog_id(), '_bp_db_version'      );
    348347}
    349348
    … …  
    355354 * component to the active components option to retain existing functionality.
    356355 *
    357  * @since BuddyPress (1.9.0)
     356 * @since 1.9.0
    358357 */
    359358function bp_update_to_1_9() {
    360359
    361     // Setup hardcoded keys
    362     $active_components_key      = 'bp-active-components';
    363     $notifications_component_id = 'notifications';
    364 
    365     // Get the active components
    366     $active_components          = bp_get_option( $active_components_key );
    367 
    368     // Add notifications
    369     if ( ! in_array( $notifications_component_id, $active_components ) ) {
    370         $active_components[ $notifications_component_id ] = 1;
    371     }
    372 
    373     // Update the active components option
    374     bp_update_option( $active_components_key, $active_components );
     360    // Setup hardcoded keys
     361    $active_components_key      = 'bp-active-components';
     362    $notifications_component_id = 'notifications';
     363
     364    // Get the active components
     365    $active_components          = bp_get_option( $active_components_key );
     366
     367    // Add notifications
     368    if ( ! in_array( $notifications_component_id, $active_components ) ) {
     369        $active_components[ $notifications_component_id ] = 1;
     370    }
     371
     372    // Update the active components option
     373    bp_update_option( $active_components_key, $active_components );
    375374}
    376375
    … …  
    389388 * but legacy installations using the theme will continue to see it.
    390389 *
    391  * @since BuddyPress (1.9.2)
     390 * @since 1.9.2
    392391 */
    393392function bp_update_to_1_9_2() {
    394     if ( 'bp-default' === get_stylesheet() || 'bp-default' === get_template() ) {
    395         update_site_option( '_bp_retain_bp_default', 1 );
    396     }
     393    if ( 'bp-default' === get_stylesheet() || 'bp-default' === get_template() ) {
     394        update_site_option( '_bp_retain_bp_default', 1 );
     395    }
    397396}
    398397
    … …  
    404403 * - Add values for all BuddyPress options to the options table.
    405404 *
    406  * @since BuddyPress (2.0.0)
     405 * @since 2.0.0
    407406 */
    408407function bp_update_to_2_0() {
    409408
    410     /** Install activity tables for 'last_activity' ***************************/
    411 
    412     bp_core_install_activity_streams();
    413 
    414     /** Migrate 'last_activity' data ******************************************/
    415 
    416     bp_last_activity_migrate();
    417 
    418     /** Migrate signups data **************************************************/
    419 
    420     if ( ! is_multisite() ) {
    421 
    422         // Maybe install the signups table
    423         bp_core_maybe_install_signups();
    424 
    425         // Run the migration script
    426         bp_members_migrate_signups();
    427     }
    428 
    429     /** Add BP options to the options table ***********************************/
    430 
    431     bp_add_options();
     409    /** Install activity tables for 'last_activity' ***************************/
     410
     411    bp_core_install_activity_streams();
     412
     413    /** Migrate 'last_activity' data ******************************************/
     414
     415    bp_last_activity_migrate();
     416
     417    /** Migrate signups data **************************************************/
     418
     419    if ( ! is_multisite() ) {
     420
     421        // Maybe install the signups table
     422        bp_core_maybe_install_signups();
     423
     424        // Run the migration script
     425        bp_members_migrate_signups();
     426    }
     427
     428    /** Add BP options to the options table ***********************************/
     429
     430    bp_add_options();
    432431}
    433432
    … …  
    435434 * 2.0.1 database upgrade routine.
    436435 *
    437  * @since BuddyPress (2.0.1)
     436 * @since 2.0.1
    438437 *
    439438 * @return void
    … …  
    441440function bp_update_to_2_0_1() {
    442441
    443     // We purposely call this during both the 2.0 upgrade and the 2.0.1 upgrade.
    444     // Don't worry; it won't break anything, and safely handles all cases.
    445     bp_core_maybe_install_signups();
     442    // We purposely call this during both the 2.0 upgrade and the 2.0.1 upgrade.
     443    // Don't worry; it won't break anything, and safely handles all cases.
     444    bp_core_maybe_install_signups();
    446445}
    447446
    … …  
    453452 * - Clean up hidden friendship activities.
    454453 *
    455  * @since BuddyPress (2.2.0)
     454 * @since 2.2.0
    456455 */
    457456function bp_update_to_2_2() {
    458457
    459     // Also handled by `bp_core_install()`
    460     if ( bp_is_active( 'messages' ) ) {
    461         bp_core_install_private_messaging();
    462     }
    463 
    464     if ( bp_is_active( 'activity' ) ) {
    465         bp_migrate_new_member_activity_component();
    466 
    467         if ( bp_is_active( 'friends' ) ) {
    468             bp_cleanup_friendship_activities();
    469         }
    470     }
     458    // Also handled by `bp_core_install()`
     459    if ( bp_is_active( 'messages' ) ) {
     460        bp_core_install_private_messaging();
     461    }
     462
     463    if ( bp_is_active( 'activity' ) ) {
     464        bp_migrate_new_member_activity_component();
     465
     466        if ( bp_is_active( 'friends' ) ) {
     467            bp_cleanup_friendship_activities();
     468        }
     469    }
    471470}
    472471
    … …  
    476475 * - Add notifications meta table.
    477476 *
    478  * @since BuddyPress (2.3.0)
     477 * @since 2.3.0
    479478 */
    480479function bp_update_to_2_3() {
    481480
    482     // Also handled by `bp_core_install()`
    483     if ( bp_is_active( 'notifications' ) ) {
    484         bp_core_install_notifications();
    485     }
     481    // Also handled by `bp_core_install()`
     482    if ( bp_is_active( 'notifications' ) ) {
     483        bp_core_install_notifications();
     484    }
    486485}
    487486
    … …  
    489488 * Updates the component field for new_members type.
    490489 *
    491  * @since BuddyPress (2.2.0)
     490 * @since 2.2.0
    492491 *
    493492 * @global $wpdb
    … …  
    496495 */
    497496function bp_migrate_new_member_activity_component() {
    498     global $wpdb;
    499     $bp = buddypress();
    500 
    501     // Update the component for the new_member type
    502     $wpdb->update(
    503         // Activity table
    504         $bp->members->table_name_last_activity,
    505         array(
    506             'component' => $bp->members->id,
    507         ),
    508         array(
    509             'component' => 'xprofile',
    510             'type'      => 'new_member',
    511         ),
    512         // Data sanitization format
    513         array(
    514             '%s',
    515         ),
    516         // WHERE sanitization format
    517         array(
    518             '%s',
    519             '%s'
    520         )
    521     );
     497    global $wpdb;
     498    $bp = buddypress();
     499
     500    // Update the component for the new_member type
     501    $wpdb->update(
     502        // Activity table
     503        $bp->members->table_name_last_activity,
     504        array(
     505            'component' => $bp->members->id,
     506        ),
     507        array(
     508            'component' => 'xprofile',
     509            'type'      => 'new_member',
     510        ),
     511        // Data sanitization format
     512        array(
     513            '%s',
     514        ),
     515        // WHERE sanitization format
     516        array(
     517            '%s',
     518            '%s'
     519        )
     520    );
    522521}
    523522
    … …  
    525524 * Remove all hidden friendship activities.
    526525 *
    527  * @since BuddyPress (2.2.0)
     526 * @since 2.2.0
    528527 *
    529528 * @uses bp_activity_delete() to delete the corresponding friendship activities.
    530529 */
    531530function bp_cleanup_friendship_activities() {
    532     bp_activity_delete( array(
    533         'component'     => buddypress()->friends->id,
    534         'type'          => 'friendship_created',
    535         'hide_sitewide' => true,
    536     ) );
     531    bp_activity_delete( array(
     532        'component'     => buddypress()->friends->id,
     533        'type'          => 'friendship_created',
     534        'hide_sitewide' => true,
     535    ) );
    537536 }
    538537
    … …  
    540539 * Redirect user to BP's What's New page on first page load after activation.
    541540 *
    542  * @since BuddyPress (1.7.0)
     541 * @since 1.7.0
    543542 *
    544543 * @internal Used internally to redirect BuddyPress to the about page on activation.
    … …  
    548547function bp_add_activation_redirect() {
    549548
    550     // Bail if activating from network, or bulk
    551     if ( isset( $_GET['activate-multi'] ) ) {
    552         return;
    553     }
    554 
    555     // Record that this is a new installation, so we show the right
    556     // welcome message
    557     if ( bp_is_install() ) {
    558         set_transient( '_bp_is_new_install', true, 30 );
    559     }
    560 
    561     // Add the transient to redirect
    562     set_transient( '_bp_activation_redirect', true, 30 );
     549    // Bail if activating from network, or bulk
     550    if ( isset( $_GET['activate-multi'] ) ) {
     551        return;
     552    }
     553
     554    // Record that this is a new installation, so we show the right
     555    // welcome message
     556    if ( bp_is_install() ) {
     557        set_transient( '_bp_is_new_install', true, 30 );
     558    }
     559
     560    // Add the transient to redirect
     561    set_transient( '_bp_activation_redirect', true, 30 );
    563562}
    564563
    … …  
    568567 * Check if the signups table needs to be created or upgraded.
    569568 *
    570  * @since BuddyPress (2.0.0)
     569 * @since 2.0.0
    571570 *
    572571 * @global WPDB $wpdb
    … …  
    575574 */
    576575function bp_core_maybe_install_signups() {
    577     global $wpdb;
    578 
    579     // The table to run queries against
    580     $signups_table = $wpdb->base_prefix . 'signups';
    581 
    582     // Suppress errors because users shouldn't see what happens next
    583     $old_suppress  = $wpdb->suppress_errors();
    584 
    585     // Never use bp_core_get_table_prefix() for any global users tables
    586     $table_exists  = (bool) $wpdb->get_results( "DESCRIBE {$signups_table};" );
    587 
    588     // Table already exists, so maybe upgrade instead?
    589     if ( true === $table_exists ) {
    590 
    591         // Look for the 'signup_id' column
    592         $column_exists = $wpdb->query( "SHOW COLUMNS FROM {$signups_table} LIKE 'signup_id'" );
    593 
    594         // 'signup_id' column doesn't exist, so run the upgrade
    595         if ( empty( $column_exists ) ) {
    596             bp_core_upgrade_signups();
    597         }
    598 
    599     // Table does not exist, and we are a single site, so install the multisite
    600     // signups table using WordPress core's database schema.
    601     } elseif ( ! is_multisite() ) {
    602         bp_core_install_signups();
    603     }
    604 
    605     // Restore previous error suppression setting
    606     $wpdb->suppress_errors( $old_suppress );
     576    global $wpdb;
     577
     578    // The table to run queries against
     579    $signups_table = $wpdb->base_prefix . 'signups';
     580
     581    // Suppress errors because users shouldn't see what happens next
     582    $old_suppress  = $wpdb->suppress_errors();
     583
     584    // Never use bp_core_get_table_prefix() for any global users tables
     585    $table_exists  = (bool) $wpdb->get_results( "DESCRIBE {$signups_table};" );
     586
     587    // Table already exists, so maybe upgrade instead?
     588    if ( true === $table_exists ) {
     589
     590        // Look for the 'signup_id' column
     591        $column_exists = $wpdb->query( "SHOW COLUMNS FROM {$signups_table} LIKE 'signup_id'" );
     592
     593        // 'signup_id' column doesn't exist, so run the upgrade
     594        if ( empty( $column_exists ) ) {
     595            bp_core_upgrade_signups();
     596        }
     597
     598    // Table does not exist, and we are a single site, so install the multisite
     599    // signups table using WordPress core's database schema.
     600    } elseif ( ! is_multisite() ) {
     601        bp_core_install_signups();
     602    }
     603
     604    // Restore previous error suppression setting
     605    $wpdb->suppress_errors( $old_suppress );
    607606}
    608607
    … …  
    614613 * Runs on BuddyPress activation.
    615614 *
    616  * @since BuddyPress (1.6.0)
     615 * @since 1.6.0
    617616 *
    618617 * @uses do_action() Calls 'bp_activation' hook.
    … …  
    620619function bp_activation() {
    621620
    622     // Force refresh theme roots.
    623     delete_site_transient( 'theme_roots' );
    624 
    625     // Add options
    626     bp_add_options();
    627 
    628     /**
    629     * Fires during the activation of BuddyPress.
    630     *
    631     * Use as of (1.6.0)
    632     *
    633      * @since BuddyPress (1.6.0)
    634     */
    635     do_action( 'bp_activation' );
    636 
    637     // @deprecated as of (1.6)
    638     do_action( 'bp_loader_activate' );
     621    // Force refresh theme roots.
     622    delete_site_transient( 'theme_roots' );
     623
     624    // Add options
     625    bp_add_options();
     626
     627    /**
     628    * Fires during the activation of BuddyPress.
     629    *
     630    * Use as of (1.6.0)
     631    *
     632     * @since 1.6.0
     633    */
     634    do_action( 'bp_activation' );
     635
     636    // @deprecated as of (1.6)
     637    do_action( 'bp_loader_activate' );
    639638}
    640639
    … …  
    644643 * Runs on BuddyPress deactivation.
    645644 *
    646  * @since BuddyPress (1.6.0)
     645 * @since 1.6.0
    647646 *
    648647 * @uses do_action() Calls 'bp_deactivation' hook.
    … …  
    650649function bp_deactivation() {
    651650
    652     // Force refresh theme roots.
    653     delete_site_transient( 'theme_roots' );
    654 
    655     // Switch to WordPress's default theme if current parent or child theme
    656     // depend on bp-default. This is to prevent white screens of doom.
    657     if ( in_array( 'bp-default', array( get_template(), get_stylesheet() ) ) ) {
    658         switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME );
    659         update_option( 'template_root',   get_raw_theme_root( WP_DEFAULT_THEME, true ) );
    660         update_option( 'stylesheet_root', get_raw_theme_root( WP_DEFAULT_THEME, true ) );
    661     }
    662 
    663     /**
    664     * Fires during the deactivation of BuddyPress.
    665     *
    666     * Use as of (1.6.0)
    667     *
    668      * @since BuddyPress (1.6.0)
    669     */
    670     do_action( 'bp_deactivation' );
    671 
    672     // @deprecated as of (1.6)
    673     do_action( 'bp_loader_deactivate' );
     651    // Force refresh theme roots.
     652    delete_site_transient( 'theme_roots' );
     653
     654    // Switch to WordPress's default theme if current parent or child theme
     655    // depend on bp-default. This is to prevent white screens of doom.
     656    if ( in_array( 'bp-default', array( get_template(), get_stylesheet() ) ) ) {
     657        switch_theme( WP_DEFAULT_THEME, WP_DEFAULT_THEME );
     658        update_option( 'template_root',   get_raw_theme_root( WP_DEFAULT_THEME, true ) );
     659        update_option( 'stylesheet_root', get_raw_theme_root( WP_DEFAULT_THEME, true ) );
     660    }
     661
     662    /**
     663    * Fires during the deactivation of BuddyPress.
     664    *
     665    * Use as of (1.6.0)
     666    *
     667     * @since 1.6.0
     668    */
     669    do_action( 'bp_deactivation' );
     670
     671    // @deprecated as of (1.6)
     672    do_action( 'bp_loader_deactivate' );
    674673}
    675674
    … …  
    679678 * Runs when uninstalling BuddyPress.
    680679 *
    681  * @since BuddyPress (1.6.0)
     680 * @since 1.6.0
    682681 *
    683682 * @uses do_action() Calls 'bp_uninstall' hook.
    … …  
    685684function bp_uninstall() {
    686685
    687     /**
    688     * Fires during the uninstallation of BuddyPress.
    689     *
    690      * @since BuddyPress (1.6.0)
    691     */
    692     do_action( 'bp_uninstall' );
    693 }
     686    /**
     687    * Fires during the uninstallation of BuddyPress.
     688    *
     689     * @since 1.6.0
     690    */
     691    do_action( 'bp_uninstall' );
     692}

  • trunk/src/bp-core/bp-core-widgets.php

    r10099 r10108  
    1313 * Register bp-core widgets.
    1414 *
    15  * @since BuddyPress (1.0.0)
     15 * @since 1.0.0
    1616 */
    1717function bp_core_register_widgets() {
    … …  
    2323 * BuddyPress Login Widget.
    2424 *
    25  * @since BuddyPress (1.9.0)
     25 * @since 1.9.0
    2626 */
    2727class BP_Core_Login_Widget extends WP_Widget {
    … …  
    5555         * Filters the title of the Login widget.
    5656         *
    57          * @since BuddyPress (1.9.0)
    58          * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     57         * @since 1.9.0
     58         * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    5959         *
    6060         * @param string $title    The widget title.
    … …  
    7474             * Fires before the display of widget content if logged in.
    7575             *
    76              * @since BuddyPress (1.9.0)
     76             * @since 1.9.0
    7777             */
    7878            do_action( 'bp_before_login_widget_loggedin' ); ?>
    … …  
    9494             * Fires after the display of widget content if logged in.
    9595             *
    96              * @since BuddyPress (1.9.0)
     96             * @since 1.9.0
    9797             */
    9898            do_action( 'bp_after_login_widget_loggedin' ); ?>
    … …  
    105105             * Fires before the display of widget content if logged out.
    106106             *
    107              * @since BuddyPress (1.9.0)
     107             * @since 1.9.0
    108108             */
    109109            do_action( 'bp_before_login_widget_loggedout' ); ?>
    … …  
    133133             * Fires after the display of widget content if logged out.
    134134             *
    135              * @since BuddyPress (1.9.0)
     135             * @since 1.9.0
    136136             */
    137137            do_action( 'bp_after_login_widget_loggedout' ); ?>

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

    r10039 r10108  
    1818 * Parse the WordPress core version number into the major release.
    1919 *
    20  * @since BuddyPress (1.5.2)
     20 * @since 1.5.2
    2121 *
    2222 * @global string $wp_version

  • trunk/src/bp-core/classes/class-bp-attachment-avatar.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1515 * Extends BP Attachment to manage the avatar uploads.
    1616 *
    17  * @since BuddyPress (2.3.0)
     17 * @since 2.3.0
    1818 */
    1919class BP_Attachment_Avatar extends BP_Attachment {
    … …  
    2222     * Construct Upload parameters.
    2323     *
    24      * @since BuddyPress (2.3.0)
     24     * @since 2.3.0
    2525     *
    2626     * @see  BP_Attachment::__construct() for list of parameters
    … …  
    4848     * Gets the available avatar types.
    4949     *
    50      * @since BuddyPress (2.3.0)
     50     * @since 2.3.0
    5151     *
    5252     * @param array $allowed_types Array of allowed avatar types.
    … …  
    6363     * Set Upload Dir data for avatars.
    6464     *
    65      * @since BuddyPress (2.3.0)
     65     * @since 2.3.0
    6666     *
    6767     * @uses bp_core_avatar_upload_path()
    … …  
    8686     * The error code is the index of $upload_error_strings.
    8787     *
    88      * @since BuddyPress (2.3.0)
     88     * @since 2.3.0
    8989     *
    9090     * @uses   bp_core_check_avatar_size()
    … …  
    117117     * Maybe shrink the attachment to fit maximum allowed width.
    118118     *
    119      * @since BuddyPress (2.3.0)
     119     * @since 2.3.0
    120120     *
    121121     * @uses  bp_core_avatar_original_max_width()
    … …  
    166166     * Check if the image dimensions are smaller than full avatar dimensions.
    167167     *
    168      * @since BuddyPress (2.3.0)
     168     * @since 2.3.0
    169169     *
    170170     * @uses  bp_core_avatar_full_width()
    … …  
    190190     * Crop the avatar.
    191191     *
    192      * @since BuddyPress (2.3.0)
     192     * @since 2.3.0
    193193     *
    194194     * @see  BP_Attachment::crop for the list of parameters
    … …  
    287287     * Get the user id to set its avatar.
    288288     *
    289      * @since BuddyPress (2.3.0)
     289     * @since 2.3.0
    290290     *
    291291     * @return integer The user ID.
    … …  
    309309     * Get the group id to set its avatar.
    310310     *
    311      * @since BuddyPress (2.3.0)
     311     * @since 2.3.0
    312312     *
    313313     * @return integer The group ID.
    … …  
    326326     * Build script datas for the Uploader UI.
    327327     *
    328      * @since BuddyPress (2.3.0)
     328     * @since 2.3.0
    329329     *
    330330     * @return array The javascript localization data.
    … …  
    391391             * e.g. Blavatar.
    392392             *
    393              * @since BuddyPress (2.3.0)
     393             * @since 2.3.0
    394394             *
    395395             * @param array $value The avatar specific BuddyPress parameters.
    … …  
    412412         * Use this filter to override/extend the avatar script data.
    413413         *
    414          * @since BuddyPress (2.3.0)
     414         * @since 2.3.0
    415415         *
    416416         * @param array  $script_data The avatar script data.

  • trunk/src/bp-core/classes/class-bp-attachment.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1515 * Extend it to manage your component's uploads.
    1616 *
    17  * @since BuddyPress (2.3.0)
     17 * @since 2.3.0
    1818 */
    1919abstract class BP_Attachment {
    … …  
    4747     * Construct Upload parameters.
    4848     *
    49      * @since BuddyPress (2.3.0)
     49     * @since 2.3.0
    5050     *
    5151     * @param array|string $args {
    … …  
    105105     * Set upload path and url for the component.
    106106     *
    107      * @since BuddyPress (2.3.0)
     107     * @since 2.3.0
    108108     *
    109109     * @uses bp_upload_dir()
    … …  
    144144     * Used into the $overrides argument of BP_Attachment->upload()
    145145     *
    146      * @since BuddyPress (2.3.0)
     146     * @since 2.3.0
    147147     *
    148148     * @param array $param A list of error messages to add to BuddyPress core ones.
    … …  
    179179     * Include the WordPress core needed files.
    180180     *
    181      * @since BuddyPress (2.3.0)
     181     * @since 2.3.0
    182182     */
    183183    public function includes() {
    … …  
    194194     * Upload the attachment.
    195195     *
    196      * @since BuddyPress (2.3.0)
     196     * @since 2.3.0
    197197     *
    198198     * @param  array       $file              The appropriate entry the from $_FILES superglobal.
    … …  
    294294     * @see check_upload_mimes()
    295295     *
    296      * @since BuddyPress (2.3.0)
     296     * @since 2.3.0
    297297     *
    298298     * @uses get_allowed_mime_types()
    … …  
    322322     * @see BP_Attachment_Avatar->validate_upload() for an example of use
    323323     *
    324      * @since BuddyPress (2.3.0)
     324     * @since 2.3.0
    325325     *
    326326     * @param  array $file The temporary file attributes (before it has been moved).
    … …  
    345345     * Default filter to save the attachments.
    346346     *
    347      * @since BuddyPress (2.3.0)
     347     * @since 2.3.0
    348348     *
    349349     * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
    … …  
    357357         * Filters the component's upload directory.
    358358         *
    359          * @since BuddyPress (2.3.0)
     359         * @since 2.3.0
    360360         *
    361361         * @param array $value Array containing the path, URL, and other helpful settings.
    … …  
    377377     * (eg: add an .htaccess file)
    378378     *
    379      * @since BuddyPress (2.3.0)
     379     * @since 2.3.0
    380380     *
    381381     * @uses wp_mkdir_p()
    … …  
    403403     * Crop an image file.
    404404     *
    405      * @since BuddyPress (2.3.0)
     405     * @since 2.3.0
    406406     *
    407407     * @param array $args {
    … …  
    505505     * Override this method from your child class to build the script datas.
    506506     *
    507      * @since BuddyPress (2.3.0)
     507     * @since 2.3.0
    508508     *
    509509     * @return array The javascript localization data.

  • trunk/src/bp-core/classes/class-bp-button.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * API to create BuddyPress buttons.
    1414 *
    15  * @since BuddyPress (1.2.6)
     15 * @since 1.2.6
    1616 *
    1717 * @param array $args {
    … …  
    153153     * Builds the button based on class parameters.
    154154     *
    155      * @since BuddyPress (1.2.6)
     155     * @since 1.2.6
    156156     *
    157157     * @param array|string $args See {@BP_Button}.
    … …  
    238238         * allows button to be manipulated externally.
    239239         *
    240          * @since BuddyPress (1.2.6)
     240         * @since 1.2.6
    241241         *
    242242         * @param string    $contents HTML being used for the button.
    … …  
    251251     * Return the markup for the generated button.
    252252     *
    253      * @since BuddyPress (1.2.6)
     253     * @since 1.2.6
    254254     *
    255255     * @return string Button markup.
    … …  
    262262     * Output the markup of button.
    263263     *
    264      * @since BuddyPress (1.2.6)
     264     * @since 1.2.6
    265265     */
    266266    public function display() {

  • trunk/src/bp-core/classes/class-bp-core-notification.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1616 *
    1717 * @package BuddyPress Core
    18  * @deprecated since BuddyPress (1.9.0)
     18 * @deprecated since 1.9.0
    1919 */
    2020class BP_Core_Notification {

  • trunk/src/bp-core/classes/class-bp-core-user.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    119119     * Profile information for the specific user.
    120120     *
    121      * @since BuddyPress (1.2.0)
     121     * @since 1.2.0
    122122     * @var array
    123123     */
    … …  
    380380         * Filters the SQL used to query for paged users.
    381381         *
    382          * @since BuddyPress (1.2.6)
     382         * @since 1.2.6
    383383         *
    384384         * @param string $value Concatenated SQL statement for the query.
    … …  
    412412         * Filters the SQL used to query for total users.
    413413         *
    414          * @since BuddyPress (1.2.6)
     414         * @since 1.2.6
    415415         *
    416416         * @param string $value Concatenated SQL statement for the query.
    … …  
    488488         * Filters the SQL used to query for total user count by first letter.
    489489         *
    490          * @since BuddyPress (1.0.0)
     490         * @since 1.0.0
    491491         *
    492492         * @param string $value SQL prepared statement for the user count query.
    … …  
    497497         * Filters the SQL used to query for users by first letter.
    498498         *
    499          * @since BuddyPress (1.0.0)
     499         * @since 1.0.0
    500500         *
    501501         * @param string $value SQL prepared statement for the user query.
    … …  
    556556         * Use 'bp_core_user_get_specific_users_count_sql' instead.
    557557         *
    558          * @deprecated BuddyPress (2.3.0)
     558         * @deprecated 2.3.0
    559559         *
    560560         * @param string $sql SQL string.
    … …  
    567567         * Use this instead of the deprecated 'bp_core_get_specific_users_count_sql'.
    568568         *
    569          * @since BuddyPress (2.3.0)
     569         * @since 2.3.0
    570570         *
    571571         * @param string   $sql             SQL string.
    … …  
    583583         * Use 'bp_core_user_get_specific_users_paged_sql' instead.
    584584         *
    585          * @deprecated BuddyPress (2.3.0)
     585         * @deprecated 2.3.0
    586586         *
    587587         * @param string $sql SQL string.
    … …  
    594594         * Use this instead of the deprecated 'bp_core_get_specific_users_count_sql'.
    595595         *
    596          * @since BuddyPress (2.3.0)
     596         * @since 2.3.0
    597597         *
    598598         * @param string   $sql             SQL string.
    … …  
    650650         * Filters the SQL used to query for searched users count.
    651651         *
    652          * @since BuddyPress (1.0.0)
     652         * @since 1.0.0
    653653         *
    654654         * @param string $value SQL statement for the searched users count query.
    … …  
    659659         * Filters the SQL used to query for searched users.
    660660         *
    661          * @since BuddyPress (1.0.0)
     661         * @since 1.0.0
    662662         *
    663663         * @param string $value SQL statement for the searched users query.
    … …  
    840840     * existing entry.
    841841     *
    842      * @since BuddyPress (2.0.0)
     842     * @since 2.0.0
    843843     *
    844844     * @param int    $user_id ID of the user whose last_activity you are updating.
    … …  
    930930     * Delete a user's last_activity value.
    931931     *
    932      * @since BuddyPress (2.0.0)
     932     * @since 2.0.0
    933933     *
    934934     * @param int $user_id

  • trunk/src/bp-core/classes/class-bp-date-query.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1616 * Extends the {@link WP_Date_Query} class for use with BuddyPress.
    1717 *
    18  * @since BuddyPress (2.1.0)
     18 * @since 2.1.0
    1919 *
    2020 * @param array $date_query {

  • trunk/src/bp-core/classes/class-bp-embed.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1515 * Extends WP_Embed class for use with BuddyPress.
    1616 *
    17  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1818 *
    1919 * @see WP_Embed
    … …  
    5858         * Filters the BuddyPress Core oEmbed setup.
    5959         *
    60          * @since BuddyPress (1.5.0)
     60         * @since 1.5.0
    6161         *
    6262         * @param BP_Embed $this Current instance of the BP_Embed. Passed by reference.
    … …  
    107107                         * Filters the oEmbed handler result for the provided URL.
    108108                         *
    109                          * @since BuddyPress (1.5.0)
     109                         * @since 1.5.0
    110110                         *
    111111                         * @param string $return Handler callback for the oEmbed.
    … …  
    122122         * Filters the embed object ID.
    123123         *
    124          * @since BuddyPress (1.5.0)
     124         * @since 1.5.0
    125125         *
    126126         * @param int $value Value of zero.
    … …  
    131131         * Filters whether or not oEmbed discovery is on.
    132132         *
    133          * @since BuddyPress (1.5.0)
     133         * @since 1.5.0
    134134         *
    135135         * @param bool $value Current status of oEmbed discovery.
    … …  
    192192             * Filters the cache value to be used in the oEmbed, if exists.
    193193             *
    194              * @since BuddyPress (1.5.0)
     194             * @since 1.5.0
    195195             *
    196196             * @param string $cache    Empty initial cache value.
    … …  
    209209                 * Filters the found cache for the provided URL.
    210210                 *
    211                  * @since BuddyPress (1.5.0)
     211                 * @since 1.5.0
    212212                 *
    213213                 * @param string $cache   Cached HTML markup for embed.
    … …  
    228228                 * Lets components / plugins save their cache.
    229229                 *
    230                  * @since BuddyPress (1.5.0)
     230                 * @since 1.5.0
    231231                 *
    232232                 * @param string $cache    Newly cached HTML markup for embed.

  • trunk/src/bp-core/classes/class-bp-media-extractor.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * Extracts media from text. Use {@link extract()}.
    1414 *
    15  * @since BuddyPress (2.3.0)
     15 * @since 2.3.0
    1616 *
    1717 * The supported types are links, mentions, images, shortcodes, embeds, audio, video, and "all".
    … …  
    4242     * Media type.
    4343     *
    44      * @since BuddyPress (2.3.0)
     44     * @since 2.3.0
    4545     * @var int
    4646     */
    … …  
    5858     * Extract media from text.
    5959     *
    60      * @since BuddyPress (2.3.0)
     60     * @since 2.3.0
    6161     *
    6262     * @param string|WP_Post $richtext        Content to parse.
    … …  
    171171         * Filters media extracted from text.
    172172         *
    173          * @since BuddyPress (2.3.0)
     173         * @since 2.3.0
    174174         *
    175175         * @param array  $media           Extracted media. See {@link BP_Media_Extractor::extract()} for format.
    … …  
    192192     * Extract `<a href>` tags from text.
    193193     *
    194      * @since BuddyPress (2.3.0)
     194     * @since 2.3.0
    195195     *
    196196     * @param string $richtext   Content to parse.
    … …  
    234234         * Filters links extracted from text.
    235235         *
    236          * @since BuddyPress (2.3.0)
     236         * @since 2.3.0
    237237         *
    238238         * @param array  $data       Extracted links. See {@link BP_Media_Extractor::extract_links()} for format.
    … …  
    252252     * If the Activity component is disabled, any @mentions are extracted.
    253253     *
    254      * @since BuddyPress (2.3.0)
     254     * @since 2.3.0
    255255     *
    256256     * @param string $richtext   Content to parse.
    … …  
    309309         * Filters @mentions extracted from text.
    310310         *
    311          * @since BuddyPress (2.3.0)
     311         * @since 2.3.0
    312312         *
    313313         * @param array  $data       Extracted @mentions. See {@link BP_Media_Extractor::extract_mentions()} for format.
    … …  
    324324     * If an image is in the Media Library, then its resolution is included in the results.
    325325     *
    326      * @since BuddyPress (2.3.0)
     326     * @since 2.3.0
    327327     *
    328328     * @param string $richtext   Content to parse.
    … …  
    428428         * Filters images extracted from text.
    429429         *
    430          * @since BuddyPress (2.3.0)
     430         * @since 2.3.0
    431431         *
    432432         * @param array  $media      Extracted images. See {@link BP_Media_Extractor::extract_images()} for format.
    … …  
    444444     * For example, [gallery] and [audio].
    445445     *
    446      * @since BuddyPress (2.3.0)
     446     * @since 2.3.0
    447447     *
    448448     * @param string $richtext   Content to parse.
    … …  
    492492         * Filters shortcodes extracted from text.
    493493         *
    494          * @since BuddyPress (2.3.0)
     494         * @since 2.3.0
    495495         *
    496496         * @param array  $data       Extracted shortcodes.
    … …  
    506506     * Extract any URL, matching a registered oEmbed endpoint, from text.
    507507     *
    508      * @since BuddyPress (2.3.0)
     508     * @since 2.3.0
    509509     *
    510510     * @param string $richtext   Content to parse.
    … …  
    571571         * Filters embeds extracted from text.
    572572         *
    573          * @since BuddyPress (2.3.0)
     573         * @since 2.3.0
    574574         *
    575575         * @param array  $data       Extracted embeds. See {@link BP_Media_Extractor::extract_embeds()} for format.
    … …  
    584584     * Extract [audio] shortcodes and `<a href="*.mp3">` tags, from text.
    585585     *
    586      * @since BuddyPress (2.3.0)
     586     * @since 2.3.0
    587587     *
    588588     * @see wp_get_audio_extensions() for supported audio formats.
    … …  
    669669         * Filters audio extracted from text.
    670670         *
    671          * @since BuddyPress (2.3.0)
     671         * @since 2.3.0
    672672         *
    673673         * @param array  $data       Extracted audio. See {@link BP_Media_Extractor::extract_audio()} for format.
    … …  
    682682     * Extract [video] shortcodes from text.
    683683     *
    684      * @since BuddyPress (2.3.0)
     684     * @since 2.3.0
    685685     *
    686686     * @see wp_get_video_extensions() for supported video formats.
    … …  
    745745         * Filters videos extracted from text.
    746746         *
    747          * @since BuddyPress (2.3.0)
     747         * @since 2.3.0
    748748         *
    749749         * @param array  $data       Extracted videos. See {@link BP_Media_Extractor::extract_videos()} for format.
    … …  
    763763     * Extract images in [galleries] shortcodes from text.
    764764     *
    765      * @since BuddyPress (2.3.0)
     765     * @since 2.3.0
    766766     *
    767767     * @param string $richtext   Content to parse.
    … …  
    781781        $galleries      = get_post_galleries( $post, false );
    782782        $galleries_data = array();
    783    
     783
    784784        if ( ! empty( $galleries ) ) {
    785785            // Validate the size of the images requested.
    … …  
    850850         * Filters image galleries extracted from text.
    851851         *
    852          * @since BuddyPress (2.3.0)
     852         * @since 2.3.0
    853853         *
    854854         * @param array  $galleries_data Galleries. See {@link BP_Media_Extractor::extract_images_from_galleries()}.
    … …  
    863863     * Extract the featured image from a Post.
    864864     *
    865      * @since BuddyPress (2.3.0)
     865     * @since 2.3.0
    866866     *
    867867     * @param string $richtext   Content to parse.
    … …  
    902902         * Filters featured images extracted from a WordPress Post.
    903903         *
    904          * @since BuddyPress (2.3.0)
     904         * @since 2.3.0
    905905         *
    906906         * @param array  $image      Extracted images. See {@link BP_Media_Extractor_Post::extract_images()} for format.
    … …  
    917917     * HTML tags and shortcodes are removed, and HTML entities are decoded.
    918918     *
    919      * @since BuddyPress (2.3.0)
     919     * @since 2.3.0
    920920     *
    921921     * @param string $richtext
    … …  
    929929         * Filters the generated plain text version of the content passed to the extractor.
    930930         *
    931          * @since BuddyPress (2.3.0)
     931         * @since 2.3.0
    932932         *
    933933         * @param array  $plaintext Generated plain text.

  • trunk/src/bp-core/classes/class-bp-members-suggestions.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1616 * and Groups is loaded before Members (alphabetical order).
    1717 *
    18  * @since BuddyPress (2.1.0)
     18 * @since 2.1.0
    1919 */
    2020class BP_Members_Suggestions extends BP_Suggestions {
    … …  
    2323     * Default arguments for this suggestions service.
    2424     *
    25      * @since BuddyPress (2.1.0)
     25     * @since 2.1.0
    2626     * @var array $args {
    2727     *     @type int    $limit        Maximum number of results to display. Default: 16.
    … …  
    4242     * Validate and sanitise the parameters for the suggestion service query.
    4343     *
    44      * @since BuddyPress (2.1.0)
     44     * @since 2.1.0
    4545     *
    4646     * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
    … …  
    5252         * Filters the members suggestions args for the current user.
    5353         *
    54          * @since BuddyPress (2.1.0)
     54         * @since 2.1.0
    5555         *
    5656         * @param array                  $args Array of arguments for the member suggestions.
    … …  
    6767         * Filters the validation status for the suggestion service query.
    6868         *
    69          * @since BuddyPress (2.1.0)
     69         * @since 2.1.0
    7070         *
    7171         * @param bool|WP_Error          $value Results of validation check.
    … …  
    7878     * Find and return a list of username suggestions that match the query.
    7979     *
    80      * @since BuddyPress (2.1.0)
     80     * @since 2.1.0
    8181     *
    8282     * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
    … …  
    102102         * Filters the members suggestions query args.
    103103         *
    104          * @since BuddyPress (2.1.0)
     104         * @since 2.1.0
    105105         *
    106106         * @param array                  $user_query Array of query arguments.
    … …  
    128128         * Filters the members suggestions results.
    129129         *
    130          * @since BuddyPress (2.1.0)
     130         * @since 2.1.0
    131131         *
    132132         * @param array                  $results Array of users to suggest.

  • trunk/src/bp-core/classes/class-bp-recursive-query.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * Base class for creating query classes that generate SQL fragments for filtering results based on recursive query params.
    1414 *
    15  * @since BuddyPress (2.2.0)
     15 * @since 2.2.0
    1616 */
    1717abstract class BP_Recursive_Query {
    … …  
    2020     * Query arguments passed to the constructor.
    2121     *
    22      * @since BuddyPress (2.2.0)
     22     * @since 2.2.0
    2323     * @access public
    2424     * @var array
    … …  
    3535     * the empty 'join' clause, and only passes the 'where' clause.
    3636     *
    37      * @since BuddyPress (2.2.0)
     37     * @since 2.2.0
    3838     * @access protected
    3939     *
    … …  
    5959     * automatically from get_sql_clauses().
    6060     *
    61      * @since BuddyPress (2.2.0)
     61     * @since 2.2.0
    6262     * @access protected
    6363     *
    … …  
    139139     * Extend this method if your class uses different sanitizing logic.
    140140     *
    141      * @since BuddyPress (2.2.0)
     141     * @since 2.2.0
    142142     * @access public
    143143     *
    … …  
    207207     * Must be overridden in a subclass.
    208208     *
    209      * @since BuddyPress (2.2.0)
     209     * @since 2.2.0
    210210     * @access protected
    211211     *
    … …  
    225225     * Must be overridden in a subclass.
    226226     *
    227      * @since BuddyPress (2.2.0)
     227     * @since 2.2.0
    228228     * @access protected
    229229     *

  • trunk/src/bp-core/classes/class-bp-suggestions.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    2424 * recommendations provided in the phpDoc blocks, particularly the expected return types.
    2525 *
    26  * @since BuddyPress (2.1.0)
     26 * @since 2.1.0
    2727 */
    2828abstract class BP_Suggestions {
    … …  
    3333     * If your custom service requires further defaults, add them here.
    3434     *
    35      * @since BuddyPress (2.1.0)
     35     * @since 2.1.0
    3636     * @var array
    3737     */
    … …  
    4747     * This includes `$default_args`, as well as the user-supplied values.
    4848     *
    49      * @since BuddyPress (2.1.0)
     49     * @since 2.1.0
    5050     * @var array
    5151     */
    … …  
    5858     *
    5959     * @param array $args Optional. If set, used as the parameters for the suggestions service query.
    60      * @since BuddyPress (2.1.0)
     60     * @since 2.1.0
    6161     */
    6262    public function __construct( array $args = array() ) {
    … …  
    7575     *                         Mandatory.
    7676     * }
    77      * @since BuddyPress (2.1.0)
     77     * @since 2.1.0
    7878     */
    7979    public function set_query( array $args = array() ) {
    … …  
    8787     * If validation fails, you must return a WP_Error object.
    8888     *
    89      * @since BuddyPress (2.1.0)
     89     * @since 2.1.0
    9090     *
    9191     * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
    … …  
    9898         * Filters the arguments to be validated for the BP_Suggestions query.
    9999         *
    100          * @since BuddyPress (2.1.0)
     100         * @since 2.1.0
    101101         *
    102102         * @param BP_Suggestions $value Arguments to be validated.
    … …  
    118118         * Filters the status of validation for the BP_Suggestions query.
    119119         *
    120          * @since BuddyPress (2.1.0)
     120         * @since 2.1.0
    121121         *
    122122         * @param bool           $value Whether or not the values are valid.
    … …  
    135135     * For example: { 'ID': 'admin', 'image': 'http://example.com/logo.png', 'name': 'Name Surname' }
    136136     *
    137      * @since BuddyPress (2.1.0)
     137     * @since 2.1.0
    138138     *
    139139     * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.

  • trunk/src/bp-core/classes/class-bp-user-query.php

    r10043 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1616 * Member directories, the Friends component, etc.
    1717 *
    18  * @since BuddyPress (1.7.0)
     18 * @since 1.7.0
    1919 *
    2020 * @param array $query {
    … …  
    6666     * Unaltered params as passed to the constructor.
    6767     *
    68      * @since BuddyPress (1.8.0)
     68     * @since 1.8.0
    6969     * @var array
    7070     */
    … …  
    7474     * Array of variables to query with.
    7575     *
    76      * @since BuddyPress (1.7.0)
     76     * @since 1.7.0
    7777     * @var array
    7878     */
    … …  
    8383     *
    8484     * @access public To allow components to manipulate them.
    85      * @since BuddyPress (1.7.0)
     85     * @since 1.7.0
    8686     * @var array
    8787     */
    … …  
    9292     *
    9393     * @access public To allow components to manipulate it.
    94      * @since BuddyPress (1.7.0)
     94     * @since 1.7.0
    9595     * @var int
    9696     */
    … …  
    101101     *
    102102     * @access public To allow components to manipulate it.
    103      * @since BuddyPress (1.7.0)
     103     * @since 1.7.0
    104104     * @var array
    105105     */
    … …  
    110110     *
    111111     * @access public To allow components to manipulate it.
    112      * @since BuddyPress (1.7.0)
     112     * @since 1.7.0
    113113     * @var array
    114114     */
    … …  
    118118     * SQL table where the user ID is being fetched from.
    119119     *
    120      * @since BuddyPress (2.2.0)
     120     * @since 2.2.0
    121121     * @access public
    122122     * @var string
    … …  
    127127     * SQL database column name to order by.
    128128     *
    129      * @since BuddyPress (1.7.0)
     129     * @since 1.7.0
    130130     * @var string
    131131     */
    … …  
    136136     *
    137137     * @access protected
    138      * @since BuddyPress (1.7.0)
     138     * @since 1.7.0
    139139     * @var string
    140140     */
    … …  
    147147     * Constructor.
    148148     *
    149      * @since BuddyPress (1.7.0)
     149     * @since 1.7.0
    150150     *
    151151     * @param string|array $query See {@link BP_User_Query}.
    … …  
    183183             * Fires before the construction of the BP_User_Query query.
    184184             *
    185              * @since BuddyPress (1.7.0)
     185             * @since 1.7.0
    186186             *
    187187             * @param BP_User_Query $this Current instance of the BP_User_Query. Passed by reference.
    … …  
    223223     * {@link BP_Group_Member_Query::setup_hooks()} for an example.
    224224     *
    225      * @since BuddyPress (1.8.0)
     225     * @since 1.8.0
    226226     */
    227227    public function setup_hooks() {}
    … …  
    230230     * Prepare the query for user_ids.
    231231     *
    232      * @since BuddyPress (1.7.0)
     232     * @since 1.7.0
    233233     */
    234234    public function prepare_user_ids_query() {
    … …  
    277277                 * Filters the threshold for activity timestamp minutes since to indicate online status.
    278278                 *
    279                  * @since BuddyPress (1.8.0)
     279                 * @since 1.8.0
    280280                 *
    281281                 * @param int $value Amount of minutes for threshold. Default 15.
    … …  
    471471         * Filters the clauses for the user query.
    472472         *
    473          * @since BuddyPress (2.0.0)
     473         * @since 2.0.0
    474474         *
    475475         * @param array         $sql  Array of SQL clauses to be used in the query.
    … …  
    488488         * Fires before the BP_User_Query query is made.
    489489         *
    490          * @since BuddyPress (1.7.0)
     490         * @since 1.7.0
    491491         *
    492492         * @param BP_User_Query $this Current BP_User_Query instance. Passed by reference.
    … …  
    503503     * Also used to quickly perform user total counts.
    504504     *
    505      * @since BuddyPress (1.7.0)
     505     * @since 1.7.0
    506506     */
    507507    public function do_user_ids_query() {
    … …  
    526526             * use a "SELECT COUNT()" query statement.
    527527             *
    528              * @since BuddyPress (1.7.0)
     528             * @since 1.7.0
    529529             *
    530530             * @param string        $value SQL statement to select FOUND_ROWS().
    … …  
    543543     * Use WP_User_Query() to pull data for the user IDs retrieved in the main query.
    544544     *
    545      * @since BuddyPress (1.7.0)
     545     * @since 1.7.0
    546546     */
    547547    public function do_wp_user_query() {
    … …  
    556556         * Filters the WP User Query arguments before passing into the class.
    557557         *
    558          * @since BuddyPress (1.7.0)
     558         * @since 1.7.0
    559559         *
    560560         * @param array         $value Array of arguments for the user query.
    … …  
    621621     * for an example.
    622622     *
    623      * @since BuddyPress (1.8.0)
     623     * @since 1.8.0
    624624     *
    625625     * @param array $include Sanitized array of user IDs, as passed to the 'include'
    … …  
    639639     * action to loop in the things they want.
    640640     *
    641      * @since BuddyPress (1.7.0)
     641     * @since 1.7.0
    642642     *
    643643     * @global WPDB $wpdb Global WordPress database access object.
    … …  
    678678         * @see bp_friends_filter_user_query_populate_extras()
    679679         *
    680          * @since BuddyPress (1.7.0)
     680         * @since 1.7.0
    681681         *
    682682         * @param BP_User_Query $this         Current BP_User_Query instance.

  • trunk/src/bp-core/classes/class-bp-walker-nav-menu-checklist.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1616 * to require an actual post type or taxonomy, and to force certain CSS classes.
    1717 *
    18  * @since BuddyPress (1.9.0)
     18 * @since 1.9.0
    1919 */
    2020class BP_Walker_Nav_Menu_Checklist extends Walker_Nav_Menu {

  • trunk/src/bp-core/classes/class-bp-walker-nav-menu.php

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * Create HTML list of BP nav items.
    1414 *
    15  * @since BuddyPress (1.7.0)
     15 * @since 1.7.0
    1616 */
    1717class BP_Walker_Nav_Menu extends Walker_Nav_Menu {
    … …  
    2020     * Description of fields indexes for building markup.
    2121     *
    22      * @since BuddyPress (1.7.0)
     22     * @since 1.7.0
    2323     * @var array
    2424     */
    … …  
    2828     * Tree type.
    2929     *
    30      * @since BuddyPress (1.7.0)
     30     * @since 1.7.0
    3131     * @var string
    3232     */
    … …  
    4646     * those have ID/post_parent.
    4747     *
    48      * @since BuddyPress (1.7.0)
     48     * @since 1.7.0
    4949     *
    5050     * @see Walker::walk()
    … …  
    138138     * @see Walker::start_el() for complete description of parameters.
    139139     *
    140      * @since BuddyPress (1.7.0)
     140     * @since 1.7.0
    141141     *
    142142     * @param string $output Passed by reference. Used to append
    … …  
    155155         * Filters the classes to be added to the nav menu markup.
    156156         *
    157          * @since BuddyPress (1.7.0)
     157         * @since 1.7.0
    158158         *
    159159         * @param array  $value Array of classes to be added.
    … …  
    170170         * Filters the value to be used for the nav menu ID attribute.
    171171         *
    172          * @since BuddyPress (1.7.0)
     172         * @since 1.7.0
    173173         *
    174174         * @param string $id   ID attribute to be added to the menu item.
    … …  
    192192         * Filters the link text to be added to the item output.
    193193         *
    194          * @since BuddyPress (1.7.0)
     194         * @since 1.7.0
    195195         *
    196196         * @param string $name  Item text to be applied.
    … …  
    204204         * Filters the final result for the menu item.
    205205         *
    206          * @since BuddyPress (1.7.0)
     206         * @since 1.7.0
    207207         *
    208208         * @param string $item_output Constructed output for the menu item to append to output.

  • trunk/src/bp-core/deprecated/1.2.php

    r9819 r10108  
    1212 * You should use bp_activity_get() instead
    1313 *
    14  * @since BuddyPress (1.0)
    15  * @deprecated BuddyPress (1.2)
     14 * @since 1.0.0
     15 * @deprecated 1.2.0
    1616 *
    1717 * @param array $args

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

    r10012 r10108  
    55 * @package BuddyPress
    66 * @subpackage Core
    7  * @deprecated Since 1.5
     7 * @deprecated Since 1.5.0
    88 */
    99
    … …  
    1414
    1515/**
    16  * @deprecated BuddyPress (1.5)
     16 * @deprecated 1.5.0
    1717 */
    1818function bp_setup_root_components() {
    … …  
    2929 * Use is_multisite() instead.
    3030 *
    31  * @deprecated BuddyPress (1.5)
     31 * @deprecated 1.5.0
    3232 * @deprecated Use is_multisite()
    3333 *
    … …  
    4444 * Checks if current blog is root blog of site. Deprecated in 1.5.
    4545 *
    46  * @deprecated BuddyPress (1.5)
     46 * @deprecated 1.5.0
    4747 * @deprecated Use is_main_site()
    4848 * @package BuddyPress
    4949 * @param int|string $blog_id optional blog id to test (default current blog)
    5050 * @return bool True if not multisite or $blog_id is main site
    51  * @since BuddyPress (1.2.6)
     51 * @since 1.2.6
    5252 */
    5353function bp_core_is_main_site( $blog_id = '' ) {
    … …  
    6060     * WPMU version of is_super_admin()
    6161     *
    62      * @deprecated BuddyPress (1.5)
     62     * @deprecated 1.5.0
    6363     * @deprecated Use is_super_admin()
    6464     * @param int|bool $user_id Optional. Defaults to logged-in user
    … …  
    7777 * that allowed positioning of menus. Deprecated in 1.5 in favour of a WP core function.
    7878 *
    79  * @deprecated BuddyPress (1.5)
     79 * @deprecated 1.5.0
    8080 * @deprecated Use add_menu_page().
    81  * @since BuddyPress (1.1)
     81 * @since 1.1.0
    8282 *
    8383 * @return string
    … …  
    126126
    127127/**
    128  * @deprecated BuddyPress (1.5)
     128 * @deprecated 1.5.0
    129129 */
    130130function bp_is_activity_permalink() {
    … …  
    136136
    137137/**
    138  * @deprecated BuddyPress (1.5)
     138 * @deprecated 1.5.0
    139139 */
    140140function bp_core_get_wp_profile() {
    … …  
    209209
    210210/**
    211  * @deprecated BuddyPress (1.5)
     211 * @deprecated 1.5.0
    212212 * @deprecated Use bp_is_my_profile()
    213213 */
    … …  
    220220 * Is the user on the front page of the site?
    221221 *
    222  * @deprecated BuddyPress (1.5)
     222 * @deprecated 1.5.0
    223223 * @deprecated Use is_front_page()
    224224 * @return bool
    … …  
    232232 * Is the front page of the site set to the Activity component?
    233233 *
    234  * @deprecated BuddyPress (1.5)
     234 * @deprecated 1.5.0
    235235 * @deprecated Use bp_is_component_front_page( 'activity' )
    236236 * @return bool
    … …  
    242242
    243243/**
    244  * @deprecated BuddyPress (1.5)
     244 * @deprecated 1.5.0
    245245 * @deprecated use bp_is_user()
    246246 */
    … …  
    251251
    252252/**
    253  * @deprecated BuddyPress (1.5)
     253 * @deprecated 1.5.0
    254254 * @deprecated use bp_loggedin_user_link()
    255255 */
    … …  
    263263 * Deprecated in 1.5; not used anymore.
    264264 *
    265  * @deprecated BuddyPress (1.5)
     265 * @deprecated 1.5.0
    266266 * @return bool
    267267 */
    … …  
    274274 * Template tag version of bp_get_page_title()
    275275 *
    276  * @deprecated BuddyPress (1.5)
     276 * @deprecated 1.5.0
    277277 * @deprecated Use wp_title()
    278  * @since BuddyPress (1.0)
     278 * @since 1.0.0
    279279 */
    280280function bp_page_title() {
    … …  
    285285     * Now, just simply use wp_title().
    286286     *
    287      * @deprecated BuddyPress (1.5)
     287     * @deprecated 1.5.0
    288288     * @deprecated Use wp_title()
    289      * @since BuddyPress (1.0)
     289     * @since 1.0.0
    290290     *
    291291     * @return string
    … …  
    304304 * Generate a link to log out. Last used in BP 1.2-beta. You should be using wp_logout_url().
    305305 *
    306  * @deprecated BuddyPress (1.5)
     306 * @deprecated 1.5.0
    307307 * @deprecated Use wp_logout_url()
    308  * @since BuddyPress (1.0)
     308 * @since 1.0.0
    309309 */
    310310function bp_log_out_link() {
    … …  
    318318 * Send an email and a BP notification on receipt of an @-mention in a group
    319319 *
    320  * @deprecated BuddyPress (1.5)
     320 * @deprecated 1.5.0
    321321 * @deprecated Deprecated in favor of the more general bp_activity_at_message_notification()
    322322 */
    … …  
    384384/**
    385385 * BP 1.5 simplified notification functions a bit
    386  * @deprecated BuddyPress (1.5)
     386 * @deprecated 1.5.0
    387387 *
    388388 * @return mixed
    … …  
    403403/**
    404404 * In BP 1.5, these functions were renamed for greater consistency
    405  * @deprecated BuddyPress (1.5)
     405 * @deprecated 1.5.0
    406406 */
    407407function bp_forum_directory_permalink() {
    … …  
    416416/**
    417417 * Last used by core in BP 1.1. The markup was merged into DTheme's header.php template.
    418  * @deprecated BuddyPress (1.5)
     418 * @deprecated 1.5.0
    419419 */
    420420function bp_search_form() {
    … …  
    436436/**
    437437 * Some _is_ function had their names normalized
    438  * @deprecated BuddyPress (1.5)
     438 * @deprecated 1.5.0
    439439 */
    440440function bp_is_profile_edit() {
    … …  
    444444
    445445/**
    446  * @deprecated BuddyPress (1.5)
     446 * @deprecated 1.5.0
    447447 */
    448448function bp_is_change_avatar() {
    … …  
    452452
    453453/**
    454  * @deprecated BuddyPress (1.5)
     454 * @deprecated 1.5.0
    455455 */
    456456function bp_is_friend_requests() {
    … …  
    464464 * You should be using bp_is_root_component().
    465465 *
    466  * @deprecated BuddyPress (1.5)
     466 * @deprecated 1.5.0
    467467 * @deprecated bp_is_root_component()
    468468 * @return bool True if root component, else false.
    … …  
    479479 * in BuddyPress 1.5.
    480480 *
    481  * @deprecated BuddyPress (1.5)
    482  * @since BuddyPress (1.5)
     481 * @deprecated 1.5.0
     482 * @since 1.5.0
    483483 */
    484484function bp_dtheme_deprecated() {
    … …  
    489489     * include "Activity Stream." As of 1.5.x, it is no longer required.
    490490     *
    491      * @deprecated BuddyPress (1.5)
     491     * @deprecated 1.5.0
    492492     * @deprecated No longer required.
    493493     * @param string $page_html A list of pages as a dropdown (select list)
    494494     * @return string
    495495     * @see wp_dropdown_pages()
    496      * @since BuddyPress (1.2)
     496     * @since 1.2.0
    497497     */
    498498    function bp_dtheme_wp_pages_filter( $page_html ) {
    … …  
    507507     * As of 1.5.x, it is no longer required.
    508508     *
    509      * @deprecated BuddyPress (1.5)
     509     * @deprecated 1.5.0
    510510     * @deprecated No longer required.
    511511     * @param string $oldvalue Previous value of get_option( 'page_on_front' )
    512512     * @param string $oldvalue New value of get_option( 'page_on_front' )
    513513     * @return bool|string
    514      * @since BuddyPress (1.2)
     514     * @since 1.2.0
    515515     */
    516516    function bp_dtheme_page_on_front_update( $oldvalue, $newvalue ) {
    … …  
    528528     * As of 1.5.x, it is no longer required.
    529529     *
    530      * @deprecated BuddyPress (1.5)
     530     * @deprecated 1.5.0
    531531     * @deprecated No longer required.
    532532     * @param string $template Absolute path to the page template
    533533     * @return string
    534      * @since BuddyPress (1.2)
     534     * @since 1.2.0
    535535     */
    536536    function bp_dtheme_page_on_front_template( $template ) {
    … …  
    545545     * As of 1.5.x, it is no longer required.
    546546     *
    547      * @deprecated BuddyPress (1.5)
     547     * @deprecated 1.5.0
    548548     * @deprecated No longer required.
    549      * @since BuddyPress (1.2)
     549     * @since 1.2.0
    550550     */
    551551    function bp_dtheme_fix_get_posts_on_activity_front() {
    … …  
    559559     * As of 1.5.x, it is no longer required.
    560560     *
    561      * @deprecated BuddyPress (1.5)
     561     * @deprecated 1.5.0
    562562     * @deprecated No longer required.
    563563     * @param array $posts Posts as retrieved by WP_Query
    564564     * @return array
    565      * @since BuddyPress (1.2.5)
     565     * @since 1.2.5
    566566     */
    567567    function bp_dtheme_fix_the_posts_on_activity_front( $posts ) {
    … …  
    576576     * As of 1.5.x, we recommend that you enqueue the comment-reply JavaScript in your theme's header.php.
    577577     *
    578      * @deprecated BuddyPress (1.5)
     578     * @deprecated 1.5.0
    579579     * @deprecated Enqueue the comment-reply script in your theme's header.php.
    580      * @since BuddyPress (1.2)
     580     * @since 1.2.0
    581581     */
    582582    function bp_dtheme_add_blog_comments_js() {
    … …  
    594594 * longer needed as the nav structure is set up by the {@link BP_Component} class.
    595595 *
    596  * @deprecated BuddyPress (1.5)
    597  * @since BuddyPress (1.6)
     596 * @deprecated 1.5.0
     597 * @since 1.6.0
    598598 */
    599599function bp_core_add_settings_nav() {
    … …  
    607607 * introduced.
    608608 *
    609  * @deprecated BuddyPress (1.5)
    610  * @since BuddyPress (1.6)
     609 * @deprecated 1.5.0
     610 * @since 1.6.0
    611611 */
    612612function bp_core_screen_general_settings() {
    … …  
    620620 * introduced.
    621621 *
    622  * @deprecated BuddyPress (1.5)
    623  * @since BuddyPress (1.6)
     622 * @deprecated 1.5.0
     623 * @since 1.6.0
    624624 */
    625625function bp_core_screen_general_settings_title() {
    … …  
    633633 * introduced.
    634634 *
    635  * @deprecated BuddyPress (1.5)
    636  * @since BuddyPress (1.6)
     635 * @deprecated 1.5.0
     636 * @since 1.6.0
    637637 */
    638638function bp_core_screen_general_settings_content() {
    … …  
    646646 * introduced.
    647647 *
    648  * @deprecated BuddyPress (1.5)
    649  * @since BuddyPress (1.6)
     648 * @deprecated 1.5.0
     649 * @since 1.6.0
    650650 */
    651651function bp_core_screen_notification_settings() {
    … …  
    659659 * introduced.
    660660 *
    661  * @deprecated BuddyPress (1.5)
    662  * @since BuddyPress (1.6)
     661 * @deprecated 1.5.0
     662 * @since 1.6.0
    663663 */
    664664function bp_core_screen_notification_settings_title() {
    … …  
    672672 * introduced.
    673673 *
    674  * @deprecated BuddyPress (1.5)
    675  * @since BuddyPress (1.6)
     674 * @deprecated 1.5.0
     675 * @since 1.6.0
    676676 */
    677677function bp_core_screen_notification_settings_content() {
    … …  
    685685 * introduced.
    686686 *
    687  * @deprecated BuddyPress (1.5)
    688  * @since BuddyPress (1.6)
     687 * @deprecated 1.5.0
     688 * @since 1.6.0
    689689 */
    690690function bp_core_screen_delete_account() {
    … …  
    698698 * introduced.
    699699 *
    700  * @deprecated BuddyPress (1.5)
    701  * @since BuddyPress (1.6)
     700 * @deprecated 1.5.0
     701 * @since 1.6.0
    702702 */
    703703function bp_core_screen_delete_account_title() {
    … …  
    711711 * introduced.
    712712 *
    713  * @deprecated BuddyPress (1.5)
    714  * @since BuddyPress (1.6)
     713 * @deprecated 1.5.0
     714 * @since 1.6.0
    715715 */
    716716function bp_core_screen_delete_account_content() {

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

    r9819 r10108  
    11<?php
    2 
    32/**
    43 * Deprecated Functions
    … …  
    65 * @package BuddyPress
    76 * @subpackage Core
    8  * @deprecated Since 1.6
     7 * @deprecated 1.6.0
    98 */
    109
    … …  
    1514
    1615/**
    17  * @deprecated BuddyPress (1.6)
     16 * @deprecated 1.6.0
    1817 */
    1918function bp_admin_bar_remove_wp_menus() {
    … …  
    2221
    2322/**
    24  * @deprecated BuddyPress (1.6)
     23 * @deprecated 1.6.0
    2524 */
    2625function bp_admin_bar_root_site() {
    … …  
    2928
    3029/**
    31  * @deprecated BuddyPress (1.6)
     30 * @deprecated 1.6.0
    3231 */
    3332function bp_admin_bar_my_sites_menu() {
    … …  
    3635
    3736/**
    38  * @deprecated BuddyPress (1.6)
     37 * @deprecated 1.6.0
    3938 */
    4039function bp_admin_bar_comments_menu( $wp_admin_bar = '' ) {
    … …  
    4342
    4443/**
    45  * @deprecated BuddyPress (1.6)
     44 * @deprecated 1.6.0
    4645 */
    4746function bp_admin_bar_appearance_menu() {
    … …  
    5049
    5150/**
    52  * @deprecated BuddyPress (1.6)
     51 * @deprecated 1.6.0
    5352 */
    5453function bp_admin_bar_updates_menu() {
    … …  
    5756
    5857/**
    59  * @deprecated BuddyPress (1.6)
     58 * @deprecated 1.6.0
    6059 */
    6160function bp_members_admin_bar_my_account_logout() {
    … …  
    6463
    6564/**
    66  * @deprecated BuddyPress (1.6)
     65 * @deprecated 1.6.0
    6766 */
    6867function bp_core_is_user_deleted( $user_id = 0 ) {
    … …  
    7271
    7372/**
    74  * @deprecated BuddyPress (1.6)
     73 * @deprecated 1.6.0
    7574 */
    7675function bp_core_is_user_spammer( $user_id = 0 ) {
    … …  
    8584
    8685/**
    87  * @deprecated BuddyPress (1.6)
     86 * @deprecated 1.6.0
    8887 * @deprecated No longer used; see bp_blogs_transition_activity_status()
    8988 */
    … …  
    9796
    9897/**
    99  * @deprecated BuddyPress (1.6)
     98 * @deprecated 1.6.0
    10099 * @deprecated No longer used; see BP_Admin::admin_menus()
    101100 */
    … …  
    105104
    106105/**
    107  * @deprecated BuddyPress (1.6)
     106 * @deprecated 1.6.0
    108107 * @deprecated No longer used. We do ajax properly now.
    109108 */
    … …  
    119118 * Displays Friends header tabs
    120119 *
    121  * @deprecated BuddyPress (1.6)
     120 * @deprecated 1.6.0
    122121 * @deprecated No longer used
    123122 */
    … …  
    137136 * Filters the title for the Friends component
    138137 *
    139  * @deprecated BuddyPress (1.6)
     138 * @deprecated 1.6.0
    140139 * @deprecated No longer used
    141140 */
    … …  
    162161
    163162/**
    164  * @deprecated BuddyPress (1.6)
     163 * @deprecated 1.6.0
    165164 * @deprecated Renamed to groups_get_id() for greater consistency
    166165 */
    … …  
    175174 * Loads admin panel styles and scripts.
    176175 *
    177  * @deprecated BuddyPress (1.6)
     176 * @deprecated 1.6.0
    178177 */
    179178function bp_core_add_admin_menu_styles() {
    … …  
    184183
    185184/**
    186  * @deprecated BuddyPress (1.6)
     185 * @deprecated 1.6.0
    187186 */
    188187function updates_register_activity_actions() {
    … …  
    193192 * Sets the "From" address in emails sent
    194193 *
    195  * @deprecated BuddyPress (1.6)
     194 * @deprecated 1.6.0
    196195 * @return string email address
    197196 */
    … …  
    220219 * function was introduced in BP 1.6 for related backward compatibility reasons).
    221220 *
    222  * @deprecated BuddyPress (1.6)
     221 * @deprecated 1.6.0
    223222 */
    224223if ( !function_exists( 'bp_dtheme_register_actions' ) ) :

  • trunk/src/bp-core/deprecated/1.7.php

    r9819 r10108  
    55 * @package BuddyPress
    66 * @subpackage Core
    7  * @deprecated Since 1.7
     7 * @deprecated Since 1.7.0
    88 */
    99
    … …  
    1414 * Output the BuddyPress maintenance mode
    1515 *
    16  * @since BuddyPress (1.6)
    17  * @deprecated BuddyPress (1.7)
     16 * @since 1.6.0
     17 * @deprecated 1.7.0
    1818 * @uses bp_get_maintenance_mode() To get the BuddyPress maintenance mode
    1919 */
    … …  
    2424     * Return the BuddyPress maintenance mode
    2525     *
    26      * @since BuddyPress (1.6)
    27      * @deprecated BuddyPress (1.7)
     26     * @since 1.6.0
     27     * @deprecated 1.7.0
    2828     * @return string The BuddyPress maintenance mode
    2929     */
    … …  
    3333
    3434/**
    35  * @deprecated BuddyPress (1.7)
     35 * @deprecated 1.7.0
    3636 */
    3737function xprofile_get_profile() {
    … …  
    4141
    4242/**
    43  * @deprecated BuddyPress (1.7)
     43 * @deprecated 1.7.0
    4444 */
    4545function bp_get_profile_header() {
    … …  
    4949
    5050/**
    51  * @deprecated BuddyPress (1.7)
     51 * @deprecated 1.7.0
    5252 * @param string $component_name
    5353 * @return boolean
    … …  
    6262
    6363/**
    64  * @deprecated BuddyPress (1.7)
     64 * @deprecated 1.7.0
    6565 */
    6666function bp_get_plugin_sidebar() {
    … …  
    7575 * step. It also means that the themes won't show for selection on other blogs.
    7676 *
    77  * @deprecated BuddyPress (1.7)
     77 * @deprecated 1.7.0
    7878 * @package BuddyPress Core
    7979 */
    … …  
    9898 * No longer used by BuddyPress core
    9999 *
    100  * @deprecated BuddyPress (1.7)
     100 * @deprecated 1.7.0
    101101 * @param string $page
    102102 * @return boolean True if is BuddyPress page
    … …  
    120120 * before we had a legitimate update process.
    121121 *
    122  * @deprecated BuddyPress (1.7)
     122 * @deprecated 1.7.0
    123123 * @global WPDB $wpdb
    124124 */

  • trunk/src/bp-core/deprecated/1.9.php

    r9819 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Notifications
    … …  
    2019 *             bp_notifications_add_notification() instead.
    2120 *
    22  * @since BuddyPress (1.0.0)
     21 * @since 1.0.0
    2322 * @param string $item_id
    2423 * @param int $user_id
    … …  
    6362 *             bp_notifications_delete_notification() instead.
    6463 *
    65  * @since BuddyPress (1.0.0)
     64 * @since 1.0.0
    6665 * @param int $id ID of notification.
    6766 * @return boolean True on success, false on failure.
    … …  
    8685 *             bp_notifications_get_notification() instead.
    8786 *
    88  * @since BuddyPress (1.0.0)
     87 * @since 1.0.0
    8988 * @param int $id ID of notification.
    9089 * @return BP_Core_Notification
    … …  
    109108 *             bp_notifications_get_notifications_for_user() instead.
    110109 *
    111  * @since BuddyPress (1.0.0)
     110 * @since 1.0.0
    112111 * @param int $user_id ID of user.
    113112 * @param string $format
    … …  
    138137 *             bp_notifications_delete_notifications_by_type() instead.
    139138 *
    140  * @since BuddyPress (1.0.0)
     139 * @since 1.0.0
    141140 * @param int $user_id
    142141 * @param string $component_name
    … …  
    166165 *             bp_notifications_delete_notifications_by_item_id() instead.
    167166 *
    168  * @since BuddyPress (1.0.0)
     167 * @since 1.0.0
    169168 * @param int $user_id
    170169 * @param string $component_name
    … …  
    191190 *             bp_notifications_delete_all_notifications_by_type() instead.
    192191 *
    193  * @since BuddyPress (1.0.0)
     192 * @since 1.0.0
    194193 * @param int $user_id
    195194 * @param string $component_name
    … …  
    218217 *             bp_notifications_delete_notifications_from_user() instead.
    219218 *
    220  * @since BuddyPress (1.0.0)
     219 * @since 1.0.0
    221220 * @param int $user_id
    222221 * @param string $component_name
    … …  
    247246 *             bp_notifications_check_notification_access() instead.
    248247 *
    249  * @since BuddyPress (1.0.0)
     248 * @since 1.0.0
    250249 * @param int $user_id
    251250 * @param int $notification_id

  • trunk/src/bp-core/deprecated/2.0.php

    r9819 r10108  
    1212
    1313/**
    14  * @deprecated BuddyPress (2.0.0)
     14 * @deprecated 2.0.0
    1515 */
    1616function bp_activity_clear_meta_cache_for_activity() {
    … …  
    1919
    2020/**
    21  * @deprecated BuddyPress (2.0.0)
     21 * @deprecated 2.0.0
    2222 */
    2323function bp_blogs_catch_published_post() {
    … …  
    2626
    2727/**
    28  * @deprecated BuddyPress (2.0.0)
     28 * @deprecated 2.0.0
    2929 */
    3030function bp_messages_screen_inbox_mark_notifications() {

  • trunk/src/bp-core/deprecated/2.1.php

    r9819 r10108  
    1414 * Register (not enqueue) scripts that used to be used by BuddyPress.
    1515 *
    16  * @since BuddyPress (2.1.0)
     16 * @since 2.1.0
    1717 */
    1818function bp_core_register_deprecated_scripts() {
    … …  
    5353 * Register (not enqueue) styles that used to be used by BuddyPress.
    5454 *
    55  * @since BuddyPress (2.1.0)
     55 * @since 2.1.0
    5656 */
    5757function bp_core_register_deprecated_styles() {
    … …  
    8383 * Add a Sites menu to the BuddyBar.
    8484 *
    85  * @since BuddyPress (1.0.0)
    86  * @deprecated BuddyPress (2.1.0)
     85 * @since 1.0.0
     86 * @deprecated 2.1.0
    8787 *
    8888 * @return bool|null Returns false on failure. Otherwise echoes the menu item.
    … …  
    150150 * to the WP Toolbar.
    151151 *
    152  * @since BuddyPress (1.6)
    153  * @deprecated BuddyPress (2.1.0)
     152 * @since 1.6.0
     153 * @deprecated 2.1.0
    154154 */
    155155function bp_admin_setting_callback_force_buddybar() {
    … …  
    170170 * to flip the boolean before saving the intval.
    171171 *
    172  * @since BuddyPress (1.6)
    173  * @deprecated BuddyPress (2.1.0)
     172 * @since 1.6.0
     173 * @deprecated 2.1.0
    174174 * @access Private
    175175 */
    … …  
    182182 *
    183183 * @return bool|null Returns false if the BuddyBar is disabled.
    184  * @deprecated BuddyPress (2.1.0)
     184 * @deprecated 2.1.0
    185185 */
    186186function bp_core_admin_bar() {
    … …  
    216216 * Output the BuddyBar logo.
    217217 *
    218  * @deprecated BuddyPress (2.1.0)
     218 * @deprecated 2.1.0
    219219 */
    220220function bp_adminbar_logo() {
    … …  
    227227 * Visible only to visitors who are not logged in.
    228228 *
    229  * @deprecated BuddyPress (2.1.0)
     229 * @deprecated 2.1.0
    230230 *
    231231 * @return bool|null Returns false if the current user is logged in.
    … …  
    248248 * Output the My Account BuddyBar menu.
    249249 *
    250  * @deprecated BuddyPress (2.1.0)
     250 * @deprecated 2.1.0
    251251 *
    252252 * @return bool|null Returns false on failure.
    … …  
    333333 * Not visible for logged-in users.
    334334 *
    335  * @deprecated BuddyPress (2.1.0)
     335 * @deprecated 2.1.0
    336336 */
    337337function bp_adminbar_random_menu() {
    … …  
    366366 * Enqueue the BuddyBar CSS.
    367367 *
    368  * @deprecated BuddyPress (2.1.0)
     368 * @deprecated 2.1.0
    369369 */
    370370function bp_core_load_buddybar_css() {
    … …  
    394394 * Add menu items to the BuddyBar.
    395395 *
    396  * @since BuddyPress (1.0.0)
    397  *
    398  * @deprecated BuddyPress (2.1.0)
     396 * @since 1.0.0
     397 *
     398 * @deprecated 2.1.0
    399399 */
    400400function bp_groups_adminbar_admin_menu() {
    … …  
    452452 * Add the Notifications menu to the BuddyBar.
    453453 *
    454  * @deprecated BuddyPress (2.1.0)
     454 * @deprecated 2.1.0
    455455 */
    456456function bp_adminbar_notifications_menu() {
    … …  
    468468 * Add the Blog Authors menu to the BuddyBar (visible when not logged in).
    469469 *
    470  * @deprecated BuddyPress (2.1.0)
     470 * @deprecated 2.1.0
    471471 */
    472472function bp_adminbar_authors_menu() {
    … …  
    524524 * that allow capable users to clean up a users account.
    525525 *
    526  * @deprecated BuddyPress (2.1.0)
     526 * @deprecated 2.1.0
    527527 */
    528528function bp_members_adminbar_admin_menu() {
    … …  
    567567 * Create the Notifications menu for the BuddyBar.
    568568 *
    569  * @since BuddyPress (1.9.0)
    570  * @deprecated BuddyPress (2.1.0)
     569 * @since 1.9.0
     570 * @deprecated 2.1.0
    571571 */
    572572function bp_notifications_buddybar_menu() {
    … …  
    614614 * Output the base URL for subdomain installations of WordPress Multisite.
    615615 *
    616  * @since BuddyPress (1.6.0)
    617  *
    618  * @deprecated BuddyPress (2.1.0)
     616 * @since 1.6.0
     617 *
     618 * @deprecated 2.1.0
    619619 */
    620620function bp_blogs_subdomain_base() {
    … …  
    626626 * Return the base URL for subdomain installations of WordPress Multisite.
    627627 *
    628  * @since BuddyPress (1.6.0)
     628 * @since 1.6.0
    629629 *
    630630 * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com.
    631631 *
    632  * @deprecated BuddyPress (2.1.0)
     632 * @deprecated 2.1.0
    633633 */
    634634function bp_blogs_get_subdomain_base() {
    … …  
    640640 * Allegedly output an avatar upload form, but it hasn't done that since 2009.
    641641 *
    642  * @since BuddyPress (1.0.0)
    643  * @deprecated BuddyPress (2.1.0)
     642 * @since 1.0.0
     643 * @deprecated 2.1.0
    644644 */
    645645function bp_avatar_upload_form() {

  • trunk/src/bp-core/deprecated/2.2.php

    r9819 r10108  
    2020 * See #4090, #3746, #2546 for background.
    2121 *
    22  * @since BuddyPress (2.0.0)
    23  * @deprecated BuddyPress (2.2.0)
     22 * @since 2.0.0
     23 * @deprecated 2.2.0
    2424 *
    2525 * @todo Support untrashing better
    … …  
    3737 * Record a new blog post in the BuddyPress activity stream.
    3838 *
    39  * @deprecated BuddyPress (2.2.0)
     39 * @deprecated 2.2.0
    4040 *
    4141 * @param int $post_id ID of the post being recorded.
    … …  
    5353 * Updates a blog post's corresponding activity entry during a post edit.
    5454 *
    55  * @since BuddyPress (2.0.0)
    56  * @deprecated BuddyPress (2.2.0)
     55 * @since 2.0.0
     56 * @deprecated 2.2.0
    5757 *
    5858 * @see bp_blogs_catch_transition_post_status()
    … …  
    6868 * Clear cache when a new blog is created.
    6969 *
    70  * @since BuddyPress (1.0.0)
    71  * @deprecated BuddyPress (2.2.0)
     70 * @since 1.0.0
     71 * @deprecated 2.2.0
    7272 *
    7373 * @param BP_Blogs_Blog $recorded_blog_obj The recorded blog, passed by
    … …  
    8282 * Format 'new_member' activity actions.
    8383 *
    84  * @since BuddyPress (2.0.0)
    85  * @deprecated BuddyPress (2.2.0)
     84 * @since 2.0.0
     85 * @deprecated 2.2.0
    8686 *
    8787 * @param string $action Static activity action.
    … …  
    9999 * Add 'bp' to global group of network wide cachable objects.
    100100 *
    101  * @since BuddyPress (1.1)
    102  * @deprecated BuddyPress (2.2.0)
     101 * @since 1.1.0
     102 * @deprecated 2.2.0
    103103 */
    104104function bp_core_add_global_group() {
    … …  
    109109 * Add a piece of message metadata.
    110110 *
    111  * @deprecated BuddyPress (2.2.2)
     111 * @deprecated 2.2.2
    112112 */
    113113function bp_message_add_meta( $message_id, $meta_key, $meta_value, $unique = false ) {

  • trunk/src/bp-core/deprecated/2.3.php

    r9819 r10108  
    1212 * Return the referrer URL without the http(s)://
    1313 *
    14  * @deprecated BuddyPress (2.3.0)
     14 * @deprecated 2.3.0
    1515 *
    1616 * @return string The referrer URL.
Note: See TracChangeset for help on using the changeset viewer.