Docs For Class BP_Options

Interface BP_Options_Interface

Description

Interface for BP_Options;

A BP_Options class must be implemented by the host application for BackPress to operate. This interface supplies a boilerplate for that class but can only be implemented in PHP 5 environments.

since: r132

Located in /includes/interface.bp-options.php (line 21)

Method Summary

void add (string $option, mixed $value)

void delete (string $option)

void get (string $option)

void prefix ()

void update (string $option, mixed $value)

Methods

add (line 59)

Adds an option with given value.

since: r132

void add (string $option, mixed $value)

string $option: Option name.
mixed $value: Option value.

delete (line 78)

Deletes an existing option.

since: r132

void delete (string $option)

string $option: Option name.

get (line 49)

Retrieve the value of the option.

Here is a minimum set of values required (from bbPress)

application_id : An id for the application, use this when running multiple applications from the same code
application_uri : The base URI of the application
cron_uri : The URI that processes cron jobs
wp_http_version : This is the version sent when making remote HTTP requests
hash_function_name : The function used to create unique hashes ( see wp_hash() )
language_locale : The current locale
language_directory : The directory containing language (po, mo) files
charset : The charset to use when appropriate (usually UTF-8)
gmt_offset : The GMT offset as a positive or negative float
timezone_string : The timezone in Zoneinfo format

since: r132

void get (string $option)

string $option: Option name.

prefix (line 28)

Retrieve the prefix to be appended to the beginning of the option key.

since: r132

void prefix ()

update (line 69)

Updates an existing option with a given value.

since: r132

void update (string $option, mixed $value)

string $option: Option name.
mixed $value: Option value.

Documentation generated on Fri, 18 May 2012 01:34:02 +0100 by phpDocumentor 1.4.3