screen_layout

Definition:
function screen_layout($screen) {}

Parameters

  • $screen

Defined filters

  • screen_layout_columns
    apply_filters('screen_layout_columns', array()

Source code

function screen_layout($screen) {

	global $screen_layout_columns, $wp_current_screen_options;



	if ( is_string($screen) )

		$screen = convert_to_screen($screen);



	// Back compat for plugins using the filter instead of add_screen_option()

	$columns = apply_filters('screen_layout_columns', array(), $screen->id, $screen);

	if ( !empty($columns) && isset($columns[$screen->id]) )

		add_screen_option('layout_columns', array('max' => $columns[$screen->id]) );



	if ( !isset($wp_current_screen_options['layout_columns']) ) {

		$screen_layout_columns = 0;

		return '';

	}



	$screen_layout_columns = get_user_option("screen_layout_$screen->id");

	$num = $wp_current_screen_options['layout_columns']['max'];



	if ( ! $screen_layout_columns ) {

		if ( isset($wp_current_screen_options['layout_columns']['default']) )

			$screen_layout_columns = $wp_current_screen_options['layout_columns']['default'];

		else

			$screen_layout_columns = 2;

	}



	$i = 1;

	$return = '<h5>' . __('Screen Layout') . "</h5>\n<div class='columns-prefs'>" . __('Number of Columns:') . "\n";

	while ( $i <= $num ) {

		$return .= "<label><input type='radio' name='screen_columns' value='$i'" . ( ($screen_layout_columns == $i) ? " checked='checked'" : "" ) . " /> $i</label>\n";

		++$i;

	}

	$return .= "</div>\n";

	return $return;

}

2809

screen_icon

Definition:
function screen_icon( $screen = '' ) {}

Parameters

  • $screen

Source code

function screen_icon( $screen = '' ) {

	echo get_screen_icon( $screen );

}

2807

save_mod_rewrite_rules

Definition:
function save_mod_rewrite_rules() {}

Updates the htaccess file with the current rules if it is writable.
Always writes to the file if it exists and is writable to ensure that we blank out old rules.

Source code

function save_mod_rewrite_rules() {

	if ( is_multisite() )

		return;



	global $wp_rewrite;



	$home_path = get_home_path();

	$htaccess_file = $home_path.'.htaccess';



	// If the file doesn't already exist check for write access to the directory and whether we have some rules.

	// else check for write access to the file.

	if ((!file_exists($htaccess_file) && is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks()) || is_writable($htaccess_file)) {

		if ( got_mod_rewrite() ) {

			$rules = explode( "\n", $wp_rewrite->mod_rewrite_rules() );

			return insert_with_markers( $htaccess_file, 'WordPress', $rules );

		}

	}



	return false;

}

2805

saveDomDocument

Definition:
function saveDomDocument($doc, $filename) {}

Saves the XML document into a file

Parameters

  • DOMDocument $doc
  • string $filename

Source code

function saveDomDocument($doc, $filename) {

	$config = $doc->saveXML();

	$config = preg_replace("/([^\r])\n/", "$1\r\n", $config);

	$fp = fopen($filename, 'w');

	fwrite($fp, $config);

	fclose($fp);

}

2803

sanitize_user_object

Definition:
function sanitize_user_object($user, $context = 'display') {}

Sanitize every user field.
If the context is ‘raw’, then the user object or array will get minimal santization of the int fields.

Parameters

  • object|array $user: The User Object or Array
  • string $context: Optional, default is ‘display’. How to sanitize user fields.

Return values

returns:The now sanitized User Object or Array (will be the same type as $user)

Source code

function sanitize_user_object($user, $context = 'display') {

	if ( is_object($user) ) {

		if ( !isset($user->ID) )

			$user->ID = 0;

		if ( isset($user->data) )

			$vars = get_object_vars( $user->data );

		else

			$vars = get_object_vars($user);

		foreach ( array_keys($vars) as $field ) {

			if ( is_string($user->$field) || is_numeric($user->$field) )

				$user->$field = sanitize_user_field($field, $user->$field, $user->ID, $context);

		}

		$user->filter = $context;

	} else {

		if ( !isset($user['ID']) )

			$user['ID'] = 0;

		foreach ( array_keys($user) as $field )

			$user[$field] = sanitize_user_field($field, $user[$field], $user['ID'], $context);

		$user['filter'] = $context;

	}



	return $user;

}

2801