Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: dynamic_sidebar_has_widgets

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 2 times in this file.

Line Code
696      }
697
698      $sidebars_widgets = wp_get_sidebars_widgets();
699      if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) {
700           /** This action is documented in wp-includes/widget.php */
701           do_action( 'dynamic_sidebar_before', $index, false );
702           /** This action is documented in wp-includes/widget.php */
703           do_action( 'dynamic_sidebar_after', $index, false );
704           /** This filter is documented in wp-includes/widget.php */
705           return apply_filters( 'dynamic_sidebar_has_widgets', false, $index );
706      }
707
708      $sidebar = $wp_registered_sidebars[ $index ];
709
710      $sidebar['before_sidebar'] = sprintf( $sidebar['before_sidebar'], $sidebar['id'], $sidebar['class'] );
711
712      /**
713       * Fires before widgets are rendered in a dynamic sidebar.
714       *
 
Line Code
857       * Note: The filter is also evaluated for empty sidebars, and on both the front end
858       * and back end, including the Inactive Widgets sidebar on the Widgets screen.
859       *
860       * @since 3.9.0
861       *
862       * @param bool       $did_one Whether at least one widget was rendered in the sidebar.
863       *                            Default false.
864       * @param int|string $index   Index, name, or ID of the dynamic sidebar.
865       */
866      return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );
867 }
868
869 /**
870  * Determines whether a given widget is displayed on the front end.
871  *
872  * Either $callback or $id_base can be used
873  * $id_base is the first argument when extending WP_Widget class
874  * Without the optional $widget_id parameter, returns the ID of the first sidebar
875  * in which the first instance of the widget with the given callback or $id_base is found.