michaeluno / admin-page-framework

Facilitates WordPress plugin and theme development.
http://admin-page-framework.michaeluno.jp/
Other
339 stars 71 forks source link

Embedding Framework in theme question #155

Closed ghost closed 9 years ago

ghost commented 9 years ago

Am I right in thinking that we don't have to use the plugin for using the framework on a theme? ie, can I embed the framework in a theme such as twenty fourteen by simply creating an inc folder, then dropping in the framework there, then calling it through functions using the tutorial found here? http://en.michaeluno.jp/admin-page-framework/tutorials-v3/01-create-an-admin-page/

Appreciate the work that has gone into this framework, really looking like it is something I would move to from using ReduxFramework.

Ciaran

michaeluno commented 9 years ago

Am I right in thinking that we don't have to use the plugin for using the framework on a theme? ie, can I embed the framework in a theme such as twenty fourteen by simply creating an inc folder, then dropping in the framework there, then calling it through functions using the tutorial found here?

Yes. That's how this framework is intended to be used. You don't want your users to be required to install extra stuff. Me either.

Just one thing you want to do when you include the framework: include the minified version and rename all the class names in the minified version. All the class names have the prefix of AdminPageFramework so rename it to something like YourTheme_AdminPageFramework in your code editor with the Replace All command. Eexample usage

This way, even if your user installs a plugin that uses this framework without modifying the class names and their version is lesser than yours, it won't cause a version conflict. This is a bit cumbersome but it is the safest way at the moment.

ghost commented 9 years ago

Fantastic. Will give it a shot and let you know how I get on.