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

返回介绍

set_user_setting()

发布于 2017-09-11 字数2626 浏览 929 评论 0

set_user_setting( string $name,  string $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().


参数

$name

(string)
(Required)
The name of the setting.

$value

(string)
(Required)
The value for the setting.


返回值

(bool|null) True if set successfully, false if not. Null if the current user can’t be established.


源代码

File: wp-includes/option.php

function set_user_setting( $name, $value ) {
	if ( headers_sent() ) {
		return false;
	}

	$all_user_settings = get_all_user_settings();
	$all_user_settings[$name] = $value;

	return wp_set_all_user_settings( $all_user_settings );
}

更新日志

Version 描述
2.8.0 Introduced.

相关函数

Uses

  • wp-includes/option.php:
    get_all_user_settings()
  • wp-includes/option.php:
    wp_set_all_user_settings()

Used By

  • wp-admin/includes/class-wp-ms-users-list-table.php:
    WP_MS_Users_List_Table::prepare_items()
  • wp-admin/includes/class-wp-ms-sites-list-table.php:
    WP_MS_Sites_List_Table::prepare_items()
  • wp-admin/includes/class-wp-posts-list-table.php:
    WP_Posts_List_Table::prepare_items()

User Contributed Notes

  1. Skip to note content

    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

    Contributed by Drew Jaynes

    Override the user setting to always collapse the admin menu for the current user:

    
    /**
     * Re-set user setting to always collapse the admin menu.
     *
     * @see set_user_setting()
     */
    function wpdocs_always_collapse_menu() {
    	if ( 'f' != get_user_setting( 'mfold' ) ) {
    		set_user_setting( 'mfold', 'f' );
    	}
    }
    add_action( 'admin_head', 'wpdocs_always_collapse_menu' );
    

上一篇:set_url_scheme()

下一篇:shortcode_atts()

发布评论

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

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