<!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>[54859] trunk/src/wp-admin/install-helper.php: Docs: Fix typo and improve DocBlock formatting in `wp-admin/install-helper.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/54859">54859</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/54859","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-11-20 14:08:38 +0000 (Sun, 20 Nov 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'>Docs: Fix typo and improve DocBlock formatting in `wp-admin/install-helper.php`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/236">[236]</a>, <a href="https://core.trac.wordpress.org/changeset/265">[265]</a>, <a href="https://core.trac.wordpress.org/changeset/8645">[8645]</a>, <a href="https://core.trac.wordpress.org/changeset/30542">[30542]</a>.
See <a href="https://core.trac.wordpress.org/ticket/56792">#56792</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmininstallhelperphp">trunk/src/wp-admin/install-helper.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmininstallhelperphp"></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/install-helper.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/install-helper.php 2022-11-19 15:40:11 UTC (rev 54858)
+++ trunk/src/wp-admin/install-helper.php 2022-11-20 14:08:38 UTC (rev 54859)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,22 +1,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Plugins may load this file to gain access to special helper functions for
- * plugin installation. This file is not included by WordPress and it is
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Plugins may load this file to gain access to special helper functions
+ * for plugin installation. This file is not included by WordPress and it is
</ins><span class="cx" style="display: block; padding: 0 10px"> * recommended, to prevent fatal errors, that this file is included using
</span><span class="cx" style="display: block; padding: 0 10px"> * require_once.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * These functions are not optimized for speed, but they should only be used
</span><span class="cx" style="display: block; padding: 0 10px"> * once in a while, so speed shouldn't be a concern. If it is and you are
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * needing to use these functions a lot, you might experience time outs. If you
- * do, then it is advised to just write the SQL code yourself.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * needing to use these functions a lot, you might experience timeouts.
+ * If you do, then it is advised to just write the SQL code yourself.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * check_column( 'wp_links', 'link_description', 'mediumtext' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * if ( check_column( $wpdb->comments, 'comment_author', 'tinytext' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * echo "ok\n";
</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">- * $error_count = 0;
- * $tablename = $wpdb->links;
</del><span class="cx" style="display: block; padding: 0 10px"> * // Check the column.
</span><span class="cx" style="display: block; padding: 0 10px"> * if ( ! check_column( $wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,6 +22,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * $q = $wpdb->query( $ddl );
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * $error_count = 0;
+ * $tablename = $wpdb->links;
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * if ( check_column( $wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * $res .= $tablename . ' - ok <br />';
</span><span class="cx" style="display: block; padding: 0 10px"> * } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,7 +64,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- No applicable variables for this query.
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( $create_ddl );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We cannot directly tell that whether this succeeded!
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We cannot directly tell whether this succeeded!
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wpdb->get_col( 'SHOW TABLES', 0 ) as $table ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $table === $table_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,7 +102,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- No applicable variables for this query.
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( $create_ddl );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We cannot directly tell that whether this succeeded!
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We cannot directly tell whether this succeeded!
</ins><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Cannot be prepared. Fetches columns for table names.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wpdb->get_col( "DESC $table_name", 0 ) as $column ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $column === $column_name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -135,7 +137,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- No applicable variables for this query.
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( $drop_ddl );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We cannot directly tell that whether this succeeded!
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We cannot directly tell whether this succeeded!
</ins><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Cannot be prepared. Fetches columns for table names.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wpdb->get_col( "DESC $table_name", 0 ) as $column ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $column === $column_name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,17 +156,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Uses the SQL DESC for retrieving the table info for the column. It will help
</span><span class="cx" style="display: block; padding: 0 10px"> * understand the parameters, if you do more research on what column information
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * is returned by the SQL statement. Pass in null to skip checking that
- * criteria.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * is returned by the SQL statement. Pass in null to skip checking that criteria.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Column names returned from DESC table are case sensitive and are listed:
- * Field
- * Type
- * Null
- * Key
- * Default
- * Extra
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Column names returned from DESC table are case sensitive and are as listed:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - Field
+ * - Type
+ * - Null
+ * - Key
+ * - Default
+ * - Extra
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span></span></pre>
</div>
</div>
</body>
</html>