Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaeluno/admin-page-framework
Facilitates WordPress plugin and theme development.
https://github.com/michaeluno/admin-page-framework
framework php wordpress wordpress-development wordpress-plugin wordpress-plugin-development wordpress-theme-development
Last synced: 6 days ago
JSON representation
Facilitates WordPress plugin and theme development.
- Host: GitHub
- URL: https://github.com/michaeluno/admin-page-framework
- Owner: michaeluno
- License: other
- Created: 2013-02-14T06:01:52.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-06-20T13:32:02.000Z (over 1 year ago)
- Last Synced: 2025-01-08T10:05:07.080Z (13 days ago)
- Topics: framework, php, wordpress, wordpress-development, wordpress-plugin, wordpress-plugin-development, wordpress-theme-development
- Language: PHP
- Homepage: http://admin-page-framework.michaeluno.jp/
- Size: 29.7 MB
- Stars: 340
- Watchers: 29
- Forks: 72
- Open Issues: 21
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: .github/contributing.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# [Admin Page Framework](http://wordpress.org/plugins/admin-page-framework/)
## Welcome to Admin Page Framework GitHub Repository
*Admin Page Framework* is an OOP based open source WordPress library that facilitates theme and plugin development.
[](https://scrutinizer-ci.com/g/michaeluno/admin-page-framework/?branch=master)
[](https://scrutinizer-ci.com/g/michaeluno/admin-page-framework/build-status/master)
## Installation
There are mainly two ways to include the framework.
- Use the framework loader plugin.
- The latest development version can be found [here](https://github.com/michaeluno/admin-page-framework/branches).
- The latest stable version can be downloaded [here](http://downloads.wordpress.org/plugin/admin-page-framework.latest-stable.zip).
- 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
setRootMenuPage( 'Settings' ); // where to belong
$this->addSubMenuItem(
array(
'title' => 'My First Page',
'page_slug' => 'myfirstpage'
)
);
}
/**
* @callback action do_{page slug}
*/
public function do_myfirstpage() {
?>
Say Something
This is my first admin page!
```PHP
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](http://admin-page-framework.michaeluno.jp/en/v3/)
- [Online tutorials](http://admin-page-framework.michaeluno.jp/tutorials/)
- [FAQ](https://wordpress.org/plugins/admin-page-framework/faq/)
- [Change Log](https://wordpress.org/plugins/admin-page-framework/#developers)
### Getting Helped
- [Support Forum](http://wordpress.org/support/plugin/admin-page-framework)
## Contributions
Anyone is welcome to contribute to *Admin Page Framework*. There are various ways you can contribute:
- Report [bugs](https://github.com/michaeluno/admin-page-framework/issues).
- Post ideas on [enhancements](https://github.com/michaeluno/admin-page-framework/issues?direction=desc&labels=Enhancement&page=1&sort=created&state=open).
- Send us a Pull Request with your bug fixes and/or new features.
- Write a [custom field type](http://admin-page-framework.michaeluno.jp/en/v3/package-AdminPageFramework.FieldType.html).
- Write [test cases](test/readme.md).
- Improve the [documentation](https://github.com/michaeluno/admin-page-framework/blob/master/documentation_guideline.md).
- Tweak the styling of the framework page elements.
- Translate the language files in the [language](https://github.com/michaeluno/admin-page-framework/tree/master/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](./.gituhb/contributing.md).
### Supporting Future Development
If you like the library, please rate and review it in the [WordPress Plugin Directory](http://wordpress.org/support/view/plugin-reviews/admin-page-framework?filter=5). Also donation would be greatly appreciated. Thank you!
[](http://en.michaeluno.jp/donate)
## Copyright and License
### Admin Page Framework (Framework Files)
[MIT license](development/LICENSE.txt)
### Admin Page Framework - Loader (WordPress Plugin)
[GPL v2](./LICENSE.txt)
