screen_layout_columns

Filter Hook

Description

Filters the array of screen layout columns. This hook provides back-compat for plugins using the back-compat Filters instead of add_screen_option().

Hook Information

File Location	`wp-admin/includes/class-wp-screen.php` View on GitHub
Hook Type	Filter
Line Number	`943`

Hook Parameters

Type	Name	Description
`array`	`$empty_columns`	Empty array.
`string`	`$screen_id`	Screen ID.
`WP_Screen`	`$screen`	Current WP_Screen instance.

Usage Examples

Basic Usage

<?php
// Hook into screen_layout_columns
add_filter('screen_layout_columns', 'my_custom_filter', 10, 3);

function my_custom_filter($empty_columns, $screen_id, $screen) {
    // Your custom filtering logic here
    return $empty_columns;
}

Source Code Context

wp-admin/includes/class-wp-screen.php:943 - How this hook is used in WordPress core

<?php
 938  		 *
 939  		 * @param array     $empty_columns Empty array.
 940  		 * @param string    $screen_id     Screen ID.
 941  		 * @param WP_Screen $screen        Current WP_Screen instance.
 942  		 */
 943  		$columns = apply_filters( 'screen_layout_columns', array(), $this->id, $this );
 944  
 945  		if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) ) {
 946  			$this->add_option( 'layout_columns', array( 'max' => $columns[ $this->id ] ) );
 947  		}
 948

PHP Documentation

<?php
/**
		 * Filters the array of screen layout columns.
		 *
		 * This hook provides back-compat for plugins using the back-compat
		 * Filters instead of add_screen_option().
		 *
		 * @since 2.8.0
		 *
		 * @param array     $empty_columns Empty array.
		 * @param string    $screen_id     Screen ID.
		 * @param WP_Screen $screen        Current WP_Screen instance.
		 */

Quick Info

Hook Type: Filter
Parameters: 3
File: wp-admin/includes/class-wp-screen.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.