Settings

This configuration contains parameters that HivePress uses for registering the custom settings. Each setting is defined as an array of HivePress field parameters. The array key is used as the setting name (prefixed with hp_).

The code example below adds a new checkbox setting to the HivePress > Settings > Listings > Display section. In the same way, you can customize any of the available settings or register a new one by adding an array with the field parameters.

add_filter(
	'hivepress/v1/settings',
	function( $settings ) {
		$settings['listings']['sections']['display']['fields']['custom_option'] = [
			'label'  => 'Custom Option',
			'type'   => 'checkbox',
			'_order' => 123,
		];

		return $settings;
	}
);

After the setting is added, you can get its value by calling the get_option function with the setting name (prefixed with hp_):

$value = get_option( 'hp_custom_option' );