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
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 | 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 );} |
Changelog
| Version | Description |
|---|---|
| BuddyPress 1.6.0 | 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.