Changeset 38125

Timestamp:

07/20/2016 07:32:05 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Fix formatting, tense, verb conjugation, and other syntax for wp-includes/* elements introduced or changed in 4.6.

Part 2/2.

Fixes #37318.

Location:

trunk/src/wp-includes

Files:

• link-template.php (modified) (1 diff)
• meta.php (modified) (3 diffs)
• ms-blogs.php (modified) (3 diffs)
• ms-load.php (modified) (2 diffs)
• plugin.php (modified) (5 diffs)
• post.php (modified) (2 diffs)
• query.php (modified) (1 diff)
• script-loader.php (modified) (1 diff)
• taxonomy.php (modified) (1 diff)
• user.php (modified) (1 diff)
• wp-db.php (modified) (3 diffs)

trunk/src/wp-includes/link-template.php

@@ -3598 +3598 @@
  *
  * @since 2.9.0
- * @since 4.6.0 Adjusted to use `wp_get_canonical_url()`.
+ * @since 4.6.0 Adjusted to use wp_get_canonical_url().
  */
 function rel_canonical() {

trunk/src/wp-includes/meta.php

@@ -1096 +1096 @@
  * @since 4.6.0
  *
- * @param string $object_type    The type of object.
- * @param string $meta_key       The meta key.
- *
+ * @param string $object_type The type of object.
+ * @param string $meta_key    The meta key.
  * @return bool True if successful. False if the meta key was not registered.
  */
@@ -1134 +1133 @@
  *
  * @param string $object_type The type of object. Post, comment, user, term.
- *
  * @return array List of registered meta keys.
  */
@@ -1156 +1154 @@
  * @param string $meta_key    Optional. Registered metadata key. If not specified, retrieve all registered
  *                            metadata for the specified object.
- *
  * @return mixed A single value or array of values for a key if specified. An array of all registered keys
  *               and values for an object ID if not.

trunk/src/wp-includes/ms-blogs.php

@@ -462 +462 @@
      * @since 4.6.0
      *
-     * @param int     $id Blog ID.
-     * @param WP_Site $blog
+     * @param int     $id              Blog ID.
+     * @param WP_Site $blog            Site object.
      * @param string  $domain_path_key md5 hash of domain and path.
      */
@@ -521 +521 @@
  *
  * @see update_site_cache()
- *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
@@ -1090 +1089 @@
  * @global WP_Network $current_site
  *
- * @param WP_Network|int|null $network Network to retrieve.
+ * @param WP_Network|int|null $network Network to retrieve, passed by reference.
  * @return WP_Network|null The network object or null if not found.
  */

trunk/src/wp-includes/ms-load.php

@@ -138 +138 @@
  * @since 3.9.0
  * @since 4.4.0 Converted to leverage WP_Network
- * @since 4.6.0 Converted to use `get_network()`
+ * @since 4.6.0 Converted to use get_network()
  *
  * @param object|int $network The network's database row or ID.
@@ -284 +284 @@
  * @param string $domain    The requested domain.
  * @param string $path      The requested path.
- * @param bool   $subdomain Whether a subdomain (true) or subdirectory (false) configuration.
+ * @param bool   $subdomain Optional. Whether a subdomain (true) or subdirectory (false) configuration.
+ *                          Default false.
  * @return bool|string True if bootstrap successfully populated `$current_blog` and `$current_site`.
  *                     False if bootstrap could not be properly completed.

trunk/src/wp-includes/plugin.php

@@ -670 +670 @@
  * @param array  $args        Array of additional function arguments to be passed to apply_filters().
  * @param string $version     The version of WordPress that deprecated the hook.
- * @param string $replacement Optional. The hook that should have been used.
- * @param string $message     Optional. A message regarding the change.
+ * @param string $replacement Optional. The hook that should have been used. Default false.
+ * @param string $message     Optional. A message regarding the change. Default null.
  */
 function apply_filters_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
@@ -1004 +1004 @@
 
 /**
- * Back up global variables used for actions and filters.
+ * Backs up global variables used for actions and filters.
  *
  * Prevents redefinition of these globals in advanced-cache.php from accidentally
@@ -1017 +1017 @@
  * @global array $wp_current_filter Stores the list of current filters with the current one last.
  * @staticvar array $backup_globals Backed up globals.
+ *
  * @return array the staticvar from the first time it is set.
  */
 function _backup_plugin_globals(){
     global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
+
     static $backup_globals = array();
+
     if ( empty( $backup_globals ) ) {
         $backup_globals = array(
@@ -1034 +1037 @@
 
 /**
- * Safely restore backed up global variables used for actions and filters.
+ * Safely restores backed up global variables used for actions and filters.
  *
  * @since 4.6.0
@@ -1047 +1050 @@
 function _restore_plugin_globals(){
     global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
+
     $backup_globals = _backup_plugin_globals();
+
     if ( $wp_filter !== $backup_globals['backup_wp_filter'] ){
         $wp_filter = array_merge_recursive( $wp_filter, $backup_globals['backup_wp_filter'] );

trunk/src/wp-includes/post.php

@@ -4317 +4317 @@
  *
  * @since 1.5.0
- * @since 4.6.0 The $page parameter is optional.
+ * @since 4.6.0 Converted the `$page` parameter to optional.
  *
  * @param WP_Post|object|int $page Optional. Page ID or WP_Post object. Default is global $post.
@@ -4956 +4956 @@
  * @since 4.6.0
  *
- * @param int $post_id Optional. Attachment ID. Default 0.
+ * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`.
  * @return string|false False on failure. Attachment caption on success.
  */

trunk/src/wp-includes/query.php

@@ -1474 +1474 @@
      *              Introduced the `$comment_status` and `$ping_status` parameters.
      *              Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
-     * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced `$lazy_load_term_meta`.
+     * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
      * @access public
      *

trunk/src/wp-includes/script-loader.php

@@ -919 +919 @@
  *
  * @link http://api.jqueryui.com/datepicker/#options
+ *
  * @global WP_Locale $wp_locale The WordPress date and time locale object.
  */

trunk/src/wp-includes/taxonomy.php

@@ -1226 +1226 @@
      *
      * @since 2.3.0
-     * @since 4.6.0 Added `$term_query`.
+     * @since 4.6.0 Added the `$term_query` parameter.
      *
      * @param array         $terms      Array of found terms.

trunk/src/wp-includes/user.php

@@ -2334 +2334 @@
 
 /**
- * Initiate email notifications related to the creation of new users.
+ * Initiates email notifications related to the creation of new users.
  *
  * Notifications are sent both to the site admin and to the newly created user.
  *
  * @since 4.4.0
- * @since 4.6.0 The `$notify` parameter accepts 'user' for sending notification only to the user created.
+ * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending
+ *              notifications only to the user created.
  *
  * @param int    $user_id ID of the newly created user.
- * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin' or an empty string
- *                        (admin only), 'user', or 'both' (admin and user). Default 'both'.
+ * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin'
+ *                        or an empty string (admin only), 'user', or 'both' (admin and user).
+ *                        Default 'both'.
  */
 function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {

trunk/src/wp-includes/wp-db.php

@@ -757 +757 @@
 
     /**
-     * Given a charset and collation, determine the best charset and collation to use.
+     * Determines the best charset and collation to use given a charset and collation.
      *
      * For example, when able, utf8mb4 should be used instead of utf8.
      *
      * @since 4.6.0
-     *
-     * @param  string $charset The character set to check.
-     * @param  string $collate The collation to check.
-     *
+     * @access public
+     *
+     * @param string $charset The character set to check.
+     * @param string $collate The collation to check.
      * @return array The most appropriate character set and collation to use.
      */
@@ -3237 +3237 @@
      *
      * @since 2.7.0
-     * @since 4.1.0 Support was added for the 'utf8mb4' feature.
-     * @since 4.6.0 Support was added for the 'utf8mb4_520' feature.
+     * @since 4.1.0 Added support for the 'utf8mb4' feature.
+     * @since 4.6.0 Added support for the 'utf8mb4_520' feature.
      *
      * @see wpdb::db_version()
@@ -3277 +3277 @@
                     return version_compare( $client_version, '5.5.3', '>=' );
                 }
-            case 'utf8mb4_520' :  // @since 4.6.0
+            case 'utf8mb4_520' : // @since 4.6.0
                 return version_compare( $version, '5.6', '>=' );
         }