Class AdminPageFramework_Controller

Called when one of the added admin page starts loading.

Alternatively the user may use the load_{instantiated class name} action hook and its auto-callback method.

Since

Overrides

The method for all the necessary set-ups.

The users should override this method to set-up necessary settings. To perform certain tasks prior to this method, use the start_{instantiated class name} hook that is triggered at the end of the class constructor.

Example

public function setUp() {
    $this->setRootMenuPage( 'APF Form' );
    $this->addSubMenuItems(
        array(
            'title' => 'Form Fields',
            'page_slug' => 'apf_form_fields',
        )
    );
}

Since

Remark

Overrides

Adds the given contextual help tab contents into the property.

Example

 $this->addHelpTab(
array(
     'page_slug                  => 'first_page', // (required)
     // 'page_tab_slug'          => null, // (optional)
     'help_tab_title'            => 'Admin Page Framework',
     'help_tab_id'               => 'admin_page_framework', // (required)
     'help_tab_content'          => __( 'This contextual help text can be set with the `addHelpTab()` method.', 'admin-page-framework' ),
     'help_tab_sidebar_content'  => __( 'This is placed in the sidebar of the help pane.', 'admin-page-framework' ),
)
);

Parameters

Since

Remark

Enqueues styles by page slug and tab slug.

Use this method to pass multiple files to the same page.

Example

$this->enqueueStyle(
        array(
            dirname( APFDEMO_FILE ) . '/asset/css/code.css',
            dirname( APFDEMO_FILE ) . '/asset/css/code2.css',
        ),
        'apf_manage_options'     // page slug
);

Returns

Since

Enqueues a style by page slug and tab slug.

Example

$this->enqueueStyle(
     dirname( APFDEMO_FILE ) . '/asset/css/code.css',
     'apf_manage_options'    // page slug
);
$this->enqueueStyle(
     plugins_url( 'asset/css/readme.css' , APFDEMO_FILE ),
     'apf_read_me'           // page slug
);

Returns

Since

See

Enqueues scripts by page slug and tab slug.

Example

$this->enqueueScripts(
    array(
         plugins_url( 'asset/js/test.js' , __FILE__ ), // source url or path
         plugins_url( 'asset/js/test2.js' , __FILE__ ),
    )
    'apf_read_me',     // page slug
);

Returns

Since

Enqueues a script by page slug and tab slug.

Example

$this->enqueueScript(
     plugins_url( 'asset/js/test.js' , __FILE__ ), // source url or path
     'apf_read_me',     // page slug
     '',     // tab slug
     array(
         'handle_id'     => 'my_script', // this handle ID also is used as the object name for the translation array below.
         'translation'   => array(
             'a'                 => 'hello world!',
             'style_handle_id'   => $sStyleHandle, // check the enqueued style handle ID here.
         ),
     )
);

Returns

Since

See

Adds the given link(s) into the description cell of the plugin listing table.

Example

$this->addLinkToPluginDescription(
      "<a href='http://www.google.com'>Google</a>",
      "<a href='http://www.yahoo.com'>Yahoo!</a>"
);

Parameters

Since

Remark

Adds the given link(s) into the title cell of the plugin listing table.

Example

$this->addLinkToPluginTitle(
      "<a href='http://www.wordpress.org'>WordPress</a>"
);

Parameters

Since

Remark

Sets the label applied to the settings link which automatically embedded to the plugin listing table of the plugin title cell.

To disable the embedded settings link, pass an empty value.

Since

Sets the overall capability.

Example

$this->setCapability( 'read' ); // let subscribers access the pages.

Parameters

Since

See

Sets an admin notice.

Example

$this->setAdminNotice( sprintf( 'Please click <a href="%1$s">here</a> to upgrade the options.', admin_url( 'admin.php?page="my_page"' ) ), 'updated' );

Parameters

Since

Remark

Sets the disallowed query keys in the links that the framework generates.

Example

$this->setDisallowedQueryKeys( 'my-custom-admin-notice' );

Parameters

Since

Retrieves the saved option value from the given option key and the dimensional array key representation.

Example

$aData       = AdminPageFramework::getOption( 'APF' );
$aSection    = AdminPageFramework::getOption( 'APF', 'my_section' );
$sText       = AdminPageFramework::getOption( 'APF', array( 'my_section', 'my_text_field' ), 'foo' );
$sColor      = AdminPageFramework::getOption( 'APF', 'my_color_field', '#FFF' );

Parameters

Returns

Since