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请求的嵌入参数: 该函数接受一个字符串参数并返回一个嵌入资源的数组: 这个函数被用来允许客户在R
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头
More

常见问题

FAQs
查看更多 >