AyeCode /
invoicing
| Total Complexity | 55 |
| Total Lines | 750 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like GetPaid_REST_Settings_Controller often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use GetPaid_REST_Settings_Controller, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
||
| 20 | |||
| 21 | /** |
||
| 22 | * An array of available settings. |
||
| 23 | * |
||
| 24 | * @var string |
||
| 25 | */ |
||
| 26 | protected $settings; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Route base. |
||
| 30 | * |
||
| 31 | * @var string |
||
| 32 | */ |
||
| 33 | protected $rest_base = 'settings'; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Registers the routes for the objects of the controller. |
||
| 37 | * |
||
| 38 | * @since 2.0.0 |
||
| 39 | * |
||
| 40 | * @see register_rest_route() |
||
| 41 | */ |
||
| 42 | public function register_namespace_routes( $namespace ) { |
||
| 151 | ) |
||
| 152 | ); |
||
| 153 | |||
| 154 | } |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Return all settings. |
||
| 158 | * |
||
| 159 | * @since 2.0.0 |
||
| 160 | * @param WP_REST_Request $request Request data. |
||
| 161 | * @return WP_Error|WP_REST_Response |
||
| 162 | */ |
||
| 163 | public function get_items( $request ) { |
||
| 164 | |||
| 165 | $settings = $this->get_settings(); |
||
| 166 | |||
| 167 | if ( ! isset( $settings[ $request['tab'] ] ) ) { |
||
| 168 | return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
||
| 169 | } |
||
| 170 | |||
| 171 | if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
||
| 172 | return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
||
| 173 | } |
||
| 174 | |||
| 175 | $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
||
| 176 | $prepared = array(); |
||
| 177 | |||
| 178 | foreach ( $settings as $setting ) { |
||
| 179 | |||
| 180 | $setting = $this->sanitize_setting( $setting ); |
||
| 181 | $setting_data = $this->prepare_item_for_response( $setting, $request ); |
||
| 182 | $setting_data = $this->prepare_response_for_collection( $setting_data ); |
||
| 183 | |||
| 184 | if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
||
| 185 | $prepared[] = $setting_data; |
||
| 186 | } |
||
| 187 | } |
||
| 188 | |||
| 189 | return rest_ensure_response( $prepared ); |
||
| 190 | } |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Return a single setting. |
||
| 194 | * |
||
| 195 | * @since 2.0.0 |
||
| 196 | * @param WP_REST_Request $request Request data. |
||
| 197 | * @return WP_Error|WP_REST_Response |
||
| 198 | */ |
||
| 199 | public function get_item( $request ) { |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Update a single setting. |
||
| 213 | * |
||
| 214 | * @since 2.0.0 |
||
| 215 | * @param WP_REST_Request $request Request data. |
||
| 216 | * @return WP_Error|WP_REST_Response |
||
| 217 | */ |
||
| 218 | public function update_item( $request ) { |
||
| 219 | $setting = $this->get_setting( $request['id'] ); |
||
| 220 | |||
| 221 | if ( is_wp_error( $setting ) ) { |
||
| 222 | return $setting; |
||
| 223 | } |
||
| 224 | |||
| 225 | if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
||
| 226 | $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
||
| 227 | } else { |
||
| 228 | $value = $this->validate_setting_text_field( $request['value'], $setting ); |
||
| 229 | } |
||
| 230 | |||
| 231 | if ( is_wp_error( $value ) ) { |
||
| 232 | return $value; |
||
| 233 | } |
||
| 234 | |||
| 235 | wpinv_update_option( $request['id'], $value ); |
||
| 236 | $setting['value'] = $value; |
||
| 237 | $setting = $this->sanitize_setting( $setting ); |
||
| 238 | $response = $this->prepare_item_for_response( $setting, $request ); |
||
| 239 | |||
| 240 | return rest_ensure_response( $response ); |
||
| 241 | } |
||
| 242 | |||
| 243 | /** |
||
| 244 | * Makes sure the current user has access to READ the settings APIs. |
||
| 245 | * |
||
| 246 | * @since 2.0.0 |
||
| 247 | * @param WP_REST_Request $request Full data about the request. |
||
| 248 | * @return WP_Error|boolean |
||
| 249 | */ |
||
| 250 | public function get_items_permissions_check( $request ) { |
||
| 251 | if ( ! wpinv_current_user_can_manage_invoicing() ) { |
||
| 252 | return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
||
| 253 | } |
||
| 254 | |||
| 255 | return true; |
||
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Makes sure the current user has access to WRITE the settings APIs. |
||
| 260 | * |
||
| 261 | * @since 2.0.0 |
||
| 262 | * @param WP_REST_Request $request Full data about the request. |
||
| 263 | * @return WP_Error|boolean |
||
| 264 | */ |
||
| 265 | public function update_items_permissions_check( $request ) { |
||
| 266 | if ( ! wpinv_current_user_can_manage_invoicing() ) { |
||
| 267 | return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
||
| 268 | } |
||
| 269 | |||
| 270 | return true; |
||
| 271 | } |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Check if a given request has access batch create, update and delete items. |
||
| 275 | * |
||
| 276 | * @param WP_REST_Request $request Full details about the request. |
||
| 277 | * |
||
| 278 | * @return boolean|WP_Error |
||
| 279 | */ |
||
| 280 | public function batch_items_permissions_check( $request ) { |
||
| 281 | return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
||
| 282 | } |
||
| 283 | |||
| 284 | /** |
||
| 285 | * Prepare links for the request. |
||
| 286 | * |
||
| 287 | * @param string $setting_id Setting ID. |
||
| 288 | * @return array Links for the given setting. |
||
| 289 | */ |
||
| 290 | protected function prepare_links( $setting_id ) { |
||
| 291 | |||
| 292 | $links = array( |
||
| 293 | 'self' => array( |
||
| 294 | 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
||
| 295 | ), |
||
| 296 | 'collection' => array( |
||
| 297 | 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
||
| 298 | ), |
||
| 299 | ); |
||
| 300 | |||
| 301 | return $links; |
||
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Prepare a settings object for serialization. |
||
| 306 | * |
||
| 307 | * @since 2.0.0 |
||
| 308 | * @param array $item Setting object. |
||
| 309 | * @param WP_REST_Request $request Request object. |
||
| 310 | * @return WP_REST_Response $response Response data. |
||
| 311 | */ |
||
| 312 | public function prepare_item_for_response( $item, $request ) { |
||
| 313 | $context = empty( $request['context'] ) ? 'view' : $request['context']; |
||
| 314 | $data = $this->add_additional_fields_to_object( $item, $request ); |
||
| 315 | $data = $this->filter_response_by_context( $data, $context ); |
||
| 316 | |||
| 317 | $response = rest_ensure_response( $data ); |
||
| 318 | |||
| 319 | $response->add_links( $this->prepare_links( $item['id'] ) ); |
||
| 320 | |||
| 321 | return $response; |
||
| 322 | } |
||
| 323 | |||
| 324 | /** |
||
| 325 | * Filters out bad values from the settings array/filter so we |
||
| 326 | * only return known values via the API. |
||
| 327 | * |
||
| 328 | * @since 2.0.0 |
||
| 329 | * @param array $setting Setting. |
||
| 330 | * @return array |
||
| 331 | */ |
||
| 332 | public function filter_setting( $setting ) { |
||
| 333 | return array_intersect_key( |
||
| 334 | $setting, |
||
| 335 | array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
||
| 336 | ); |
||
| 337 | } |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Callback for allowed keys for each setting response. |
||
| 341 | * |
||
| 342 | * @param string $key Key to check. |
||
| 343 | * @return boolean |
||
| 344 | */ |
||
| 345 | public function allowed_setting_keys( $key ) { |
||
| 346 | return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
||
| 347 | } |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Returns default options for a setting. null means the field is required. |
||
| 351 | * |
||
| 352 | * @since 2.0.0 |
||
| 353 | * @return array |
||
| 354 | */ |
||
| 355 | protected function setting_defaults() { |
||
| 356 | return array( |
||
| 357 | 'id' => null, |
||
| 358 | 'name' => null, |
||
| 359 | 'desc' => '', |
||
| 360 | 'options' => array(), |
||
| 361 | 'std' => false, |
||
| 362 | 'value' => false, |
||
| 363 | 'placeholder' => '', |
||
| 364 | 'readonly' => false, |
||
| 365 | 'faux' => false, |
||
| 366 | 'section' => 'main', |
||
| 367 | 'tab' => 'general', |
||
| 368 | 'type' => 'text', |
||
| 369 | ); |
||
| 370 | } |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Sanitizes a setting's field. |
||
| 374 | * |
||
| 375 | * @param array $setting The setting to sanitize. |
||
| 376 | * @return array |
||
| 377 | */ |
||
| 378 | public function sanitize_setting( $setting ) { |
||
| 379 | |||
| 380 | $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
||
| 381 | $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
||
| 382 | return $this->filter_setting( $setting ); |
||
| 383 | |||
| 384 | } |
||
| 385 | |||
| 386 | /** |
||
| 387 | * Get setting data. |
||
| 388 | * |
||
| 389 | * @since 2.0.0 |
||
| 390 | * @param string $setting_id Setting ID. |
||
| 391 | * @return array|WP_Error |
||
| 392 | */ |
||
| 393 | public function get_setting( $setting_id ) { |
||
| 394 | |||
| 395 | if ( empty( $setting_id ) ) { |
||
| 396 | return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
||
| 397 | } |
||
| 398 | |||
| 399 | $settings = $this->get_settings(); |
||
| 400 | |||
| 401 | foreach ( $settings as $tabs ) { |
||
| 402 | |||
| 403 | foreach ( $tabs as $sections ) { |
||
| 404 | |||
| 405 | if ( isset( $sections[ $setting_id ] ) ) { |
||
| 406 | if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
||
| 407 | return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
||
| 408 | } |
||
| 409 | |||
| 410 | return $sections[ $setting_id ]; |
||
| 411 | } |
||
| 412 | } |
||
| 413 | } |
||
| 414 | |||
| 415 | return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
||
| 416 | } |
||
| 417 | |||
| 418 | /** |
||
| 419 | * Get all tabs. |
||
| 420 | * |
||
| 421 | * @param WP_REST_Request $request Request data. |
||
| 422 | * @return array |
||
| 423 | */ |
||
| 424 | public function get_tabs( $request ) { |
||
| 425 | $tabs = wpinv_get_settings_tabs(); |
||
| 426 | $prepared = array(); |
||
| 427 | |||
| 428 | foreach ( $tabs as $id => $tab ) { |
||
| 429 | |||
| 430 | $_request = $request; |
||
| 431 | $_request['tab'] = sanitize_title( $id ); |
||
| 432 | $data = array( |
||
| 433 | 'id' => sanitize_title( $id ), |
||
| 434 | 'label' => sanitize_text_field( $tab ), |
||
| 435 | 'sections' => $this->get_sections( $_request ), |
||
| 436 | ); |
||
| 437 | |||
| 438 | $data = $this->add_additional_fields_to_object( $data, $request ); |
||
| 439 | $response = rest_ensure_response( $data ); |
||
| 440 | |||
| 441 | if ( ! is_wp_error( $response ) ) { |
||
| 442 | $links = array( |
||
| 443 | 'sections' => array( |
||
| 444 | 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
||
| 445 | ), |
||
| 446 | 'collection' => array( |
||
| 447 | 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
||
| 448 | ), |
||
| 449 | ); |
||
| 450 | $response->add_links( $links ); |
||
| 451 | $response = $this->prepare_response_for_collection( $response ); |
||
| 452 | } |
||
| 453 | |||
| 454 | $prepared[] = $response; |
||
| 455 | |||
| 456 | } |
||
| 457 | |||
| 458 | return rest_ensure_response( $prepared ); |
||
| 459 | } |
||
| 460 | |||
| 461 | /** |
||
| 462 | * Get all sections. |
||
| 463 | * |
||
| 464 | * @param WP_REST_Request $request Request data. |
||
| 465 | * @return array |
||
| 466 | */ |
||
| 467 | public function get_sections( $request ) { |
||
| 468 | |||
| 469 | $tab = sanitize_title( $request['tab'] ); |
||
| 470 | $sections = wpinv_get_settings_tab_sections( $tab ); |
||
| 471 | $prepared = array(); |
||
| 472 | |||
| 473 | foreach ( $sections as $id => $section ) { |
||
| 474 | |||
| 475 | $data = array( |
||
| 476 | 'id' => sanitize_title( $id ), |
||
| 477 | 'label' => sanitize_text_field( $section ), |
||
| 478 | ); |
||
| 479 | |||
| 480 | $data = $this->add_additional_fields_to_object( $data, $request ); |
||
| 481 | $response = rest_ensure_response( $data ); |
||
| 482 | |||
| 483 | if ( ! is_wp_error( $response ) ) { |
||
| 484 | $links = array( |
||
| 485 | 'settings' => array( |
||
| 486 | 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
||
| 487 | ), |
||
| 488 | 'collection' => array( |
||
| 489 | 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
||
| 490 | ), |
||
| 491 | 'tabs' => array( |
||
| 492 | 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
||
| 493 | ), |
||
| 494 | ); |
||
| 495 | $response->add_links( $links ); |
||
| 496 | $response = $this->prepare_response_for_collection( $response ); |
||
| 497 | } |
||
| 498 | |||
| 499 | $prepared[] = $response; |
||
| 500 | |||
| 501 | } |
||
| 502 | |||
| 503 | return rest_ensure_response( $prepared ); |
||
| 504 | } |
||
| 505 | |||
| 506 | /** |
||
| 507 | * Get all settings. |
||
| 508 | * |
||
| 509 | * @return array |
||
| 510 | */ |
||
| 511 | public function get_settings() { |
||
| 512 | |||
| 513 | if ( empty( $this->settings ) ) { |
||
| 514 | $this->settings = wpinv_get_registered_settings(); |
||
| 515 | } |
||
| 516 | |||
| 517 | return $this->settings; |
||
| 518 | |||
| 519 | } |
||
| 520 | |||
| 521 | /** |
||
| 522 | * Boolean for if a setting type is a valid supported setting type. |
||
| 523 | * |
||
| 524 | * @since 2.0.0 |
||
| 525 | * @param string $type Type. |
||
| 526 | * @return bool |
||
| 527 | */ |
||
| 528 | public function is_setting_type_valid( $type ) { |
||
| 544 | ) |
||
| 545 | ); |
||
| 546 | |||
| 547 | } |
||
| 548 | |||
| 549 | /** |
||
| 550 | * Get the settings schema, conforming to JSON Schema. |
||
| 551 | * |
||
| 552 | * @return array |
||
| 553 | */ |
||
| 554 | public function get_item_schema() { |
||
| 555 | |||
| 556 | // Maybe retrieve the schema from cache. |
||
| 557 | if ( ! empty( $this->schema ) ) { |
||
| 558 | return $this->add_additional_fields_schema( $this->schema ); |
||
| 559 | } |
||
| 560 | |||
| 561 | $schema = array( |
||
| 562 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
||
| 563 | 'title' => 'setting', |
||
| 564 | 'type' => 'object', |
||
| 565 | 'properties' => array( |
||
| 566 | 'id' => array( |
||
| 567 | 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
||
| 568 | 'type' => 'string', |
||
| 569 | 'arg_options' => array( |
||
| 570 | 'sanitize_callback' => 'sanitize_title', |
||
| 571 | ), |
||
| 572 | 'context' => array( 'view', 'edit' ), |
||
| 573 | 'readonly' => true, |
||
| 574 | ), |
||
| 575 | 'tab' => array( |
||
| 576 | 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
||
| 577 | 'type' => 'string', |
||
| 578 | 'arg_options' => array( |
||
| 579 | 'sanitize_callback' => 'sanitize_title', |
||
| 580 | ), |
||
| 581 | 'context' => array( 'view', 'edit' ), |
||
| 582 | 'readonly' => true, |
||
| 583 | ), |
||
| 584 | 'section' => array( |
||
| 585 | 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
||
| 586 | 'type' => 'string', |
||
| 587 | 'arg_options' => array( |
||
| 588 | 'sanitize_callback' => 'sanitize_title', |
||
| 589 | ), |
||
| 590 | 'context' => array( 'view', 'edit' ), |
||
| 591 | 'readonly' => true, |
||
| 592 | ), |
||
| 593 | 'name' => array( |
||
| 594 | 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
||
| 595 | 'type' => 'string', |
||
| 596 | 'arg_options' => array( |
||
| 597 | 'sanitize_callback' => 'sanitize_text_field', |
||
| 598 | ), |
||
| 599 | 'context' => array( 'view', 'edit' ), |
||
| 600 | 'readonly' => true, |
||
| 601 | ), |
||
| 602 | 'desc' => array( |
||
| 603 | 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
||
| 604 | 'type' => 'string', |
||
| 605 | 'context' => array( 'view', 'edit' ), |
||
| 606 | 'readonly' => true, |
||
| 607 | ), |
||
| 608 | 'value' => array( |
||
| 609 | 'description' => __( 'The current value of this setting.', 'invoicing' ), |
||
| 610 | 'type' => 'mixed', |
||
| 611 | 'context' => array( 'view', 'edit' ), |
||
| 612 | ), |
||
| 613 | 'default' => array( |
||
| 614 | 'description' => __( 'Default value for the setting.', 'invoicing' ), |
||
| 615 | 'type' => 'mixed', |
||
| 616 | 'context' => array( 'view', 'edit' ), |
||
| 617 | 'readonly' => true, |
||
| 618 | ), |
||
| 619 | 'placeholder' => array( |
||
| 620 | 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
||
| 621 | 'type' => 'string', |
||
| 622 | 'arg_options' => array( |
||
| 623 | 'sanitize_callback' => 'sanitize_text_field', |
||
| 624 | ), |
||
| 625 | 'context' => array( 'view', 'edit' ), |
||
| 626 | 'readonly' => true, |
||
| 627 | ), |
||
| 628 | 'type' => array( |
||
| 629 | 'description' => __( 'Type of setting.', 'invoicing' ), |
||
| 630 | 'type' => 'string', |
||
| 631 | 'arg_options' => array( |
||
| 632 | 'sanitize_callback' => 'sanitize_text_field', |
||
| 633 | ), |
||
| 634 | 'context' => array( 'view', 'edit' ), |
||
| 635 | 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
||
| 636 | 'readonly' => true, |
||
| 637 | ), |
||
| 638 | 'options' => array( |
||
| 639 | 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
||
| 640 | 'type' => 'object', |
||
| 641 | 'context' => array( 'view', 'edit' ), |
||
| 642 | 'readonly' => true, |
||
| 643 | ), |
||
| 644 | 'readonly' => array( |
||
| 645 | 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
||
| 646 | 'type' => 'string', |
||
| 647 | 'context' => array( 'view' ), |
||
| 648 | 'readonly' => true, |
||
| 649 | ), |
||
| 650 | 'faux' => array( |
||
| 651 | 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
||
| 652 | 'type' => 'string', |
||
| 653 | 'context' => array( 'view' ), |
||
| 654 | 'readonly' => true, |
||
| 655 | ), |
||
| 656 | ), |
||
| 657 | ); |
||
| 658 | |||
| 659 | // Filters the settings schema for the REST API. |
||
| 660 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
||
| 661 | |||
| 662 | // Cache the settings schema. |
||
| 663 | $this->schema = $schema; |
||
| 664 | |||
| 665 | return $this->add_additional_fields_schema( $this->schema ); |
||
| 666 | |||
| 667 | } |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Validate a text value for a text based setting. |
||
| 671 | * |
||
| 672 | * @since 2.0.0 |
||
| 673 | * @param string $value Value. |
||
| 674 | * @param array $setting Setting. |
||
| 675 | * @return string |
||
| 676 | */ |
||
| 677 | public function validate_setting_text_field( $value ) { |
||
| 678 | $value = is_null( $value ) ? '' : $value; |
||
| 679 | return wp_kses_post( trim( stripslashes( $value ) ) ); |
||
| 680 | } |
||
| 681 | |||
| 682 | /** |
||
| 683 | * Validate select based settings. |
||
| 684 | * |
||
| 685 | * @since 2.0.0 |
||
| 686 | * @param string $value Value. |
||
| 687 | * @param array $setting Setting. |
||
| 688 | * @return string|WP_Error |
||
| 689 | */ |
||
| 690 | public function validate_setting_select_field( $value, $setting ) { |
||
| 695 | } |
||
| 696 | } |
||
| 697 | |||
| 698 | /** |
||
| 699 | * Validate multiselect based settings. |
||
| 700 | * |
||
| 701 | * @since 2.0.0 |
||
| 702 | * @param array $values Values. |
||
| 703 | * @param array $setting Setting. |
||
| 704 | * @return array|WP_Error |
||
| 705 | */ |
||
| 706 | public function validate_setting_multiselect_field( $values, $setting ) { |
||
| 723 | } |
||
| 724 | |||
| 725 | /** |
||
| 726 | * Validate radio based settings. |
||
| 727 | * |
||
| 728 | * @since 2.0.0 |
||
| 729 | * @param string $value Value. |
||
| 730 | * @param array $setting Setting. |
||
| 731 | * @return string|WP_Error |
||
| 732 | */ |
||
| 733 | public function validate_setting_radio_field( $value, $setting ) { |
||
| 734 | return $this->validate_setting_select_field( $value, $setting ); |
||
| 735 | } |
||
| 736 | |||
| 737 | /** |
||
| 738 | * Validate checkbox based settings. |
||
| 739 | * |
||
| 740 | * @since 2.0.0 |
||
| 741 | * @param string $value Value. |
||
| 742 | * @return int |
||
| 743 | */ |
||
| 744 | public function validate_setting_checkbox_field( $value ) { |
||
| 746 | } |
||
| 747 | |||
| 748 | /** |
||
| 749 | * Validate textarea based settings. |
||
| 750 | * |
||
| 751 | * @since 2.0.0 |
||
| 752 | * @param string $value Value. |
||
| 753 | * @return string |
||
| 754 | */ |
||
| 755 | public function validate_setting_textarea_field( $value ) { |
||
| 769 | ) |
||
| 770 | ); |
||
| 771 | } |
||
| 772 | |||
| 773 | } |
||
| 774 |
Loading history...