add_object_page() - WordPress 函数参考中文文档

返回介绍

add_object_page()

发布于 2017-09-10 字数3595 浏览 1107 评论 0

Warning: This function has been deprecated. Use add_menu_page() instead.

add_object_page( string $page_title,  string $menu_title,  string $capability,  string $menu_slug,  callable $function = '',  string $icon_url = '' )

Add a top-level menu page in the ‘objects’ section.


描述

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.


参数

$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).

$function

(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: ”


返回值

(string) The resulting page’s hook_suffix.


源代码

File: wp-admin/includes/deprecated.php

function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $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, $function, $icon_url, $_wp_last_object_menu);
}

更新日志

Version 描述
4.5.0 Use add_menu_page()
2.7.0 Introduced.

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.


相关函数

Uses

  • wp-admin/includes/plugin.php:
    add_menu_page()
  • wp-includes/functions.php:
    _deprecated_function()

User Contributed Notes

上一篇:add_new_user_to_blog()

下一篇:add_option()

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!