Ticket #2847: 2847.diff

functions.php

@@ -96 +96 @@
 add_action( 'init', __NAMESPACE__ . '\\init' );
 add_action( 'widgets_init', __NAMESPACE__ . '\\widgets_init' );
 
+/**
+ * @since 1.x.y Setup to filter wp-parser-since archives by change_type
+ */
 function init() {
 
         register_nav_menus();
@@ -118 +121 @@
         add_filter( 'document_title_separator', __NAMESPACE__ . '\\theme_title_separator', 10, 2 );
 
         add_filter( 'syntaxhighlighter_htmlresult', __NAMESPACE__ . '\\syntaxhighlighter_htmlresult' );
+
+        add_filter( 'query_vars',  __NAMESPACE__ . '\\add_change_type_query_var' );
+        add_filter( 'posts_pre_query', __NAMESPACE__ . '\\since_change_type_filter', 10, 2 );
+
 }
 
 /**
@@ -199 +206 @@
 
 /**
  * @param \WP_Query $query
+ *
+ * @since 1.x.y wp-parser-since archive is now sorted by post_type then title;
+ *                              support for filtering wp-parser-since archives by whether a change was newly
+ *                              newly introduced or a modification from previous version(s)
  */
 function pre_get_posts( $query ) {
 
@@ -211 +222 @@
                 $query->set( 'wp-parser-source-file', str_replace( array( '.php', '/' ), array( '-php', '_' ), $query->query['wp-parser-source-file'] ) );
         }
 
+        if ( $query->is_main_query() && $query->is_tax() && $query->get( 'wp-parser-since' ) ) {
+                $query->set( 'orderby', 'type title' );
+                $query->set( 'order', 'ASC' );
+                $query->set( 'change_type', empty( $_REQUEST['change_type'] ) ? 'any' : $_REQUEST['change_type'] );
+        }
+
         // For search query modifications see DevHub_Search.
 }
 
+/**
+ * Add change_type to the public_query_vars
+ *
+ * @since 1.x.y
+ *
+ * @param array $public_query_vars The array of whitelisted query variables.
+ * @return array $public_query_vars with 'change_type' added
+ */
+function add_change_type_query_var( $public_query_vars )
+{
+        $public_query_vars['change_type'] = 'any';
+
+        return $public_query_vars;
+}
+
+/**
+ * Filter wp-parser-since archive by the type of change
+ *
+ * @since 1.x.y
+ *
+ * @param array $posts
+ * @param WP_Query $query WP_Query object.
+ * @return array Posts which a specific type of change
+ */
+function since_change_type_filter( $posts, &$query ) {
+        global $wpdb;
+
+        $version = $query->get( 'wp-parser-since' );
+        $change_type = $query->get( 'change_type' );
+
+        if ( ! ( $query->is_archive() && $query->is_tax() && ! empty( $version ) ) ||
+                        ( empty( $change_type ) || 'any' === $change_type ) ) {
+                // bail, no need to filter
+                return $posts;
+        }
+
+        $posts = array();
+
+        // strip the $limits so we get all changes for the specified version
+        $sql = preg_replace( '/\s+LIMIT.*$/', '', $query->request );
+
+        // get all the posts that changed in the specified version
+        $_posts = $wpdb->get_results( $sql );
+
+        foreach ( $_posts as $post ) {
+                $changelog_data = get_changelog_data( $post->ID );
+                if ( empty( $changelog_data[$version] ) ) {
+                        // should never happen...
+                        continue;
+                }
+
+                // keep the post if fits the $change_type
+                if ( 'introduced' === $change_type && empty( $changelog_data[$version]['description'] ) ) {
+                        $posts[] = $post;
+                }
+                elseif ( 'modified' === $change_type && ! empty( $changelog_data[$version]['description'] ) ) {
+                        $posts[] = $post;
+                }
+        }
+
+        // grab only those changed posts for the current page
+        $paged = $query->get( 'paged' );
+        $posts_per_page = $query->get( 'posts_per_page' );
+        $offset = $posts_per_page * ( 0 === $paged ? 0 : $paged - 1 );
+        $query->posts = array_slice( $posts, $offset, $posts_per_page );
+
+        // set the pagination properties
+        // @todo unfortunately we can't call WP_Query::set_found_posts()
+        $query->post_count = count( $query->posts );
+        $query->found_posts = count( $posts );
+        $query->max_num_pages = ceil( $query->found_posts / $query->get( 'posts_per_page' ) );
+
+        return $query->posts;
+}
+
 function register_nav_menus() {
 
         \register_nav_menus( array(

inc/template-tags.php

@@ -1449 +1449 @@
         }
 
         /**
-         * Displays a post type filter dropdown on taxonomy pages.
-         *
-         * @return string HTML filter form.
-         */
+         * Displays filter dropdowns for post type and change type on taxonomy pages.
+         *
+         * @since 1.x.y Added dropdown to filter by type of change when 'wp-parser-since' == $taxonomy
+         *
+         * @return string HTML filter form.
+         */
         function taxonomy_archive_filter() {
                 global $wp_rewrite;
 
@@ -1483 +1485 @@
                         $form .= "<input type='hidden' name='" . esc_attr( $taxonomy ) . "' value='" . esc_attr( $term ) . "'>";
                 }
 
-                $form .= "<label for='archive-filter'>";
-                $form .= __( 'Filter by type:', 'wporg' ) . ' ';
+                $form .= "<label for='post-type-archive-filter'>";
+                $form .= __( 'Filter by post type:', 'wporg' ) . ' ';
                 $form .= '<select name="post_type[]" id="archive-filter">';
                 $form .= $options . '</select></label>';
+
+                if ( 'wp-parser-since' === $taxonomy ) {
+                        $change_types = array(
+                                        'any' => __( 'Any change', 'wporg' ),
+                                        'introduced' => __( 'Introduced', 'wporg' ),
+                                        'modified' => __( 'Modified', 'wporg' ),
+                        );
+                        $options = '';
+                        $current_change_type = get_query_var( 'change_type' );
+                        foreach ( $change_types as $change_type => $label ) {
+                                $selected = selected( $change_type, $current_change_type, false);
+                                $options .= "<option value='$change_type'$selected>$label</option>";
+                        }
+
+                        $form .= "<label for='change-type-archive-filter'>";
+                        $form .= __( 'Filter by type of change:', 'wporg' ) . ' ';
+                        $form .= '<select name="change_type" id="change-type-archive-filter">';
+                        $form .= $options . '</select></label>';
+                }
+
                 $form .= "<input class='shiny-blue' type='submit' value='Filter' /></form>";
 
                 echo $form;

style.css

@@ -4 +4 @@
 Author: Underscores.me
 Author URI: http://underscores.me/
 Description: Description
-Version: 1.0
+Version: 1.x.y
 License: GNU General Public License
 License URI: license.txt
 Text Domain: wporg-developer

stylesheets/main.css

@@ -1108 +1108 @@
   font-size: 1.5rem;
 }
 
+/* @since 1.x.y */
+.devhub-wrap .archive-filter-form select {
+        margin-right: 6px;
+}
+
 .devhub-wrap .archive-filter-form input[type="submit"] {
   margin-left: .5em;
   padding: 0.2em 0.5em;