bbp_admin_settings_help()

Contextual help for Forums settings page

Description

Source

File: bp-forums/admin/settings.php

function bbp_admin_settings_help() {

	$current_screen = get_current_screen();

	// Bail if current screen could not be found
	if ( empty( $current_screen ) )
		return;

	// Overview
	$current_screen->add_help_tab( array(
		'id'      => 'overview',
		'title'   => __( 'Overview', 'buddyboss' ),
		'content' => '<p>' . __( 'This screen provides access to all of the Forums settings.',                          'buddyboss' ) . '</p>' .
					 '<p>' . __( 'Please see the additional help tabs for more information on each indiviual section.', 'buddyboss' ) . '</p>'
	) );

	// Main Settings
	$current_screen->add_help_tab( array(
		'id'      => 'main_settings',
		'title'   => __( 'Main Settings', 'buddyboss' ),
		'content' => '<p>' . __( 'In the Main Settings you have a number of options:', 'buddyboss' ) . '</p>' .
					 '<p>' .
						'<ul>' .
							'<li>' . __( 'You can choose to lock a post after a certain number of minutes. "Locking post editing" will prevent the author from editing some amount of time after saving a post.',              'buddyboss' ) . '</li>' .
							'<li>' . __( '"Throttle time" is the amount of time required between posts from a single author. The higher the throttle time, the longer a user will need to wait between posting to the forum.', 'buddyboss' ) . '</li>' .
							'<li>' . __( 'Saving discussions allows users to return later to discussions they are interested in. This is enabled by default.',                                                                           'buddyboss' ) . '</li>' .
							'<li>' . __( 'Subscriptions allow users to subscribe for notifications to discussions that interest them. This is enabled by default.',                                                                 'buddyboss' ) . '</li>' .
							'<li>' . __( 'Discussion-Tags allow users to filter discussions between forums. This is enabled by default.',                                                                                                'buddyboss' ) . '</li>' .
							'<li>' . __( '"Anonymous Posting" allows guest users who do not have accounts on your site to both create discussions as well as replies.',                                                             'buddyboss' ) . '</li>' .
							'<li>' . __( 'The Fancy Editor brings the luxury of the Visual editor and HTML editor from the traditional WordPress dashboard into your theme.',                                                  'buddyboss' ) . '</li>' .
							'<li>' . __( 'Auto-embed will embed the media content from a URL directly into the replies. For example: links to Flickr and YouTube.',                                                            'buddyboss' ) . '</li>' .
						'</ul>' .
					'</p>' .
					'<p>' . __( 'You must click the Save Changes button at the bottom of the screen for new settings to take effect.', 'buddyboss' ) . '</p>'
	) );

	// Per Page
	$current_screen->add_help_tab( array(
		'id'      => 'per_page',
		'title'   => __( 'Per Page', 'buddyboss' ),
		'content' => '<p>' . __( 'Per Page settings allow you to control the number of discussions and replies to appear on each page.',                                                    'buddyboss' ) . '</p>' .
					 '<p>' . __( 'This is comparable to the WordPress "Reading Settings" page, where you can set the number of posts that should show on blog pages and in feeds.', 'buddyboss' ) . '</p>' .
					 '<p>' . __( 'These are broken up into two separate groups: one for what appears in your theme, another for RSS feeds.',                                        'buddyboss' ) . '</p>'
	) );

	// Slugs
	$current_screen->add_help_tab( array(
		'id'      => 'slus',
		'title'   => __( 'Slugs', 'buddyboss' ),
		'content' => '<p>' . __( 'The Slugs section allows you to control the permalink structure for your forums.',                                                                                                            'buddyboss' ) . '</p>' .
					 '<p>' . __( '"Archive Slugs" are used as the "root" for your forums and discussions. If you combine these values with existing page slugs, Forums will attempt to output the most correct title and content.', 'buddyboss' ) . '</p>' .
					 '<p>' . __( '"Single Slugs" are used as a prefix when viewing an individual forum, discussion, reply, user, or view.',                                                                                          'buddyboss' ) . '</p>' .
					 '<p>' . __( 'In the event of a slug collision with WordPress or BuddyBoss, a warning will appear next to the problem slug(s).', 'buddyboss' ) . '</p>'
	) );

	// Help Sidebar
	$current_screen->set_help_sidebar(
		'<p><strong>' . __( 'For more information:', 'buddyboss' ) . '</strong></p>' .
		'<p>' . __( '<a href="https://www.buddyboss.com/resources/">Documentation</a>',    'buddyboss' ) . '</p>'
	);
}

Changelog

Changelog
Version Description
bbPress (r3119) Introduced.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.