This repository has been archived on 2020-05-08. You can view files and clone it, but cannot push or open issues or pull requests.
understrap/inc/widgets.php

175 lines
6.1 KiB
PHP
Raw Permalink Normal View History

2014-12-10 11:36:38 +00:00
<?php
2015-09-09 08:58:25 +00:00
/**
* Declaring widgets
*
* @package understrap
*/
2017-02-01 16:10:32 +00:00
2019-06-20 08:57:12 +00:00
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
2018-09-10 21:59:04 +00:00
/**
2018-09-10 22:58:25 +00:00
* Add filter to the parameters passed to a widget's display callback.
* The filter is evaluated on both the front and the back end!
*
* @link https://developer.wordpress.org/reference/hooks/dynamic_sidebar_params/
*/
2018-09-10 22:58:25 +00:00
add_filter( 'dynamic_sidebar_params', 'understrap_widget_classes' );
if ( ! function_exists( 'understrap_widget_classes' ) ) {
2018-09-10 22:58:25 +00:00
/**
* Count number of visible widgets in a sidebar and add classes to widgets accordingly,
* so widgets can be displayed one, two, three or four per row.
*
* @global array $sidebars_widgets
*
* @param array $params {
* Parameters passed to a widgets display callback.
*
2018-09-10 22:58:25 +00:00
* @type array $args {
* An array of widget display arguments.
*
* @type string $name Name of the sidebar the widget is assigned to.
* @type string $id ID of the sidebar the widget is assigned to.
* @type string $description The sidebar description.
* @type string $class CSS class applied to the sidebar container.
* @type string $before_widget HTML markup to prepend to each widget in the sidebar.
* @type string $after_widget HTML markup to append to each widget in the sidebar.
* @type string $before_title HTML markup to prepend to the widget title when displayed.
* @type string $after_title HTML markup to append to the widget title when displayed.
* @type string $widget_id ID of the widget.
* @type string $widget_name Name of the widget.
* }
* @type array $widget_args {
* An array of multi-widget arguments.
*
* @type int $number Number increment used for multiples of the same widget.
* }
* }
* @return array $params
*/
function understrap_widget_classes( $params ) {
global $sidebars_widgets;
/*
* When the corresponding filter is evaluated on the front end
* this takes into account that there might have been made other changes.
*/
$sidebars_widgets_count = apply_filters( 'sidebars_widgets', $sidebars_widgets );
// Only apply changes if sidebar ID is set and the widget's classes depend on the number of widgets in the sidebar.
if ( isset( $params[0]['id'] ) && strpos( $params[0]['before_widget'], 'dynamic-classes' ) ) {
$sidebar_id = $params[0]['id'];
$widget_count = count( $sidebars_widgets_count[ $sidebar_id ] );
2018-09-10 22:58:25 +00:00
$widget_classes = 'widget-count-' . $widget_count;
if ( 0 === $widget_count % 4 || $widget_count > 6 ) {
// Four widgets per row if there are exactly four or more than six.
$widget_classes .= ' col-md-3';
2018-09-10 22:58:25 +00:00
} elseif ( 6 === $widget_count ) {
// If two widgets are published.
$widget_classes .= ' col-md-2';
2018-09-10 22:58:25 +00:00
} elseif ( $widget_count >= 3 ) {
// Three widgets per row if there's three or more widgets.
$widget_classes .= ' col-md-4';
2018-09-10 22:58:25 +00:00
} elseif ( 2 === $widget_count ) {
// If two widgets are published.
$widget_classes .= ' col-md-6';
2018-09-10 22:58:25 +00:00
} elseif ( 1 === $widget_count ) {
// If just on widget is active.
$widget_classes .= ' col-md-12';
2018-09-10 22:58:25 +00:00
}
// Replace the placeholder class 'dynamic-classes' with the classes stored in $widget_classes.
$params[0]['before_widget'] = str_replace( 'dynamic-classes', $widget_classes, $params[0]['before_widget'] );
}
return $params;
}
} // End of if function_exists( 'understrap_widget_classes' ).
2016-11-21 17:12:36 +00:00
add_action( 'widgets_init', 'understrap_widgets_init' );
if ( ! function_exists( 'understrap_widgets_init' ) ) {
2016-11-21 17:12:36 +00:00
/**
* Initializes themes widgets.
*/
function understrap_widgets_init() {
2018-09-10 22:58:25 +00:00
register_sidebar(
array(
'name' => __( 'Right Sidebar', 'understrap' ),
'id' => 'right-sidebar',
'description' => __( 'Right sidebar widget area', 'understrap' ),
'before_widget' => '<aside id="%1$s" class="widget %2$s">',
'after_widget' => '</aside>',
'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>',
)
);
register_sidebar(
array(
'name' => __( 'Left Sidebar', 'understrap' ),
'id' => 'left-sidebar',
'description' => __( 'Left sidebar widget area', 'understrap' ),
'before_widget' => '<aside id="%1$s" class="widget %2$s">',
'after_widget' => '</aside>',
'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>',
)
);
register_sidebar(
array(
'name' => __( 'Hero Slider', 'understrap' ),
'id' => 'hero',
'description' => __( 'Hero slider area. Place two or more widgets here and they will slide!', 'understrap' ),
'before_widget' => '<div class="carousel-item">',
'after_widget' => '</div>',
'before_title' => '',
'after_title' => '',
)
);
register_sidebar(
array(
'name' => __( 'Hero Canvas', 'understrap' ),
'id' => 'herocanvas',
'description' => __( 'Full size canvas hero area for Bootstrap and other custom HTML markup', 'understrap' ),
'before_widget' => '',
'after_widget' => '',
'before_title' => '',
'after_title' => '',
)
);
register_sidebar(
array(
'name' => __( 'Top Full', 'understrap' ),
'id' => 'statichero',
'description' => __( 'Full top widget with dynamic grid', 'understrap' ),
'before_widget' => '<div id="%1$s" class="static-hero-widget %2$s dynamic-classes">',
2018-09-10 22:58:25 +00:00
'after_widget' => '</div><!-- .static-hero-widget -->',
'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>',
)
);
register_sidebar(
array(
'name' => __( 'Footer Full', 'understrap' ),
'id' => 'footerfull',
'description' => __( 'Full sized footer widget with dynamic grid', 'understrap' ),
'before_widget' => '<div id="%1$s" class="footer-widget %2$s dynamic-classes">',
'after_widget' => '</div><!-- .footer-widget -->',
'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>',
)
);
}
} // End of function_exists( 'understrap_widgets_init' ).