Warning: This function has been deprecated. Use add_menu_page() instead.
add_object_page() WordPress Function
The add_object_page() function allows you to add a top-level menu item for an object type.
add_object_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', string $icon_url = '' ) #
Add a top-level menu page in the ‘objects’ section.
Description
This function takes a capability which will be used to determine whether or not a page is included in the menu.
The function which is hooked in to handle the output of the page must check that the user has the required capability as well.
See also
Parameters
- $page_title
(string)(Required)The text to be displayed in the title tags of the page when the menu is selected.
- $menu_title
(string)(Required)The text to be used for the menu.
- $capability
(string)(Required)The capability required for this menu to be displayed to the user.
- $menu_slug
(string)(Required)The slug name to refer to this menu by (should be unique for this menu).
- $callback
(callable)(Optional) The function to be called to output the content for this page.
Default value: ''
- $icon_url
(string)(Optional) The URL to the icon to be used for this menu.
Default value: ''
Return
(string) The resulting page's hook_suffix.
More Information
Technically, the function parameter is optional, but if it is not supplied, then WordPress will assume that including the PHP file will generate the administration screen, without calling a function. Most plugin authors choose to put the page-generating code in a function within their main plugin file. If the function parameter is omitted, the menu_slug should be the PHP file that handles the display of the menu page content.
In the event that the function parameter is specified, it is possible to use any string for the file parameter. This allows usage of pages such as ?page=my_super_plugin_page instead of ?page=my-super-plugin/admin-options.php.Capability checking based on capability should happen within the PHP file as well – the capability parameter defines both the visibility of the menu link and the visibility of the menu page contents.
Source
File: wp-admin/includes/deprecated.php
function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '') {
_deprecated_function( __FUNCTION__, '4.5.0', 'add_menu_page()' );
global $_wp_last_object_menu;
$_wp_last_object_menu++;
return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $callback, $icon_url, $_wp_last_object_menu);
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.5.0 | Use add_menu_page() |
| 2.7.0 | Introduced. |