WordPress.org

Make WordPress Core

Changeset 47892


Ignore:
Timestamp:
06/03/2020 10:00:27 AM (18 months ago)
Author:
SergeyBiryukov
Message:

Docs: Miscellaneous DocBlock corrections.

See #49572.

Location:
trunk/src/wp-includes
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/kses.php

    r47891 r47892  
    23062306             * Filters the regex limiting the list of characters not allowed in CSS rules.
    23072307             *
    2308              * Default behaviour is to remove any css containing \ ( & } = or comments, except for url() usage.
     2308             * Default behaviour is to remove any CSS containing \ ( & } = or comments,
     2309             * except for url() usage.
    23092310             *
    23102311             * @since 5.5.0
    23112312             *
    2312              * @param string $regex           Regex pattern of disallowed characters in CSS rules. Default is '%[\\\(&=}]|/\*%'.
     2313             * @param string $regex           Regex pattern of disallowed characters in CSS rules.
     2314             *                                Default is '%[\\\(&=}]|/\*%'.
    23132315             * @param string $css_test_string CSS value to test.
    23142316             */
  • trunk/src/wp-includes/link-template.php

    r47808 r47892  
    38633863     * @since 3.0.0
    38643864     *
    3865      * @param bool|string $return      Short-circuit return value. Either false or a URL string.
    3866      * @param int         $id          Post ID, or 0 for the current post.
    3867      * @param string      $context     The context for the link. One of 'post' or 'query',
    3868      * @param bool        $allow_slugs Whether to allow post slugs in the shortlink.
     3865     * @param false|string $return      Short-circuit return value. Either false or a URL string.
     3866     * @param int          $id          Post ID, or 0 for the current post.
     3867     * @param string       $context     The context for the link. One of 'post' or 'query',
     3868     * @param bool         $allow_slugs Whether to allow post slugs in the shortlink.
    38693869     */
    38703870    $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );
  • trunk/src/wp-includes/ms-deprecated.php

    r47855 r47892  
    166166 * @param string $email        Email address to verify.
    167167 * @param bool   $check_domain Deprecated.
    168  * @return string|bool Either false or the valid email address.
     168 * @return string|false Valid email address on success, false on failure.
    169169 */
    170170function validate_email( $email, $check_domain = true) {
  • trunk/src/wp-includes/ms-functions.php

    r47855 r47892  
    393393 *
    394394 * @param string $user_email The email provided by the user at registration.
    395  * @return bool Returns true when the email address is banned.
     395 * @return bool True when the email address is banned, false otherwise.
    396396 */
    397397function is_email_address_unsafe( $user_email ) {
  • trunk/src/wp-includes/nav-menu-template.php

    r47808 r47892  
    9292     * Filters whether to short-circuit the wp_nav_menu() output.
    9393     *
    94      * Returning a non-null value to the filter will short-circuit
     94     * Passing a non-null value to the filter will short-circuit
    9595     * wp_nav_menu(), echoing that value if $args->echo is true,
    9696     * returning that value otherwise.
  • trunk/src/wp-includes/post.php

    r47856 r47892  
    36823682     * 2. The title, editor, and excerpt fields are all empty
    36833683     *
    3684      * Returning a truthy value to the filter will effectively short-circuit
     3684     * Passing a truthy value to the filter will effectively short-circuit
    36853685     * the new post being inserted, returning 0. If $wp_error is true, a WP_Error
    36863686     * will be returned instead.
Note: See TracChangeset for help on using the changeset viewer.