Changeset 12933

Timestamp:

10/06/2023 02:09:21 AM (3 years ago)

Author:

tellyworth

Message:

Plugins: add opt-out toggle for Live Preview button

This allows plugin committers to disable the Live Preview button for specific plugins. It adds a button to the Danger Zone section on the Advanced view of the plugin page.

See #7251

Location:

sites/trunk/wordpress.org/public_html/wp-content

Files:

• plugins/plugin-directory/api/class-base.php (modified) (1 diff)
• plugins/plugin-directory/api/routes/class-plugin-self-toggle-preview.php (added)
• plugins/plugin-directory/class-template.php (modified) (1 diff)
• themes/pub/wporg-plugins/inc/template-tags.php (modified) (2 diffs)
• themes/pub/wporg-plugins/template-parts/plugin-single.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php

@@ -34 +34 @@
                 new Routes\Plugin_Self_Close();
                 new Routes\Plugin_Self_Transfer();
+                new Routes\Plugin_Self_Toggle_Preview();
                 new Routes\Plugin_Release_Confirmation();
                 new Routes\Plugin_E2E_Callback();

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

@@ -794 +794 @@
                         array( '_wpnonce' => wp_create_nonce( 'wp_rest' ) ),
                         home_url( 'wp-json/plugins/v1/plugin/' . $post->post_name . '/self-transfer' )
+                );
+        }
+
+        /**
+         * Generates a link to toggle the Live Preview button.
+         *
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
+         * @return string URL to toggle status.
+         */
+        public static function get_self_toggle_preview_link( $post = null ) {
+                $post = get_post( $post );
+
+                return add_query_arg(
+                        array( '_wpnonce' => wp_create_nonce( 'wp_rest' ) ),
+                        home_url( 'wp-json/plugins/v1/plugin/' . $post->post_name . '/self-toggle-preview' )
                 );
         }

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/inc/template-tags.php

@@ -520 +520 @@
                 // Output the self close button.
                 the_plugin_self_close_button();
+
+                // Output the toggle preview button.
+                the_plugin_self_toggle_preview_button();
         }
 
@@ -554 +557 @@
                 // Translators: %s is the plugin name, as defined by the plugin itself.
                 echo '<p><input class="button" type="submit" value="' . esc_attr( sprintf( __( 'I understand, please close %s.', 'wporg-plugins' ), get_the_title() ) ) . '" /></p>';
+                echo '</form>';
+        }
+}
+
+/**
+ * Displays a form for plugin committers to toggle the Live Preview button.
+ */
+function the_plugin_self_toggle_preview_button() {
+        $post            = get_post();
+        $toggle_link     = Template::get_self_toggle_preview_link( $post );
+
+        if ( ! current_user_can( 'plugin_self_close', $post ) ) {
+                return;
+        }
+
+        echo '<h4>' . esc_html__( 'Toggle Live Preview', 'wporg-plugins' ) . '</h4>';
+        $preview_status = get_post_meta( $post->ID, '_no_preview', true ) ? 'disabled' : 'enabled';
+        if ( 'enabled' === $preview_status ) {
+                echo '<p>' . esc_html__( 'The Live Preview link to Playground is currently enabled. Use the toggle button to disable it.', 'wporg-plugins' ) . '</p>';
+        } else {
+                echo '<p>' . esc_html__( 'The Live Preview link to Playground is currently disabled. Use the toggle button to enable it.', 'wporg-plugins' ) . '</p>';
+        }
+
+        echo '<div class="plugin-notice notice notice-warning notice-alt"><p>';
+        _e( '<strong>Note:</strong> This only affects the availability of the Live Preview button on the plugin page. It does not prevent a plugin from running in the Playground.', 'wporg-plugins' );
+        echo '</p></div>';
+
+        if ( $toggle_link ) {
+                echo '<form method="POST" action="' . esc_url( $toggle_link ) . '" onsubmit="return confirm( jQuery(this).prev(\'.notice\').text() );">';
+                // Translators: %s is the plugin name, as defined by the plugin itself.
+                echo '<p><input class="button" type="submit" value="' . esc_attr( sprintf( __( 'Please toggle the Live Preview link for %s', 'wporg-plugins' ), get_the_title() ) ) . '" /></p>';
                 echo '</form>';
         }

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/template-parts/plugin-single.php

@@ -41 +41 @@
                         <?php if ( 'publish' === get_post_status() || current_user_can( 'plugin_admin_view', $post ) ) : ?>
                                 <a class="plugin-download button download-button button-large" href="<?php echo esc_url( Template::download_link() ); ?>"><?php esc_html_e( 'Download', 'wporg-plugins' ); ?></a>
-                                <?php if ( !Template::is_plugin_outdated( $post ) ) : ?>
+                                <?php if ( !Template::is_plugin_outdated( $post ) && !get_post_meta( $post->ID, '_no_preview', true ) ) : ?>
                                         <a class="plugin-download button download-button button-large" href="<?php echo esc_url( Template::preview_link() ); ?>"><?php esc_html_e( 'Live Preview', 'wporg-plugins' ); ?></a>
                                 <?php endif; ?>