API Documentation
Back to top  

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
package BackPress

 Methods

Adds an option with given value.

add(string $option, mixed $value) 
since r132

Parameters

$option

string

Option name.

$value

mixed

Option value.

Deletes an existing option.

delete(string $option) 
since r132

Parameters

$option

string

Option name.

Retrieve the value of the option.

get(string $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

Parameters

$option

string

Option name.

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

prefix() 
since r132

Updates an existing option with a given value.

update(string $option, mixed $value) 
since r132

Parameters

$option

string

Option name.

$value

mixed

Option value.