Skip to:
Content

BuddyPress.org

Changeset 10010


Ignore:
Timestamp:
07/11/2015 11:00:19 PM (5 years ago)
Author:
tw2113
Message:

Initial documentation cleanup for the bp-loader.php file.

See #6401.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-loader.php

    r10000 r10010  
    11<?php
    22/**
    3  * The BuddyPress Plugin
     3 * The BuddyPress Plugin.
    44 *
    55 * BuddyPress is social networking software with a twist from the creators of WordPress.
     
    2828if ( !class_exists( 'BuddyPress' ) ) :
    2929/**
    30  * Main BuddyPress Class
     30 * Main BuddyPress Class.
    3131 *
    3232 * Tap tap tap... Is this thing on?
     
    113113     * Main BuddyPress Instance.
    114114     *
    115      * BuddyPress is great
    116      * Please load it only one time
    117      * For this, we thank you
     115     * BuddyPress is great.
     116     * Please load it only one time.
     117     * For this, we thank you.
    118118     *
    119119     * Insures that only one instance of BuddyPress exists in memory at any
     
    182182     *
    183183     * @since BuddyPress (1.7.0)
     184     *
     185     * @param string $key Key to check the set status for.
     186     *
     187     * @return bool
    184188     */
    185189    public function __isset( $key ) { return isset( $this->data[$key] ); }
     
    189193     *
    190194     * @since BuddyPress (1.7.0)
     195     *
     196     * @param string $key Key to return the value for.
     197     *
     198     * @return mixed
    191199     */
    192200    public function __get( $key ) { return isset( $this->data[$key] ) ? $this->data[$key] : null; }
     
    196204     *
    197205     * @since BuddyPress (1.7.0)
     206     *
     207     * @param string $key   Key to set a value for.
     208     * @param mixed  $value Value to set.
    198209     */
    199210    public function __set( $key, $value ) { $this->data[$key] = $value; }
     
    203214     *
    204215     * @since BuddyPress (1.7.0)
     216     *
     217     * @param string $key Key to unset a value for.
    205218     */
    206219    public function __unset( $key ) { if ( isset( $this->data[$key] ) ) unset( $this->data[$key] ); }
     
    210223     *
    211224     * @since BuddyPress (1.7.0)
     225     *
     226     * @param string $name
     227     * @param array  $args
     228     *
     229     * @return null
    212230     */
    213231    public function __call( $name = '', $args = array() ) { unset( $name, $args ); return null; }
     
    320338         * @since BuddyPress (2.0.0)
    321339         *
    322          * @param constant BP_IGNORE_DEPRECATED Whether or not to ignore deprecated functionality.
     340         * @const constant BP_IGNORE_DEPRECATED Whether or not to ignore deprecated functionality.
    323341         */
    324342        $this->load_deprecated = ! apply_filters( 'bp_ignore_deprecated', BP_IGNORE_DEPRECATED );
     
    327345
    328346        /**
    329          * @var string The primary toolbar ID
     347         * @var string The primary toolbar ID.
    330348         */
    331349        $this->my_account_menu_id = '';
     
    347365
    348366        /**
    349          * @var string Name of the current BuddyPress component (primary)
     367         * @var string Name of the current BuddyPress component (primary).
    350368         */
    351369        $this->current_component = '';
    352370
    353371        /**
    354          * @var string Name of the current BuddyPress item (secondary)
     372         * @var string Name of the current BuddyPress item (secondary).
    355373         */
    356374        $this->current_item = '';
    357375
    358376        /**
    359          * @var string Name of the current BuddyPress action (tertiary)
     377         * @var string Name of the current BuddyPress action (tertiary).
    360378         */
    361379        $this->current_action = '';
    362380
    363381        /**
    364          * @var bool Displaying custom 2nd level navigation menu (I.E a group)
     382         * @var bool Displaying custom 2nd level navigation menu (I.E a group).
    365383         */
    366384        $this->is_single_item = false;
     
    368386        /** Root **************************************************************/
    369387
    370         // BuddyPress Root blog ID
    371388        /**
    372389         * Filters the BuddyPress Root blog ID.
     
    374391         * @since BuddyPress (1.5.0)
    375392         *
    376          * @param constant BP_ROOT_BLOG BuddyPress Root blog ID.
     393         * @const constant BP_ROOT_BLOG BuddyPress Root blog ID.
    377394         */
    378395        $this->root_blog_id = (int) apply_filters( 'bp_get_root_blog_id', BP_ROOT_BLOG );
     
    653670
    654671/**
    655  * Hook BuddyPress early onto the 'plugins_loaded' action..
     672 * Hook BuddyPress early onto the 'plugins_loaded' action.
    656673 *
    657674 * This gives all other plugins the chance to load before BuddyPress, to get
Note: See TracChangeset for help on using the changeset viewer.