Title: WP_Widget_Pages
Published: April 25, 2014
Last modified: February 24, 2026

---

# class WP_Widget_Pages {}

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#description)
    - [See also](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#see-also)
 * [Methods](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#methods)
 * [Source](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#wp--skip-link--target)

Core class used to implement a Pages widget.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#description)󠁿

### 󠀁[See also](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#see-also)󠁿

 * [WP_Widget](https://developer.wordpress.org/reference/classes/wp_widget/)

## 󠀁[Methods](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#methods)󠁿

| Name | Description | 
| [WP_Widget_Pages::__construct](https://developer.wordpress.org/reference/classes/wp_widget_pages/__construct/) | Sets up a new Pages widget instance. | 
| [WP_Widget_Pages::form](https://developer.wordpress.org/reference/classes/wp_widget_pages/form/) | Outputs the settings form for the Pages widget. | 
| [WP_Widget_Pages::update](https://developer.wordpress.org/reference/classes/wp_widget_pages/update/) | Handles updating settings for the current Pages widget instance. | 
| [WP_Widget_Pages::widget](https://developer.wordpress.org/reference/classes/wp_widget_pages/widget/) | Outputs the content for the current Pages widget instance. |

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#source)󠁿

    ```php
    class WP_Widget_Pages extends WP_Widget {

    	/**
    	 * Sets up a new Pages widget instance.
    	 *
    	 * @since 2.8.0
    	 */
    	public function __construct() {
    		$widget_ops = array(
    			'classname'                   => 'widget_pages',
    			'description'                 => __( 'A list of your site’s Pages.' ),
    			'customize_selective_refresh' => true,
    			'show_instance_in_rest'       => true,
    		);
    		parent::__construct( 'pages', __( 'Pages' ), $widget_ops );
    	}

    	/**
    	 * Outputs the content for the current Pages widget instance.
    	 *
    	 * @since 2.8.0
    	 *
    	 * @param array $args     Display arguments including 'before_title', 'after_title',
    	 *                        'before_widget', and 'after_widget'.
    	 * @param array $instance Settings for the current Pages widget instance.
    	 */
    	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'];
    		}
    	}

    	/**
    	 * Handles updating settings for the current Pages widget instance.
    	 *
    	 * @since 2.8.0
    	 *
    	 * @param array $new_instance New settings for this instance as input by the user via
    	 *                            WP_Widget::form().
    	 * @param array $old_instance Old settings for this instance.
    	 * @return array Updated settings to save.
    	 */
    	public function update( $new_instance, $old_instance ) {
    		$instance          = $old_instance;
    		$instance['title'] = sanitize_text_field( $new_instance['title'] );
    		if ( in_array( $new_instance['sortby'], array( 'post_title', 'menu_order', 'ID' ), true ) ) {
    			$instance['sortby'] = $new_instance['sortby'];
    		} else {
    			$instance['sortby'] = 'menu_order';
    		}

    		$instance['exclude'] = sanitize_text_field( $new_instance['exclude'] );

    		return $instance;
    	}

    	/**
    	 * Outputs the settings form for the Pages widget.
    	 *
    	 * @since 2.8.0
    	 *
    	 * @param array $instance Current settings.
    	 */
    	public function form( $instance ) {
    		// Defaults.
    		$instance = wp_parse_args(
    			(array) $instance,
    			array(
    				'sortby'  => 'post_title',
    				'title'   => '',
    				'exclude' => '',
    			)
    		);
    		?>
    		<p>
    			<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php _e( 'Title:' ); ?></label>
    			<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" />
    		</p>

    		<p>
    			<label for="<?php echo esc_attr( $this->get_field_id( 'sortby' ) ); ?>"><?php _e( 'Sort by:' ); ?></label>
    			<select name="<?php echo esc_attr( $this->get_field_name( 'sortby' ) ); ?>" id="<?php echo esc_attr( $this->get_field_id( 'sortby' ) ); ?>" class="widefat">
    				<option value="post_title"<?php selected( $instance['sortby'], 'post_title' ); ?>><?php _e( 'Page title' ); ?></option>
    				<option value="menu_order"<?php selected( $instance['sortby'], 'menu_order' ); ?>><?php _e( 'Page order' ); ?></option>
    				<option value="ID"<?php selected( $instance['sortby'], 'ID' ); ?>><?php _e( 'Page ID' ); ?></option>
    			</select>
    		</p>

    		<p>
    			<label for="<?php echo esc_attr( $this->get_field_id( 'exclude' ) ); ?>"><?php _e( 'Exclude:' ); ?></label>
    			<input type="text" value="<?php echo esc_attr( $instance['exclude'] ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'exclude' ) ); ?>" id="<?php echo esc_attr( $this->get_field_id( 'exclude' ) ); ?>" class="widefat" />
    			<br />
    			<small><?php _e( 'Page IDs, separated by commas.' ); ?></small>
    		</p>
    		<?php
    	}
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/widgets/class-wp-widget-pages.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/widgets/class-wp-widget-pages.php#L17)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/widgets/class-wp-widget-pages.php#L17-L185)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#related)󠁿

| Uses | Description | 
| [WP_Widget](https://developer.wordpress.org/reference/classes/wp_widget/)`wp-includes/class-wp-widget.php` |

Core base class extended to register widgets.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_widget_pages/?output_format=md#changelog)󠁿

| Version | Description | 
| [2.8.0](https://developer.wordpress.org/reference/since/2.8.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_widget_pages%2F)
before being able to contribute a note or feedback.