Changeset 12928

Timestamp:

10/03/2023 09:56:08 PM (14 months ago)

Author:

coffee2code

Message:

Handbooks, Admin Notices: Show a notice if an established handbook is missing its published landing page.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/admin-notices.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/admin-notices.php

@@ -15 +15 @@
     public static function init() {
         add_action( 'admin_notices', [ __CLASS__, 'show_new_handbook_message' ] );
+        add_action( 'admin_notices', [ __CLASS__, 'show_missing_handbook_landing_page_message' ] );
         add_action( 'admin_notices', [ __CLASS__, 'show_imported_handbook_notice' ] );
         add_action( 'admin_notices', [ __CLASS__, 'show_imported_handbook_config_errors' ] );
+    }
+
+    /**
+     * Determines if the main admin listing of handbooks is being shown.
+     *
+     * "Main" in this context is the listing of all handbook posts for a handbook,
+     * or at least the listing of its published posts.
+     *
+     * @param bool $must_be_empty Should the listing of handbook posts not actually
+     *                            have any posts in the list? If true, then the
+     *                            listing MUST be empty, else the listing MUST have
+     *                            at least one post. Default true.
+     * @return bool True if the main admin listing of handbooks is being shown with
+     *              the required presence or absense of posts, else false.
+     */
+    protected static function is_main_handbook_listing( $must_be_empty = true ) {
+        global $wp_query;
+
+        $current_screen = get_current_screen();
+
+        return (
+            $current_screen
+        &&
+            'edit' === $current_screen->base
+        &&
+            in_array( $current_screen->post_type, wporg_get_handbook_post_types() )
+        &&
+            ( $must_be_empty ? ( 0 === $wp_query->post_count ) : ( $wp_query->post_count > 0 ) )
+        &&
+            ( empty( $wp_query->query_vars['post_status'] ) || 'publish' === $wp_query->query_vars['post_status'] )
+        );
     }
 
@@ -61 +93 @@
             echo "</p></div>\n";
         }
+    }
+
+    /**
+     * Outputs admin notice showing tips for newly created handbook.
+     *
+     * @todo Maybe instead of hiding the message once posts are present it should persist as long as no landing page has been created?
+     *
+     * @access public
+     */
+    public static function show_missing_handbook_landing_page_message() {
+        if ( ! self::is_main_handbook_listing( false ) ) {
+            return;
+        }
+
+        $current_screen = get_current_screen();
+        $handbook_post_type = $current_screen->post_type;
+
+        $handbook_obj = WPorg_Handbook_Init::get_handbook( $handbook_post_type );
+        if ( ! $handbook_obj ) {
+            return;
+        }
+
+        // Get landing page and return if one already exists.
+        $landing_page = $handbook_obj->get_landing_page();
+        if ( $landing_page ) {
+            return;
+        }
+
+        $suggested_slugs = array_map(
+            function( $x ) { return "<code>{$x}</code>"; },
+            $handbook_obj->get_possible_landing_page_slugs()
+        );
+
+        echo '<div class="notice notice-error"><p>';
+        printf(
+            /* translators: 1: example landing page title that includes post type name, 2: comma-separated list of acceptable post slugs */
+            __( '<strong>Warning:</strong> A landing page for this handbook has not been created or is not published. You can title it anything you like (suggestions: <code>%1$s</code> or <code>Welcome</code>). However, you must ensure that it has one of the following slugs: %2$s. The slug will ultimately be omitted from the page&#8216;s permalink URL, but will still appear in the permalinks for its sub-pages. Without this page your handbook&#8216;s URL will show a seemingly random handbook page.', 'wporg' ),
+            WPorg_Handbook::get_name( $handbook_post_type ),
+            implode( ', ', $suggested_slugs )
+        );
+        echo "</p></div>\n";
     }