Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ernilambar/widget-helper
Simple helper library which helps to create WordPress widgets in fast and east way.
https://github.com/ernilambar/widget-helper
Last synced: about 1 month ago
JSON representation
Simple helper library which helps to create WordPress widgets in fast and east way.
- Host: GitHub
- URL: https://github.com/ernilambar/widget-helper
- Owner: ernilambar
- License: mit
- Created: 2019-12-28T06:53:17.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-17T14:27:04.000Z (over 2 years ago)
- Last Synced: 2024-06-29T05:45:05.250Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 165 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Widget Helper
Simple helper library which helps to create WordPress widgets in fast and east way.
## Requirements
* WordPress 5.1+.
* PHP 5.6+.
* [Composer](https://getcomposer.org/) for managing PHP dependencies.
## Installation
First, you'll need to open your command line tool and change directories to your theme folder.
```bash
cd path/to/wp-content/themes/
```
Then, use Composer to install the package.
```bash
composer require ernilambar/widget-helper
```
Assuming you're not already including the Composer autoload file for your theme and are shipping this as part of your theme package, you'll want something like the following bit of code in your theme's `functions.php` to autoload this package (and any others).
The Composer autoload file will automatically load up the package for you and make its code available for you to use.
```php
if ( file_exists( get_parent_theme_file_path( 'vendor/autoload.php' ) ) ) {
require_once( get_parent_theme_file_path( 'vendor/autoload.php' ) );
}
```
Package comes with the JS and CSS needed for the widgets fields. You can enqueue assets like given in the example below.
## Usage
You can create your new widget with extending the helper class.
```php
use Nilambar\WidgetHelper\Helper;
use Nilambar\WidgetHelper\Assets;
/**
* Load widget assets.
*
* @since 1.0.0
*
* @param string $hook Hook name.
*/
function theme_slug_load_widget_assets( $hook ) {
if ( 'widgets.php' === $hook ) {
Assets::load_assets();
}
}
add_action( 'admin_enqueue_scripts', 'theme_slug_load_widget_assets' );
/**
* Widget class.
*
* @since 1.0.0
*/
class Theme_Hello_World extends Helper {
/**
* Constructor.
*
* @since 1.0.0
*/
public function __construct() {
$args['id'] = 'theme-hello-world';
$args['label'] = esc_html__( 'Hello World Widget', 'widget-helper' );
$args['widget'] = array(
'classname' => 'theme_hello_world',
'description' => esc_html__( 'Hello world widget', 'widget-helper' ),
);
$args['fields'] = array(
'sample_title' => array(
'label' => esc_html__( 'Title:', 'widget-helper' ),
'type' => 'text',
'class' => 'widefat',
),
'sample_message' => array(
'label' => esc_html__( 'Message:', 'widget-helper' ),
'type' => 'textarea',
'class' => 'widefat',
),
'sample_image' => array(
'label' => esc_html__( 'Image:', 'widget-helper' ),
'type' => 'image',
),
'sample_color' => array(
'label' => esc_html__( 'Color:', 'widget-helper' ),
'type' => 'color',
'default' => '#DDDDDD',
),
);
parent::create_widget( $args );
}
/**
* Echo the widget content.
*
* @since 1.0.0
*
* @param array $args Display arguments.
* @param array $instance Instance of the widget.
*/
public function widget( $args, $instance ) {
// Fetch widget values.
$values = $this->get_field_values( $instance );
$values['title'] = apply_filters( 'widget_title', empty( $instance['title'] ) ? '' : $instance['title'], $instance, $this->id_base );
echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
if ( ! empty( $values['title'] ) ) {
echo $args['before_title'] . esc_html( $values['title'] ) . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
// Display logic will be here.
echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}
/**
* Register widget.
*
* @since 1.0.0
*/
function theme_slug_custom_widgets_init() {
register_widget( 'Theme_Hello_World' );
}
add_action( 'widgets_init', 'theme_slug_custom_widgets_init' );
```
### Available fields
* Text
* URL
* Email
* Number
* Checkbox
* Radio
* Radio Image
* Color
* Select
* Dropdown Pages
* Dropdown Taxonomies
* Image
* Textarea
* Heading
* Message
* Separator
## Copyright and License
This project is licensed under the [MIT](http://opensource.org/licenses/MIT).
2020 © [Nilambar Sharma](https://www.nilambar.net).