API Documentation » \BBP

Loads bbPress plugin admin area

package	bbPress
subpackage	Administration
since	2.0.0 bbPress (r2464)

Methods

The main bbPress admin loader

__construct()

since	2.0.0 bbPress (r2515)

Output the about screen

about_screen()

since	2.2.0 bbPress (r4159)
todo	Host this remotely.

Add a notice to the notices array

add_notice(string|\WP_Error $message, string $class = false, boolean $is_dismissible = true) : void

since	2.6.0 bbPress (r6771)

Parameters

$message

string\WP_Error

A message to be displayed or {@link WP_Error}

$class

string

Optional. A class to be added to the message div

$is_dismissible

boolean

Optional. True to dismiss, false to persist

Maybe append the pending upgrade count to the "Tools" menu.

add_upgrade_count()

since	2.6.0 bbPress (r6896)
global	menu $menu

Remove the individual recount and converter menus.

admin_head()

They are grouped together by h2 tabs

since	2.0.0 bbPress (r2464)

Add the admin menus

admin_menus()

since	2.0.0 bbPress (r2646)

Output the credits screen

credits_screen()

since	2.2.0 bbPress (r4159)
todo	Host this remotely.

Add post-state support for shortcode usages.

display_post_states(array $post_states = array(), integer|\WP_Post $post = 0) : array

Also does a quick slug comparison, to avoid doing many get_page_by_path() calls inside of a list-table loop. This is less precise but should work well-enough for most installations.

since	2.7.0

Parameters

$post_states

array

$post

integer\WP_Post

Returns

array

Enqueue any admin scripts we might need

enqueue_scripts()

since	2.2.0 bbPress (r4260)

Enqueue any admin scripts we might need

enqueue_styles()

since	2.6.0 bbPress (r5224)

Handle hiding of general admin area notices.

hide_notices()

since	2.6.0 bbPress (r6701)

Maps settings capabilities

map_settings_meta_caps(array $caps = array(), string $cap = '', integer $user_id = 0, array $args = array()) : array

Static

since	2.2.0 bbPress (r4242)

Parameters

$caps

array

Capabilities for meta capability

$cap

string

Capability name

$user_id

integer

User id

$args

array

Arguments

Returns

arrayActual capabilities for meta capability

Add Settings link to plugins area

modify_plugin_action_links(array $links, string $file) : array

Static

since	2.0.0 bbPress (r2737)

Parameters

$links

array

Links array in which we would prepend our link

$file

string

Current plugin basename

Returns

arrayProcessed links

Add the network admin menus

network_admin_menus()

since	2.1.0 bbPress (r3689)

Update all bbPress forums across all sites

network_update_screen()

Static

since	2.1.0 bbPress (r3689)

Allow keymaster role to save Forums settings

option_page_capability_bbpress(string $capability = 'manage_options') : string

since	2.3.0 bbPress (r4678)

Parameters

$capability

string

Returns

stringReturn minimum capability

Output all admin area notices

output_notices()

since	2.6.0 bbPress (r6771)

Registers the bbPress admin color schemes

register_admin_scripts()

Because wp-content can exist outside of the WordPress root there is no way to be certain what the relative path of the admin images is. We are including the two most common configurations here, just in case.

since	2.6.0 bbPress (r2521)

Register the settings

register_admin_settings()

Static

since	2.0.0 bbPress (r2737)
todo	Put fields into multidimensional array

Registers the bbPress admin styling and color schemes

register_admin_styles()

Because wp-content can exist outside of the WordPress root, there is no way to be certain what the relative path of admin images is.

since	2.6.0 bbPress (r2521)

Register the importers

register_importers()

since	2.0.0 bbPress (r2737)

Setup general admin area notices.

setup_notices()

since	2.6.0 bbPress (r6701)

Ajax action for facilitating the forum auto-suggest

suggest_topic()

since	2.2.0 bbPress (r4261)

Ajax action for facilitating the topic and reply author auto-suggest

suggest_user()

since	2.4.0 bbPress (r5014)

Update all bbPress forums across all sites

update_screen()

Static

since	2.1.0 bbPress (r3689)

Escape message string output

esc_notice(string $message = '') : string

since	2.6.0 bbPress (r6775)

Parameters

$message

string

Returns

string

Include required files

includes()

since	2.0.0 bbPress (r2646)
access	private

Output the shared screen header for about_screen() & credits_screen()

screen_header()

Contains title, subtitle, and badge area

since	2.6.0 bbPress (r6604)

Setup the admin hooks, actions and filters

setup_actions()

since	2.0.0 bbPress (r2646)
access	private

Admin globals

setup_globals()

since	2.0.0 bbPress (r2646)
access	private

Properties

Path to the bbPress admin directory

$admin_dir : string

Default

''

URL to the bbPress admin directory

$admin_url : string

Default

''

Converter admin

$converter : \BBP_Converter

Default

null

URL to the bbPress admin css directory

$css_url : string

Default

''

Forums admin

$forums : \BBP_Forums_Admin

Default

null

URL to the bbPress images directory

$images_url : string

Default

''

URL to the bbPress admin js directory

$js_url : string

Default

''

Minimum capability to access Tools and Settings

$minimum_capability : boolean

Default

'keep_gate'

Array of notices to output to the current user

$notices : array

Default

array()

Replies admin

$replies : \BBP_Replies_Admin

Default

null

Whether or not to add an extra top level menu separator

$show_separator : boolean

Default

false

URL to the bbPress admin styles directory

$styles_url : string

Default

''

Array of available repair tools

$tools : array

Default

array()

Topics admin

$topics : \BBP_Topics_Admin

Default

null