<!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" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { 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 { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#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>
<title>[16831] trunk/wp-admin/includes/plugin.php: Add @return to add_*menu_page()
docs.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/16831">16831</a></dd>
<dt>Author</dt> <dd>scribu</dd>
<dt>Date</dt> <dd>2010-12-09 06:54:48 +0000 (Thu, 09 Dec 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add @return to add_*menu_page() docs. Fixes <a href="http://trac.wordpress.org/ticket/15747">#15747</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludespluginphp">trunk/wp-admin/includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludespluginphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/plugin.php (16830 => 16831)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/plugin.php 2010-12-09 05:27:37 UTC (rev 16830)
+++ trunk/wp-admin/includes/plugin.php 2010-12-09 06:54:48 UTC (rev 16831)
</span><span class="lines">@@ -862,6 +862,8 @@
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><span class="cx"> * @param string $icon_url The url to the icon to be used for this menu
</span><span class="cx"> * @param int $position The position in the menu order this one should appear
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = NULL ) {
</span><span class="cx"> global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;
</span><span class="lines">@@ -910,6 +912,8 @@
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><span class="cx"> * @param string $icon_url The url to the icon to be used for this menu
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
</span><span class="cx"> global $_wp_last_object_menu;
</span><span class="lines">@@ -934,6 +938,8 @@
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><span class="cx"> * @param string $icon_url The url to the icon to be used for this menu
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
</span><span class="cx"> global $_wp_last_utility_menu;
</span><span class="lines">@@ -958,6 +964,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> global $submenu;
</span><span class="lines">@@ -1020,6 +1028,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1039,6 +1049,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1058,6 +1070,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1077,6 +1091,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1096,6 +1112,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> if ( current_user_can('edit_users') )
</span><span class="lines">@@ -1118,6 +1136,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1137,6 +1157,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1156,6 +1178,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1175,6 +1199,8 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><ins>+ *
+ * @return string The resulting page's hook_suffix
</ins><span class="cx"> */
</span><span class="cx"> function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="lines">@@ -1194,7 +1220,9 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><del>- */
</del><ins>+ *
+ * @return string The resulting page's hook_suffix
+*/
</ins><span class="cx"> function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="cx"> }
</span><span class="lines">@@ -1213,7 +1241,9 @@
</span><span class="cx"> * @param string $capability The capability required for this menu to be displayed to the user.
</span><span class="cx"> * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
</span><span class="cx"> * @param callback $function The function to be called to output the content for this page.
</span><del>- */
</del><ins>+ *
+ * @return string The resulting page's hook_suffix
+*/
</ins><span class="cx"> function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
</span><span class="cx"> return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>