wp-includes/rest-api.php

WP檔案 82
REST API functions.
函式/鉤子名 描述
rest_output_link_header (函式) rest_output_link_header: 這是一個WordPress的函式,為REST API響應傳送一個連結頭: 該函式接收一個連結陣列併傳送相應的連結頭: 這個函式用於向客戶提供額外的連結
rest_is_object (函式) rest_is_object: 這是一個WordPress的函式,用來檢查一個值是否是一個物件。如果該值是一個物件,該函式返回真,否則返回假: 這個函式是用來驗證和淨化WordPress REST A
rest_is_ip_address (函式) rest_is_ip_address: 這是一個WordPress的函式,用來檢查一個值是否是一個有效的IP地址。如果該值是一個有效的IP地址,該函式返回真,否則返回假: 這個函式是用來驗證和淨化Wo
rest_is_integer (函式) rest_is_integer: 這是一個WordPress函式,用於檢查一個值是否是整數。如果該值是一個整數,該函式返回真,否則返回假: 這個函式是用來驗證和淨化WordPress REST API
rest_is_field_included (函式) rest_is_field_included: 這是一個WordPress的函式,用來檢查一個欄位是否包含在REST API響應的欄位集合中: 該函式接收一個欄位名和一個欄位陣列,如果該欄位被包括,則
rest_is_boolean (函式) rest_is_boolean: 這是一個WordPress的函式,用來檢查一個值是否是布林值。如果該值是布林值,該函式返回真,否則返回假: 這個函式是用來驗證和淨化WordPress REST AP
rest_is_array (函式) rest_is_array: 這是一個WordPress的函式,檢查一個值是否是一個陣列。如果該值是一個陣列,該函式返回真,否則返回假: 這個函式是用來驗證和淨化WordPress REST API的
rest_handle_options_request (函式) rest_handle_options_request: 這是一個WordPress的函式,用於處理一個REST API端點的HTTP OPTIONS請求: 該函式在HTTP允許頭中為端點傳送允許的H
rest_handle_multi_type_schema (函式) rest_handle_multi_type_schema: 這個函式用來處理一個允許多種型別的模式。它接受兩個引數,第一個是允許多種型別的模式,第二個是代表正在驗證的資料型別的字串。如果根據模式不允
rest_handle_doing_it_wrong (函式) rest_handle_doing_it_wrong: 這個函式用於處理由”做錯了”的開發者產生的錯誤。它接受三個引數,第一個是被錯誤呼叫的函式或方法名稱,第二個是解釋錯誤的訊息,第三個是錯誤用法被棄
rest_handle_deprecated_function (函式) rest_handle_deprecated_function: 這個函式用於處理REST API端點中呼叫的棄用函式。它接受兩個引數,第一個是函式名稱,第二個是該函式被棄用的版本。它產生一個警告資訊
rest_handle_deprecated_argument (函式) rest_handle_deprecated_argument: 該函式用於處理傳遞給REST API端點的過時的引數。它接受兩個引數,第一個是引數名稱,第二個是該引數被棄用的版本。它生成一條警告資訊
rest_get_url_prefix (函式) rest_get_url_prefix: 這個函式用來檢索用於REST API請求的URL字首。它返回一個代表URL字首的字串。
rest_get_server (函式) rest_get_server: 這個函式用於檢索當前的REST伺服器例項。它返回WP_REST_Server的一個例項,它是負責處理REST API請求的類。
rest_get_route_for_term (函式) rest_get_route_for_term: 這個函式用於檢索分類法中某個特定術語的REST API路由。它接受兩個引數,術語ID和分類法名稱,並返回一個代表指定術語的REST API路由的字串。
rest_get_route_for_taxonomy_items (函式) rest_get_route_for_taxonomy_items: 這個函式用於檢索特定分類法的所有術語的REST API路由。它接受一個引數,即分類法名稱,並返回一個字串,代表指定分類法的所有術語
rest_get_route_for_post_type_items (函式) rest_get_route_for_post_type_items: 這個函式用來檢索一個特定文章型別的所有文章的REST API路由。它接受一個引數,即文章型別名稱,並返回一個字串,代表指定文章型
rest_get_route_for_post (函式) rest_get_route_for_post: 這個函式是用來檢索特定文章的REST API路由的。它接受一個引數,即文章的ID,並返回一個代表指定文章的REST API路由的字串。
rest_get_queried_resource_route (函式) rest_get_queried_resource_route: 該函式用於檢索當前被查詢資源的REST API路由。它返回一個字串,代表當前正在查詢的資源的REST API路由。
rest_get_endpoint_args_for_schema (函式) rest_get_endpoint_args_for_schema: 這個函式用於檢索特定模式的端點引數。它接受兩個引數,第一個是需要端點引數的模式,第二個是一個布林值,表示是否在響應中包括模式描述。
rest_get_date_with_gmt (函式) rest_get_date_with_gmt:該函式用於檢索GMT時區的日期字串。它接受一個單一的引數,一個日期字串,並返回在GMT時區的同一日期。它在REST API中用於格式化日期字串。
rest_get_combining_operation_error (函式) rest_get_combining_operation_error: 這個函式用於為使用”allOf”或”anyOf”等組合操作的JSON模式生成一個錯誤響應。它用於確保JSON模式驗證工作正常,並
rest_get_best_type_for_value (函式) rest_get_best_type_for_value: 這個函式用來獲取給定值的最佳資料型別。它接收一個值並返回該值的最佳資料型別。
rest_get_avatar_urls (函式) rest_get_avatar_urls: 這個函式用來獲取一個給定使用者的頭像URLs。它接收一個使用者ID或物件,以及一個頭像尺寸名稱陣列,並返回一個指定尺寸的頭像URL陣列。
rest_get_avatar_sizes (函式) rest_get_avatar_sizes: 這個函式用來獲取在WordPress註冊的頭像尺寸。它返回一個頭像尺寸名稱和它們相應尺寸的陣列。
rest_get_authenticated_app_password (函式) rest_get_authenticated_app_password: 這個函式用來獲取REST API請求的認證應用密碼。它接收當前的請求物件並返回認證的應用程式密碼。
rest_get_allowed_schema_keywords (函式) rest_get_allowed_schema_keywords: 這個函式用來獲取一個模式的允許的關鍵字。它接收一個模式物件並返回一個允許的關鍵字陣列。
rest_format_combining_operation_error (函式) rest_format_combining_operation_error: 這個函式用於格式化包含組合操作(如allOf、anyOf或oneOf)的模式的錯誤資訊,該操作未能驗證。它接收一個錯誤資訊
rest_find_one_matching_schema (函式) rest_find_one_matching_schema: 這個函式用於查詢與給定資料相匹配的模式。它接收一個資料物件和一個模式物件的陣列,並返回與資料相匹配的第一個模式物件。
rest_find_matching_pattern_property_schema (函式) rest_find_matching_pattern_property_schema: 該函式用於查詢與模式屬性相匹配的模式。它接收一個資料物件、屬性名稱和一個模式物件的陣列,並返回與模式屬性相匹配的
rest_find_any_matching_schema (函式) rest_find_any_matching_schema: 這個函式用於查詢與給定資料相匹配的模式。它接收一個資料物件和一個模式物件的陣列,並返回與資料相匹配的第一個模式物件。
rest_filter_response_fields (函式) rest_filter_response_fields: 這個函式用於根據請求的欄位過濾響應資料。它接收一個資料物件、一個要包括的欄位陣列和一個要排除的欄位陣列,並返回過濾後的資料。
rest_filter_response_by_context (函式) rest_filter_response_by_context: 這個函式是用來根據請求的上下文過濾響應資料的。上下文可以是”檢視”、”嵌入”或”編輯”。它接收一個資料物件和當前上下文,並返回過濾後的
rest_ensure_response (函式) rest_ensure_response: 這個函式用來確保REST API返回的資料是正確的格式。它接收一個資料物件,並返回一個包含資料的WP_REST_Response物件,以及相應的頭資訊和狀態
rest_ensure_request (函式) rest_ensure_request: 這個函式確保一個變數是一個WP_REST_Request物件。如果該變數不是WP_REST_Request物件,它將被轉換為WP_REST_Request物件
rest_do_request (函式) rest_do_request: 這個函式使用WP HTTP API執行一個HTTP請求。在REST API中,它被用來向外部API發出請求。
rest_default_additional_properties_to_false (函式) rest_default_additional_properties_to_false:這個過濾器鉤子允許開發者在檢查cookie的有效性時修改返回的狀態。這個過濾鉤子允許開發者在定義JSON模式時設
rest_cookie_collect_status (函式) rest_cookie_collect_status。這個過濾鉤子允許開發者修改在檢查cookie的有效性時返回的狀態。
rest_cookie_check_errors (函式) rest_cookie_check_errors: 這個過濾器鉤子允許開發者修改在檢查cookie的有效性時返回的錯誤。
rest_convert_error_to_response (函式) rest_convert_error_to_response: 這是一個將WP_Error物件轉換為REST API響應的實用函式。它是用來規範REST API中的錯誤響應。

常見問題

FAQs
檢視更多 >