• 홈
• WC_Settings_API

PHP 클래스 WC_Settings_API

파일 보기 프로젝트 열기: woocommerce/woocommerce 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$errors		Validation errors.
$form_fields	array	Form option fields.
$id	string	ID of the class extending the settings API. Used in option names.
$plugin_id	string	The plugin ID. Used for option names.
$settings	array	Setting values.

보호된 프로퍼티들

프로퍼티	타입	설명
$data	array	The posted settings data. When empty, $_POST data will be used.

공개 메소드들

메소드	설명
add_error ( string $error )	Add an error message for display in admin on save.
admin_options ( )	Output the admin options table.
display_errors ( )	Display admin error messages.
format_settings ( array $value ) : array	Format settings if needed.
generate_checkbox_html ( mixed $key, mixed $data ) : string	Generate Checkbox HTML.
generate_color_html ( mixed $key, mixed $data ) : string	Generate Color Picker Input HTML.
generate_decimal_html ( mixed $key, mixed $data ) : string	Generate Decimal Input HTML.
generate_multiselect_html ( mixed $key, mixed $data ) : string	Generate Multiselect HTML.
generate_password_html ( mixed $key, mixed $data ) : string	Generate Password Input HTML.
generate_price_html ( mixed $key, mixed $data ) : string	Generate Price Input HTML.
generate_select_html ( mixed $key, mixed $data ) : string	Generate Select HTML.
generate_settings_html ( array $form_fields = [], $echo = true ) : string	Generate Settings HTML.
generate_text_html ( mixed $key, mixed $data ) : string	Generate Text Input HTML.
generate_textarea_html ( mixed $key, mixed $data ) : string	Generate Textarea HTML.
generate_title_html ( mixed $key, mixed $data ) : string	Generate Title HTML.
get_custom_attribute_html ( array $data ) : string	Get custom attributes.
get_description_html ( array $data ) : string	Get HTML for descriptions.
get_errors ( )	Get admin error messages.
get_field_default ( array $field ) : string	Get a fields default value. Defaults to "" if not set.
get_field_key ( mixed $key ) : string	Prefix key for settings.
get_field_type ( array $field ) : string	Get a fields type. Defaults to "text" if not set.
get_field_value ( string $key, array $field, array $post_data = [] ) : string	Get a field's posted and validated value.
get_form_fields ( ) : array	Get the form fields after they are initialized.
get_option ( string $key, mixed $empty_value = null ) : string	get_option function.
get_option_key ( ) : string	Return the name of the option in the WP DB.
get_post_data ( ) : array	Returns the POSTed data, to be used to save the settings.
get_tooltip_html ( array $data ) : string	Get HTML for tooltips.
init_form_fields ( ) : string	Initialise settings form fields.
init_settings ( )	Initialise Settings.
process_admin_options ( ) : boolean	Processes and saves options.
set_post_data ( $data = [] )	Sets the POSTed data. This method can be used to set specific data, instead of taking it from the $_POST array.
validate_checkbox_field ( string $key, string | null $value ) : string	Validate Checkbox Field.
validate_decimal_field ( string $key, string | null $value ) : string	Validate Decimal Field.
validate_multiselect_field ( string $key, string $value ) : string	Validate Multiselect Field.
validate_password_field ( string $key, string | null $value ) : string	Validate Password Field. No input sanitization is used to avoid corrupting passwords.
validate_price_field ( string $key, string | null $value ) : string	Validate Price Field.
validate_select_field ( string $key, string $value ) : string	Validate Select Field.
validate_settings_fields ( $form_fields = [] )	Validate the data on the "Settings" form.
validate_text_field ( string $key, string | null $value ) : string	Validate Text Field.
validate_textarea_field ( string $key, string | null $value ) : string	Validate Textarea Field.

보호된 메소드들

메소드	설명
set_defaults ( $field )	Set default required properties for each field.

메소드 상세

프로퍼티 상세