PHP Class WC_Admin_Settings

Afficher le fichier Open project: woocommerce/woocommerce Class Usage Examples

Méthodes publiques

Méthode Description
add_error ( string $text ) Add an error.
add_message ( string $text ) Add a message.
check_download_folder_protection ( ) Checks which method we're using to serve downloads.
get_field_description ( array $value ) : array Helper function to get the formated description and tip HTML for a given form field. Plugins can call this when implementing their own custom settings types.
get_option ( mixed $option_name, $default = '' ) : string Get a setting from the settings API.
get_settings_pages ( ) Include the settings page classes.
output ( ) Settings page.
output_fields ( array $options ) Output admin fields.
save ( ) Save the settings.
save_fields ( array $options, array $data = null ) : boolean Save admin fields.
show_messages ( ) : string Output messages + errors.

Method Details

add_error() public static méthode

Add an error.
public static add_error ( string $text )
$text string

add_message() public static méthode

Add a message.
public static add_message ( string $text )
$text string

check_download_folder_protection() public static méthode

If using force or x-sendfile, this ensures the .htaccess is in place.
public static check_download_folder_protection ( )

get_field_description() public static méthode

Helper function to get the formated description and tip HTML for a given form field. Plugins can call this when implementing their own custom settings types.
public static get_field_description ( array $value ) : array
$value array The form field value array
Résultat array The description and tip as a 2 element array

get_option() public static méthode

Get a setting from the settings API.
public static get_option ( mixed $option_name, $default = '' ) : string
$option_name mixed
Résultat string

get_settings_pages() public static méthode

Include the settings page classes.
public static get_settings_pages ( )

output() public static méthode

Handles the display of the main woocommerce settings page in admin.
public static output ( )

output_fields() public static méthode

Loops though the woocommerce options array and outputs each field.
public static output_fields ( array $options )
$options array Opens array to output

save() public static méthode

Save the settings.
public static save ( )

save_fields() public static méthode

Loops though the woocommerce options array and outputs each field.
public static save_fields ( array $options, array $data = null ) : boolean
$options array Options array to output
$data array Optional. Data to use for saving. Defaults to $_POST.
Résultat boolean

show_messages() public static méthode

Output messages + errors.
public static show_messages ( ) : string
Résultat string