wppaste
WordPress

WP_Widget_Pages

Since
2.8.0
Source
wp-includes/widgets/class-wp-widget-pages.php:17
Core class used to implement a Pages widget.

Compatibility

WordPress
since 2.8.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 3

Every hook that fires from inside WP_Widget_Pages, in the order it appears in the class, grouped by the method that fires it.

Methods · 4

  • __construct()Sets up a new Pages widget instance.
  • widget()Outputs the content for the current Pages widget instance.
  • update()Handles updating settings for the current Pages widget instance.
  • form()Outputs the settings form for the Pages widget.

Source code

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';

Changelog

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/widgets/class-wp-widget-pages.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.