Skip to:
Content

BuddyPress.org

Changeset 10137


Ignore:
Timestamp:
09/24/2015 11:49:25 PM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Settings component.

See #6576.

Location:
trunk/src/bp-settings
Files:
5 edited

Legend:

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

    r9994 r10137  
    11<?php
    2 
    32/**
    43 * BuddyPress Settings Actions
     
    98 */
    109
    11 // Exit if accessed directly
     10// Exit if accessed directly.
    1211defined( 'ABSPATH' ) || exit;
    1312
     
    127126                     * Filter the email text sent when a user changes emails.
    128127                     *
    129                      * @since BuddyPress (2.1.0)
     128                     * @since 2.1.0
    130129                     *
    131130                     * @param string  $email_text     Text of the email.
     
    271270     * Fires after the general settings have been saved, and before redirect.
    272271     *
    273      * @since BuddyPress (1.5.0)
     272     * @since 1.5.0
    274273     */
    275274    do_action( 'bp_core_general_settings_after_save' );
     
    321320     * Fires after the notification settings have been saved, and before redirect.
    322321     *
    323      * @since BuddyPress (1.5.0)
     322     * @since 1.5.0
    324323     */
    325324    do_action( 'bp_core_notification_settings_after_save' );
     
    364363     * Fires before the capabilities settings have been saved.
    365364     *
    366      * @since BuddyPress (1.6.0)
     365     * @since 1.6.0
    367366     */
    368367    do_action( 'bp_settings_capabilities_before_save' );
     
    379378         * Fires after processing a user as a spammer.
    380379         *
    381          * @since BuddyPress (1.1.0)
     380         * @since 1.1.0
    382381         *
    383382         * @param int    $value  ID of the currently displayed user.
     
    392391     * Fires after the capabilities settings have been saved and before redirect.
    393392     *
    394      * @since BuddyPress (1.6.0)
     393     * @since 1.6.0
    395394     */
    396395    do_action( 'bp_settings_capabilities_after_save' );
     
    450449 * Process email change verification or cancel requests.
    451450 *
    452  * @since BuddyPress (2.1.0)
     451 * @since 2.1.0
    453452 */
    454453function bp_settings_verify_email_change(){
     
    508507 * Removes 'Email' sub nav, if no component has registered options there.
    509508 *
    510  * @since BuddyPress (2.2.0)
     509 * @since 2.2.0
    511510 */
    512511function bp_settings_remove_email_subnav() {
  • trunk/src/bp-settings/bp-settings-functions.php

    r9819 r10137  
    11<?php
    2 
    32/**
    43 * BuddyPress Settings Functions
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
  • trunk/src/bp-settings/bp-settings-loader.php

    r9994 r10137  
    11<?php
    2 
    32/**
    43 * BuddyPress Settings Loader.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1615     * Start the settings component creation process.
    1716     *
    18      * @since BuddyPress (1.5.0)
     17     * @since 1.5.0
    1918     */
    2019    public function __construct() {
     
    5150     * @param array $args Array of arguments.
    5251     *
    53      * @since BuddyPress (1.5.0)
     52     * @since 1.5.0
    5453     */
    5554    public function setup_globals( $args = array() ) {
  • trunk/src/bp-settings/bp-settings-screens.php

    r9994 r10137  
    11<?php
    2 
    32/**
    43 * BuddyPress Settings Screens.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Show the general settings template.
    1514 *
    16  * @since BuddyPress (1.5.0)
     15 * @since 1.5.0
    1716 */
    1817function bp_settings_screen_general() {
     
    2625     * Filters the template file path to use for the general settings screen.
    2726     *
    28      * @since BuddyPress (1.6.0)
     27     * @since 1.6.0
    2928     *
    3029     * @param string $value Directory path to look in for the template file.
     
    3635 * Show the notifications settings template.
    3736 *
    38  * @since BuddyPress (1.5.0)
     37 * @since 1.5.0
    3938 */
    4039function bp_settings_screen_notification() {
     
    4847     * Filters the template file path to use for the notification settings screen.
    4948     *
    50      * @since BuddyPress (1.6.0)
     49     * @since 1.6.0
    5150     *
    5251     * @param string $value Directory path to look in for the template file.
     
    5857 * Show the delete-account settings template.
    5958 *
    60  * @since BuddyPress (1.5.0)
     59 * @since 1.5.0
    6160 */
    6261function bp_settings_screen_delete_account() {
     
    7069     * Filters the template file path to use for the delete-account settings screen.
    7170     *
    72      * @since BuddyPress (1.6.0)
     71     * @since 1.6.0
    7372     *
    7473     * @param string $value Directory path to look in for the template file.
     
    8079 * Show the capabilities settings template.
    8180 *
    82  * @since BuddyPress (1.6.0)
     81 * @since 1.6.0
    8382 */
    8483function bp_settings_screen_capabilities() {
     
    9291     * Filters the template file path to use for the capabilities settings screen.
    9392     *
    94      * @since BuddyPress (1.6.0)
     93     * @since 1.6.0
    9594     *
    9695     * @param string $value Directory path to look in for the template file.
  • trunk/src/bp-settings/bp-settings-template.php

    r9994 r10137  
    11<?php
    2 
    32/**
    43 * BuddyPress Settings Template Functions.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1615 * @package BuddyPress
    1716 * @subpackage SettingsTemplate
    18  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1918 *
    2019 * @uses bp_get_settings_slug()
     
    2827     * @package BuddyPress
    2928     * @subpackage SettingsTemplate
    30      * @since BuddyPress (1.5.0)
     29     * @since 1.5.0
    3130     */
    3231    function bp_get_settings_slug() {
     
    3534         * Filters the Settings component slug.
    3635         *
    37          * @since BuddyPress (1.5.0)
     36         * @since 1.5.0
    3837         *
    3938         * @param string $slug Settings component slug.
     
    4746 * @package BuddyPress
    4847 * @subpackage SettingsTemplate
    49  * @since BuddyPress (1.5.0)
     48 * @since 1.5.0
    5049 *
    5150 * @uses bp_get_settings_root_slug()
     
    5958     * @package BuddyPress
    6059     * @subpackage SettingsTemplate
    61      * @since BuddyPress (1.5.0)
     60     * @since 1.5.0
    6261     */
    6362    function bp_get_settings_root_slug() {
     
    6665         * Filters the Settings component root slug.
    6766         *
    68          * @since BuddyPress (1.5.0)
     67         * @since 1.5.0
    6968         *
    7069         * @param string $root_slug Settings component root slug.
     
    7675 * Add the 'pending email change' message to the settings page.
    7776 *
    78  * @since BuddyPress (2.1.0)
     77 * @since 2.1.0
    7978 */
    8079function bp_settings_pending_email_notice() {
Note: See TracChangeset for help on using the changeset viewer.