[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/ -> class-buddypress.php (summary)

(no description)

File Size: 777 lines (24 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BuddyPress:: (19 methods):
  instance()
  __construct()
  __clone()
  __wakeup()
  __isset()
  __get()
  __set()
  __unset()
  __call()
  constants()
  setup_globals()
  legacy_constants()
  includes()
  autoload()
  setup_actions()
  versions()
  register_theme_directory()
  register_theme_packages()
  setup_theme()


Class: BuddyPress  - X-Ref

Main BuddyPress Class.

Tap tap tap... Is this thing on?

instance()   X-Ref
Main BuddyPress Instance.

BuddyPress is great.
Please load it only one time.
For this, we thank you.

Insures that only one instance of BuddyPress exists in memory at any
one time. Also prevents needing to define globals all over the place.

return: BuddyPress|null The one true BuddyPress.
since: 1.7.0

__construct()   X-Ref
A dummy constructor to prevent BuddyPress from being loaded more than once.

since: 1.7.0

__clone()   X-Ref
A dummy magic method to prevent BuddyPress from being cloned.

since: 1.7.0

__wakeup()   X-Ref
A dummy magic method to prevent BuddyPress from being unserialized.

since: 1.7.0

__isset( $key )   X-Ref
Magic method for checking the existence of a certain custom field.

return: bool
param: string $key Key to check the set status for.
since: 1.7.0

__get( $key )   X-Ref
Magic method for getting BuddyPress variables.

return: mixed
param: string $key Key to return the value for.
since: 1.7.0

__set( $key, $value )   X-Ref
Magic method for setting BuddyPress variables.

param: string $key   Key to set a value for.
param: mixed  $value Value to set.
since: 1.7.0

__unset( $key )   X-Ref
Magic method for unsetting BuddyPress variables.

param: string $key Key to unset a value for.
since: 1.7.0

__call( $name = '', $args = array()   X-Ref
Magic method to prevent notices and errors from invalid method calls.

return: null
param: string $name
param: array  $args
since: 1.7.0

constants()   X-Ref
Bootstrap constants.

since: 1.6.0

setup_globals()   X-Ref
Component global variables.

since: 1.6.0

legacy_constants()   X-Ref
Legacy BuddyPress constants.

Try to avoid using these. Their values have been moved into variables
in the instance, and have matching functions to get/set their values.

since: 1.7.0

includes()   X-Ref
Include required files.

since: 1.6.0

autoload( $class )   X-Ref
Autoload classes.

param: string $class
since: 2.5.0

setup_actions()   X-Ref
Set up the default hooks and actions.

since: 1.6.0

versions()   X-Ref
Private method to align the active and database versions.

since: 1.7.0

register_theme_directory()   X-Ref
Set up BuddyPress's legacy theme directory.

Starting with version 1.2, and ending with version 1.8, BuddyPress
registered a custom theme directory - bp-themes - which contained
the bp-default theme. Since BuddyPress 1.9, bp-themes is no longer
registered (and bp-default no longer offered) on new installations.
Sites using bp-default (or a child theme of bp-default) will
continue to have bp-themes registered as before.

since: 1.5.0

register_theme_packages()   X-Ref
Register bundled theme packages.

Note that since we currently have complete control over bp-themes and
the bp-legacy folders, it's fine to hardcode these here. If at a
later date we need to automate this, an API will need to be built.

since: 1.7.0

setup_theme()   X-Ref
Set up the default BuddyPress theme compatibility location.

since: 1.7.0



Generated: Wed Dec 19 01:01:54 2018 Cross-referenced by PHPXref 0.7.1