checked( mixed $checked, mixed $current = true, bool $echo = true )

Outputs the html checked attribute.

Contents

Description Description

Compares the first two arguments and if identical marks as checked

Parameters Parameters

$checked

(mixed) (Required) One of the values to compare

$current

(mixed) (Optional) (true) The other value to compare if not just true

Default value: true

$echo

(bool) (Optional) Whether to echo or just return the string

Default value: true

Top ↑

Return Return

(string) html attribute or empty string

Top ↑

Source Source

File: wp-includes/general-template.php 

function checked( $checked, $current = true, $echo = true ) {
	return __checked_selected_helper( $checked, $current, $echo, 'checked' );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/class-wp-screen.php: WP_Screen::render_meta_boxes_preferences()

Render the meta boxes preferences.
wp-admin/includes/class-wp-screen.php: WP_Screen::render_list_table_columns_preferences()

Render the list table columns preferences.
wp-admin/includes/class-wp-screen.php: WP_Screen::render_view_mode()

Render the list table view mode preferences.
wp-signup.php: signup_user()

Setup the new user signup process
wp-admin/includes/network.php: network_step1()

Prints step 1 for Network installation process.
wp-admin/install.php: display_setup_form()

Display installer setup form.
wp-admin/includes/user.php: use_ssl_preference()

Optional SSL preference that can be turned on by hooking to the ‘personal_options’ action.
wp-admin/includes/class-wp-screen.php: WP_Screen::show_screen_options()
wp-admin/includes/class-wp-screen.php: WP_Screen::render_screen_layout()

Render the option for number of columns on the page
wp-admin/includes/screen.php: meta_box_prefs()

Prints the meta box preferences for screen meta.
wp-admin/includes/misc.php: admin_color_scheme_picker()

Display the default admin color scheme picker (Used in user-edit.php)
wp-admin/includes/class-walker-category-checklist.php: Walker_Category_Checklist::start_el()

Start the element output.
wp-admin/includes/media.php: wp_media_insert_url_form()

Creates the form for external url
wp-admin/includes/meta-boxes.php: post_comment_status_meta_box()

Display comments status form fields.
wp-admin/includes/meta-boxes.php: link_submit_meta_box()

Display link create form fields.
wp-admin/includes/meta-boxes.php: post_submit_meta_box()

Displays post submit form fields.
wp-admin/includes/meta-boxes.php: post_format_meta_box()

Display post format form elements.
wp-admin/includes/class-walker-nav-menu-edit.php: Walker_Nav_Menu_Edit::start_el()

Start the element output.
wp-admin/includes/file.php: request_filesystem_credentials()

Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
wp-admin/custom-header.php: Custom_Image_Header::step_1()

Display first step of custom header image page.
wp-admin/custom-header.php: Custom_Image_Header::show_header_selector()

Display UI for selecting one of several default headers.
wp-admin/custom-background.php: Custom_Background::admin_page()

Display the custom background page.
wp-includes/widgets/class-wp-widget-tag-cloud.php: WP_Widget_Tag_Cloud::form()

Outputs the Tag Cloud widget settings form.
wp-includes/widgets/class-wp-widget-categories.php: WP_Widget_Categories::form()

Outputs the settings form for the Categories widget.
wp-includes/widgets/class-wp-widget-recent-posts.php: WP_Widget_Recent_Posts::form()

Outputs the settings form for the Recent Posts widget.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::form()

Outputs the Text widget settings form.
wp-includes/widgets/class-wp-widget-archives.php: WP_Widget_Archives::form()

Outputs the settings form for the Archives widget.
wp-includes/widgets/class-wp-widget-links.php: WP_Widget_Links::form()

Outputs the settings form for the Links widget.
wp-includes/widgets.php: wp_widget_rss_form()

Display RSS widget options form.
wp-includes/class-wp-customize-control.php: WP_Customize_Control::render_content()

Render the control’s content.
Show 25 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

    <?php

// Get an array of options from the database.
$options = get_option( 'slug_option' );

// Get the value of this option.
$checked = $options['self-destruct'];

// The value to compare with (the value of the checkbox below).
$current = 1; 

// True by default, just here to make things clear.
$echo = true;

?>
<input name="slug-option[self-destruct]" value="1"
	<?php checked( $checked, $current, $echo ); ?>/>

    Expand full source codeCollapse full source code

    Testing the value with if():

    <input type='checkbox' name='options[postlink]' value='1'
	<?php if ( 1 == $options['postlink'] ) echo 'checked="checked"'; ?> />

    Using checked() instead:

    <input type="checkbox" name="options[postlink]" value="1"
	<?php checked( $options['postlink'], 1 ); ?> />

You must log in before being able to contribute a note or feedback.