# Class Sidecar_Admin_Page

Class Sidecar_Admin_Page

Located at classes/class-admin-page.php

Methods summary
`public` | # `__construct( mixed $page_name, array $args = array() )` #### Parameters $page_name `mixed` $page_name $args `array` $args
`public` | # `initialize( )` #### Throws ``Exception``
`public array` | # `filter_postback( array $input )` #### Parameters $input `array` $input #### Returns `array`
`public array` | # `get_auth_credentials( )` #### Returns `array`
`public `Sidecar_Form`` | # `get_auth_form( )` #### Returns ``Sidecar_Form``
`public` | # `set_auth_form( string|`Sidecar_Form` $form )` #### Parameters $form `string|`Sidecar_Form`` $form
`public` | # `add_tab( string $tab_slug, string $tab_text, array $args = array() )` #### Parameters $tab_slug `string` $tab_slug $tab_text `string` $tab_text $args `array` $args
`public `Sidecar_Admin_Tab`` | # `get_default_tab( )` #### Returns ``Sidecar_Admin_Tab``
`public boolean` | # `is_authentication_tab( )` Test to see if the current tab is the authentication tab Test to see if the current tab is the authentication tab #### Returns `boolean`
`public `Sidecar_Admin_Tab`` | # `get_authentication_tab( )` #### Returns ``Sidecar_Admin_Tab``
`protected boolean|mixed` | # `_apply_plugin_filter( string $method )` Filters a value by calling a method in the plugin. Filters a value by calling a method in the plugin. Captures whatever additional parameters and passes them on. #### Parameters $method `string` $method #### Returns `boolean|mixed`
`protected boolean|mixed` | # `_do_plugin_action( string $method )` Executes an action by calling a method in the plugin. Executes an action by calling a method in the plugin. Captures whatever additional parameters and passes them on. #### Parameters $method `string` $method #### Returns `boolean|mixed`
`protected boolean|mixed` | # `_get_plugin_value( string $method )` Retrieves a value from the plugin. Retrieves a value from the plugin. Captures whatever additional parameters and passes them on. #### Parameters $method `string` $method #### Returns `boolean|mixed`
`public` | # `admin_menu( )`
`public` | # `admin_print_styles( )`
`public` | # `the_css( )` #### Todo Call this from HEAD instead of from here.
`public` | # `the_page( )` Displays admin page Displays admin page
`public` | # `the_tab_specific_content( string $tab, string $content_type, array $args = array() )` #### Parameters $tab `string` $tab $content_type `string` $content_type $args `array` $args
`public` | # `the_page_content( )`
`public` | # `the_icon( )` Displays the icon for the plugin page Displays the icon for the plugin page #### Todo Research to see if we need to support something other than icon32
`public` | # `get_tabs( )`
`public boolean|`Sidecar_Admin_Tab`` | # `get_tab( string $tab_name )` #### Parameters $tab_name `string` $tab_name #### Returns `boolean|`Sidecar_Admin_Tab``
`public` | # `has_tabs( )`
`public` | # `the_title_and_tabs( )` Display the row of tabs at the top of a page with the <h2> tab wrapper element Display the row of tabs at the top of a page with the <h2> tab wrapper element
`public string` | # `get_tabs_html( )` Returns the tabs as a block of HTML for display at the top of the admin page. Returns the tabs as a block of HTML for display at the top of the admin page. #### Returns `string`
`public` | # `get_tab_links_html( )` Returns an array of HTML for each tabs for display at the top of the admin page. Returns an array of HTML for each tabs for display at the top of the admin page.
`public string|` | # `get_page_url( )` #### Returns `string|`
`public string|` | # `get_tab_link( null|boolean|string|`Sidecar_Admin_Tab` $tab, string $text, boolean $blank = false )` #### Parameters $tab `null|boolean|string|`Sidecar_Admin_Tab`` $tab $text `string` $text $blank `boolean` $blank #### Returns `string|`
`public string|` | # `get_tab_url( null|boolean|string|`Sidecar_Admin_Tab` $tab = false )` #### Parameters $tab `null|boolean|string|`Sidecar_Admin_Tab`` $tab If null is passed then don't add a default tab. #### Returns `string|`
`public string|` | # `get_base_page_url( )` #### Returns `string|`
`public boolean` | # `is_current_tab( string $tab )` Check if the passed $tab variable matches the URL's tab parameter. Check if the passed $tab variable matches the URL's tab parameter. #### Parameters $tab `string` $tab #### Returns `boolean`
`public `Sidecar_Admin_Tab`` | # `get_current_tab( )` Check if the passed $tab variable matches the URL's tab parameter. Check if the passed $tab variable matches the URL's tab parameter. #### Returns ``Sidecar_Admin_Tab``
`public boolean` | # `has_tab( string|`Sidecar_Admin_Tab` $tab )` Check if the passed $tab variable matches the URL's tab parameter. Check if the passed $tab variable matches the URL's tab parameter. #### Parameters $tab `string|`Sidecar_Admin_Tab`` $tab #### Returns `boolean`
`public integer` | # `tab_count( )` #### Returns `integer`
`public boolean` | # `is_current_tab_valid( )` Validates to ensure that we have a URL tab parameter that is one of the valid tabs. Validates to ensure that we have a URL tab parameter that is one of the valid tabs. #### Returns `boolean`
`public boolean` | # `is_page_url( )` Check to see if we are on the admin URL for this plugin. Check to see if we are on the admin URL for this plugin. #### Returns `boolean`
`public boolean` | # `is_postback_update( )` #### Returns `boolean`
`public boolean` | # `verify_current_tab( )` Check to make sure we are on the right tab. Check to make sure we are on the right tab. Redirect if we are not on the right tab based on authentication status or invalid tab, OR return if not even on this plugin's Admin URL Register an error message for later display if not authenticated. #### Returns `boolean` Returns true if we are on a verified tab, false or URL redirect otherwise.
`public boolean|string` | # `__get( mixed $property_name )` #### Parameters $property_name `mixed` $property_name #### Returns `boolean|string`

Properties summary
`public `Sidecar_Plugin_Base`` | $plugin | `` | #
`protected null|array` | $_forms | `array()` | # Array contains Sidecar_Form objects Array contains Sidecar_Form objects
`protected array` | $_tabs | `array()` | #
`protected string` | $_page_url | `` | #
`protected boolean` | $_is_page_url | `` | #
`protected `Sidecar_Admin_Tab`` | $_authentication_tab | `` | #
`protected string` | $_settings_group_name | `` | #
`protected boolean` | $_initialized | `false` | #
`public string` | $parent_slug | `'options-general.php'` | #
`public string` | $page_name | `` | #
`public string` | $page_slug | `` | #
`public string` | $page_title | `` | #
`public string` | $menu_title | `` | #
`public string` | $menu_page | `` | #
`public string` | $capability_required | `'manage_options'` | #
`public string` | $icon | `'options-general'` | # One of the built in icons (below), or a custom icon starting with 'https://' or 'https://' One of the built in icons (below), or a custom icon starting with 'https://' or 'https://' #### Example: admin, appearance, comments, dashboard, edit, edit-comments, edit-pages, index, link, links, link-category, link-manager, media, ms-admin, options-general, page, plugins, post, profile, settings, site, sitescreen, themes, tools, upload, user-edit, users
`protected string` | $_auth_form | `false` | #