-
Notifications
You must be signed in to change notification settings - Fork 1
FAQ
Questions? You've come to the right place my friend. If you don't see anything here you need, mosey on over to the Issues area (don't forget to search closed issues). Wireframe aims to be community-driven by talented volunteers and likeminded peeps. Play nice 👍
- Troubleshooting
- Extending
- Automation
- Coding Standards
- Object-Oriented Programming
- Licensing
- About Us
No problem, the community is here for you. Wireframe Plugin can be an educational project for novice Developers or a rapid deployment process for experienced Developers. We hope the Wireframe Plugin community will grow over time with all experience levels. Head on over to the Issues area and see if a volunteer can help with your scenario.
We created Wireframe Plugin to suit our own internal workflow, hoping that others may find our work useful and educational. All Developers have their preferred coding methods. Please feel free to reach out to us if you think Wireframe Plugin can do something better!
Developers use Wireframe Plugin as a starting point, roll their own features, then release their plugins to the public.
Clone it! Assuming your IDE is up-and-running, we recommend you initially setup Wireframe Plugin for Unit Testing and then allocate time for some Discovery. Familiarize yourself with the Wireframe Plugin front-end presentation. After you're comfy seeing how Wireframe Plugin looks, now you're ready to dig into the files, JavaScript SCSS, class files, etc. Poke around in the wireframe_dev directory. After you're done with your Discovery phase, you're ready for Development.
Any. Most Developers will only need to add/edit styles and templates for Wireframe Plugin to match their mock-ups. Advanced Developers who wish to add more features to Wireframe Plugin will most likely begin modding the wireframe.php file, the modules, or any other file to meet their requirements. There is no "de facto" way to extend Wireframe Plugin.
Remember: Wireframe Plugin was built with an OOP approach in mind. Wireframe Plugin is very modular by design, de-coupled and most things can be swapped in and out.
Yes. If you're using Wireframe Plugin as a starter plugin, you may wish to trim/remove any extraneous code or comments you don't need from Wireframe Plugin prior to packaging or distributing your theme to a marketplace. Just about every line of code in Wireframe Plugin is commented for completeness and educational purposes. Note: If you use phpDocumentor (optional) with your theme, you may wish to keep much of the comments intact.
Yes. We use the SCSS syntax of SASS or .scss files. We don't support LESS. But feel free to re-compile using the syntax and compiler/wrapper of your choice. Learn More
Yes. We autoload with Composer and support PSR-4. You should take a look at the ../plugins/wireframe-plugin/composer.json file for more details. If you don't wish to support autoloading, simply remove it and include/instantiate your classes your way. Learn More
Not out-of-the-box. We've opted to not enforce Composer dependencies because some Developers don't use Composer. However, Wireframe is currently pre-packaged with a composer.json file for autoloading classes, therefore, Developers can still integrate Composer to suit their own requirements.
No. We don't enforce package managers or task runners because you shouldn't feel "over-stacked" or "locked-down" to what we use. Wireframe Plugin is a WordPress theme—not a large scale project for Enterprise. The amount of time/work involved setting up an environment, learning a new syntax/language, maintaining certain tasks, training, all outweigh the fact that Wireframe is just a theme. Any Developer already familiar and using an Automation workflow will probably have it set up by the time you read this paragraph.
If you wish to contribute to Wireframe Plugin then WPCS is required. For our workflow, we adhere to WordPress Coding Standards and a few PSR's to future-proof Wireframe. If you don't think you'll be contributing to Wireframe then you can scale with any Coding Standards you feel most compliant with (PEAR, PHPCS, WPCS, PSR, etc.). We won't preach. Standards are ultimately up to Developers and Teams.
Yes. We've adopted a hybrid PSR-4 for autoloading. We've begun using the proposed PSR-5 for DocBlocks. We use PSR-2 at our discretion. Fully compliant PSR adoption is not currently possible with WordPress Coding Standards, minimum system requirements and backwards compatibility. Although we are very conscience of PSR while we code Wireframe, we lean more towards WPCS above all. Therefore, we're aligned using hybrid standards to stay forward-thinking. Take a look at this Trac ticket for some insight. You don't need to use PSR whatsoever.
Yes. However, since we use PSR and other OOP patterns in our class files, PHPCS + WPCS may throw some unexpected errors or false positives for Wireframe classes. For example, we use DI for object dependencies. WPCS will throw an error for, "Unknown type hint." Also, some file structures are capitalized. This may throw WPCS errors, just FYI.
Yes. Since you're using Wireframe Plugin, you probably wish to learn OOP or already know OOP. The Wireframe Plugin architecture has already been built for you. At the basic starter theme level, you can swap some assets or modify some code and you're done. At the more advanced level, you can use Wireframe Plugin as a boilerplate to facilitate professional OOP child theme development.
Read, read, and more reading! But if you don't like reading, you should checkout the Derek Banas YouTube channel. OOP is not for everyone. Some people enjoy using OOP. Some people prefer procedual programming. We hope you can at least have an educational takeaway from using OOP alongside WordPress Theme Development.
GPLv2. We use libraries which are compatible with GPL version 2. Click here to learn more about overall GPL-compatible licenses.
Yes! This is exactly what Wireframe Plugin was created for: derivative works. It's up to you if you wish to sell your work or not. Please keep in mind: your derivative work and the packaged libraries you use must also be GPL-compatible/compliant. Do not use "split licensing."
No. We developed Wireframe Plugin for 1 purpose only: challenge ourselves to build an object-oriented WordPress plugin, then release it to the public under the GPL for educational purposes. We sell commercial products, but Wireframe Plugin is totes free without any kind of "Pro" version or "Freemium" model. Ain't nobody got time for 🐮 💩
MixaTheme is a WordPress development studio founded by Tada Burke.
Tada Burke is a Creative Director (who codes) based in Washington, DC USA.
Tada Burke has a Thai first name and an Irish last name. He's Thairish! The proper way to pronounce his name is: Tah-da (rhymes with Prada or Dada-ism). Stop laughing 🎉 But it's okay if you say it wrong the first time (loud echo).
Copyright © 2016 MixaTheme. All rights reserved. Wireframe Plugin is licensed GPL-2.0.
🐞 Found a Bug, Typo, Error? Help the community by reporting an Issue.
❌ Report a Vulnerability? Please private message us via our Website.
❤️ Thanks for using MIXA products! Follow us? Twitter | Facebook