register_meta
函式
register_meta ( $object_type, $meta_key, $args, $deprecated = null )
- 引數
-
-
(string)
$object_type
Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
- Required: 是
-
(string)
$meta_key
Meta key to register.
- Required: 是
-
(array)
$args
{ Data used to describe the meta key when registered. @type string $object_subtype A subtype; e.g. if the object type is "post", the post type. If left empty, the meta key will be registered on the entire object type. Default empty. @type string $type The type of data associated with this meta key. Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'. @type string $description A description of the data attached to this meta key. @type bool $single Whether the meta key has one value per object, or an array of values per object. @type mixed $default The default value returned from get_metadata() if no value has been set yet. When using a non-single meta key, the default value is for the first entry. In other words, when calling get_metadata() with `$single` set to `false`, the default value given here will be wrapped in an array. @type callable $sanitize_callback A function or method to call when sanitizing `$meta_key` data. @type callable $auth_callback Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks. @type bool|array $show_in_rest Whether data associated with this meta key can be considered public and should be accessible via the REST API. A custom post type must also declare support for custom fields for registered meta to be accessible via REST. When registering complex meta values this argument may optionally be an array with 'schema' or 'prepare_callback' keys instead of a boolean. }
- Required: 是
-
(string|array)
$deprecated
Deprecated. Use `$args` instead.
- Required: 否
- Default: null
-
(string)
$object_type
Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
- 返回值
-
- (bool) True if the meta key was successfully registered in the global array, false if not. Registering a meta key with distinct sanitize and auth callbacks will fire those callbacks, but will not add to the global registry.
- 定義位置
-
- wp-includes/meta.php , line 1396
- 相關方法
- register_term_metaregister_post_metaunregister_meta_keyunregister_term_metaunregister_post_meta
- 引入
- 3.3.0
- 棄用
- -
register_meta: 這個函式用來為一個文章、使用者、評論或術語物件註冊後設資料。它需要四個引數:$object_type, $meta_key, $args, 和 $deprecated。$object_type是後設資料將被附加到的物件的型別,$meta_key是後設資料的名稱,$args是定義後設資料行為的引數陣列,$deprecated是表示該引數不再使用的資訊。
註冊一個元鍵。
我們建議為物件型別和物件子型別的特定組合註冊元鍵。如果省略了物件子型別的傳遞,元鍵將為整個物件型別註冊,然而它可以部分地被覆蓋,以防同一物件型別和一個子型別存在相同名稱的更具體的元鍵。
如果一個物件型別不支援任何子型別,如使用者或評論,你通常應該呼叫這個函式而不傳遞子型別。
function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
global $wp_meta_keys;
if ( ! is_array( $wp_meta_keys ) ) {
$wp_meta_keys = array();
}
$defaults = array(
'object_subtype' => '',
'type' => 'string',
'description' => '',
'default' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => null,
'show_in_rest' => false,
);
// There used to be individual args for sanitize and auth callbacks.
$has_old_sanitize_cb = false;
$has_old_auth_cb = false;
if ( is_callable( $args ) ) {
$args = array(
'sanitize_callback' => $args,
);
$has_old_sanitize_cb = true;
} else {
$args = (array) $args;
}
if ( is_callable( $deprecated ) ) {
$args['auth_callback'] = $deprecated;
$has_old_auth_cb = true;
}
/**
* Filters the registration arguments when registering meta.
*
* @since 4.6.0
*
* @param array $args Array of meta registration arguments.
* @param array $defaults Array of default arguments.
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
* or any other object type with an associated meta table.
* @param string $meta_key Meta key.
*/
$args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );
unset( $defaults['default'] );
$args = wp_parse_args( $args, $defaults );
// Require an item schema when registering array meta.
if ( false !== $args['show_in_rest'] && 'array' === $args['type'] ) {
if ( ! is_array( $args['show_in_rest'] ) || ! isset( $args['show_in_rest']['schema']['items'] ) ) {
_doing_it_wrong( __FUNCTION__, __( 'When registering an "array" meta type to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.3.0' );
return false;
}
}
$object_subtype = ! empty( $args['object_subtype'] ) ? $args['object_subtype'] : '';
// If `auth_callback` is not provided, fall back to `is_protected_meta()`.
if ( empty( $args['auth_callback'] ) ) {
if ( is_protected_meta( $meta_key, $object_type ) ) {
$args['auth_callback'] = '__return_false';
} else {
$args['auth_callback'] = '__return_true';
}
}
// Back-compat: old sanitize and auth callbacks are applied to all of an object type.
if ( is_callable( $args['sanitize_callback'] ) ) {
if ( ! empty( $object_subtype ) ) {
add_filter( "sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['sanitize_callback'], 10, 4 );
} else {
add_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'], 10, 3 );
}
}
if ( is_callable( $args['auth_callback'] ) ) {
if ( ! empty( $object_subtype ) ) {
add_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['auth_callback'], 10, 6 );
} else {
add_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'], 10, 6 );
}
}
if ( array_key_exists( 'default', $args ) ) {
$schema = $args;
if ( is_array( $args['show_in_rest'] ) && isset( $args['show_in_rest']['schema'] ) ) {
$schema = array_merge( $schema, $args['show_in_rest']['schema'] );
}
$check = rest_validate_value_from_schema( $args['default'], $schema );
if ( is_wp_error( $check ) ) {
_doing_it_wrong( __FUNCTION__, __( 'When registering a default meta value the data must match the type provided.' ), '5.5.0' );
return false;
}
if ( ! has_filter( "default_{$object_type}_metadata", 'filter_default_metadata' ) ) {
add_filter( "default_{$object_type}_metadata", 'filter_default_metadata', 10, 5 );
}
}
// Global registry only contains meta keys registered with the array of arguments added in 4.6.0.
if ( ! $has_old_auth_cb && ! $has_old_sanitize_cb ) {
unset( $args['object_subtype'] );
$wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ] = $args;
return true;
}
return false;
}
常見問題
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`函式獲取所有使用者列表的步驟是:- 呼叫`
get_users`函式獲取使用者列表。 - 使用可選的過濾引數,根據需要過濾使用者列表。
- 使用迴圈遍歷使用者列表,並訪問每個使用者的屬性。
- 呼叫`
-
如何使用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編寫並新增自定義功能:
- 開啟WordPress安裝目錄中的主題資料夾,通常位於wp-content/themes/下,找到正在使用的主題資料夾。
- 在主題資料夾中,可以建立一個名為functions.php的檔案。如果該檔案已經存在,可以直接編輯它。
- 在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: 自定義模板 */ // 自定義模板的內容和樣式 } - 編輯完functions.php檔案後,儲存並上傳到WordPress主題資料夾中。
請注意,修改主題檔案可以在主題更新時丟失,因此建議在進行任何更改之前備份functions.php檔案。此外,為避免不必要的錯誤和衝突,建議在新增自定義功能前先了解WordPress開發文件和最佳實踐,以確保正確、安全地實現所需的自定義功能。
-
如何進行WordPress資料庫查詢優化?
-
如何使用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;
