云策 WordPress 开发者社区

钩子文档

current_screen

查看官方原文 ↗
💡 云策文档标注

概述

current_screen 是一个 WordPress 管理后台的 Hook，在屏幕识别元素设置完成后触发，用于访问当前屏幕的 WP_Screen 对象。

关键要点

  • Hook 类型：admin hook，在屏幕设置后触发
  • 参数：传递一个 WP_Screen 对象作为参数，包含屏幕的详细信息如 id、base、post_type、taxonomy 等
  • 用途：常用于根据当前屏幕上下文执行特定操作，如自定义文章类型编辑或小工具页面管理

代码示例

/**
 * Example of current_screen usage
 * @param $current_screen
 */
function wporg_current_screen_example( $current_screen ) {
    if ( 'someposttype' == $current_screen->post_type && 'post' === $current_screen->base ) {
        // Do something in the edit screen of this post type
    }
}
add_action( 'current_screen', 'wporg_current_screen_example' );
/**
 * Hides out the desired sidebar area from the widgets admin page.
 *
 * @param   WP_Screen  $current_screen  Current WP_Screen object.
 * @return  void.
 */
function prefix_hide_sidebar( $current_screen ) {    
    global $wp_registered_sidebars;
    $sidebar_id = 'sidebar-1';

    if ( 'widgets' === $current_screen->id ) {
        if ( array_key_exists( $sidebar_id, $wp_registered_sidebars ) ) {
            unset( $wp_registered_sidebars[ $sidebar_id ] );
        }
    }
}
add_action( 'current_screen', 'prefix_hide_sidebar', 10, 1 );

注意事项

  • WP_Screen 对象包含私有和受保护属性，如 columns、_help_tabs 等，需注意访问权限
  • Hook 在 WordPress 3.0.0 版本引入，确保兼容性
  • 使用前应检查屏幕属性（如 id、base）以避免误操作
📄 原文内容

Fires after the current screen has been set.

Parameters

$current_screenWP_Screen
Current WP_Screen object.

More Information

current_screen is an admin hook triggered after the necessary elements to identify a screen are set up. This hook provides a WP_Screen object as a parameter.

Parameter for hooked function

The following is a sample of the WP_Screen object passed as parameter to a function hooked to current_screen and called in a custom post type editing screen.

WP_Screen Object {
	["action"] => string(0) ""
	["base"] => string(4) "post"
	["columns":"WP_Screen":private] => int(0)
	["id"] => string(12) "someposttype"
	["in_admin":protected] => string(4) "site"
	["is_network"] => bool(false)
	["is_user"] => bool(false)
	["parent_base"] => NULL
	["parent_file"] => NULL
	["post_type"] => string(12) "someposttype"
	["taxonomy"] => string(0) ""
	["_help_tabs":"WP_Screen":private] => array(0) { }
	["_help_sidebar":"WP_Screen":private] => string(0) ""
	["_options":"WP_Screen":private] => array(0) { }
	["_show_screen_options":"WP_Screen":private] => NULL
	["_screen_settings":"WP_Screen":private] => NULL
}

and a sample of the object returned in a taxonomy list screen

WP_Screen Object {
	["action"] => string(0) ""
	["base"] => string(9) "edit-tags"
	["columns":"WP_Screen":private] => int(0)
	["id"] => string(10) "edit-mytax"
	["in_admin":protected] => string(4) "site"
	["is_network"] => bool(false)
	["is_user"] => bool(false)
	["parent_base"] => NULL
	["parent_file"] => NULL
	["post_type"] => string(12) "someposttype"
	["taxonomy"] => string(5) "mytax"
	["_help_tabs":"WP_Screen":private] => array(0) { }
	["_help_sidebar":"WP_Screen":private] =>	string(0) ""
	["_options":"WP_Screen":private] => array(0) { }
	["_show_screen_options":"WP_Screen":private] => NULL
	["_screen_settings":"WP_Screen":private] => NULL
}

Source

do_action( 'current_screen', $current_screen );

View all references View on Trac View on GitHub

Used by Description
WP_Screen::set_current_screen()wp-admin/includes/class-wp-screen.php

Makes the screen object the current screen.

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes

  1. Skip to note 3 content


    Collins Mbaka


    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    /**
 * Example of current_screen usage
 * @param $current_screen
 */
function wporg_current_screen_example( $current_screen ) {
	if ( 'someposttype' == $current_screen->post_type && 'post' === $current_screen->base ) {
		// Do something in the edit screen of this post type
	}
}
add_action( 'current_screen', 'wporg_current_screen_example' );

  2. Skip to note 4 content


    Mahdi Yazdani


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Hide the desired sidebar area from the Widgets admin page.

    /**
 * Hides out the desired sidebar area from the widgets admin page.
 *
 * @param   WP_Screen  $current_screen  Current WP_Screen object.
 * @return 	void.
 */
function prefix_hide_sidebar( $current_screen ) {	
	global $wp_registered_sidebars;
	$sidebar_id = 'sidebar-1';

	if ( 'widgets' === $current_screen->id ) {
		if ( array_key_exists( $sidebar_id, $wp_registered_sidebars ) ) {
			unset( $wp_registered_sidebars[ $sidebar_id ] );
		}
	}
}
add_action( 'current_screen', 'prefix_hide_sidebar', 10, 1 );