Changeset 52569 for trunk/src/wp-admin/includes/plugin.php

Timestamp:

01/12/2022 11:23:41 PM (4 years ago)

Author:

audrasjb

Message:

Administration: Ensure an integer is used for menu priority in add_menu_page().

This change adds a verification of the $position parameter in add_menu_page() to ensure an integer is used. If not, the function informs developers of the wrong parameter type via a _doing_it_wrong message. This brings consistency with a similar check used in add_submenu_page().

This change also typecasts any floating number to string to ensure that in case a float value was passed, at least it doesn't override existing menus.

Follow-up to [46570].

Props kirtan95.
Fixes #54798. See #48249.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (1 diff)

trunk/src/wp-admin/includes/plugin.php

@@ -1330 +1330 @@
         $menu[ "$position" ] = $new_menu;
     } else {
+        if ( ! is_int( $position ) ) {
+            _doing_it_wrong(
+                __FUNCTION__,
+                sprintf(
+                /* translators: %s: add_submenu_page() */
+                    __( 'The seventh parameter passed to %s should be an integer representing menu position.' ),
+                    '<code>add_menu_page()</code>'
+                ),
+                '6.0.0'
+            );
+            // If the position is not a string (i.e. float), convert it to string.
+            if ( ! is_string( $position ) ) {
+                $position = (string) $position;
+            }
+        }
         $menu[ $position ] = $new_menu;
     }