Changeset 6034

Timestamp:

10/16/2017 12:35:07 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Plugin Directory: Provide the ability to specify a reason when closing or disabling a plugin.

Props jdgrimes.
See #2860.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin

Files:

• class-customizations.php (modified) (3 diffs)
• metabox/class-controls.php (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/class-customizations.php

@@ -41 +41 @@
         add_filter( 'wp_unique_post_slug', array( $this, 'check_existing_plugin_slug_on_inline_save' ), 10, 6 );
 
+        add_action( 'save_post', array( $this, 'save_close_reason' ), 10, 2 );
+
         add_action( 'wp_ajax_replyto-comment', array( $this, 'save_custom_comment' ), 0 );
         add_filter( 'comment_row_actions', array( $this, 'custom_comment_row_actions' ), 10, 2 );
@@ -51 +53 @@
         add_filter( 'postbox_classes_plugin_internal-notes',      array( __NAMESPACE__ . '\Metabox\Internal_Notes', 'postbox_classes' ) );
         add_filter( 'postbox_classes_plugin_plugin-committers',   array( __NAMESPACE__ . '\Metabox\Committers',     'postbox_classes' ) );
-        add_filter( 'postbox_classes_plugin_plugin-support-reps', array( __NAMESPACE__ . '\Metabox\Support_Reps',     'postbox_classes' ) );
-        add_filter( 'wp_ajax_add-committer',        array( __NAMESPACE__ . '\Metabox\Committers', 'add_committer'    ) );
+        add_filter( 'postbox_classes_plugin_plugin-support-reps', array( __NAMESPACE__ . '\Metabox\Support_Reps',   'postbox_classes' ) );
+        add_filter( 'wp_ajax_add-committer',        array( __NAMESPACE__ . '\Metabox\Committers', 'add_committer' ) );
         add_filter( 'wp_ajax_delete-committer',     array( __NAMESPACE__ . '\Metabox\Committers', 'remove_committer' ) );
         add_filter( 'wp_ajax_add-support-rep',      array( __NAMESPACE__ . '\Metabox\Support_Reps', 'add_support_rep' ) );
         add_filter( 'wp_ajax_delete-support-rep',   array( __NAMESPACE__ . '\Metabox\Support_Reps', 'remove_support_rep' ) );
         add_action( 'wp_ajax_plugin-author-lookup', array( __NAMESPACE__ . '\Metabox\Author', 'lookup_author' ) );
-
     }
 
@@ -378 +379 @@
 
     /**
+     * Save the reason for closing or disabling a plugin.
+     *
+     * @param int      $post_id Post ID.
+     * @param \WP_Post $post    Post object.
+     */
+    public function save_close_reason( $post_id, $post ) {
+        if ( 'plugin' !== $post->post_type || ! isset( $_POST['close_reason'] ) ) {
+            return;
+        }
+
+        if ( ! current_user_can( 'plugin_approve', $post_id ) ) {
+            return;
+        }
+
+        if ( ! in_array( $post->post_status, array( 'closed', 'disabled' ) ) ) {
+            return;
+        }
+
+        update_post_meta( $post_id, '_close_reason', sanitize_key( $_POST['close_reason'] ) );
+    }
+
+    /**
      * Register the Admin metaboxes for the plugin management screens.
      *

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/metabox/class-controls.php

@@ -15 +15 @@
      */
     static function display() {
-        echo '<div class="submitbox" id="submitpost">';
-            echo '<div id="misc-publishing-actions">';
+        ?>
+        <div class="submitbox" id="submitpost">
+            <div id="misc-publishing-actions">
+                <?php
                 self::display_post_status();
 
@@ -22 +24 @@
                     self::display_tested_up_to();
                 }
-            echo '</div>';
+                ?>
+            </div>
 
-            echo '<div id="major-publishing-actions"><div id="publishing-action">';
-                echo '<span class="spinner"></span>';
-                printf( '<input type="submit" name="save_changes" id="publish" class="button button-primary button-large" value="%s">', __( 'Save Changes', 'wporg-plugins' ) );
-            echo '</div><div class="clear"></div></div>';
-        echo '</div>';
+            <div id="major-publishing-actions">
+                <div id="publishing-action">
+                    <span class="spinner"></span>
+                    <input type="submit" name="save_changes" id="publish" class="button button-primary button-large" value="<?php esc_attr_e( 'Save Changes', 'wporg-plugins' ); ?>">
+                </div>
+                <div class="clear"></div>
+            </div>
+        </div>
+        <?php
     }
 
@@ -66 +73 @@
 
     /**
+     * Get reasons for closing or disabling a plugin.
+     *
+     * @return array Close/disable reason labels.
+     */
+    public static function get_close_reasons() {
+        return array(
+            'security-issue'                => __( 'Security Issue', 'wporg-plugins' ),
+            'author-request'                => __( 'Author Request', 'wporg-plugins' ),
+            'guideline-violation'           => __( 'Guideline Violation', 'wporg-plugins' ),
+            'licensing-trademark-violation' => __( 'Licensing/Trademark Violation', 'wporg-plugins' ),
+            'merged-into-core'              => __( 'Merged into Core', 'wporg-plugins' ),
+        );
+    }
+
+    /**
      * Displays the Plugin Status control in the Publish metabox.
      */
@@ -81 +103 @@
             $statuses = Status_Transitions::get_allowed_transitions( $post->post_status );
         }
+
+        $close_reasons = self::get_close_reasons();
+        $close_reason  = (string) get_post_meta( $post->ID, '_close_reason', true );
+
+        if ( isset( $close_reasons[ $close_reason ] ) ) {
+            $reason_label   = $close_reasons[ $close_reason ];
+            $reason_unknown = false;
+        } else {
+            $reason_label   = _x( 'Unknown', 'unknown close reason', 'wporg-plugins' );
+            $reason_unknown = true;
+        }
         ?>
         <div class="misc-pub-section misc-pub-plugin-status">
@@ -86 +119 @@
             <strong id="plugin-status-display"><?php echo esc_html( get_post_status_object( $post->post_status )->label ); ?></strong>
 
+            <?php if ( 'closed' === $post->post_status ) : ?>
+
+                <p><?php printf( __( 'Close Reason: %s', 'wporg-plugins' ), '<strong>' . $reason_label . '</strong>' ); ?></p>
+
+            <?php elseif ( 'disabled' === $post->post_status ) : ?>
+
+                <p><?php printf( __( 'Disable Reason: %s', 'wporg-plugins' ), '<strong>' . $reason_label . '</strong>' ); ?></p>
+
+            <?php endif; ?>
+
+            <?php if (
+                    ( in_array( 'closed', $statuses, true ) || in_array( 'disabled', $statuses, true ) )
+                &&
+                    ! in_array( $post->post_status, array( 'closed', 'disabled' ) ) || $reason_unknown
+                ) : ?>
+
+                <p>
+                    <label for="close_reason"><?php _e( 'Close/Disable Reason:', 'wporg-plugins' ); ?></label>
+                    <select name="close_reason" id="close_reason">
+                        <?php foreach ( $close_reasons as $key => $label ) : ?>
+                            <option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $close_reason ); ?>><?php echo esc_html( $label ); ?></option>
+                        <?php endforeach; ?>
+                    </select>
+                </p>
+
+            <?php endif; ?>
+
             <?php foreach ( $statuses as $status ) : ?>
+
                 <p><button type="submit" name="post_status" value="<?php echo esc_attr( $status ); ?>" class="button set-plugin-status">
                     <?php echo self::get_status_button_label( $status ); ?>
                 </button></p>
+
             <?php endforeach; ?>
         </div><!-- .misc-pub-section --><?php