Fix for #796 - Thx @IanDelMar !
This commit is contained in:
Holger 2018-11-16 08:07:53 +01:00 committed by GitHub
commit 05cbe7bedf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 134 additions and 81 deletions

View File

@ -10,44 +10,85 @@ if ( ! defined( 'ABSPATH' ) ) {
} }
/** /**
* Count number of widgets in a sidebar * Add filter to the parameters passed to a widget's display callback.
* Used to add classes to widget areas so widgets can be displayed one, two, three or four per row * The filter is evaluated on both the front and the back end!
*
* @link https://developer.wordpress.org/reference/hooks/dynamic_sidebar_params/
*/ */
if ( ! function_exists( 'understrap_slbd_count_widgets' ) ) { add_filter( 'dynamic_sidebar_params', 'understrap_widget_classes' );
function understrap_slbd_count_widgets( $sidebar_id ) {
// If loading from front page, consult $_wp_sidebars_widgets rather than options
// to see if wp_convert_widget_settings() has made manipulations in memory.
global $_wp_sidebars_widgets;
if ( empty( $_wp_sidebars_widgets ) ) :
$_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() );
endif;
$sidebars_widgets_count = $_wp_sidebars_widgets; if ( ! function_exists( 'understrap_widget_classes' ) ) {
/**
* 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 {
* @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 ) {
if ( isset( $sidebars_widgets_count[ $sidebar_id ] ) ) : 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 ] ); $widget_count = count( $sidebars_widgets_count[ $sidebar_id ] );
$widget_classes = 'widget-count-' . count( $sidebars_widgets_count[ $sidebar_id ] );
if ( $widget_count % 4 == 0 || $widget_count > 6 ) : $widget_classes = 'widget-count-' . $widget_count;
// Four widgets per row if there are exactly four or more than six 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'; $widget_classes .= ' col-md-3';
elseif ( 6 == $widget_count ) : } elseif ( 6 === $widget_count ) {
// If two widgets are published // If two widgets are published.
$widget_classes .= ' col-md-2'; $widget_classes .= ' col-md-2';
elseif ( $widget_count >= 3 ) : } elseif ( $widget_count >= 3 ) {
// Three widgets per row if there's three or more widgets // Three widgets per row if there's three or more widgets.
$widget_classes .= ' col-md-4'; $widget_classes .= ' col-md-4';
elseif ( 2 == $widget_count ) : } elseif ( 2 === $widget_count ) {
// If two widgets are published // If two widgets are published.
$widget_classes .= ' col-md-6'; $widget_classes .= ' col-md-6';
elseif ( 1 == $widget_count ) : } elseif ( 1 === $widget_count ) {
// If just on widget is active // If just on widget is active.
$widget_classes .= ' col-md-12'; $widget_classes .= ' col-md-12';
endif;
return $widget_classes;
endif;
} }
// 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;
}
} // endif function_exists( 'understrap_widget_classes' ).
add_action( 'widgets_init', 'understrap_widgets_init' ); add_action( 'widgets_init', 'understrap_widgets_init' );
if ( ! function_exists( 'understrap_widgets_init' ) ) { if ( ! function_exists( 'understrap_widgets_init' ) ) {
@ -55,7 +96,8 @@ if ( ! function_exists( 'understrap_widgets_init' ) ) {
* Initializes themes widgets. * Initializes themes widgets.
*/ */
function understrap_widgets_init() { function understrap_widgets_init() {
register_sidebar( array( register_sidebar(
array(
'name' => __( 'Right Sidebar', 'understrap' ), 'name' => __( 'Right Sidebar', 'understrap' ),
'id' => 'right-sidebar', 'id' => 'right-sidebar',
'description' => __( 'Right sidebar widget area', 'understrap' ), 'description' => __( 'Right sidebar widget area', 'understrap' ),
@ -63,9 +105,11 @@ if ( ! function_exists( 'understrap_widgets_init' ) ) {
'after_widget' => '</aside>', 'after_widget' => '</aside>',
'before_title' => '<h3 class="widget-title">', 'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>', 'after_title' => '</h3>',
) ); )
);
register_sidebar( array( register_sidebar(
array(
'name' => __( 'Left Sidebar', 'understrap' ), 'name' => __( 'Left Sidebar', 'understrap' ),
'id' => 'left-sidebar', 'id' => 'left-sidebar',
'description' => __( 'Left sidebar widget area', 'understrap' ), 'description' => __( 'Left sidebar widget area', 'understrap' ),
@ -73,9 +117,11 @@ if ( ! function_exists( 'understrap_widgets_init' ) ) {
'after_widget' => '</aside>', 'after_widget' => '</aside>',
'before_title' => '<h3 class="widget-title">', 'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>', 'after_title' => '</h3>',
) ); )
);
register_sidebar( array( register_sidebar(
array(
'name' => __( 'Hero Slider', 'understrap' ), 'name' => __( 'Hero Slider', 'understrap' ),
'id' => 'hero', 'id' => 'hero',
'description' => __( 'Hero slider area. Place two or more widgets here and they will slide!', 'understrap' ), 'description' => __( 'Hero slider area. Place two or more widgets here and they will slide!', 'understrap' ),
@ -83,9 +129,11 @@ if ( ! function_exists( 'understrap_widgets_init' ) ) {
'after_widget' => '</div>', 'after_widget' => '</div>',
'before_title' => '', 'before_title' => '',
'after_title' => '', 'after_title' => '',
) ); )
);
register_sidebar( array( register_sidebar(
array(
'name' => __( 'Hero Canvas', 'understrap' ), 'name' => __( 'Hero Canvas', 'understrap' ),
'id' => 'herocanvas', 'id' => 'herocanvas',
'description' => __( 'Full size canvas hero area for Bootstrap and other custom HTML markup', 'understrap' ), 'description' => __( 'Full size canvas hero area for Bootstrap and other custom HTML markup', 'understrap' ),
@ -93,27 +141,32 @@ if ( ! function_exists( 'understrap_widgets_init' ) ) {
'after_widget' => '', 'after_widget' => '',
'before_title' => '', 'before_title' => '',
'after_title' => '', 'after_title' => '',
) ); )
);
register_sidebar( array( register_sidebar(
array(
'name' => __( 'Top Full', 'understrap' ), 'name' => __( 'Top Full', 'understrap' ),
'id' => 'statichero', 'id' => 'statichero',
'description' => __( 'Full top widget with dynamic grid', 'understrap' ), 'description' => __( 'Full top widget with dynamic grid', 'understrap' ),
'before_widget' => '<div id="%1$s" class="static-hero-widget %2$s '. understrap_slbd_count_widgets( 'statichero' ) .'">', 'before_widget' => '<div id="%1$s" class="footer-widget %2$s dynamic-classes">',
'after_widget' => '</div><!-- .static-hero-widget -->', 'after_widget' => '</div><!-- .static-hero-widget -->',
'before_title' => '<h3 class="widget-title">', 'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>', 'after_title' => '</h3>',
) ); )
);
register_sidebar( array( register_sidebar(
array(
'name' => __( 'Footer Full', 'understrap' ), 'name' => __( 'Footer Full', 'understrap' ),
'id' => 'footerfull', 'id' => 'footerfull',
'description' => __( 'Full sized footer widget with dynamic grid', 'understrap' ), 'description' => __( 'Full sized footer widget with dynamic grid', 'understrap' ),
'before_widget' => '<div id="%1$s" class="footer-widget %2$s '. understrap_slbd_count_widgets( 'footerfull' ) .'">', 'before_widget' => '<div id="%1$s" class="footer-widget %2$s dynamic-classes">',
'after_widget' => '</div><!-- .footer-widget -->', 'after_widget' => '</div><!-- .footer-widget -->',
'before_title' => '<h3 class="widget-title">', 'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>', 'after_title' => '</h3>',
) ); )
);
} }
} // endif function_exists( 'understrap_widgets_init' ). } // endif function_exists( 'understrap_widgets_init' ).