register_setting

函式


      register_setting ( $option_group, $option_name, $args = array() )

引數

(string) $option_group A settings group name. Should correspond to an allowed option key name. Default allowed option key names include 'general', 'discussion', 'media', 'reading', 'writing', and 'options'.

Required: 是
(string) $option_name The name of an option to sanitize and save.

Required: 是
(array) $args { Data used to describe the setting when registered. @type string $type The type of data associated with this setting. Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'. @type string $description A description of the data attached to this setting. @type callable $sanitize_callback A callback function that sanitizes the option's value. @type bool|array $show_in_rest Whether data associated with this setting should be included in the REST API. When registering complex settings, this argument may optionally be an array with a 'schema' key. @type mixed $default Default value when calling `get_option()`. }

Required: 否

Default: array()

定義位置

wp-includes/option.php , line 2339

相關方法: unregister_setting get_registered_settings register_initial_settings register_meta set_user_setting

引入: 2.7.0

棄用: -

register_setting: 這個函式是用來在WordPress中註冊一個新的設定。設定可以用來儲存外掛或主題的配置資料，如API金鑰或其他選項。

註冊一個設定和它的資料。

function register_setting( $option_group, $option_name, $args = array() ) {
	global $new_allowed_options, $wp_registered_settings;

	/*
	 * In 5.5.0, the `$new_whitelist_options` global variable was renamed to `$new_allowed_options`.
	 * Please consider writing more inclusive code.
	 */
	$GLOBALS['new_whitelist_options'] = &$new_allowed_options;

	$defaults = array(
		'type'              => 'string',
		'group'             => $option_group,
		'description'       => '',
		'sanitize_callback' => null,
		'show_in_rest'      => false,
	);

	// Back-compat: old sanitize callback is added.
	if ( is_callable( $args ) ) {
		$args = array(
			'sanitize_callback' => $args,
		);
	}

	/**
	 * Filters the registration arguments when registering a setting.
	 *
	 * @since 4.7.0
	 *
	 * @param array  $args         Array of setting registration arguments.
	 * @param array  $defaults     Array of default arguments.
	 * @param string $option_group Setting group.
	 * @param string $option_name  Setting name.
	 */
	$args = apply_filters( 'register_setting_args', $args, $defaults, $option_group, $option_name );

	$args = wp_parse_args( $args, $defaults );

	// Require an item schema when registering settings with an array type.
	if ( false !== $args['show_in_rest'] && 'array' === $args['type'] && ( ! is_array( $args['show_in_rest'] ) || ! isset( $args['show_in_rest']['schema']['items'] ) ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'When registering an "array" setting to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.4.0' );
	}

	if ( ! is_array( $wp_registered_settings ) ) {
		$wp_registered_settings = array();
	}

	if ( 'misc' === $option_group ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.0.0',
			sprintf(
				/* translators: %s: misc */
				__( 'The "%s" options group has been removed. Use another settings group.' ),
				'misc'
			)
		);
		$option_group = 'general';
	}

	if ( 'privacy' === $option_group ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.5.0',
			sprintf(
				/* translators: %s: privacy */
				__( 'The "%s" options group has been removed. Use another settings group.' ),
				'privacy'
			)
		);
		$option_group = 'reading';
	}

	$new_allowed_options[ $option_group ][] = $option_name;

	if ( ! empty( $args['sanitize_callback'] ) ) {
		add_filter( "sanitize_option_{$option_name}", $args['sanitize_callback'] );
	}
	if ( array_key_exists( 'default', $args ) ) {
		add_filter( "default_option_{$option_name}", 'filter_default_option', 10, 3 );
	}

	/**
	 * Fires immediately before the setting is registered but after its filters are in place.
	 *
	 * @since 5.5.0
	 *
	 * @param string $option_group Setting group.
	 * @param string $option_name  Setting name.
	 * @param array  $args         Array of setting registration arguments.
	 */
	do_action( 'register_setting', $option_group, $option_name, $args );

	$wp_registered_settings[ $option_name ] = $args;
}

常見問題

FAQs

如何使用get_users獲取所有使用者列表？
要使用` get_users `函式獲取所有使用者列表，可以按照以下步驟進行：

1. 使用` get_users `函式呼叫獲取使用者列表：
```
$users = get_users();
```
2. 您可以按需使用引數來過濾結果。例如，您可以通過角色、使用者ID、使用者登入名等過濾使用者列表。以下是一個根據使用者角色為過濾條件的示例：
```
$users = get_users( array(
    'role' => 'subscriber' // 將角色名稱替換為您要過濾的角色
) );
```
在上述示例中，將` role `引數設定為所需的角色名稱來過濾使用者列表。

3. 您可以使用迴圈遍歷獲取的使用者列表，並訪問每個使用者的屬性。例如，以下示例將顯示每個使用者的使用者名稱和電子郵件地址：
```
foreach( $users as $user ) {
    echo '使用者名稱：' . $user->user_login . ', 電子郵件：' . $user->user_email . ;
}
```
在上述示例中，通過` $user->user_login `和` $user->user_email `訪問每個使用者的使用者名稱和電子郵件地址。

請注意，` get_users `函式預設返回所有使用者，並可以根據需要使用更多引數進行過濾。您可以參閱WordPress官方文件中的` get_users `函式文件，瞭解更多可用引數和用法示例。

總結起來，使用` get_users `函式獲取所有使用者列表的步驟是：
1. 呼叫` get_users `函式獲取使用者列表。
2. 使用可選的過濾引數，根據需要過濾使用者列表。
3. 使用迴圈遍歷使用者列表，並訪問每個使用者的屬性。
如何使用WP_PLUGIN_DIR和WP_PLUGIN_URL定義外掛的目錄和URL？
在WordPress中，可以使用WP_PLUGIN_DIR和WP_PLUGIN_URL常量來定義外掛的目錄路徑和URL。

1. `WP_PLUGIN_DIR`：這是一個常量，用於定義外掛的目錄路徑（檔案系統路徑）。您可以使用以下程式碼在外掛檔案中訪問該常量：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
```
在上述程式碼中，將"your-plugin-folder"替換為您外掛的實際資料夾名稱。使用該常量，您可以獲取外掛檔案的完整路徑。

2. `WP_PLUGIN_URL`：這是一個常量，用於定義外掛的URL（用於在網頁上訪問外掛檔案）。以下是一個使用該常量的示例：
```
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
同樣，請將"your-plugin-folder"替換為您外掛的實際資料夾名稱。使用該常量，您可以獲取外掛在網頁上的完整URL。

請注意，`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量在WordPress版本2.6之後引入。從WordPress 5.5版本開始，這兩個常量被標記為過時（deprecated），因為WordPress更傾向於使用新的外掛檔案結構。如果您正在開發新外掛，建議使用新的外掛檔案結構和相關函式。

在新的外掛檔案結構中，可以使用以下函式來獲取外掛的目錄路徑和URL：

- `plugin_dir_path()`：獲取外掛目錄路徑。
- `plugin_dir_url()`：獲取外掛URL。

這些函式會自動將外掛的版本、多站點和SSL等考慮因素納入計算。

總結起來，使用`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量定義外掛的目錄和URL的方法是：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
但請注意，這兩個常量已被標記為過時，建議使用新的外掛檔案結構和相關函式來獲取外掛的路徑和URL。
如何使用PHP在WordPress中新增自定義功能？
使用PHP在WordPress中新增自定義功能可以通過以下方式實現：
- 建立一個自定義外掛，將功能程式碼新增到外掛中。
- 使用WordPress的鉤子系統，將自定義功能繫結到適當的鉤子上。
- 在主題檔案中新增自定義功能程式碼，例如functions.php檔案。
- 使用WordPress的短程式碼功能，將自定義功能封裝為短程式碼。
- 使用WordPress的外掛或主題編輯器，將自定義功能程式碼新增到適當的位置。
下面是一個實操示例。

要在WordPress中新增自定義功能，可以按照以下步驟使用PHP編寫並新增自定義功能：
1. 開啟WordPress安裝目錄中的主題資料夾，通常位於wp-content/themes/下，找到正在使用的主題資料夾。
2. 在主題資料夾中，可以建立一個名為functions.php的檔案。如果該檔案已經存在，可以直接編輯它。
3. 在functions.php檔案中，可以使用PHP程式碼新增自定義功能。以下是一些常見的示例：
```
// 新增自定義功能示例

// 1. 建立自定義短程式碼
function custom_shortcode() {
    return '這是我的自定義短程式碼內容';
}
add_shortcode('custom', 'custom_shortcode');

// 2. 自定義小工具
function custom_widget() {
    echo '這是我的自定義小工具內容';
}
register_widget('custom_widget');

// 3. 自定義選單
function custom_menu() {
    register_nav_menu('custom-menu', '自定義選單');
}
add_action('after_setup_theme', 'custom_menu');

// 4. 自定義頁面模板
function custom_page_template() {
    /* Template Name: 自定義模板 */
    // 自定義模板的內容和樣式
}
```
4. 編輯完functions.php檔案後，儲存並上傳到WordPress主題資料夾中。
請注意，修改主題檔案可以在主題更新時丟失，因此建議在進行任何更改之前備份functions.php檔案。此外，為避免不必要的錯誤和衝突，建議在新增自定義功能前先了解WordPress開發文件和最佳實踐，以確保正確、安全地實現所需的自定義功能。
如何進行WordPress資料庫查詢優化？
進行WordPress資料庫查詢優化可以通過以下方式實現：
- 使用WordPress提供的內建查詢函式，例如 WP_Query 、 get_posts 等。
- 使用適當的查詢引數和過濾器，減少查詢次數和資料量。
- 編寫自定義的資料庫查詢語句，使用適當的索引和快取。
- 優化資料庫伺服器配置和效能。
- 定期清理和優化資料庫表。
如何使用do_action來觸發一個鉤子函式？
使用 do_action 函式可以觸發一個鉤子函式。do_action 函式的引數與要觸發的鉤子函式的引數相同。

例如，觸發save_post鉤子函式的程式碼如下：
```
do_action( 'save_post', $post_ID, $post );
```
這裡，$post_ID 和 $post 是傳遞給鉤子函式的引數。

如何使用wp_get_current_user獲取當前登入使用者的資訊？

使用 wp_get_current_user 獲取當前登入使用者的資訊：

$current_user = wp_get_current_user();  
  
// 獲取當前使用者的ID  
$user_id = $current_user->ID;  
  
// 獲取當前使用者的使用者名稱  
$user_login = $current_user->user_login;  
  
// 獲取當前使用者的郵箱  
$user_email = $current_user->user_email;  
  
// 獲取當前使用者的顯示名稱  
$display_name = $current_user->display_name;

檢視更多 >

register_setting

常見問題

相關文章