/**
* Callback for administration header.
*
- * @var callback
+ * @var callable
* @since 2.1.0
- * @access private
*/
- var $admin_header_callback;
+ public $admin_header_callback;
/**
* Callback for header div.
*
- * @var callback
+ * @var callable
* @since 3.0.0
- * @access private
*/
- var $admin_image_div_callback;
+ public $admin_image_div_callback;
/**
* Holds default headers.
* @since 3.0.0
* @access private
*/
- var $default_headers = array();
-
- /**
- * Holds custom headers uploaded by the user.
- *
- * @var array
- * @since 3.2.0
- * @access private
- */
- var $uploaded_headers = array();
+ public $default_headers = array();
/**
- * Holds the page menu hook.
- *
- * @var string
+ * Used to trigger a success message when settings updated and set to true.
+ *
* @since 3.0.0
* @access private
+ * @var bool
*/
- var $page = '';
+ private $updated;
/**
* Constructor - Register administration header callback.
*
* @since 2.1.0
- * @param callback $admin_header_callback
- * @param callback $admin_image_div_callback Optional custom image div output callback.
- * @return Custom_Image_Header
+ * @param callable $admin_header_callback
+ * @param callable $admin_image_div_callback Optional custom image div output callback.
*/
- function __construct($admin_header_callback, $admin_image_div_callback = '') {
+ public function __construct($admin_header_callback, $admin_image_div_callback = '') {
$this->admin_header_callback = $admin_header_callback;
$this->admin_image_div_callback = $admin_image_div_callback;
*
* @since 2.1.0
*/
- function init() {
- if ( ! current_user_can('edit_theme_options') )
+ public function init() {
+ $page = add_theme_page( __( 'Header' ), __( 'Header' ), 'edit_theme_options', 'custom-header', array( $this, 'admin_page' ) );
+ if ( ! $page ) {
return;
+ }
- $this->page = $page = add_theme_page(__('Header'), __('Header'), 'edit_theme_options', 'custom-header', array($this, 'admin_page'));
-
- add_action("admin_print_scripts-$page", array($this, 'js_includes'));
- add_action("admin_print_styles-$page", array($this, 'css_includes'));
- add_action("admin_head-$page", array($this, 'help') );
- add_action("admin_head-$page", array($this, 'take_action'), 50);
- add_action("admin_head-$page", array($this, 'js'), 50);
- if ( $this->admin_header_callback )
- add_action("admin_head-$page", $this->admin_header_callback, 51);
-
+ add_action( "admin_print_scripts-$page", array( $this, 'js_includes' ) );
+ add_action( "admin_print_styles-$page", array( $this, 'css_includes' ) );
+ add_action( "admin_head-$page", array( $this, 'help' ) );
+ add_action( "admin_head-$page", array( $this, 'take_action' ), 50 );
+ add_action( "admin_head-$page", array( $this, 'js' ), 50 );
+ if ( $this->admin_header_callback ) {
+ add_action( "admin_head-$page", $this->admin_header_callback, 51 );
+ }
}
/**
*
* @since 3.0.0
*/
- function help() {
+ public function help() {
get_current_screen()->add_help_tab( array(
'id' => 'overview',
'title' => __('Overview'),
get_current_screen()->set_help_sidebar(
'<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
- '<p>' . __( '<a href="http://codex.wordpress.org/Appearance_Header_Screen" target="_blank">Documentation on Custom Header</a>' ) . '</p>' .
+ '<p>' . __( '<a href="https://codex.wordpress.org/Appearance_Header_Screen" target="_blank">Documentation on Custom Header</a>' ) . '</p>' .
'<p>' . __( '<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>' ) . '</p>'
);
}
*
* @return int Current step
*/
- function step() {
+ public function step() {
if ( ! isset( $_GET['step'] ) )
return 1;
*
* @since 2.1.0
*/
- function js_includes() {
+ public function js_includes() {
$step = $this->step();
if ( ( 1 == $step || 3 == $step ) ) {
*
* @since 2.7.0
*/
- function css_includes() {
+ public function css_includes() {
$step = $this->step();
if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) )
*
* @since 2.6.0
*/
- function take_action() {
+ public function take_action() {
if ( ! current_user_can('edit_theme_options') )
return;
* Process the default headers
*
* @since 3.0.0
+ *
+ * @global array $_wp_default_headers
*/
- function process_default_headers() {
+ public function process_default_headers() {
global $_wp_default_headers;
- if ( !empty($this->headers) )
- return;
-
if ( !isset($_wp_default_headers) )
return;
*
* @since 3.0.0
*/
- function show_header_selector( $type = 'default' ) {
+ public function show_header_selector( $type = 'default' ) {
if ( 'default' == $type ) {
$headers = $this->default_headers;
} else {
if ( 1 < count( $headers ) ) {
echo '<div class="random-header">';
echo '<label><input name="default-header" type="radio" value="random-' . $type . '-image"' . checked( is_random_header_image( $type ), true, false ) . ' />';
- echo __( '<strong>Random:</strong> Show a different image on each page.' );
+ _e( '<strong>Random:</strong> Show a different image on each page.' );
echo '</label>';
echo '</div>';
}
$header_thumbnail = $header['thumbnail_url'];
$header_url = $header['url'];
$header_desc = empty( $header['description'] ) ? '' : $header['description'];
+ $header_alt_text = empty( $header['alt_text'] ) ? $header_desc : $header['alt_text'];
echo '<div class="default-header">';
echo '<label><input name="default-header" type="radio" value="' . esc_attr( $header_key ) . '" ' . checked( $header_url, get_theme_mod( 'header_image' ), false ) . ' />';
$width = '';
if ( !empty( $header['attachment_id'] ) )
$width = ' width="230"';
- echo '<img src="' . set_url_scheme( $header_thumbnail ) . '" alt="' . esc_attr( $header_desc ) .'" title="' . esc_attr( $header_desc ) . '"' . $width . ' /></label>';
+ echo '<img src="' . set_url_scheme( $header_thumbnail ) . '" alt="' . esc_attr( $header_alt_text ) .'" title="' . esc_attr( $header_desc ) . '"' . $width . ' /></label>';
echo '</div>';
}
echo '<div class="clear"></div></div>';
}
/**
- * Execute Javascript depending on step.
+ * Execute JavaScript depending on step.
*
* @since 2.1.0
*/
- function js() {
+ public function js() {
$step = $this->step();
if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) )
$this->js_1();
}
/**
- * Display Javascript based on Step 1 and 3.
+ * Display JavaScript based on Step 1 and 3.
*
* @since 2.6.0
*/
- function js_1() { ?>
+ public function js_1() {
+ $default_color = '';
+ if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
+ $default_color = get_theme_support( 'custom-header', 'default-text-color' );
+ if ( $default_color && false === strpos( $default_color, '#' ) ) {
+ $default_color = '#' . $default_color;
+ }
+ }
+ ?>
<script type="text/javascript">
-/* <![CDATA[ */
(function($){
- var default_color = '#<?php echo get_theme_support( 'custom-header', 'default-text-color' ); ?>',
+ var default_color = '<?php echo $default_color; ?>',
header_text_fields;
function pickColor(color) {
<?php endif; ?>
});
})(jQuery);
-/* ]]> */
</script>
<?php
}
/**
- * Display Javascript based on Step 2.
+ * Display JavaScript based on Step 2.
*
* @since 2.6.0
*/
- function js_2() { ?>
+ public function js_2() { ?>
<script type="text/javascript">
-/* <![CDATA[ */
function onEndCrop( coords ) {
jQuery( '#x1' ).val(coords.x);
jQuery( '#y1' ).val(coords.y);
}
});
});
-/* ]]> */
</script>
<?php
}
*
* @since 2.1.0
*/
- function step_1() {
+ public function step_1() {
$this->process_default_headers();
?>
<div class="wrap">
-<h2><?php _e( 'Custom Header' ); ?></h2>
+<h1><?php _e( 'Custom Header' ); ?></h1>
+
+<?php if ( current_user_can( 'customize' ) ) { ?>
+<div class="notice notice-info hide-if-no-customize">
+ <p>
+ <?php
+ printf(
+ __( 'You can now manage and live-preview Custom Header in the <a href="%1$s">Customizer</a>.' ),
+ admin_url( 'customize.php?autofocus[control]=header_image' )
+ );
+ ?>
+ </p>
+</div>
+<?php } ?>
<?php if ( ! empty( $this->updated ) ) { ?>
<div id="message" class="updated">
call_user_func( $this->admin_image_div_callback );
} else {
$custom_header = get_custom_header();
- $header_image_style = 'background-image:url(' . esc_url( get_header_image() ) . ');';
+ $header_image = get_header_image();
+
+ if ( $header_image ) {
+ $header_image_style = 'background-image:url(' . esc_url( $header_image ) . ');';
+ } else {
+ $header_image_style = '';
+ }
+
if ( $custom_header->width )
$header_image_style .= 'max-width:' . $custom_header->width . 'px;';
if ( $custom_header->height )
else
$style = ' style="display:none;"';
?>
- <h1><a id="name" class="displaying-header-text" <?php echo $style; ?> onclick="return false;" href="<?php bloginfo('url'); ?>"><?php bloginfo( 'name' ); ?></a></h1>
+ <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>
<div id="desc" class="displaying-header-text" <?php echo $style; ?>><?php bloginfo( 'description' ); ?></div>
</div>
<?php } ?>
</tr>
<?php endif; ?>
-<?php if ( current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
+<?php if ( current_user_can( 'upload_files' ) && current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
<tr>
<th scope="row"><?php _e( 'Select Image' ); ?></th>
<td>
?>
<p>
<label for="choose-from-library-link"><?php _e( 'Or choose an image from your media library:' ); ?></label><br />
- <a id="choose-from-library-link" class="button"
+ <button id="choose-from-library-link" class="button"
data-update-link="<?php echo esc_attr( $modal_update_href ); ?>"
data-choose="<?php esc_attr_e( 'Choose a Custom Header' ); ?>"
- data-update="<?php esc_attr_e( 'Set as header' ); ?>"><?php _e( 'Choose Image' ); ?></a>
+ data-update="<?php esc_attr_e( 'Set as header' ); ?>"><?php _e( 'Choose Image' ); ?></button>
</p>
</form>
</td>
</table>
<form method="post" action="<?php echo esc_url( add_query_arg( 'step', 1 ) ) ?>">
+<?php submit_button( null, 'screen-reader-text', 'save-header-options', false ); ?>
<table class="form-table">
<tbody>
<?php if ( get_uploaded_header_images() ) : ?>
<th scope="row"><?php _e( 'Text Color' ); ?></th>
<td>
<p>
-<?php
-$header_textcolor = display_header_text() ? get_header_textcolor() : get_theme_support( 'custom-header', 'default-text-color' );
-$default_color = '';
-if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
- $default_color = '#' . get_theme_support( 'custom-header', 'default-text-color' );
- $default_color_attr = ' data-default-color="' . esc_attr( $default_color ) . '"';
- echo '<input type="text" name="text-color" id="text-color" value="#' . esc_attr( $header_textcolor ) . '"' . $default_color_attr . ' />';
- if ( $default_color )
- echo ' <span class="description hide-if-js">' . sprintf( _x( 'Default: %s', 'color' ), $default_color ) . '</span>';
-}
-?>
+ <?php
+ $default_color = '';
+ if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
+ $default_color = get_theme_support( 'custom-header', 'default-text-color' );
+ if ( $default_color && false === strpos( $default_color, '#' ) ) {
+ $default_color = '#' . $default_color;
+ }
+ }
+
+ $default_color_attr = $default_color ? ' data-default-color="' . esc_attr( $default_color ) . '"' : '';
+
+ $header_textcolor = display_header_text() ? get_header_textcolor() : get_theme_support( 'custom-header', 'default-text-color' );
+ if ( $header_textcolor && false === strpos( $header_textcolor, '#' ) ) {
+ $header_textcolor = '#' . $header_textcolor;
+ }
+
+ echo '<input type="text" name="text-color" id="text-color" value="' . esc_attr( $header_textcolor ) . '"' . $default_color_attr . ' />';
+ if ( $default_color ) {
+ echo ' <span class="description hide-if-js">' . sprintf( _x( 'Default: %s', 'color' ), esc_html( $default_color ) ) . '</span>';
+ }
+ ?>
</p>
</td>
</tr>
*
* @since 2.1.0
*/
- function step_2() {
+ public function step_2() {
check_admin_referer('custom-header-upload', '_wpnonce-custom-header-upload');
- if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
- wp_die( __( 'Cheatin’ uh?' ) );
+ if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
+ wp_die(
+ '<h1>' . __( 'Cheatin’ uh?' ) . '</h1>' .
+ '<p>' . __( 'The current theme does not support uploading a custom header image.' ) . '</p>',
+ 403
+ );
+ }
if ( empty( $_POST ) && isset( $_GET['file'] ) ) {
$attachment_id = absint( $_GET['file'] );
$file = get_attached_file( $attachment_id, true );
- $url = wp_get_attachment_image_src( $attachment_id, 'full');
+ $url = wp_get_attachment_image_src( $attachment_id, 'full' );
$url = $url[0];
} elseif ( isset( $_POST ) ) {
- extract($this->step_2_manage_upload());
+ $data = $this->step_2_manage_upload();
+ $attachment_id = $data['attachment_id'];
+ $file = $data['file'];
+ $url = $data['url'];
}
if ( file_exists( $file ) ) {
?>
<div class="wrap">
-<h2><?php _e( 'Crop Header Image' ); ?></h2>
+<h1><?php _e( 'Crop Header Image' ); ?></h1>
<form method="post" action="<?php echo esc_url(add_query_arg('step', 3)); ?>">
<p class="hide-if-no-js"><?php _e('Choose the part of the image you want to use as your header.'); ?></p>
- <p class="hide-if-js"><strong><?php _e( 'You need Javascript to choose a part of the image.'); ?></strong></p>
+ <p class="hide-if-js"><strong><?php _e( 'You need JavaScript to choose a part of the image.'); ?></strong></p>
<div id="crop_image" style="position: relative">
- <img src="<?php echo esc_url( $url ); ?>" id="upload" width="<?php echo $width; ?>" height="<?php echo $height; ?>" />
+ <img src="<?php echo esc_url( $url ); ?>" id="upload" width="<?php echo $width; ?>" height="<?php echo $height; ?>" alt="" />
</div>
<input type="hidden" name="x1" id="x1" value="0"/>
*
* @since 3.4.0
*/
- function step_2_manage_upload() {
+ public function step_2_manage_upload() {
$overrides = array('test_form' => false);
$uploaded_file = $_FILES['import'];
- $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'], false );
+ $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'] );
if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
* Display third step of custom header image page.
*
* @since 2.1.0
+ * @since 4.4.0 Switched to using wp_get_attachment_url() instead of the guid
+ * for retrieving the header image URL.
*/
- function step_3() {
+ public function step_3() {
check_admin_referer( 'custom-header-crop-image' );
- if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
- wp_die( __( 'Cheatin’ uh?' ) );
+ if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
+ wp_die(
+ '<h1>' . __( 'Cheatin’ uh?' ) . '</h1>' .
+ '<p>' . __( 'The current theme does not support uploading a custom header image.' ) . '</p>',
+ 403
+ );
+ }
- if ( ! empty( $_POST['skip-cropping'] ) && ! ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) )
- wp_die( __( 'Cheatin’ uh?' ) );
+ if ( ! empty( $_POST['skip-cropping'] ) && ! ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) ) {
+ wp_die(
+ '<h1>' . __( 'Cheatin’ uh?' ) . '</h1>' .
+ '<p>' . __( 'The current theme does not support a flexible sized header image.' ) . '</p>',
+ 403
+ );
+ }
if ( $_POST['oitar'] > 1 ) {
$_POST['x1'] = $_POST['x1'] * $_POST['oitar'];
// Update the attachment
$attachment_id = $this->insert_attachment( $object, $cropped );
- $url = $object['guid'];
+ $url = wp_get_attachment_url( $attachment_id );
$this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
- // cleanup
+ // Cleanup.
$medium = str_replace( basename( $original ), 'midsize-' . basename( $original ), $original );
if ( file_exists( $medium ) ) {
- /**
- * Filter the path of the file to delete.
- *
- * @since 2.1.0
- *
- * @param string $medium Path to the file to delete.
- */
- @unlink( apply_filters( 'wp_delete_file', $medium ) );
+ wp_delete_file( $medium );
}
if ( empty( $_POST['create-new-attachment'] ) && empty( $_POST['skip-cropping'] ) ) {
- /** This filter is documented in wp-admin/custom-header.php */
- @unlink( apply_filters( 'wp_delete_file', $original ) );
+ wp_delete_file( $original );
}
return $this->finished();
*
* @since 2.1.0
*/
- function finished() {
+ public function finished() {
$this->updated = true;
$this->step_1();
}
*
* @since 2.1.0
*/
- function admin_page() {
+ public function admin_page() {
if ( ! current_user_can('edit_theme_options') )
wp_die(__('You do not have permission to customize headers.'));
$step = $this->step();
* Unused since 3.5.0.
*
* @since 3.4.0
+ *
+ * @param array $form_fields
+ * @return array $form_fields
*/
- function attachment_fields_to_edit( $form_fields ) {
+ public function attachment_fields_to_edit( $form_fields ) {
return $form_fields;
}
* Unused since 3.5.0.
*
* @since 3.4.0
+ *
+ * @param array $tabs
+ * @return array $tabs
*/
- function filter_upload_tabs( $tabs ) {
+ public function filter_upload_tabs( $tabs ) {
return $tabs;
}
* Or an array of arguments: attachment_id, url, width, height. All are required.
*
* @since 3.4.0
+ *
+ * @param array|object|string $choice
*/
final public function set_header_image( $choice ) {
if ( is_array( $choice ) || is_object( $choice ) ) {
* @since 3.4.0
*/
final public function remove_header_image() {
- return $this->set_header_image( 'remove-header' );
+ $this->set_header_image( 'remove-header' );
}
/**
$this->process_default_headers();
$default = get_theme_support( 'custom-header', 'default-image' );
- if ( ! $default )
- return $this->remove_header_image();
-
+ if ( ! $default ) {
+ $this->remove_header_image();
+ return;
+ }
$default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
$default_data = array();
/**
* Calculate width and height based on what the currently selected theme supports.
*
+ * @param array $dimensions
* @return array dst_height and dst_width of header image.
*/
final public function get_header_dimensions( $dimensions ) {
$has_flex_width = current_theme_supports( 'custom-header', 'flex-width' );
$has_flex_height = current_theme_supports( 'custom-header', 'flex-height' );
$has_max_width = current_theme_supports( 'custom-header', 'max-width' ) ;
- $dst = array( 'dst_height' => null, 'dst_height' => null );
+ $dst = array( 'dst_height' => null, 'dst_width' => null );
// For flex, limit size of image displayed to 1500px unless theme says otherwise
if ( $has_flex_width ) {
/**
* Create an attachment 'object'.
*
- * @param string $cropped Cropped image URL.
- * @param int $parent_attachment_id Attachment ID of parent image.
+ * @param string $cropped Cropped image URL.
+ * @param int $parent_attachment_id Attachment ID of parent image.
*
* @return array Attachment object.
*/
final public function create_attachment_object( $cropped, $parent_attachment_id ) {
$parent = get_post( $parent_attachment_id );
- $parent_url = $parent->guid;
+ $parent_url = wp_get_attachment_url( $parent->ID );
$url = str_replace( basename( $parent_url ), basename( $cropped ), $parent_url );
$size = @getimagesize( $cropped );
$object = array(
'ID' => $parent_attachment_id,
'post_title' => basename($cropped),
- 'post_content' => $url,
'post_mime_type' => $image_type,
'guid' => $url,
'context' => 'custom-header'
}
/**
- * Insert an attachment & its metadata.
+ * Insert an attachment and its metadata.
*
- * @param array $object Attachment object.
+ * @param array $object Attachment object.
* @param string $cropped Cropped image URL.
*
* @return int Attachment ID.
$attachment_id = wp_insert_attachment( $object, $cropped );
$metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
/**
- * Allows us to insert custom meta data for an attachment.
+ * Filter the header image attachment metadata.
+ *
+ * @since 3.9.0
+ *
+ * @see wp_generate_attachment_metadata()
*
+ * @param array $metadata Attachment metadata.
*/
$metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata );
wp_update_attachment_metadata( $attachment_id, $metadata );
* Gets attachment uploaded by Media Manager, crops it, then saves it as a
* new object. Returns JSON-encoded object details.
*/
- function ajax_header_crop() {
+ public function ajax_header_crop() {
check_ajax_referer( 'image_editor-' . $_POST['id'], 'nonce' );
if ( ! current_user_can( 'edit_theme_options' ) ) {
wp_send_json_error( array( 'message' => __( 'Image could not be processed. Please go back and try again.' ) ) );
}
+ /** This filter is documented in wp-admin/custom-header.php */
$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication
$object = $this->create_attachment_object( $cropped, $attachment_id );
$new_attachment_id = $this->insert_attachment( $object, $cropped );
$object['attachment_id'] = $new_attachment_id;
+ $object['url'] = wp_get_attachment_url( $new_attachment_id );;
$object['width'] = $dimensions['dst_width'];
$object['height'] = $dimensions['dst_height'];
* Triggered when the user tries adds a new header image from the
* Media Manager, even if s/he doesn't save that change.
*/
- function ajax_header_add() {
+ public function ajax_header_add() {
check_ajax_referer( 'header-add', 'nonce' );
if ( ! current_user_can( 'edit_theme_options' ) ) {
* Triggered when the user clicks the overlay "X" button next to each image
* choice in the Customizer's Header tool.
*/
- function ajax_header_remove() {
+ public function ajax_header_remove() {
check_ajax_referer( 'header-remove', 'nonce' );
if ( ! current_user_can( 'edit_theme_options' ) ) {
wp_send_json_success();
}
- function customize_set_last_used( $wp_customize ) {
+ /**
+ *
+ * @param WP_Customize_Manager $wp_customize
+ */
+ public function customize_set_last_used( $wp_customize ) {
$data = $wp_customize->get_setting( 'header_image_data' )->post_value();
if ( ! isset( $data['attachment_id'] ) ) {
update_post_meta( $attachment_id, $key, time() );
}
+ /**
+ *
+ * @return array
+ */
public function get_default_header_images() {
$this->process_default_headers();
);
// The rest of the set comes after.
- $header_images = array_merge( $header_images, $this->default_headers );
- return $header_images;
+ return array_merge( $header_images, $this->default_headers );
}
+ /**
+ *
+ * @return array
+ */
public function get_uploaded_header_images() {
$header_images = get_uploaded_header_images();
$timestamp_key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();