rest_filter_response_by_context

函式


      rest_filter_response_by_context ( $data, $schema, $context )

引數

(array|object) $data The response data to modify.

Required: 是
(array) $schema The schema for the endpoint used to filter the response.

Required: 是
(string) $context The requested context.

Required: 是

返回值

(array|object) The filtered response data.

定義位置

wp-includes/rest-api.php , line 2942

相關方法: rest_filter_response_fields rest_ensure_response _oembed_filter_feed_content _wp_menu_item_classes_by_context register_block_core_post_content

引入: 5.5.0

棄用: -

rest_filter_response_by_context: 這個函式是用來根據請求的上下文過濾響應資料的。上下文可以是”檢視”、”嵌入”或”編輯”。它接收一個資料物件和當前上下文，並返回過濾後的資料。

過濾響應，刪除在給定上下文中不可用的任何欄位。

function rest_filter_response_by_context( $data, $schema, $context ) {
	if ( isset( $schema['anyOf'] ) ) {
		$matching_schema = rest_find_any_matching_schema( $data, $schema, '' );
		if ( ! is_wp_error( $matching_schema ) ) {
			if ( ! isset( $schema['type'] ) ) {
				$schema['type'] = $matching_schema['type'];
			}

			$data = rest_filter_response_by_context( $data, $matching_schema, $context );
		}
	}

	if ( isset( $schema['oneOf'] ) ) {
		$matching_schema = rest_find_one_matching_schema( $data, $schema, '', true );
		if ( ! is_wp_error( $matching_schema ) ) {
			if ( ! isset( $schema['type'] ) ) {
				$schema['type'] = $matching_schema['type'];
			}

			$data = rest_filter_response_by_context( $data, $matching_schema, $context );
		}
	}

	if ( ! is_array( $data ) && ! is_object( $data ) ) {
		return $data;
	}

	if ( isset( $schema['type'] ) ) {
		$type = $schema['type'];
	} elseif ( isset( $schema['properties'] ) ) {
		$type = 'object'; // Back compat if a developer accidentally omitted the type.
	} else {
		return $data;
	}

	$is_array_type  = 'array' === $type || ( is_array( $type ) && in_array( 'array', $type, true ) );
	$is_object_type = 'object' === $type || ( is_array( $type ) && in_array( 'object', $type, true ) );

	if ( $is_array_type && $is_object_type ) {
		if ( rest_is_array( $data ) ) {
			$is_object_type = false;
		} else {
			$is_array_type = false;
		}
	}

	$has_additional_properties = $is_object_type && isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] );

	foreach ( $data as $key => $value ) {
		$check = array();

		if ( $is_array_type ) {
			$check = isset( $schema['items'] ) ? $schema['items'] : array();
		} elseif ( $is_object_type ) {
			if ( isset( $schema['properties'][ $key ] ) ) {
				$check = $schema['properties'][ $key ];
			} else {
				$pattern_property_schema = rest_find_matching_pattern_property_schema( $key, $schema );
				if ( null !== $pattern_property_schema ) {
					$check = $pattern_property_schema;
				} elseif ( $has_additional_properties ) {
					$check = $schema['additionalProperties'];
				}
			}
		}

		if ( ! isset( $check['context'] ) ) {
			continue;
		}

		if ( ! in_array( $context, $check['context'], true ) ) {
			if ( $is_array_type ) {
				// All array items share schema, so there's no need to check each one.
				$data = array();
				break;
			}

			if ( is_object( $data ) ) {
				unset( $data->$key );
			} else {
				unset( $data[ $key ] );
			}
		} elseif ( is_array( $value ) || is_object( $value ) ) {
			$new_value = rest_filter_response_by_context( $value, $check, $context );

			if ( is_object( $data ) ) {
				$data->$key = $new_value;
			} else {
				$data[ $key ] = $new_value;
			}
		}
	}

	return $data;
}

常見問題

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;

檢視更多 >

rest_filter_response_by_context

常見問題

相關文章