michaeluno/admin-page-framework

A PHP class based framework which facilitates WordPress plugin and theme development.

3.9.1 2022-04-15 03:21 UTC

Requires

• php: >=5.2.4

Suggests

• composer/installers: ~1.0

GPL-2.0+

• framework
• plugin
• form
• wordpress
• options
• Settings
• admin page

README

Welcome to Admin Page Framework GitHub Repository

Admin Page Framework is an OOP based open source WordPress library that facilitates theme and plugin development.

                       

Installation

There are mainly two ways to include the framework.

• Use the framework loader plugin.

  • The latest development version can be found here.
  • The latest stable version can be downloaded here.

• Use the generated framework files which can be downloaded via Dashboard -> Admin Page Framework -> Tools -> Generator.

For more details, see the Getting Started (Dashboard -> Admin Page Framework -> Help -> Getting Started) of the admin pages of the loader plugin.

Examples

Create a Page

<?php
/* Plugin Name: Admin Page Framework - Getting Started */ 

include( dirname( __FILE__ ) . '/library/apf/admin-page-framework.php' );
    
class APF extends AdminPageFramework {

    public function setUp() {
        
        $this->setRootMenuPage( 'Settings' );    // where to belong
        $this->addSubMenuItem(
            array(
                'title'        => 'My First Page',
                'page_slug'    => 'myfirstpage'
            )
        );
            
    }
    
    /**
     * @callback        action      do_{page slug}
     */
    public function do_myfirstpage() {
        ?>
        <h3>Say Something</h3>
        <p>This is my first admin page!</p>
        <?php   
    }
    
}
new APF;

Create a Form

<?php
/* Plugin Name: Admin Page Framework - My First Form */ 

include( dirname( __FILE__ ) . '/library/apf/admin-page-framework.php' );
    
class APF_MyFirstFrom extends AdminPageFramework {

    public function setUp() {
        
        $this->setRootMenuPage( 'My Settings' );    // create a root page 
        $this->addSubMenuItem(
            array(
                'title'        => 'My First Form',
                'page_slug'    => 'my_first_form'
            )
        );
                    
    }
    
    /**
     * The pre-defined callback method that is triggered when the page loads.
     * @callback        action      load_{page slug}
     */     
    public function load_my_first_form( $oAdminPage ) {
    
        $this->addSettingSections(    
            array(
                'section_id'    => 'my_first_text_section',    
                'page_slug'     => 'my_first_form',    
            )
        );
        
        $this->addSettingFields(
            array(    
                'field_id'      => 'text',
                'section_id'    => 'my_first_text_section',
                'title'         => 'Text',
                'type'          => 'text',
                'default'       => 123456,
            ),
            array(    
                'field_id'      => 'submit',
                'type'          => 'submit',
            )
        );
        
    }
    
}
new APF_MyFirstFrom;

See more code examples in Dashboard -> AdminPageFramework -> Help -> Examples.

Resources

• Online documentation
• Online tutorials
• FAQ
• Change Log

Getting Helped

• Support Forum

Contributions

Anyone is welcome to contribute to Admin Page Framework. There are various ways you can contribute:

• Report bugs.
• Post ideas on enhancements.
• Send us a Pull Request with your bug fixes and/or new features.
• Write a custom field type.
• Write test cases.
• Improve the documentation.
• Tweak the styling of the framework page elements.
• Translate the language files in the language directory to your native language.
• Possibly more.

Browser Compatibility

Internet Explorer 9 or below is not supported.

The framework uses

• CSS flex.

Framework Core Development

See the contribution guideline.

Supporting Future Development

If you like the library, please rate and review it in the WordPress Plugin Directory. Also donation would be greatly appreciated. Thank you!

Copyright and License

Admin Page Framework (Framework Files)

MIT license

Admin Page Framework - Loader (WordPress Plugin)

GPL v2