groundhogg/admin/register_settings/before

πŸ“… Published on

πŸ“ Last updated

Documentation

Β»

Action Hooks

Β»

groundhogg/admin/register_settings/before

Fires before Groundhogg registers its settings fields. Use this to add custom tabs, sections, or fields to the Groundhogg settings page.

do_action( 'groundhogg/admin/register_settings/before', $settings_page );

You will receive the Settings_Page instance.

Example

add_action( 'groundhogg/admin/register_settings/before', 'my_extension_add_settings_tab' );

/**
 * Add a custom settings tab to the Groundhogg settings page.
 *
 * @param \Groundhogg\Admin\Settings\Settings_Page $settings_page
 *
 * @return void
 */
function my_extension_add_settings_tab( $settings_page ) {
    $settings_page->add_tab( [
        'id'    => 'my_extension',
        'title' => 'My Extension',
    ] );

    $settings_page->add_section( [
        'id'    => 'my_extension_general',
        'title' => 'General',
        'tab'   => 'my_extension',
    ] );

    $settings_page->add_setting( [
        'id'      => 'my_extension_api_key',
        'label'   => 'API Key',
        'section' => 'my_extension_general',
        'type'    => 'input',
        'atts'    => [ 'type' => 'password' ],
    ] );
}

Was this helpful?

Let us know if this document answered your question. That’s the only way we can improve.