<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[52946] trunk/src/wp-admin/includes/class-custom-image-header.php: Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/class-custom-image-header.php`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/52946">52946</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/52946","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-03-17 20:17:48 +0000 (Thu, 17 Mar 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/class-custom-image-header.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$object` variable in `Custom_Image_Header` class methods to `$attachment` for clarity and consistency, as the variable type is actually an array, and updates the documentation accordingly.
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/55327">#55327</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasscustomimageheaderphp">trunk/src/wp-admin/includes/class-custom-image-header.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasscustomimageheaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-custom-image-header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-custom-image-header.php 2022-03-17 04:55:48 UTC (rev 52945)
+++ trunk/src/wp-admin/includes/class-custom-image-header.php 2022-03-17 20:17:48 UTC (rev 52946)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -975,8 +975,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $file = $file['file'];
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = wp_basename( $file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Construct the object array.
- $object = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Construct the array with attachment object data.
+ $attachment = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'post_title' => $filename,
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_content' => $url,
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_mime_type' => $type,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -985,7 +985,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Save the data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment_id = wp_insert_attachment( $object, $file );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment_id = wp_insert_attachment( $attachment, $file );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return compact( 'attachment_id', 'file', 'filename', 'url', 'type' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1061,14 +1061,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-admin/includes/class-custom-image-header.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $object = $this->create_attachment_object( $cropped, $attachment_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = $this->create_attachment_object( $cropped, $attachment_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $_POST['create-new-attachment'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $object['ID'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $attachment['ID'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Update the attachment.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment_id = $this->insert_attachment( $object, $cropped );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment_id = $this->insert_attachment( $attachment, $cropped );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $url = wp_get_attachment_url( $attachment_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1300,7 +1300,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $cropped Cropped image URL.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $parent_attachment_id Attachment ID of parent image.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Attachment object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array An array with attachment object data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> final public function create_attachment_object( $cropped, $parent_attachment_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $parent = get_post( $parent_attachment_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1310,7 +1310,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $size = wp_getimagesize( $cropped );
</span><span class="cx" style="display: block; padding: 0 10px"> $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $object = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'ID' => $parent_attachment_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_title' => wp_basename( $cropped ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_mime_type' => $image_type,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1319,7 +1319,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_parent' => $parent_attachment_id,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $object;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $attachment;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1327,15 +1327,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $object Attachment object.
- * @param string $cropped File path to cropped image.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $attachment An array with attachment object data.
+ * @param string $cropped File path to cropped image.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int Attachment ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- final public function insert_attachment( $object, $cropped ) {
- $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null;
- unset( $object['post_parent'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ final public function insert_attachment( $attachment, $cropped ) {
+ $parent_id = isset( $attachment['post_parent'] ) ? $attachment['post_parent'] : null;
+ unset( $attachment['post_parent'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment_id = wp_insert_attachment( $object, $cropped );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment_id = wp_insert_attachment( $attachment, $cropped );
</ins><span class="cx" style="display: block; padding: 0 10px"> $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If this is a crop, save the original attachment ID as metadata.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1404,25 +1404,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-admin/includes/class-custom-image-header.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $object = $this->create_attachment_object( $cropped, $attachment_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = $this->create_attachment_object( $cropped, $attachment_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $previous = $this->get_previous_crop( $object );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $previous = $this->get_previous_crop( $attachment );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $previous ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $object['ID'] = $previous;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment['ID'] = $previous;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $object['ID'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $attachment['ID'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_attachment_id = $this->insert_attachment( $object, $cropped );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_attachment_id = $this->insert_attachment( $attachment, $cropped );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $object['attachment_id'] = $new_attachment_id;
- $object['url'] = wp_get_attachment_url( $new_attachment_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment['attachment_id'] = $new_attachment_id;
+ $attachment['url'] = wp_get_attachment_url( $new_attachment_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $object['width'] = $dimensions['dst_width'];
- $object['height'] = $dimensions['dst_height'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment['width'] = $dimensions['dst_width'];
+ $attachment['height'] = $dimensions['dst_height'];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_send_json_success( $object );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_send_json_success( $attachment );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1577,10 +1577,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $object A crop attachment object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $attachment An array with a cropped attachment object data.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int|false An attachment ID if one exists. False if none.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function get_previous_crop( $object ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function get_previous_crop( $attachment ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $header_images = $this->get_uploaded_header_images();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail early if there are no header images.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1591,7 +1591,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $previous = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $header_images as $image ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $image['attachment_parent'] === $object['post_parent'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $image['attachment_parent'] === $attachment['post_parent'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $previous = $image['attachment_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>