Skip to content

AleksandarPredic/WordPress-Widget-Builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 

Repository files navigation

WordPress Widget Builder Framework

Code Climate

The WordPress Widget Builder serves as a framework to quickly build your WordPress widgets.

  • Requires at least: 4.0.0

Please read our Wiki documentation also to find more details about using the framework

Table of contents

Description

The WordPress Widget Builder serves as a framework to quickly build your WordPress widgets.

You can make configuration array of desired widget name, description, fields... and the framework will create widget admin part for you. Leaving you to worry only about widget frontend output.

In addition the framework will pass two additional parameters to your function or method that handles frontend output: $form_fields and $widget_id. See more details about them on features page.

Features

  • The Widget Bulder is fully-based on the WordPress Widget API.

  • Widget admin is automatically created from configuration array.

  • Frontend rendering function receive two additional params: $form_fields and $widget_id.

    • $form_fields is used to pass admin form fields configuration array so you can set default same default values for vars as it the admin form. Example: If default select form field value is set for admin form, the same value can be retreived to be default value on frontend if somehow variable is not set or any other case. It will be easier to explain through examples.

    • $widget_id is used to pass widget instance id so it can be used as unique id to apply custom css only for that widget instance.

  • You can use function or class method to handle frontend output.

Licence

The WordPress Widget Boilerplate is licensed under the GPL v2 or later.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Chengelog

1.0.0 (24th March 2017)

  • Official release

1.0.1 (28th March 2018)

  • FontAwesome iconpicker admin field added
  • Various minor fixes
  • Minor code refactoring
  • Enable styles and scripts enqueue the WP way

Developers

Miss a feature? Pull requests are welcome.

The project is open-source and hopefully will receive contributions from awesome WordPress Developers throughout the world.

Author information

The WordPress Widget Boilerplate was originally started and is maintained by Aleksandar Predic.

About

The WordPress Widget Builder serves as a framework to quickly build your WordPress widgets.

Resources

Stars

Watchers

Forks

Packages

No packages published