enmi-conf.org: comparison wp/wp-admin/includes/class-custom-image-header.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 /**
 * The custom header image class.
 *
 * @since 2.1.0
 */
+#[AllowDynamicProperties]
 class Custom_Image_Header {
 	/**
 	 * Callback for administration header.
 	 *
 	 * @var bool
 	 */
 	private $updated;
 	/**
-	 * Constructor - Register administration header callback.
+	 * Constructor - Registers administration header callback.
 	 *
 	 * @since 2.1.0
-	 * @param callable $admin_header_callback
+	 *
-	 * @param callable $admin_image_div_callback Optional custom image div output callback.
+	 * @param callable $admin_header_callback    Administration header callback.
+	 * @param callable $admin_image_div_callback Optional. Custom image div output callback.
+	 *                                           Default empty string.
 	 */
 	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;
 		add_action( 'wp_ajax_custom-header-add', array( $this, 'ajax_header_add' ) );
 		add_action( 'wp_ajax_custom-header-remove', array( $this, 'ajax_header_remove' ) );
 	}
 	/**
-	 * Set up the hooks for the Custom Header admin page.
+	 * Sets up the hooks for the Custom Header admin page.
 	 *
 	 * @since 2.1.0
 	 */
 	public function init() {
-		$page = add_theme_page( __( 'Header' ), __( 'Header' ), 'edit_theme_options', 'custom-header', array( $this, 'admin_page' ) );
+		$page = add_theme_page(
+			_x( 'Header', 'custom image header' ),
+			_x( 'Header', 'custom image header' ),
+			'edit_theme_options',
+			'custom-header',
+			array( $this, 'admin_page' )
+		);
 		if ( ! $page ) {
 			return;
 		}
 		);
 		get_current_screen()->set_help_sidebar(
 			'<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
 			'<p>' . __( '<a href="https://codex.wordpress.org/Appearance_Header_Screen">Documentation on Custom Header</a>' ) . '</p>' .
-			'<p>' . __( '<a href="https://wordpress.org/support/">Support</a>' ) . '</p>'
+			'<p>' . __( '<a href="https://wordpress.org/support/forums/">Support forums</a>' ) . '</p>'
 		);
 	}
 	/**
-	 * Get the current step.
+	 * Gets the current step.
 	 *
 	 * @since 2.6.0
 	 *
 	 * @return int Current step.
 	 */
 		return $step;
 	}
 	/**
-	 * Set up the enqueue for the JavaScript files.
+	 * Sets up the enqueue for the JavaScript files.
 	 *
 	 * @since 2.1.0
 	 */
 	public function js_includes() {
 		$step = $this->step();
 			wp_enqueue_script( 'imgareaselect' );
 		}
 	}
 	/**
-	 * Set up the enqueue for the CSS files
+	 * Sets up the enqueue for the CSS files.
 	 *
 	 * @since 2.7.0
 	 */
 	public function css_includes() {
 		$step = $this->step();
 			wp_enqueue_style( 'imgareaselect' );
 		}
 	}
 	/**
-	 * Execute custom header modification.
+	 * Executes custom header modification.
 	 *
 	 * @since 2.6.0
 	 */
 	public function take_action() {
 		if ( ! current_user_can( 'edit_theme_options' ) ) {
 			return;
 		}
 	}
 	/**
-	 * Process the default headers
+	 * Processes the default headers.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @global array $_wp_default_headers
 	 */
 			);
 		}
 	}
 	/**
-	 * Display UI for selecting one of several default headers.
+	 * Displays UI for selecting one of several default headers.
 	 *
-	 * Show the random image option if this theme has multiple header images.
+	 * Shows the random image option if this theme has multiple header images.
 	 * Random image option is on by default if no header has been set.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param string $type The header type. One of 'default' (for the Uploaded Images control)
 			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_alt_text ) . '"' . $width . ' /></label>';
+			echo '<img src="' . esc_url( set_url_scheme( $header_thumbnail ) ) . '" alt="' . esc_attr( $header_alt_text ) . '"' . $width . ' /></label>';
 			echo '</div>';
 		}
 		echo '<div class="clear"></div></div>';
 	}
 	/**
-	 * Execute JavaScript depending on step.
+	 * Executes JavaScript depending on step.
 	 *
 	 * @since 2.1.0
 	 */
 	public function js() {
 		$step = $this->step();
 			$this->js_2();
 		}
 	}
 	/**
-	 * Display JavaScript based on Step 1 and 3.
+	 * Displays JavaScript based on Step 1 and 3.
 	 *
 	 * @since 2.6.0
 	 */
 	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, '#' ) ) {
+			if ( $default_color && ! str_contains( $default_color, '#' ) ) {
 				$default_color = '#' . $default_color;
 			}
 		}
 		?>
 <script type="text/javascript">
 </script>
 		<?php
 	}
 	/**
-	 * Display JavaScript based on Step 2.
+	 * Displays JavaScript based on Step 2.
 	 *
 	 * @since 2.6.0
 	 */
 	public function js_2() {
 </script>
 		<?php
 	}
 	/**
-	 * Display first step of custom header image page.
+	 * Displays first step of custom header image page.
 	 *
 	 * @since 2.1.0
 	 */
 	public function step_1() {
 		$this->process_default_headers();
 		?>
 <div class="wrap">
 <h1><?php _e( 'Custom Header' ); ?></h1>
-		<?php if ( current_user_can( 'customize' ) ) { ?>
+		<?php
-<div class="notice notice-info hide-if-no-customize">
+		if ( current_user_can( 'customize' ) ) {
-	<p>
+			$message = sprintf(
-			<?php
-			printf(
 				/* translators: %s: URL to header image configuration in Customizer. */
 				__( 'You can now manage and live-preview Custom Header in the <a href="%s">Customizer</a>.' ),
 				admin_url( 'customize.php?autofocus[control]=header_image' )
 			);
-			?>
+			wp_admin_notice(
-	</p>
+				$message,
-</div>
+				array(
-		<?php } ?>
+					'type'               => 'info',
+					'additional_classes' => array( 'hide-if-no-customize' ),
-		<?php if ( ! empty( $this->updated ) ) { ?>
+				)
-<div id="message" class="updated">
+			);
-	<p>
+		}
-			<?php
-			/* translators: %s: Home URL. */
+		if ( ! empty( $this->updated ) ) {
-			printf( __( 'Header updated. <a href="%s">Visit your site</a> to see how it looks.' ), home_url( '/' ) );
+			$updated_message = sprintf(
-			?>
+				/* translators: %s: Home URL. */
-	</p>
+				__( 'Header updated. <a href="%s">Visit your site</a> to see how it looks.' ),
-</div>
+				esc_url( home_url( '/' ) )
-		<?php } ?>
+			);
+			wp_admin_notice(
+				$updated_message,
+				array(
+					'id'                 => 'message',
+					'additional_classes' => array( 'updated' ),
+				)
+			);
+		}
+		?>
 <h2><?php _e( 'Header Image' ); ?></h2>
 <table class="form-table" role="presentation">
 <tbody>
 			?>
 <tr>
 <th scope="row"><?php _e( 'Default Images' ); ?></th>
 <td>
 			<?php if ( current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
-	<p><?php _e( 'If you don&lsquo;t want to upload your own image, you can use one of these cool headers, or show a random one.' ); ?></p>
+	<p><?php _e( 'If you do not want to upload your own image, you can use one of these cool headers, or show a random one.' ); ?></p>
 	<?php else : ?>
 	<p><?php _e( 'You can use one of these cool headers or show a random one on each page.' ); ?></p>
 	<?php endif; ?>
 			<?php
 			$this->show_header_selector( 'default' );
 	<p>
 			<?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, '#' ) ) {
+				if ( $default_color && ! str_contains( $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, '#' ) ) {
+			if ( $header_textcolor && ! str_contains( $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 ) {
 		<?php
 	}
 	/**
-	 * Display second step of custom header image page.
+	 * Displays second step of custom header image page.
 	 *
 	 * @since 2.1.0
 	 */
 	public function step_2() {
 		check_admin_referer( 'custom-header-upload', '_wpnonce-custom-header-upload' );
 			}
 			$this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
 			/**
-			 * Fires after the header image is set or an error is returned.
+			 * Filters the attachment file path after the custom header or background image is set.
+			 *
+			 * Used for file replication.
 			 *
 			 * @since 2.1.0
 			 *
 			 * @param string $file          Path to the file.
 			 * @param int    $attachment_id Attachment ID.
 			 */
-			do_action( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication.
+			$file = apply_filters( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication.
 			return $this->finished();
 		} elseif ( $width > $max_width ) {
 			$oitar = $width / $max_width;
 <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>
 	<div id="crop_image" style="position: relative">
-		<img src="<?php echo esc_url( $url ); ?>" id="upload" width="<?php echo $width; ?>" height="<?php echo $height; ?>" alt="" />
+		<img src="<?php echo esc_url( $url ); ?>" id="upload" width="<?php echo esc_attr( $width ); ?>" height="<?php echo esc_attr( $height ); ?>" alt="" />
 	</div>
 	<input type="hidden" name="x1" id="x1" value="0" />
 	<input type="hidden" name="y1" id="y1" value="0" />
 	<input type="hidden" name="width" id="width" value="<?php echo esc_attr( $width ); ?>" />
 		<?php
 	}
 	/**
-	 * Upload the file to be cropped in the second step.
+	 * Uploads the file to be cropped in the second step.
 	 *
 	 * @since 3.4.0
 	 */
 	public function step_2_manage_upload() {
 		$overrides = array( 'test_form' => false );
 		return compact( 'attachment_id', 'file', 'filename', 'url', 'type' );
 	}
 	/**
-	 * Display third step of custom header image page.
+	 * Displays 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.
 	 */
 		}
 		/** This filter is documented in wp-admin/includes/class-custom-image-header.php */
 		$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
-		$attachment = $this->create_attachment_object( $cropped, $attachment_id );
+		$attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, 'custom-header' );
 		if ( ! empty( $_POST['create-new-attachment'] ) ) {
 			unset( $attachment['ID'] );
 		}
 		return $this->finished();
 	}
 	/**
-	 * Display last step of custom header image page.
+	 * Displays last step of custom header image page.
 	 *
 	 * @since 2.1.0
 	 */
 	public function finished() {
 		$this->updated = true;
 		$this->step_1();
 	}
 	/**
-	 * Display the page based on the current step.
+	 * Displays the page based on the current step.
 	 *
 	 * @since 2.1.0
 	 */
 	public function admin_page() {
 		if ( ! current_user_can( 'edit_theme_options' ) ) {
 	public function filter_upload_tabs( $tabs ) {
 		return $tabs;
 	}
 	/**
-	 * Choose a header image, selected from existing uploaded and default headers,
+	 * Chooses a header image, selected from existing uploaded and default headers,
-	 * or provide an array of uploaded header data (either new, or from media library).
+	 * or provides an array of uploaded header data (either new, or from media library).
 	 *
 	 * @since 3.4.0
 	 *
 	 * @param mixed $choice Which header image to select. Allows for values of 'random-default-image',
-	 *  for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling
+	 *                      for randomly cycling among the default images; 'random-uploaded-image',
-	 *  among the uploaded images; the key of a default image registered for that theme; and
+	 *                      for randomly cycling among the uploaded images; the key of a default image
-	 *  the key of an image uploaded for that theme (the attachment ID of the image).
+	 *                      registered for that theme; and the key of an image uploaded for that theme
-	 *  Or an array of arguments: attachment_id, url, width, height. All are required.
+	 *                      (the attachment ID of the image). Or an array of arguments: attachment_id,
+	 *                      url, width, height. All are required.
 	 */
 	final public function set_header_image( $choice ) {
 		if ( is_array( $choice ) || is_object( $choice ) ) {
 			$choice = (array) $choice;
 			if ( ! isset( $choice['attachment_id'] ) || ! isset( $choice['url'] ) ) {
 				return;
 			}
-			$choice['url'] = esc_url_raw( $choice['url'] );
+			$choice['url'] = sanitize_url( $choice['url'] );
 			$header_image_data = (object) array(
 				'attachment_id' => $choice['attachment_id'],
 				'url'           => $choice['url'],
 				'thumbnail_url' => $choice['url'],
 			} else {
 				return;
 			}
 		}
-		set_theme_mod( 'header_image', esc_url_raw( $header_image_data['url'] ) );
+		set_theme_mod( 'header_image', sanitize_url( $header_image_data['url'] ) );
 		set_theme_mod( 'header_image_data', $header_image_data );
 	}
 	/**
-	 * Remove a header image.
+	 * Removes a header image.
 	 *
 	 * @since 3.4.0
 	 */
 	final public function remove_header_image() {
 		$this->set_header_image( 'remove-header' );
 	}
 	/**
-	 * Reset a header image to the default image for the theme.
+	 * Resets a header image to the default image for the theme.
 	 *
 	 * This method does not do anything if the theme does not have a default header image.
 	 *
 	 * @since 3.4.0
 	 */
 		set_theme_mod( 'header_image', $default );
 		set_theme_mod( 'header_image_data', (object) $default_data );
 	}
 	/**
-	 * Calculate width and height based on what the currently selected theme supports.
+	 * Calculates width and height based on what the currently selected theme supports.
 	 *
 	 * @since 3.9.0
 	 *
 	 * @param array $dimensions
 	 * @return array dst_height and dst_width of header image.
 		return $dst;
 	}
 	/**
-	 * Create an attachment 'object'.
+	 * Creates an attachment 'object'.
 	 *
 	 * @since 3.9.0
+	 * @deprecated 6.5.0
 	 *
 	 * @param string $cropped              Cropped image URL.
 	 * @param int    $parent_attachment_id Attachment ID of parent image.
 	 * @return array An array with attachment object data.
 	 */
 	final public function create_attachment_object( $cropped, $parent_attachment_id ) {
+		_deprecated_function( __METHOD__, '6.5.0', 'wp_copy_parent_attachment_properties()' );
 		$parent     = get_post( $parent_attachment_id );
 		$parent_url = wp_get_attachment_url( $parent->ID );
 		$url        = str_replace( wp_basename( $parent_url ), wp_basename( $cropped ), $parent_url );
 		$size       = wp_getimagesize( $cropped );
 		return $attachment;
 	}
 	/**
-	 * Insert an attachment and its metadata.
+	 * Inserts an attachment and its metadata.
 	 *
 	 * @since 3.9.0
 	 *
 	 * @param array  $attachment An array with attachment object data.
 	 * @param string $cropped    File path to cropped image.
 		}
 		/** This filter is documented in wp-admin/includes/class-custom-image-header.php */
 		$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
-		$attachment = $this->create_attachment_object( $cropped, $attachment_id );
+		$attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, 'custom-header' );
 		$previous = $this->get_previous_crop( $attachment );
 		if ( $previous ) {
 			$attachment['ID'] = $previous;
 		return $header_images;
 	}
 	/**
-	 * Get the ID of a previous crop from the same base image.
+	 * Gets the ID of a previous crop from the same base image.
 	 *
 	 * @since 4.9.0
 	 *
 	 * @param array $attachment An array with a cropped attachment object data.
 	 * @return int|false An attachment ID if one exists. False if none.

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef