Home

set_user_setting

February 12, 2011 by Thorsten 0 Comments

Definition:
function set_user_setting( $name, $value ) {}

Add or update user interface setting.
Both $name and $value can contain only ASCII letters, numbers and underscores. This function has to be used before any output has started as it calls setcookie().

Parameters

  • string $name: The name of the setting.
  • string $value: The value for the setting.

Return values

returns:true if set successfully/false if not.

Source code

function set_user_setting( $name, $value ) {



	if ( headers_sent() )

		return false;



	$all = get_all_user_settings();

	$name = preg_replace( '/[^A-Za-z0-9_]+/', '', $name );



	if ( empty($name) )

		return false;



	$all[$name] = $value;



	return wp_set_all_user_settings($all);

}

2859

/wp-includes/functions.php, Documentation, Files, Functions, Functions by letter s
,

set_transient

February 12, 2011 by Thorsten 0 Comments

Definition:
function set_transient( $transient, $value, $expiration = 0 ) {}

Set/update the value of a transient.
You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is set.

Parameters

  • string $transient: Transient name. Expected to not be SQL-escaped.
  • mixed $value: Transient value. Expected to not be SQL-escaped.
  • int $expiration: Time until expiration in seconds, default 0

Return values

returns:False if value was not set and true if value was set.

Defined filters

  • pre_set_transient_$transient
    apply_filters( 'pre_set_transient_' . $transient, $value )

Defined actions

  • set_transient_’.$transient
    do_action( 'set_transient_' . $transient );
  • setted_transient
    do_action( 'setted_transient', $transient );

Source code

function set_transient( $transient, $value, $expiration = 0 ) {

	global $_wp_using_ext_object_cache;



	$value = apply_filters( 'pre_set_transient_' . $transient, $value );



	if ( $_wp_using_ext_object_cache ) {

		$result = wp_cache_set( $transient, $value, 'transient', $expiration );

	} else {

		$transient_timeout = '_transient_timeout_' . $transient;

		$transient = '_transient_' . $transient;

		if ( false === get_option( $transient ) ) {

			$autoload = 'yes';

			if ( $expiration ) {

				$autoload = 'no';

				add_option( $transient_timeout, time() + $expiration, '', 'no' );

			}

			$result = add_option( $transient, $value, '', $autoload );

		} else {

			if ( $expiration )

				update_option( $transient_timeout, time() + $expiration );

			$result = update_option( $transient, $value );

		}

	}

	if ( $result ) {

		do_action( 'set_transient_' . $transient );

		do_action( 'setted_transient', $transient );

	}

	return $result;

}

2857

/wp-includes/functions.php, Actions, Actions by letter s, Documentation, Files, Filters, Filters by letter p, Functions, Functions by letter s
, , , ,

set_theme_mod

February 12, 2011 by Thorsten 0 Comments

Definition:
function set_theme_mod( $name, $value ) {}

Update theme modification value for the current theme.

Parameters

  • string $name: Theme modification name.
  • string $value: theme modification value.

Source code

function set_theme_mod( $name, $value ) {

	$mods = get_theme_mods();



	$mods[ $name ] = $value;



	$theme = get_option( 'stylesheet' );

	update_option( "theme_mods_$theme", $mods );

}

2855

/wp-includes/theme.php, Documentation, Files, Functions, Functions by letter s
, ,

set_site_transient

February 12, 2011 by Thorsten 0 Comments

Definition:
function set_site_transient( $transient, $value, $expiration = 0 ) {}

Set/update the value of a site transient.
You do not need to serialize values, if the value needs to be serialize, then it will be serialized before it is set.

Parameters

  • string $transient: Transient name. Expected to not be SQL-escaped.
  • mixed $value: Transient value. Expected to not be SQL-escaped.
  • int $expiration: Time until expiration in seconds, default 0

Return values

returns:False if value was not set and true if value was set.

Defined filters

  • pre_set_site_transient_$transient
    apply_filters( 'pre_set_site_transient_' . $transient, $value )

Defined actions

  • set_site_transient_’.$transient
    do_action( 'set_site_transient_' . $transient );
  • setted_site_transient
    do_action( 'setted_site_transient', $transient );

Source code

function set_site_transient( $transient, $value, $expiration = 0 ) {

	global $_wp_using_ext_object_cache;



	$value = apply_filters( 'pre_set_site_transient_' . $transient, $value );



	if ( $_wp_using_ext_object_cache ) {

		$result = wp_cache_set( $transient, $value, 'site-transient', $expiration );

	} else {

		$transient_timeout = '_site_transient_timeout_' . $transient;

		$transient = '_site_transient_' . $transient;

		if ( false === get_site_option( $transient ) ) {

			if ( $expiration )

				add_site_option( $transient_timeout, time() + $expiration );

			$result = add_site_option( $transient, $value );

		} else {

			if ( $expiration )

				update_site_option( $transient_timeout, time() + $expiration );

			$result = update_site_option( $transient, $value );

		}

	}

	if ( $result ) {

		do_action( 'set_site_transient_' . $transient );

		do_action( 'setted_site_transient', $transient );

	}

	return $result;

}

2853

/wp-includes/functions.php, Actions, Actions by letter s, Documentation, Files, Filters, Filters by letter p, Functions, Functions by letter s
, , , ,

set_screen_options

February 12, 2011 by Thorsten 0 Comments

Definition:
function set_screen_options() {}

Saves option for number of rows when listing posts, pages, comments, etc.

Defined filters

  • set-screen-option
    apply_filters('set-screen-option', false, $option, $value)

Source code

function set_screen_options() {



	if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {

		check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );



		if ( !$user = wp_get_current_user() )

			return;

		$option = $_POST['wp_screen_options']['option'];

		$value = $_POST['wp_screen_options']['value'];



		if ( !preg_match( '/^[a-z_-]+$/', $option ) )

			return;



		$option = str_replace('-', '_', $option);



		$map_option = $option;

		$type = str_replace('edit_', '', $map_option);

		$type = str_replace('_per_page', '', $type);

		if ( in_array($type, get_post_types()) )

			$map_option = 'edit_per_page';

		if ( in_array( $type, get_taxonomies()) )

			$map_option = 'edit_tags_per_page';





		switch ( $map_option ) {

			case 'edit_per_page':

			case 'users_per_page':

			case 'edit_comments_per_page':

			case 'upload_per_page':

			case 'edit_tags_per_page':

			case 'plugins_per_page':

			// Network admin

			case 'sites_network_per_page':

			case 'users_network_per_page':

			case 'site_users_network_per_page':

			case 'plugins_network_per_page':

			case 'themes_network_per_page':

			case 'site_themes_network_per_page':

				$value = (int) $value;

				if ( $value < 1 || $value > 999 )

					return;

				break;

			default:

				$value = apply_filters('set-screen-option', false, $option, $value);

				if ( false === $value )

					return;

				break;

		}



		update_user_meta($user->ID, $option, $value);

		wp_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );

		exit;

	}

}

2851

/wp-admin/includes/misc.php, Documentation, Files, Filters, Filters by letter s, Functions, Functions by letter s
, ,
Newer Entries
Older Entries