Class CMB2_Options_Hookup

Handles hooking CMB2 forms/metaboxes into the post/attachement/user screens and handles hooking in and saving those fields.

CMB2_Hookup_Base

CMB2_Hookup

CMB2_Options_Hookup

Package: CMB2
Category: WordPress_Plugin
License: GPL-2.0+
Author: CMB2 team
Since: 2.0.0
Link: https://cmb2.io
Located at includes/CMB2_Options_Hookup.php

Methods summary

`public`	# `__construct( CMB2 $cmb, string $option_key )` Constructor Constructor Parameters `$cmb` The CMB2 object to hookup. `$option_key` Option key to use. Since 2.0.0 Overrides `CMB2_Hookup_Base::__construct`
`public`	# `hooks( )`
`public`	# `options_page_menu_hooks( )` Hook up our admin menu item and admin page. Hook up our admin menu item and admin page. Since 2.2.5
`public`	# `maybe_register_message( )` If there is a message callback, let it determine how to register the message, else add a settings message if on this settings page. If there is a message callback, let it determine how to register the message, else add a settings message if on this settings page. Since 2.2.6
`public`	# `options_page_output( )` Display options-page output. To override, set 'display_cb' box property. Display options-page output. To override, set 'display_cb' box property. Since 2.2.5
`public`	# `options_page_tab_nav_output( )` Display options-page Tab Navigation output. Display options-page Tab Navigation output. Since 2.9.0
`public`	# `maybe_output_settings_notices( )` Outputs the settings notices if a) not a sub-page of 'options-general.php' (because settings_errors() already called in wp-admin/options-head.php), and b) the 'disable_settings_errors' prop is not set or truthy. Outputs the settings notices if a) not a sub-page of 'options-general.php' (because settings_errors() already called in wp-admin/options-head.php), and b) the 'disable_settings_errors' prop is not set or truthy. Since 2.2.5
`public array`	# `get_tab_group_tabs( )` Gets navigation tabs array for CMB2 options pages which share the same tab_group property. Gets navigation tabs array for CMB2 options pages which share the same tab_group property. Returns array Array of tab information ($option_key => $tab_title) Since 2.4.0
`public`	# `options_page_metabox( )` Display metaboxes for an options-page object. Display metaboxes for an options-page object. Since 2.2.5
`public`	# `save_options( )` Save data from options page, then redirects back. Save data from options page, then redirects back. Since 2.2.5
`public mixed`	# `network_get_override( mixed $test, mixed $default = false )` Replaces get_option with get_site_option. Replaces get_option with get_site_option. Parameters `$test` Not used. `$default` Default value to use. Returns mixed Value set for the network option. Since 2.2.5
`public boolean`	# `network_update_override( mixed $test, mixed $option_value )` Replaces update_option with update_site_option. Replaces update_option with update_site_option. Parameters `$test` Not used. `$option_value` Value to use. Returns boolean Success/Failure Since 2.2.5
`public static boolean`	# `is_page( string $page )` Determines if given page slug matches the 'page' GET query variable. Determines if given page slug matches the 'page' GET query variable. Parameters `$page` Page slug. Returns boolean Since 2.4.0
`public mixed`	# `__get( string $field )` Magic getter for our object. Magic getter for our object. Parameters `$field` Property to retrieve. Returns mixed Throws Exception Throws an exception if the field is invalid. Overrides `CMB2_Hookup_Base::__get`

Methods inherited from CMB2_Hookup

add_context_metaboxes(), add_metaboxes(), alternate_context_postbox_classes(), can_save(), column_display(), columns_sortable(), columns_sortable_orderby(), comment_hooks(), context_box_title_markup_close(), context_box_title_markup_open(), delete_term(), do_scripts(), enqueue_cmb_css(), enqueue_cmb_js(), get_priority(), maybe_enqueue_column_display_styles(), maybe_init_and_hookup(), metabox_callback(), options_page_hooks(), output_context_metabox(), post_hooks(), postbox_classes(), register_column_headers(), register_js(), register_scripts(), register_styles(), remove_default_tax_metaboxes(), return_column_display(), save_comment(), save_post(), save_term(), save_user(), show_form_for_type(), show_on(), taxonomy_can_save(), term_hooks(), term_metabox(), universal_hooks(), user_hooks(), user_metabox(), user_new_metabox()

Methods inherited from CMB2_Hookup_Base

once()

Properties summary

`protected string`	`$object_type` The object type we are performing the hookup for The object type we are performing the hookup for Since 2.0.9	# `'options-page'`
`protected string`	`$option_key` Options page key. Options page key. Since 2.2.5	# `''`

Packages

Classes

Functions

Hooks

Class CMB2_Options_Hookup

Methods summary

Parameters

Since

Overrides

Since

Since

Since

Since

Since

Returns

Since

Since

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Overrides

Methods inherited from CMB2_Hookup

Methods inherited from CMB2_Hookup_Base

Properties summary

Since

Since

Properties inherited from CMB2_Hookup

Properties inherited from CMB2_Hookup_Base

Magic properties inherited from CMB2_Hookup_Base