Changeset 47786 for trunk/src/wp-admin/install-helper.php

Timestamp:

05/12/2020 06:38:02 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for functions in wp-admin/install-helper.php per the documentation standards.

Synchronize descriptions with the functions' counterparts from wp-admin/includes/upgrade.php.

See #49572.

File:

• trunk/src/wp-admin/install-helper.php (modified) (8 diffs)

trunk/src/wp-admin/install-helper.php

@@ -40 +40 @@
 if ( ! function_exists( 'maybe_create_table' ) ) :
         /**
-         * Create database table, if it doesn't already exist.
+         * Creates a table in the database if it doesn't already exist.
          *
          * @since 1.0.0
@@ -47 +47 @@
          *
          * @param string $table_name Database table name.
-         * @param string $create_ddl Create database table SQL.
-         * @return bool False on error, true if already exists or success.
+         * @param string $create_ddl SQL statement to create table.
+         * @return bool True on success or if the table already exists. False on failure.
          */
         function maybe_create_table( $table_name, $create_ddl ) {
@@ -75 +75 @@
 if ( ! function_exists( 'maybe_add_column' ) ) :
         /**
-         * Add column to database table, if column doesn't already exist in table.
+         * Adds column to database table, if it doesn't already exist.
          *
          * @since 1.0.0
@@ -81 +81 @@
          * @global wpdb $wpdb WordPress database abstraction object.
          *
-         * @param string $table_name Database table name
-         * @param string $column_name Table column name
-         * @param string $create_ddl SQL to add column to table.
-         * @return bool False on failure. True, if already exists or was successful.
+         * @param string $table_name  Database table name.
+         * @param string $column_name Table column name.
+         * @param string $create_ddl  SQL statement to add column.
+         * @return bool True on success or if the column already exists. False on failure.
          */
         function maybe_add_column( $table_name, $column_name, $create_ddl ) {
@@ -110 +110 @@
 
 /**
- * Drop column from database table, if it exists.
+ * Drops column from database table, if it exists.
  *
  * @since 1.0.0
@@ -116 +116 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string $table_name Table name
- * @param string $column_name Column name
- * @param string $drop_ddl SQL statement to drop column.
- * @return bool True on success or if the column doesn't exist, false on failure.
+ * @param string $table_name  Database table name.
+ * @param string $column_name Table column name.
+ * @param string $drop_ddl    SQL statement to drop column.
+ * @return bool True on success or if the column doesn't exist. False on failure.
  */
 function maybe_drop_column( $table_name, $column_name, $drop_ddl ) {
@@ -144 +144 @@
 
 /**
- * Check column matches criteria.
+ * Checks that database table column matches the criteria.
  *
  * Uses the SQL DESC for retrieving the table info for the column. It will help
@@ -163 +163 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string $table_name Table name
- * @param string $col_name   Column name
- * @param string $col_type   Column type
+ * @param string $table_name Database table name.
+ * @param string $col_name   Table column name.
+ * @param string $col_type   Table column type.
  * @param bool   $is_null    Optional. Check is null.
  * @param mixed  $key        Optional. Key info.