* @copyright Copyright (c) 2008 - 2014, Justin Tadlock * @link http://themehybrid.com/hybrid-core * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html */ /** * Pages Widget Class * * @since 0.6.0 */ class Hybrid_Widget_Pages extends WP_Widget { /** * Default arguments for the widget settings. * * @since 2.0.0 * @access public * @var array */ public $defaults = array(); /** * Set up the widget's unique name, ID, class, description, and other options. * * @since 1.2.0 * @access public * @return void */ function __construct() { /* Set up the widget options. */ $widget_options = array( 'classname' => 'widget-pages widget_pages', 'description' => esc_html__( 'An advanced widget that gives you total control over the output of your page links.', 'hybrid-core' ) ); /* Set up the widget control options. */ $control_options = array( 'width' => 800, 'height' => 350 ); /* Create the widget. */ $this->WP_Widget( 'hybrid-pages', __( 'Pages', 'hybrid-core'), $widget_options, $control_options ); /* Set up the defaults. */ $this->defaults = array( 'title' => esc_attr__( 'Pages', 'hybrid-core'), 'post_type' => 'page', 'depth' => 0, 'number' => '', 'offset' => '', 'child_of' => '', 'include' => '', 'exclude' => '', 'exclude_tree' => '', 'meta_key' => '', 'meta_value' => '', 'authors' => '', 'link_before' => '', 'link_after' => '', 'show_date' => '', 'hierarchical' => true, 'sort_column' => 'post_title', 'sort_order' => 'ASC', 'date_format' => get_option( 'date_format' ) ); } /** * Outputs the widget based on the arguments input through the widget controls. * * @since 0.6.0 * @access public * @param array $sidebar * @param array $instance * @return void */ function widget( $sidebar, $instance ) { /* Set the $args for wp_list_pages() to the $instance array. */ $args = wp_parse_args( $instance, $this->defaults ); /* Set the $title_li and $echo to false. */ $args['title_li'] = false; $args['echo'] = false; /* Output the sidebar's $before_widget wrapper. */ echo $sidebar['before_widget']; /* If a title was input by the user, display it. */ if ( !empty( $args['title'] ) ) echo $sidebar['before_title'] . apply_filters( 'widget_title', $args['title'], $instance, $this->id_base ) . $sidebar['after_title']; /* Output the page list. */ echo ''; /* Close the sidebar's widget wrapper. */ echo $sidebar['after_widget']; } /** * The update callback for the widget control options. This method is used to sanitize and/or * validate the options before saving them into the database. * * @since 0.6.0 * @access public * @param array $new_instance * @param array $old_instance * @return array */ function update( $new_instance, $old_instance ) { /* Strip tags. */ $instance['title'] = strip_tags( $new_instance['title'] ); $instance['meta_key'] = strip_tags( $new_instance['meta_key'] ); $instance['meta_value'] = strip_tags( $new_instance['meta_value'] ); $instance['date_format'] = strip_tags( $new_instance['date_format'] ); /* Sanitize key. */ $instance['post_type'] = sanitize_key( $new_instance['post_type'] ); /* Whitelist options. */ $sort_order = array( 'ASC', 'DESC' ); $sort_column = array( 'post_author', 'post_date', 'ID', 'menu_order', 'post_modified', 'post_name', 'post_title' ); $show_date = array( '', 'created', 'modified' ); $instance['sort_column'] = in_array( $new_instance['sort_column'], $sort_column ) ? $new_instance['sort_column'] : 'post_title'; $instance['sort_order'] = in_array( $new_instance['sort_order'], $sort_order ) ? $new_instance['sort_order'] : 'ASC'; $instance['show_date'] = in_array( $new_instance['show_date'], $show_date ) ? $new_instance['show_date'] : ''; /* Text boxes. Make sure user can use 'unfiltered_html'. */ $instance['link_before'] = current_user_can( 'unfiltered_html' ) ? $new_instance['link_before'] : wp_filter_post_kses( $new_instance['link_before'] ); $instance['link_after'] = current_user_can( 'unfiltered_html' ) ? $new_instance['link_after'] : wp_filter_post_kses( $new_instance['link_after'] ); /* Integers. */ $instance['number'] = intval( $new_instance['number'] ); $instance['depth'] = absint( $new_instance['depth'] ); $instance['child_of'] = absint( $new_instance['child_of'] ); $instance['offset'] = absint( $new_instance['offset'] ); /* Only allow integers and commas. */ $instance['include'] = preg_replace( '/[^0-9,]/', '', $new_instance['include'] ); $instance['exclude'] = preg_replace( '/[^0-9,]/', '', $new_instance['exclude'] ); $instance['exclude_tree'] = preg_replace( '/[^0-9,]/', '', $new_instance['exclude_tree'] ); $instance['authors'] = preg_replace( '/[^0-9,]/', '', $new_instance['authors'] ); /* Checkboxes. */ $instance['hierarchical'] = isset( $new_instance['hierarchical'] ) ? 1 : 0; /* Return sanitized options. */ return $instance; } /** * Displays the widget control options in the Widgets admin screen. * * @since 0.6.0 * @access public * @param array $instance * @param void */ function form( $instance ) { /* Merge the user-selected arguments with the defaults. */ $instance = wp_parse_args( (array) $instance, $this->defaults ); $post_types = get_post_types( array( 'public' => true, 'hierarchical' => true ), 'objects' ); $sort_order = array( 'ASC' => esc_attr__( 'Ascending', 'hybrid-core' ), 'DESC' => esc_attr__( 'Descending', 'hybrid-core' ) ); $sort_column = array( 'post_author' => esc_attr__( 'Author', 'hybrid-core' ), 'post_date' => esc_attr__( 'Date', 'hybrid-core' ), 'ID' => esc_attr__( 'ID', 'hybrid-core' ), 'menu_order' => esc_attr__( 'Menu Order', 'hybrid-core' ), 'post_modified' => esc_attr__( 'Modified', 'hybrid-core' ), 'post_name' => esc_attr__( 'Slug', 'hybrid-core' ), 'post_title' => esc_attr__( 'Title', 'hybrid-core' ) ); $show_date = array( '' => '', 'created' => esc_attr__( 'Created', 'hybrid-core' ), 'modified' => esc_attr__( 'Modified', 'hybrid-core' ) ); $meta_key = array_merge( array( '' ), (array) get_meta_keys() ); ?>