is_wide_widget_in_customizer

Filter Hook

Description

Filters whether the given widget is considered "wide".

Hook Information

File Location	`wp-includes/class-wp-customize-widgets.php` View on GitHub
Hook Type	Filter
Line Number	`615`

Hook Parameters

Type	Name	Description
`bool`	`$is_wide`	Whether the widget is wide, Default false.
`string`	`$widget_id`	Widget ID.

Usage Examples

Basic Usage

<?php
// Hook into is_wide_widget_in_customizer
add_filter('is_wide_widget_in_customizer', 'my_custom_filter', 10, 2);

function my_custom_filter($is_wide, $widget_id) {
    // Your custom filtering logic here
    return $is_wide;
}

Source Code Context

wp-includes/class-wp-customize-widgets.php:615 - How this hook is used in WordPress core

<?php
 610  		 * @since 3.9.0
 611  		 *
 612  		 * @param bool   $is_wide   Whether the widget is wide, Default false.
 613  		 * @param string $widget_id Widget ID.
 614  		 */
 615  		return apply_filters( 'is_wide_widget_in_customizer', $is_wide, $widget_id );
 616  	}
 617  
 618  	/**
 619  	 * Converts a widget ID into its id_base and number components.
 620  	 *

PHP Documentation

<?php
/**
		 * Filters whether the given widget is considered "wide".
		 *
		 * @since 3.9.0
		 *
		 * @param bool   $is_wide   Whether the widget is wide, Default false.
		 * @param string $widget_id Widget ID.
		 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/class-wp-customize-widgets.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.