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
查看更多 >