underpin/sidebar-loader

Sidebar loader for Underpin

1.1.0 2021-11-24 21:42 UTC

Requires

• underpin/underpin: ^2.0

GPL-2.0-or-later

• Alex Standiford

README

Loader That assists with adding sidebars (widget areas) to a WordPress website.

Installation

Using Composer

composer require underpin/sidebar-loader

Manually

This plugin uses a built-in autoloader, so as long as it is required before Underpin, it should work as-expected.

require_once(__DIR__ . '/underpin-sidebars/sidebars.php');

Setup

1. Install Underpin. See Underpin Docs
2. Register new sidebars menus as-needed.

Example

A very basic example could look something like this.

// Register sidebar
underpin()->sidebars()->add( 'example-sidebar', [
	'name'        => underpin()->__( 'Human readable name' ),
	'id'          => 'example',
	'description' => underpin()->__( 'Human readable description' ),
] );

Alternatively, you can extend Sidebar and reference the extended class directly, like so:

underpin()->sidebars()->add('sidebar-key','Namespace\To\Class');