wp-includes/rest-api.php

WP檔案 82
REST API functions.
函式/鉤子名 描述
wp_rest_server_class (過濾鉤子) wp_rest_server_class:這是 WordPress 中的一個鉤子,它可以用於自定義 REST API 伺服器類。使用這個鉤子,開發者可以建立自定義的 REST API 伺服器類,以實現
wp_rest_search_handlers (過濾鉤子) wp_rest_search_handlers:這是 WordPress 中的一個鉤子,它可以被用於為 REST API 新增自定義搜尋處理程式: 當 REST API 請求帶有搜尋引數時,這個鉤子可
rest_url_prefix (過濾鉤子) rest_url_prefix: 這個函式返回REST API端點的URL字首,它是新增到網站基本URL的字串,形成完整的REST API端點URL。
rest_url (過濾鉤子) rest_url: 這個函式返回一個WordPress站點的REST API端點的URL。REST API為開發者提供了一種方法,可以通過向API端點傳送HTTP請求來與WordPress站點進行互動
rest_route_for_term (過濾鉤子) rest_route_for_term: 這是WordPress中的一個過濾器鉤子,當REST API為一個單一的術語資源構建路由時被觸發。它允許開發者在術語資源被返回之前修改它的路徑。
rest_route_for_taxonomy_items (過濾鉤子) rest_route_for_taxonomy_items: 這是WordPress中的一個過濾鉤,當REST API為特定分類的術語集合構建路由時被觸發。它允許開發者在分類法集合被返回之前修改其路徑
rest_route_for_post_type_items (過濾鉤子) rest_route_for_post_type_items: 這是WordPress中的一個過濾鉤,當REST API為一個特定的文章型別的文章集合構建路由時被觸發。它允許開發者在文章型別集合被返回
rest_route_for_post (過濾鉤子) rest_route_for_post: 這是WordPress中的一個過濾器鉤子,當REST API為一個單一的文章資源構建路由時被觸發。它允許開發者在返回之前修改文章資源的路由。
rest_queried_resource_route (過濾鉤子) rest_queried_resource_route: 這是WordPress中的一個過濾器鉤子,當REST API查詢一個資源的路由時被觸發。它允許開發者為一個給定的請求修改資源路由。
rest_post_dispatch (過濾鉤子) rest_post_dispatch。這個動作是在REST API請求被派發後觸發的。它允許開發者在請求被處理後執行額外的動作,如記錄或修改響應。
rest_avatar_sizes (過濾鉤子) rest_avatar_sizes – 這個鉤子用來過濾WordPress REST API中可用的頭像(使用者資料圖片)的尺寸。開發人員可以使用這個鉤子從可用的頭像尺寸列表中新增或刪除尺寸。
rest_api_init (動作鉤子) rest_api_init – 這是一個核心的WordPress動作,當REST API被初始化時被呼叫。它被用來為REST API註冊路由和端點,併為API的執行設定必要的資料結構。開發者可以使用這
rest_validate_value_from_schema (函式) rest_validate_value_from_schema: 這是一個WordPress的函式,根據一個指定的模式驗證一個值: 該函式接收一個值和一個模式引數,如果該值與模式不匹配,則返回一個錯誤
rest_validate_string_value_from_schema (函式) rest_validate_string_value_from_schema: 這是一個WordPress函式,用於驗證一個字串值是否與模式相匹配: 該函式接收一個字串引數和一個模式引數,如果字串值與
rest_validate_request_arg (函式) rest_validate_request_arg: 這是一個WordPress函式,根據指定的模式驗證一個請求引數: 該函式接收一個引數名、一個值和一個模式引數,如果該值與模式不匹配,則返回錯誤資訊
rest_validate_object_value_from_schema (函式) rest_validate_object_value_from_schema: 這是一個WordPress函式,用於驗證一個物件值是否與模式相匹配: 該函式接收一個物件引數和一個模式引數,如果物件與模
rest_validate_number_value_from_schema (函式) rest_validate_number_value_from_schema: 這是一個WordPress的函式,用於驗證一個數字值是否與模式相匹配: 該函式接收一個數字引數和一個模式引數,如果數字值
rest_validate_null_value_from_schema (函式) rest_validate_null_value_from_schema: 這是一個WordPress的函式,驗證一個空值是否與模式相匹配: 該函式接收一個空值引數和一個模式引數,如果空值與模式不匹配
rest_validate_json_schema_pattern (函式) rest_validate_json_schema_pattern: 這是一個WordPress函式,用於驗證一個值是否與JSON模式中指定的正規表示式模式相匹配: 該函式接收一個值引數和一個模式引數
rest_validate_integer_value_from_schema (函式) rest_validate_integer_value_from_schema: 這是一個WordPress函式,用於驗證一個整數值是否與模式相匹配: 該函式接受一個整數引數和一個模式引數,如果整數值
rest_validate_enum (函式) rest_validate_enum: 這是一個WordPress的函式,用來驗證一個值是否是一個指定的值集的成員: 該函式接收一個值引數和一組允許的值,如果該值不是該組的成員,則返回一個錯誤資訊。
rest_validate_boolean_value_from_schema (函式) rest_validate_boolean_value_from_schema: 這是一個WordPress函式,用於驗證一個布林值是否與模式相匹配: 該函式接收一個布林引數和一個模式引數,如果布林值
rest_validate_array_value_from_schema (函式) rest_validate_array_value_from_schema: 這是一個WordPress的函式,用於驗證一個陣列的值是否與模式相匹配: 該函式接收一個陣列引數和一個模式引數,如果陣列與
rest_validate_array_contains_unique_items (函式) rest_validate_array_contains_unique_items: 這是一個WordPress的函式,驗證一個陣列是否只包含唯一的值: 該函式接受一個陣列引數,如果陣列中的任何值不是
rest_url (函式) rest_url: 這是一個WordPress的函式,用於生成REST API端點的URL: 該函式接受一個路徑引數並返回REST API端點的完整URL。
rest_stabilize_value (函式) rest_stabilize_value: 這是一個WordPress的函式,確保提供的值可以安全地用作REST API的響應: 該函式對值應用了一組過濾器,以確保它沒有安全風險並可以安全地被序列化。
rest_send_cors_headers (函式) rest_send_cors_headers: 這是一個WordPress的函式,用來傳送跨源資源共享(CORS)頭資訊,以允許跨域請求。CORS是一種安全功能,它可以防止網頁向與提供原始頁面的域不同
rest_send_allow_header (函式) rest_send_allow_header: 這是一個WordPress的函式,傳送一個HTTP允許頭,以表明REST API端點允許的HTTP方法: 該函式接收一個允許的方法陣列,併傳送相應的允許
rest_sanitize_value_from_schema (函式) rest_sanitize_value_from_schema: 這是一個WordPress的函式,根據指定的模式對一個值進行淨化: 該函式接收一個值和一個模式引數,並返回該值的淨化值。
rest_sanitize_request_arg (函式) rest_sanitize_request_arg: 這是一個WordPress的函式,對一個請求引數進行淨化,根據引數型別應用適當的淨化過濾器: 該函式接收一個引數名稱、一個預設值和一個模式引數,並
rest_sanitize_object (函式) rest_sanitize_object: 這是一個WordPress的函式,它對一個物件進行淨化,對物件中的每個屬性應用適當的淨化過濾器: 這個函式用來確保傳遞給WordPress REST API
rest_sanitize_boolean (函式) rest_sanitize_boolean: 這是一個WordPress的函式,它對一個布林值進行淨化,確保它是真或假: 該函式用於確保傳遞給WordPress REST API的布林值可以安全使用。
rest_sanitize_array (函式) rest_sanitize_array: 這是一個WordPress的函式,對一個陣列的值進行淨化,對陣列中的每個值應用適當的淨化過濾器: 這個函式用來確保傳遞給WordPress REST API的
rest_preload_api_request (函式) rest_preload_api_request: 這是一個WordPress動作,在WordPress REST API處理一個請求之前被觸發。這個動作用於在處理請求前預裝資料或執行其他設定任務。
rest_parse_request_arg (函式) rest_parse_request_arg: 這是一個WordPress的函式,解析一個請求引數並返回一個經過淨化的值: 該函式接收一個引數名稱、一個預設值和一個模式引數,並返回引數的淨化值。
rest_parse_hex_color (函式) rest_parse_hex_color: 這是一個WordPress的函式,解析十六進位制的顏色程式碼並返回一個RGB顏色值: 該函式接收一個十六進位制的顏色程式碼並返回相應的RGB顏色值: 這個函
rest_parse_embed_param (函式) rest_parse_embed_param: 這是一個WordPress函式,用於解析REST API請求的嵌入引數: 該函式接受一個字串引數並返回一個嵌入資源的陣列: 這個函式被用來允許客戶在RE
rest_parse_date (函式) rest_parse_date:這是一個WordPress的函式,它解析一個日期字串並返回一個相應的Unix時間戳: 該函式接收一個日期字串和一個格式引數,並返回相應的Unix時間戳: 這個函式用來解
rest_output_rsd (函式) rest_output_rsd: 這是一個WordPress函式,用於輸出WordPress站點的Really Simple Discovery(RSD)端點。RSD端點是用來讓客戶發現WordPre
rest_output_link_wp_head (函式) rest_output_link_wp_head: 這是一個WordPress的函式,在HTML頭部部分為REST API響應輸出一個連結頭: 該函式接收一個連結陣列,並將相應的連結頭新增到HTML頭

常見問題

FAQs
檢視更多 >