WP_Widget_Pages::widget()publicWP 2.8.0

Outputs the content for the current Pages widget instance.

Method of the class: WP_Widget_Pages{}

Return

null. Nothing (null).

Usage

$WP_Widget_Pages = new WP_Widget_Pages();
$WP_Widget_Pages->widget( $args, $instance );
$args(array) (required)
Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
$instance(array) (required)
Settings for the current Pages widget instance.

Changelog

Since 2.8.0 Introduced.

WP_Widget_Pages::widget() code WP 6.4.3

<?php
public function widget( $args, $instance ) {
	$default_title = __( 'Pages' );
	$title         = ! empty( $instance['title'] ) ? $instance['title'] : $default_title;

	/**
	 * Filters the widget title.
	 *
	 * @since 2.6.0
	 *
	 * @param string $title    The widget title. Default 'Pages'.
	 * @param array  $instance Array of settings for the current widget.
	 * @param mixed  $id_base  The widget ID.
	 */
	$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

	$sortby  = empty( $instance['sortby'] ) ? 'menu_order' : $instance['sortby'];
	$exclude = empty( $instance['exclude'] ) ? '' : $instance['exclude'];

	if ( 'menu_order' === $sortby ) {
		$sortby = 'menu_order, post_title';
	}

	$output = wp_list_pages(
		/**
		 * Filters the arguments for the Pages widget.
		 *
		 * @since 2.8.0
		 * @since 4.9.0 Added the `$instance` parameter.
		 *
		 * @see wp_list_pages()
		 *
		 * @param array $args     An array of arguments to retrieve the pages list.
		 * @param array $instance Array of settings for the current widget.
		 */
		apply_filters(
			'widget_pages_args',
			array(
				'title_li'    => '',
				'echo'        => 0,
				'sort_column' => $sortby,
				'exclude'     => $exclude,
			),
			$instance
		)
	);

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

		$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 aria-label="' . esc_attr( $aria_label ) . '">';
		}
		?>

		<ul>
			<?php echo $output; ?>
		</ul>

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

		echo $args['after_widget'];
	}
}