Custom_Image_Header::step_1()

Hooks fired · 1

One hook fires while Custom_Image_Header::step_1() runs, in this order:

1. 1
   do_action( custom_header_options )actionline 811 (+304 into the body)

   Fires just before the submit button in the custom header options form.

Uses · 30

• _e()Displays translated text.
• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• admin_url()Retrieves the URL to the admin area for the current site.
• wp_admin_notice()Outputs an admin notice.
• esc_url()Checks and cleans a URL.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• get_custom_header()Gets the header image data.
• display_header_text()Whether to display the header text.
• get_header_image()Retrieves header image for custom header.
• get_header_textcolor()Retrieves the custom header text color in 3- or 6-digit hexadecimal form.
• bloginfo()Displays information about the current site.

Used by · 2

• Custom_Image_Header::admin_page()Displays the page based on the current step.
• Custom_Image_Header::finished()Displays last step of custom header image page.

Source

View on Trac ↗View on GitHub ↗

507	public function step_1() {508		$this->process_default_headers();509		?>510 511<div class="wrap">512<h1><?php _e( 'Custom Header' ); ?></h1>513 514		<?php515		if ( current_user_can( 'customize' ) ) {516			$message = sprintf(517				/* translators: %s: URL to header image configuration in Customizer. */518				__( 'You can now manage and live-preview Custom Header in the <a href="%s">Customizer</a>.' ),519				admin_url( 'customize.php?autofocus[control]=header_image' )520			);521			wp_admin_notice(522				$message,523				array(524					'type'               => 'info',525					'additional_classes' => array( 'hide-if-no-customize' ),526				)527			);528		}529 530		if ( ! empty( $this->updated ) ) {531			$updated_message = sprintf(532				/* translators: %s: Home URL. */533				__( 'Header updated. <a href="%s">Visit your site</a> to see how it looks.' ),534				esc_url( home_url( '/' ) )535			);536			wp_admin_notice(537				$updated_message,538				array(539					'id'                 => 'message',540					'additional_classes' => array( 'updated' ),541				)542			);543		}544		?>545 546<h2><?php _e( 'Header Image' ); ?></h2>547 548<table class="form-table" role="presentation">549<tbody>550 551		<?php if ( get_custom_header() || display_header_text() ) : ?>552<tr>553<th scope="row"><?php _e( 'Preview' ); ?></th>554<td>555			<?php556			if ( $this->admin_image_div_callback ) {557				call_user_func( $this->admin_image_div_callback );558			} else {559				$custom_header = get_custom_header();560				$header_image  = get_header_image();561 562				if ( $header_image ) {563					$header_image_style = 'background-image:url(' . esc_url( $header_image ) . ');';564				} else {565					$header_image_style = '';566				}567 568				if ( $custom_header->width ) {569					$header_image_style .= 'max-width:' . $custom_header->width . 'px;';570				}571				if ( $custom_header->height ) {572					$header_image_style .= 'height:' . $custom_header->height . 'px;';573				}574				?>575	<div id="headimg" style="<?php echo $header_image_style; ?>">576				<?php577				if ( display_header_text() ) {578					$style = ' style="color:#' . get_header_textcolor() . ';"';579				} else {580					$style = ' style="display:none;"';581				}582				?>583		<h1><a id="name" class="displaying-header-text" <?php echo $style; ?> onclick="return false;" href="<?php bloginfo( 'url' ); ?>" tabindex="-1"><?php bloginfo( 'name' ); ?></a></h1>584		<div id="desc" class="displaying-header-text" <?php echo $style; ?>><?php bloginfo( 'description' ); ?></div>585	</div>586			<?php } ?>

History

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/class-custom-image-header.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.