Improve the `@param` docs for `src/wp-admin/includes/plugin.php`.

See #30224.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30658 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2014-11-30 22:23:23 +00:00
parent 04453cbe01
commit 67417897ec
2 changed files with 13 additions and 13 deletions

View File

@ -1119,7 +1119,7 @@ function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $f
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
global $submenu; global $submenu;
@ -1189,7 +1189,7 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability,
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1210,7 +1210,7 @@ function add_management_page( $page_title, $menu_title, $capability, $menu_slug,
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1231,7 +1231,7 @@ function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $f
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1252,7 +1252,7 @@ function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1273,7 +1273,7 @@ function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $f
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
if ( current_user_can('edit_users') ) if ( current_user_can('edit_users') )
@ -1297,7 +1297,7 @@ function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1318,7 +1318,7 @@ function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug,
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1339,7 +1339,7 @@ function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1360,7 +1360,7 @@ function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1381,7 +1381,7 @@ function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
@ -1402,7 +1402,7 @@ function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $fun
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu) * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page. * @param callback $function The function to be called to output the content for this page.
* *
* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required. * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/ */
function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) { function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function ); return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30667'; $wp_version = '4.1-beta2-30668';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.