Changeset 47892

Timestamp:

06/03/2020 10:00:27 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Miscellaneous DocBlock corrections.

See #49572.

Location:

trunk/src/wp-includes

Files:

• kses.php (modified) (1 diff)
• link-template.php (modified) (1 diff)
• ms-deprecated.php (modified) (1 diff)
• ms-functions.php (modified) (1 diff)
• nav-menu-template.php (modified) (1 diff)
• post.php (modified) (1 diff)

trunk/src/wp-includes/kses.php

@@ -2306 +2306 @@
                          * Filters the regex limiting the list of characters not allowed in CSS rules.
                          *
-                         * Default behaviour is to remove any css containing \ ( & } = or comments, except for url() usage.
+                         * Default behaviour is to remove any CSS containing \ ( & } = or comments,
+                         * except for url() usage.
                          *
                          * @since 5.5.0
                          *
-                         * @param string $regex           Regex pattern of disallowed characters in CSS rules. Default is '%[\\\(&=}]|/\*%'.
+                         * @param string $regex           Regex pattern of disallowed characters in CSS rules.
+                         *                                Default is '%[\\\(&=}]|/\*%'.
                          * @param string $css_test_string CSS value to test.
                          */

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

@@ -3863 +3863 @@
          * @since 3.0.0
          *
-         * @param bool|string $return      Short-circuit return value. Either false or a URL string.
-         * @param int         $id          Post ID, or 0 for the current post.
-         * @param string      $context     The context for the link. One of 'post' or 'query',
-         * @param bool        $allow_slugs Whether to allow post slugs in the shortlink.
+         * @param false|string $return      Short-circuit return value. Either false or a URL string.
+         * @param int          $id          Post ID, or 0 for the current post.
+         * @param string       $context     The context for the link. One of 'post' or 'query',
+         * @param bool         $allow_slugs Whether to allow post slugs in the shortlink.
          */
         $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );

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

@@ -166 +166 @@
  * @param string $email        Email address to verify.
  * @param bool   $check_domain Deprecated.
- * @return string|bool Either false or the valid email address.
+ * @return string|false Valid email address on success, false on failure.
  */
 function validate_email( $email, $check_domain = true) {

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

@@ -393 +393 @@
  *
  * @param string $user_email The email provided by the user at registration.
- * @return bool Returns true when the email address is banned.
+ * @return bool True when the email address is banned, false otherwise.
  */
 function is_email_address_unsafe( $user_email ) {

trunk/src/wp-includes/nav-menu-template.php

@@ -92 +92 @@
          * Filters whether to short-circuit the wp_nav_menu() output.
          *
-         * Returning a non-null value to the filter will short-circuit
+         * Passing a non-null value to the filter will short-circuit
          * wp_nav_menu(), echoing that value if $args->echo is true,
          * returning that value otherwise.

trunk/src/wp-includes/post.php

@@ -3682 +3682 @@
          * 2. The title, editor, and excerpt fields are all empty
          *
-         * Returning a truthy value to the filter will effectively short-circuit
+         * Passing a truthy value to the filter will effectively short-circuit
          * the new post being inserted, returning 0. If $wp_error is true, a WP_Error
          * will be returned instead.