W3cubDocs

/WordPress

WP_Widget_Categories::widget( array $args, array $instance )

Outputs the content for the current Categories widget instance.

Parameters

$args

(array) (Required) Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.

$instance

(array) (Required) Settings for the current Categories widget instance.

Source

File: wp-includes/widgets/class-wp-widget-categories.php 

public function widget( $args, $instance ) {
		static $first_dropdown = true;

		$default_title = __( 'Categories' );
		$title         = ! empty( $instance['title'] ) ? $instance['title'] : $default_title;

		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

		$count        = ! empty( $instance['count'] ) ? '1' : '0';
		$hierarchical = ! empty( $instance['hierarchical'] ) ? '1' : '0';
		$dropdown     = ! empty( $instance['dropdown'] ) ? '1' : '0';

		echo $args['before_widget'];

		if ( $title ) {
			echo $args['before_title'] . $title . $args['after_title'];
		}

		$cat_args = array(
			'orderby'      => 'name',
			'show_count'   => $count,
			'hierarchical' => $hierarchical,
		);

		if ( $dropdown ) {
			printf( '<form action="%s" method="get">', esc_url( home_url() ) );
			$dropdown_id    = ( $first_dropdown ) ? 'cat' : "{$this->id_base}-dropdown-{$this->number}";
			$first_dropdown = false;

			echo '<label class="screen-reader-text" for="' . esc_attr( $dropdown_id ) . '">' . $title . '</label>';

			$cat_args['show_option_none'] = __( 'Select Category' );
			$cat_args['id']               = $dropdown_id;

			/**
			 * Filters the arguments for the Categories widget drop-down.
			 *
			 * @since 2.8.0
			 * @since 4.9.0 Added the `$instance` parameter.
			 *
			 * @see wp_dropdown_categories()
			 *
			 * @param array $cat_args An array of Categories widget drop-down arguments.
			 * @param array $instance Array of settings for the current widget.
			 */
			wp_dropdown_categories( apply_filters( 'widget_categories_dropdown_args', $cat_args, $instance ) );

			echo '</form>';

			$type_attr = current_theme_supports( 'html5', 'script' ) ? '' : ' type="text/javascript"';
			?>

<script<?php echo $type_attr; ?>>
/* <![CDATA[ */
(function() {
	var dropdown = document.getElementById( "<?php echo esc_js( $dropdown_id ); ?>" );
	function onCatChange() {
		if ( dropdown.options[ dropdown.selectedIndex ].value > 0 ) {
			dropdown.parentNode.submit();
		}
	}
	dropdown.onchange = onCatChange;
})();
/* ]]> */
</script>

			<?php
		} else {
			$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';

			/** This filter is documented in wp-includes/widgets/class-wp-nav-menu-widget.php */
			$format = apply_filters( 'navigation_widgets_format', $format );

			if ( 'html5' === $format ) {
				// The title may be filtered: Strip out HTML and make sure the aria-label is never empty.
				$title      = trim( strip_tags( $title ) );
				$aria_label = $title ? $title : $default_title;
				echo '<nav role="navigation" aria-label="' . esc_attr( $aria_label ) . '">';
			}
			?>

			<ul>
				<?php
				$cat_args['title_li'] = '';

				/**
				 * Filters the arguments for the Categories widget.
				 *
				 * @since 2.8.0
				 * @since 4.9.0 Added the `$instance` parameter.
				 *
				 * @param array $cat_args An array of Categories widget options.
				 * @param array $instance Array of settings for the current widget.
				 */
				wp_list_categories( apply_filters( 'widget_categories_args', $cat_args, $instance ) );
				?>
			</ul>

			<?php
			if ( 'html5' === $format ) {
				echo '</nav>';
			}
		}

		echo $args['after_widget'];
	}

Uses

Uses Description
wp-includes/widgets/class-wp-nav-menu-widget.php: navigation_widgets_format

Filters the HTML format of widgets with navigation links.
wp-includes/category-template.php: wp_dropdown_categories()

Displays or retrieves the HTML dropdown list of categories.
wp-includes/category-template.php: wp_list_categories()

Displays or retrieves the HTML list of categories.
wp-includes/theme.php: current_theme_supports()

Checks a theme’s support for a given feature.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/formatting.php: esc_attr()

Escaping for HTML attributes.
wp-includes/formatting.php: esc_js()

Escape single quotes, htmlspecialchar ” &, and fix line endings.
wp-includes/widgets/class-wp-widget-categories.php: widget_categories_dropdown_args

Filters the arguments for the Categories widget drop-down.
wp-includes/widgets/class-wp-widget-categories.php: widget_categories_args

Filters the arguments for the Categories widget.
wp-includes/widgets/class-wp-widget-pages.php: widget_title

Filters the widget title.
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
4.2.0 Creates a unique HTML ID for the <select> element if more than one instance is displayed on the page.
2.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_widget_categories/widget