WordPress/wp-admin
Drew Jaynes d829ec4cf2 Docs: Provide best practice guidance for achieving parity between `$menu_slug` values supplied when adding menu and submenu pages, and later trying to compare those initial values against sanitized screen IDs derived from `$menu_slug`.
At the heart of the matter, the `$menu_slug` parameter in `add_menu_page()` and `add_submenu_page()` is not sanitized with `sanitize_key()`. When the screen object is later built for the admin page, the screen ID is derived from that `$menu_slug` value, though passed through `sanitize_key()`, which can produce unexpected results in comparison check.

Changing the sanitization code to provide actual parity is out of the question at this juncture, so updating the docs to describe how to avoid this edge case is the next best option.

Props GregRoss.
Fixes #35305.

Built from https://develop.svn.wordpress.org/trunk@40967


git-svn-id: http://core.svn.wordpress.org/trunk@40817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-06-30 04:18:43 +00:00
..
css Import: Increase color contrast for "This importer is not installed" message on Multisite. 2017-06-24 18:07:43 +00:00
images Customize: Add a RTL version of "browser.png" for the site icon preview. 2016-07-05 11:32:29 +00:00
includes Docs: Provide best practice guidance for achieving parity between `$menu_slug` values supplied when adding menu and submenu pages, and later trying to compare those initial values against sanitized screen IDs derived from `$menu_slug`. 2017-06-30 04:18:43 +00:00
js Widgets: Add accessibility mode support for TinyMCE-enhanced Text and Media widgets (Video, Audio, Images). 2017-06-25 18:48:41 +00:00
maint I18N: Make the translator comment added in [37858] more explicit and consistent with other similar instances. 2016-07-04 13:10:30 +00:00
network Multisite: Remove full stops from radio and checkbox labels in the Network Settings screen. 2017-06-26 19:20:40 +00:00
user Docs: Standardize hook docs in wp-admin/* to use third-person singular verbs per the inline documentation standards for PHP. 2016-05-22 18:01:30 +00:00
about.php About: Swap out images and videos for CDN versions, and add responsive images. 2017-06-07 22:07:40 +00:00
admin-ajax.php Dashboard: Update the existing WordPress News dashboard widget to also include upcoming meetup events and WordCamps near the current user’s location. 2017-05-10 20:04:42 +00:00
admin-footer.php Docs: Remove incorrect `@param` tags for `admin_print_footer_scripts-{$hook_suffix}` and `admin_footer-{$hook_suffix}` dynamic actiona. 2017-01-09 14:38:41 +00:00
admin-functions.php Docs: Use 3-digit, x.x.x-style semantic versioning for `_doing_it_wrong()`, `_deprecated_function()`, `_deprecated_argument()`, and `_deprecated_file()` throughout core. 2016-07-06 12:40:29 +00:00
admin-header.php I18n: Introduce more translator comments for strings that contain placeholders but don't have an accompanying translator comment. 2016-11-21 02:46:30 +00:00
admin-post.php Spelling: Standardize on "front end"/"back end" (noun) and "front-end"/"back-end" (adjective). 2016-02-25 12:53:27 +00:00
admin.php Text Changes: Add a period to the only `wp_die()` message that didn't have it: "Invalid plugin page". 2017-01-22 02:33:42 +00:00
async-upload.php Posts, Post Types: Use an existing string for "Invalid post type" error message. 2017-01-10 02:40:42 +00:00
comment.php Accessibility: Remove target=_blank from the comment/edit-comments help tabs links. 2016-10-04 06:54:30 +00:00
credits.php About: Sync tagline from about page with credits and freedoms. 2017-06-01 09:24:43 +00:00
custom-background.php Customize: Improve custom background properties UI. 2016-10-26 06:52:29 +00:00
custom-header.php Customize: Ensure `header_image_data` setting exists before attempting to use it. 2017-06-25 07:04:42 +00:00
customize.php Customize: Igore invalid customization sessions. 2017-05-16 12:07:43 +00:00
edit-comments.php General: Use interpolation instead of concatenation for all dynamic hook names. 2016-12-14 04:18:42 +00:00
edit-form-advanced.php Accessibility: Make the Get Shortlink button be a real button. 2017-05-07 11:47:41 +00:00
edit-form-comment.php Accessibility: Standardize the remove/delete/cancel links in the Menus screen and Publish meta boxes. 2016-09-17 15:39:30 +00:00
edit-link-form.php Accessibility: Remove inappropriate content from the Link Manager screens headings. 2016-12-07 20:18:46 +00:00
edit-tag-form.php Taxonomy: Remove extraneous `'` included in Term delete markup. 2017-05-14 19:50:44 +00:00
edit-tags.php Taxonomy: Add a "delete" button on term edit page. 2017-05-12 19:26:41 +00:00
edit.php Posts, Post Types: Preserve author filter in list table after entering a page number in paging input. 2017-01-21 02:22:26 +00:00
export.php Accessibility: Remove target=_blank from the help tab links on several admin screens. 2016-10-04 20:27:33 +00:00
freedoms.php Docs: Replace a variety of http links referenced in inline docs with their https counterparts (where possible). 2017-06-25 22:06:41 +00:00
import.php Accessibility: Remove target=_blank from the help tab links on several admin screens. 2016-10-04 20:27:33 +00:00
index.php Dashboard: Properly localize data for events 2017-05-18 14:34:43 +00:00
install-helper.php Docs: Add missing descriptions for the `$wpdb` global in DocBlocks all the places. 2015-10-14 23:44:25 +00:00
install.php Login and Registration: Avoid a potentially incorrect value for the cookie hash on multisite installations that don't have a value in the `siteurl` network option. 2017-03-23 19:01:42 +00:00
link-add.php Text Changes: Unify permission error messages. 2016-06-29 15:16:29 +00:00
link-manager.php Accessibility: Remove inappropriate content from the Link Manager screens headings. 2016-12-07 20:18:46 +00:00
link-parse-opml.php General: Check to see that the PHP-XML module is enabled before using XML functions. 2016-10-24 04:45:31 +00:00
link.php Docs: Standardize capitalization of Ajax throughout core documentation per the core spelling guide. 2016-07-10 00:51:30 +00:00
load-scripts.php Bootstrap: do not go gentle into that good night r38411, r38412, and parts of r38389. 2016-08-31 16:31:29 +00:00
load-styles.php Bootstrap: do not go gentle into that good night r38411, r38412, and parts of r38389. 2016-08-31 16:31:29 +00:00
media-new.php Accessibility: Remove target=_blank from the help tab links on several admin screens. 2016-10-04 20:27:33 +00:00
media-upload.php Hooks: Standardize naming of dynamic hooks to use interpolation vs concatenation. 2016-08-22 18:25:31 +00:00
media.php Accessibility: Remove inappropriate content from the old Edit Media screen heading. 2016-12-07 23:30:40 +00:00
menu-header.php Administration: Ensure collapse menu is usable with a keyboard 2016-11-04 17:18:57 +00:00
menu.php Multisite: Introduce a `setup_network` capability for setting up multisite. 2017-04-07 12:53:45 +00:00
moderation.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-admin.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-delete-site.php I18N: Introduce a locale-switching function. 2016-10-26 15:36:31 +00:00
ms-edit.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-options.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-sites.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-themes.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-upgrade-network.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
ms-users.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
my-sites.php Accessibility: Remove inappropriate content from the Network screens headings. 2016-12-09 18:57:42 +00:00
nav-menus.php Customize: Prevent links to `customize.php` from being generated which have query vars from `wp_removable_query_args()` present. 2017-03-22 23:04:42 +00:00
network.php Multisite: Introduce a `setup_network` capability for setting up multisite. 2017-04-07 12:53:45 +00:00
options-discussion.php Administration: Use consistent spacing for form elements in the Discussion Settings screen. 2017-05-18 15:55:44 +00:00
options-general.php Administration: Fix some HTML validation errors. 2017-05-23 17:58:43 +00:00
options-head.php Docs: Standardize on 'backward compatibility/compatible' nomenclature in core inline docs. 2016-05-13 18:41:31 +00:00
options-media.php Administration: Fix some HTML validation errors. 2017-05-23 17:58:43 +00:00
options-permalink.php Accessibility: Remove target=_blank from the Settings screens help tabs links. 2016-10-04 06:59:29 +00:00
options-reading.php Help/About: Fix typo in help text on Reading Settings screen. 2017-04-23 14:34:42 +00:00
options-writing.php Accessibility: Remove target=_blank from the Settings screens help tabs links. 2016-10-04 06:59:29 +00:00
options.php Multisite: Replace `is_super_admin()` with `manage_network_options` in `wp-admin/options.php`. 2017-01-20 17:39:41 +00:00
plugin-editor.php Plugins: Correctly display the current plugin in the plugin editor. 2016-10-07 16:58:28 +00:00
plugin-install.php Accessibility: Remove inappropriate content from the Add Plugins screen heading. 2016-12-07 19:06:41 +00:00
plugins.php Plugins: Add file check to plugin deletions. 2017-03-06 12:55:41 +00:00
post-new.php I18N: Combine two duplicate "Invalid post type" strings. 2016-07-17 16:05:31 +00:00
post.php Posts, Post Types: Use an existing string for "Invalid post type" error message. 2017-01-10 02:40:42 +00:00
press-this.php Bootstrap: do not go gentle into that good night r38411, r38412, and parts of r38389. 2016-08-31 16:31:29 +00:00
profile.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
revision.php I18n: Begin introducing translator comments for strings which include placeholders but no accompanying translator comment. 2016-11-21 01:22:32 +00:00
setup-config.php Drop the requirement for the entry points to WordPress to be parsable by PHP4. 2016-10-25 03:15:30 +00:00
term.php Taxonomy: Add a "delete" button on term edit page. 2017-05-12 19:26:41 +00:00
theme-editor.php Accessibility: Remove target=_blank from the Plugins, Themes, Media, Update, and Tools screens help tabs links. 2016-10-04 07:08:29 +00:00
theme-install.php Themes: Avoid PHP warnings in the admin when no theme directory exists. 2017-05-11 19:21:44 +00:00
themes.php Themes: Fix missing search field in the Theme Install screen after [40572]. 2017-05-08 15:59:44 +00:00
tools.php Accessibility: Remove target=_blank from the Plugins, Themes, Media, Update, and Tools screens help tabs links. 2016-10-04 07:08:29 +00:00
update-core.php Updates: Translate plugin data on the Updates screen. 2017-01-11 10:37:48 +00:00
update.php Bootstrap: do not go gentle into that good night r38411, r38412, and parts of r38389. 2016-08-31 16:31:29 +00:00
upgrade-functions.php Docs: Use 3-digit, x.x.x-style semantic versioning for `_doing_it_wrong()`, `_deprecated_function()`, `_deprecated_argument()`, and `_deprecated_file()` throughout core. 2016-07-06 12:40:29 +00:00
upgrade.php Install/Upgrade: Keep indexing bots away until a site is ready to be seen. 2015-12-08 21:56:27 +00:00
upload.php Accessibility: Improve the Media Library inline uploader accessibility. 2017-03-31 17:38:43 +00:00
user-edit.php Users: Display the name of user being edited on Edit User screen. 2017-01-15 07:14:39 +00:00
user-new.php Multisite: Remove unnecessary `is_super_admin()` check when adding an existing user to a site. 2017-01-24 12:03:43 +00:00
users.php Users: Use more appropriate HTTP status codes for errors relating to user management. 2017-06-25 18:46:44 +00:00
widgets.php Customize: Prevent links to `customize.php` from being generated which have query vars from `wp_removable_query_args()` present. 2017-03-22 23:04:42 +00:00