<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[45085] trunk/src/wp-admin/includes/plugin.php: Docs: Improve documentation for `get_plugin_page_hook()` and `get_plugin_page_hookname()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/45085">45085</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/45085","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-04-01 14:08:01 +0000 (Mon, 01 Apr 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve documentation for `get_plugin_page_hook()` and `get_plugin_page_hookname()`.
Props subrataemfluence, desrosj.
Fixes <a href="https://core.trac.wordpress.org/ticket/44224">#44224</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludespluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin.php 2019-04-01 13:29:24 UTC (rev 45084)
+++ trunk/src/wp-admin/includes/plugin.php 2019-04-01 14:08:01 UTC (rev 45085)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1354,8 +1354,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $_registered_pages[ $hookname ] = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Backward-compatibility for plugins using add_management page.
- * See wp-admin/admin.php for redirect from edit.php to tools.php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Backward-compatibility for plugins using add_management_page().
+ * See wp-admin/admin.php for redirect from edit.php to tools.php.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'tools.php' == $parent_slug ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_registered_pages[ get_plugin_page_hookname( $menu_slug, 'edit.php' ) ] = true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1713,6 +1713,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_wp_real_parent_file
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_wp_menu_nopriv
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_wp_submenu_nopriv
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return string
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_admin_page_parent( $parent = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $parent_file, $menu, $submenu, $pagenow, $typenow,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1783,6 +1785,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $pagenow
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $plugin_page
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $typenow
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return string
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_admin_page_title() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $title, $menu, $submenu, $pagenow, $plugin_page, $typenow;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1859,9 +1863,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $plugin_page
- * @param string $parent_page
- * @return string|null
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $plugin_page The slug name of the plugin page.
+ * @param string $parent_page The slug name for the parent menu (or the file name of a standard
+ * WordPress admin page).
+ * @return string|null Hook attached to the plugin page, null otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_plugin_page_hook( $plugin_page, $parent_page ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $hook = get_plugin_page_hookname( $plugin_page, $parent_page );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1874,8 +1879,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $admin_page_hooks
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $plugin_page
- * @param string $parent_page
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param string $plugin_page The slug name of the plugin page.
+ * @param string $parent_page The slug name for the parent menu (or the file name of a standard
+ * WordPress admin page).
+ * @return string Hook name for the plugin page.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_plugin_page_hookname( $plugin_page, $parent_page ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $admin_page_hooks;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1906,6 +1914,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_wp_submenu_nopriv
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $plugin_page
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $_registered_pages
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return bool Whether the current user can access the current admin page.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function user_can_access_admin_page() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $pagenow, $menu, $submenu, $_wp_menu_nopriv, $_wp_submenu_nopriv,
</span></span></pre>
</div>
</div>
</body>
</html>