Skip to content

[Update] Documentation for sniff WordPress.Security.PluginMenuSlug #2592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

[Update] Documentation for sniff WordPress.Security.PluginMenuSlug #2592

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d90eef
initial commit for PluginMenuSlugStandard
jasonkenison Aug 26, 2025
c4f55f3
updated description and added add_submenu_page examples
jasonkenison Sep 2, 2025
9c5d551
included example of concatination on parent
jasonkenison Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions WordPress/Docs/Security/PluginMenuSlugStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Plugin Menu Slug"
>
<standard>
<![CDATA[
Wordpress functions that can be used to add pages to the WP Admin menu should not include `__FILE__` for the menu slug (or parent menu slug) parameter to avoid revealing system paths.
]]>
</standard>
<code_comparison>
<code title="Valid: Slug does not include `__FILE__`.">
<![CDATA[
add_menu_page(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is worth adding a second valid/invalid example with add_submenu_page() as this is the only function that has a different signature than the others, and where __FILE__ should not be used for the parent_slug as well as the menu_slug?

There is no need to create new <code> blocks, you can add the new example in the <code> blocks that already exist.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodrigoprimo Good call. I added add_submenu_page() examples to the existing code blocks with similar __FILE__ examples.

'My Plugin Main Page',
'My Plugin',
'manage_options',
<em>'my-plugin-main'</em>,
'my_plugin_main_page'
);

add_submenu_page(
<em>'my_plugin_main_page'</em>,
'My Plugin Subpage',
'Subpage',
'manage_options',
'my-plugin-subpage',
'my_plugin_subpage'
);
]]>
</code>
<code title="Invalid: Slug includes `__FILE__`.">
<![CDATA[
add_menu_page(
'My Plugin Main Page',
'My Plugin',
'manage_options',
<em>__FILE__ . </em>'my-plugin-subpage',
'my_plugin_main_page'
);

add_submenu_page(
<em>__FILE__ . </em>'my_plugin_main_page',
'My Plugin Subpage',
'Subpage',
'manage_options',
'my-plugin-subpage',
'my_plugin_subpage'
);
]]>
</code>
</code_comparison>
</documentation>
Loading