bp_get_form_option( string $option, string $default = '', bool $slug = false )

Return settings API option

Description

Parameters

$option

(Required) Form option to return.

$default

(Optional) Form option default.

Default value: ''

$slug

(Optional) Form option slug.

Default value: false

Return

(string)

Source

File: bp-core/admin/bp-core-admin-settings.php

	function bp_get_form_option( $option, $default = '', $slug = false ) {

		// Get the option and sanitize it.
		$value = bp_get_option( $option, $default );

		// Slug?
		if ( true === $slug ) {

			/**
			 * Filters the slug value in the form field.
			 *
			 * @since BuddyPress 1.6.0
			 *
			 * @param string $value Value being returned for the requested option.
			 */
			$value = esc_attr( apply_filters( 'editable_slug', $value ) );
		} else { // Not a slug.
			$value = esc_attr( $value );
		}

		// Fallback to default.
		if ( empty( $value ) )
			$value = $default;

		/**
		 * Filters the settings API option.
		 *
		 * @since BuddyPress 1.6.0
		 *
		 * @param string $value  Value being returned for the requested option.
		 * @param string $option Option whose value is being requested.
		 */
		return apply_filters( 'bp_get_form_option', $value, $option );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.6.0	Introduced.

Uses

Uses
Uses	Description
bp-core/admin/bp-core-admin-settings.php: editable_slug	Filters the slug value in the form field.
bp-core/admin/bp-core-admin-settings.php: bp_get_form_option	Filters the settings API option.
bp-core/bp-core-options.php: bp_get_option()	Retrieve an option.

Used By
Used By	Description
bp-core/admin/bp-core-admin-settings.php: bp_form_option()	Output settings API option.

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.

Contents