wp_ability_validate_output
Filters the output validation result for an ability.
Allows developers to add custom validation logic on top of the default JSON Schema validation. If default validation already failed, the filter receives the WP_Error object and can add additional error information or override it. If default validation passed, the filter can add additional validation checks and return a WP_Error if those checks fail.
Usage
add_filter( 'wp_ability_validate_output', 'wp_kama_ability_validate_output_filter', 10, 3 );
/**
* Function for `wp_ability_validate_output` filter-hook.
*
* @param true|WP_Error $is_valid The validation result from default validation.
* @param mixed $output The output data being validated.
* @param string $ability_name The name of the ability.
*
* @return true|WP_Error
*/
function wp_kama_ability_validate_output_filter( $is_valid, $output, $ability_name ){
// filter...
return $is_valid;
}
- $is_valid(true|WP_Error)
- The validation result from default validation.
- $output(mixed)
- The output data being validated.
- $ability_name(string)
- The name of the ability.
Changelog
| Since 7.1.0 | Introduced. |
Where the hook is called
wp_ability_validate_output
wp-includes/abilities-api/class-wp-ability.php 748
$validity = apply_filters( 'wp_ability_validate_output', $is_valid, $output, $this->name );