Changeset 45418

Timestamp:

05/25/2019 09:58:18 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Switch to the more common syntax for variadic function documentation.

See #37402

Location:

trunk

Files:

• src/wp-includes/class-wp-user.php (modified) (1 diff)
• src/wp-includes/deprecated.php (modified) (1 diff)
• src/wp-includes/formatting.php (modified) (1 diff)
• src/wp-includes/plugin.php (modified) (2 diffs)
• src/wp-includes/theme.php (modified) (1 diff)
• src/wp-includes/wp-db.php (modified) (1 diff)
• tests/phpunit/includes/abstract-testcase.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-user.php

@@ -722 +722 @@
      * @see map_meta_cap()
      *
-     * @param string $cap           Capability name.
-     * @param int    $object_id,... Optional. ID of a specific object to check against if `$cap` is a "meta" capability.
-     *                              Meta capabilities such as `edit_post` and `edit_user` are capabilities used by
-     *                              by the `map_meta_cap()` function to map to primitive capabilities that a user or
-     *                              role has, such as `edit_posts` and `edit_others_posts`.
+     * @param string $cap          Capability name.
+     * @param int    ...$object_id Optional. ID of a specific object to check against if `$cap` is a "meta" capability.
+     *                             Meta capabilities such as `edit_post` and `edit_user` are capabilities used by
+     *                             by the `map_meta_cap()` function to map to primitive capabilities that a user or
+     *                             role has, such as `edit_posts` and `edit_others_posts`.
      * @return bool Whether the user has the given capability, or, if `$object_id` is passed, whether the user has
      *              the given capability for that object.

trunk/src/wp-includes/deprecated.php

@@ -2110 +2110 @@
  * @param callable   $output_callback Run when widget is called.
  * @param string     $classname       Optional. Classname widget option. Default empty.
- * @param mixed      $params ,...     Widget parameters.
+ * @param mixed      ...$params       Widget parameters.
  */
 function register_sidebar_widget($name, $output_callback, $classname = '') {

trunk/src/wp-includes/formatting.php

@@ -4812 +4812 @@
  * @link https://secure.php.net/sprintf
  *
- * @param string $pattern   The string which formatted args are inserted.
- * @param mixed  $args ,... Arguments to be formatted into the $pattern string.
+ * @param string $pattern The string which formatted args are inserted.
+ * @param mixed  ...$args Arguments to be formatted into the $pattern string.
  * @return string The formatted string.
  */

trunk/src/wp-includes/plugin.php

@@ -171 +171 @@
  * @global array $wp_current_filter Stores the list of current filters with the current one last.
  *
- * @param string $tag     The name of the filter hook.
- * @param mixed  $value   The value on which the filters hooked to `$tag` are applied on.
- * @param mixed  $var,... Additional variables passed to the functions hooked to `$tag`.
+ * @param string $tag    The name of the filter hook.
+ * @param mixed  $value  The value on which the filters hooked to `$tag` are applied on.
+ * @param mixed  ...$var Additional variables passed to the functions hooked to `$tag`.
  * @return mixed The filtered value after all hooked functions are applied to it.
  */
@@ -422 +422 @@
  * @global array $wp_current_filter Stores the list of current filters with the current one last
  *
- * @param string $tag     The name of the action to be executed.
- * @param mixed  $arg,... Optional. Additional arguments which are passed on to the
- *                        functions hooked to the action. Default empty.
+ * @param string $tag    The name of the action to be executed.
+ * @param mixed  ...$arg Optional. Additional arguments which are passed on to the
+ *                       functions hooked to the action. Default empty.
  */
 function do_action( $tag, $arg = '' ) {

trunk/src/wp-includes/theme.php

@@ -2331 +2331 @@
  * @global array $_wp_theme_features
  *
- * @param string $feature  The feature being added. Likely core values include 'post-formats',
- *                         'post-thumbnails', 'html5', 'custom-logo', 'custom-header-uploads',
- *                         'custom-header', 'custom-background', 'title-tag', 'starter-content',
- *                         'responsive-embeds', etc.
- * @param mixed  $args,... Optional extra arguments to pass along with certain features.
+ * @param string $feature The feature being added. Likely core values include 'post-formats',
+ *                        'post-thumbnails', 'html5', 'custom-logo', 'custom-header-uploads',
+ *                        'custom-header', 'custom-background', 'title-tag', 'starter-content',
+ *                        'responsive-embeds', etc.
+ * @param mixed  ...$args Optional extra arguments to pass along with certain features.
  * @return void|bool False on failure, void otherwise.
  */

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

@@ -1287 +1287 @@
      * @since 2.3.0
      *
-     * @param string      $query    Query statement with sprintf()-like placeholders
-     * @param array|mixed $args     The array of variables to substitute into the query's placeholders if being called with an array of arguments,
-     *                              or the first variable to substitute into the query's placeholders if being called with individual arguments.
-     * @param mixed       $args,... further variables to substitute into the query's placeholders if being called wih individual arguments.
+     * @param string      $query   Query statement with sprintf()-like placeholders
+     * @param array|mixed $args    The array of variables to substitute into the query's placeholders if being called with an array of arguments,
+     *                             or the first variable to substitute into the query's placeholders if being called with individual arguments.
+     * @param mixed       ...$args further variables to substitute into the query's placeholders if being called wih individual arguments.
      * @return string|void Sanitized query string, if there is a query to prepare.
      */

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -909 +909 @@
      * @since 3.8.0 Moved from `Tests_Query_Conditionals` to `WP_UnitTestCase`.
      *
-     * @param string $prop,... Any number of WP_Query properties that are expected to be true for the current request.
+     * @param string ...$prop Any number of WP_Query properties that are expected to be true for the current request.
      */
     public function assertQueryTrue() {