dwarvesforge/wp-stack

Wordpress stack that gives you nice classes as wrapper of the wordpress ones as well as some nice helper functions.

1.0.4 2018-11-27 10:16 UTC

Requires

• php: >=7.0
• dwarvesforge/thorin: ^2.0
• paquettg/php-html-parser: ^1.7

Requires (Dev)

• phpunit/phpunit: 5.2.*

MIT

• Olivier Bossel
• Paul Balanche

• php
• toolkit
• wordpress
• stack
• wp
• wps
• dwarvesforge

README

WP-Stack

Wordpress stack that gives you nice classes as wrapper of the wordpress ones as well as some nice helper functions in these areas:

• ACF
• Admin
• Archive
• Categorie
• Comment
• Image
• Is
• Media
• Menu
• Metabox
• Pagination
• Post
• Search
• User
• Util
• Widget
• Descriptive classes
  • WPS\ACF_Post : class that represent an ACF drived post
  • WPS\Category : class that represent a category object
  • WPS\Comment : class that represent a comment object
  • WPS\Menu_Item : class that represent a menu item returned by function like WPS::menu.
  • WPS\Post : class that represent a post object
  • WPS\User : class that represent a user object
• Usable classes
  • WPS\Query : same as WP_Query but return posts in WPS\Post object format

Table of content

1. Goals
2. Install
3. Documentation
4. Options page
5. Contribute
6. License
7. Who are Dwarvesforge

Goals

The main goal is to give you access to some nice features like some cool wrapper classes and some helper functions to help you develop your wordpress more like a developer than a designer trying to code something. We will make this package grow every time we encounter and implement some nice functions/classes/helpers.

Install

composer require dwarvesforge/wp-stack

Options page

WP-Stack offer the ability to have an options page in the admin that expose a UI to some of the programatic features like google_analytics, excerpt_length, set_login_logo, etc...

In order to access this page, you'll need two things:

1. Having a proper running ACF Advanced Custom Fields PRO plugin installed
2. Call the WPS::enable_options_page() function in your functions.php file

Contribute

Dwarvesforge is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

1. Share the love ❤️
2. Declare issues
3. Fix issues
4. Add features

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...

Who are Dwarvesforge

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are