Make WordPress Core

Ticket #26869: 26869-hook-docs-audit-fixes.diff

File 26869-hook-docs-audit-fixes.diff, 10.6 KB (added by kpdesign, 11 years ago)

Hook docs audit recommended fixes

  • src/wp-admin/includes/menu.php

     
    1313         *
    1414         * The hook fires before menus and sub-menus are removed based on user privileges.
    1515         *
    16          * @private
    1716         * @since 3.1.0
     17         * @access private
    1818         */
    1919        do_action( '_network_admin_menu' );
    2020} elseif ( is_user_admin() ) {
     
    2424         *
    2525         * The hook fires before menus and sub-menus are removed based on user privileges.
    2626         *
    27          * @private
    2827         * @since 3.1.0
     28         * @access private
    2929         */
    3030        do_action( '_user_admin_menu' );
    3131} else {
     
    3535         *
    3636         * The hook fires before menus and sub-menus are removed based on user privileges.
    3737         *
    38          * @private
    3938         * @since 2.2.0
     39         * @access private
    4040         */
    4141        do_action( '_admin_menu' );
    4242}
  • src/wp-admin/includes/plugin-install.php

     
    5353         *
    5454         * @since 2.7.0
    5555         *
    56          * @param bool|object         The result object. Default is false.
     56         * @param bool|object $result The result object. Default false.
    5757         * @param string      $action The type of information being requested from the Plugin Install API.
    5858         * @param object      $args   Plugin API arguments.
    5959         */
  • src/wp-admin/network/admin.php

     
    2222 *
    2323 * @since 3.2.0
    2424 *
    25  * @param bool $redirect_user_admin_request Whether the request should be redirected.
     25 * @param bool $redirect_network_admin_request Whether the request should be redirected.
    2626 */
    2727$redirect_network_admin_request = apply_filters( 'redirect_network_admin_request', $redirect_network_admin_request );
    2828if ( $redirect_network_admin_request ) {
  • src/wp-admin/options-discussion.php

     
    8080 *
    8181 * @since 2.7.0.
    8282 *
    83  * @param int $10 The maximum depth of threaded comments. Default 10.
     83 * @param int $max_depth The maximum depth of threaded comments. Default 10.
    8484 */
    8585$maxdeep = (int) apply_filters( 'thread_comments_depth_max', 10 );
    8686
  • src/wp-admin/options-writing.php

     
    3838}
    3939
    4040/**
    41  * Toggle site update services configuration functionality.
     41 * Filter whether the site update services configuration functionality is enabled.
    4242 *
    4343 * @since 3.0.0
    4444 *
    45  * @param bool True or false, based on whether update services configuration is enabled or not.
     45 * @param bool $enable_configuration Whether the update services configuration
     46 *                                   functionality is enabled. Default true.
    4647 */
    4748if ( apply_filters( 'enable_update_services_configuration', true ) ) {
    4849        get_current_screen()->add_help_tab( array(
  • src/wp-admin/options.php

     
    108108        $whitelist_options['general'][] = 'WPLANG';
    109109
    110110        /**
    111          * Toggle post-by-email functionality.
     111         * Filter whether the post-by-email functionality is enabled.
    112112         *
    113113         * @since 3.0.0
    114114         *
    115          * @param bool True or false, based on whether post-by-email configuration is enabled or not.
     115         * @param bool $enabled Whether post-by-email configuration is enabled. Default true.
    116116         */
    117117        if ( apply_filters( 'enable_post_by_email_configuration', true ) )
    118118                $whitelist_options['writing'] = array_merge($whitelist_options['writing'], $mail_options);
  • src/wp-admin/user/admin.php

     
    1818
    1919$redirect_user_admin_request = ( ( $current_blog->domain != $current_site->domain ) || ( $current_blog->path != $current_site->path ) );
    2020/**
    21  * Filter whether a user should be redirected to the Global Dashboard in Multisite.
     21 * Filter whether to redirect the request to the User Admin in Multisite.
    2222 *
    23  * Users not assigned to any sites in the network will be redirected to the Global
    24  * Dashboard after logging in.
    25  *
    2623 * @since 3.2.0
    2724 *
    2825 * @param bool $redirect_user_admin_request Whether the request should be redirected.
  • src/wp-includes/class-wp-embed.php

     
    209209                        /**
    210210                         * Filter whether to inspect the given URL for discoverable <link> tags.
    211211                         *
     212                         * @since 2.9.0
     213                         *
    212214                         * @see WP_oEmbed::discover()
    213215                         *
    214216                         * @param bool false Whether to enable <link> tag discovery. Default false.
  • src/wp-includes/class-wp-xmlrpc-server.php

     
    57755775                sleep(1);
    57765776
    57775777                $remote_ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
     5778
     5779                /** This filter is documented in wp-includes/class-http.php */
    57785780                $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $GLOBALS['wp_version'] . '; ' . get_bloginfo( 'url' ) );
    57795781
    57805782                // Let's check the remote site
  • src/wp-includes/comment-template.php

     
    518518                $excerpt .= $blah[$i] . ' ';
    519519        }
    520520        $excerpt .= ($use_dotdotdot) ? '&hellip;' : '';
    521         return apply_filters('get_comment_excerpt', $excerpt);
     521
     522        /**
     523         * Filter the retrieved comment excerpt.
     524         *
     525         * @since 1.5.0
     526         *
     527         * @param string $excerpt The comment excerpt text.
     528         */
     529        return apply_filters( 'get_comment_excerpt', $excerpt );
    522530}
    523531
    524532/**
     
    641649        /**
    642650         * Filter the returned post comments permalink.
    643651         *
    644          * @since
     652         * @since 3.6.0
    645653         *
    646654         * @param string      $comments_link Post comments permalink with '#comments' appended.
    647655         * @param int|WP_Post $post_id       Post ID or WP_Post object.
     
    976984        /**
    977985         * Filter whether the current post is open for comments.
    978986         *
    979          * @since
     987         * @since 2.5.0
    980988         *
    981989         * @param bool        $open    Whether the current post is open for comments.
    982990         * @param int|WP_Post $post_id The post ID or WP_Post object.
     
    9971005        $_post = get_post($post_id);
    9981006
    9991007        $open = ( 'open' == $_post->ping_status );
     1008
     1009        /**
     1010         * Filter whether the current post is open for pings.
     1011         *
     1012         * @since 2.5.0
     1013         *
     1014         * @param bool        $open    Whether the current post is open for pings.
     1015         * @param int|WP_Post $post_id The post ID or WP_Post object.
     1016         */
    10001017        return apply_filters( 'pings_open', $open, $post_id );
    10011018}
    10021019
     
    20552072        $defaults = array(
    20562073                'fields'               => $fields,
    20572074                'comment_field'        => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" aria-required="true"></textarea></p>',
     2075                /** This filter is documented in wp-includes/link-template.php */
    20582076                'must_log_in'          => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
     2077                /** This filter is documented in wp-includes/link-template.php */
    20592078                'logged_in_as'         => '<p class="logged-in-as">' . sprintf( __( 'Logged in as <a href="%1$s">%2$s</a>. <a href="%3$s" title="Log out of this account">Log out?</a>' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
    20602079                'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
    20612080                'comment_notes_after'  => '<p class="form-allowed-tags">' . sprintf( __( 'You may use these <abbr title="HyperText Markup Language">HTML</abbr> tags and attributes: %s' ), ' <code>' . allowed_tags() . '</code>' ) . '</p>',
  • src/wp-includes/l10n.php

     
    5353        if ( empty( $locale ) )
    5454                $locale = 'en_US';
    5555
    56         // duplicate_hook
     56        /** This filter is documented in wp-includes/l10n.php */
    5757        return apply_filters( 'locale', $locale );
    5858}
    5959
     
    424424         *
    425425         * @since 2.9.0
    426426         *
    427          * @param boolean        Whether to override the text domain. Default false.
    428          * @param string $domain Text domain. Unique identifier for retrieving translated strings.
    429          * @param string $mofile Path to the MO file.
     427         * @param bool   $override Whether to override the text domain. Default false.
     428         * @param string $domain   Text domain. Unique identifier for retrieving translated strings.
     429         * @param string $mofile   Path to the MO file.
    430430         */
    431431        $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
    432432
     
    479479        global $l10n;
    480480
    481481        /**
    482          * Filter text text domain for loading translation.
     482         * Filter the text domain for loading translation.
    483483         *
    484484         * @since 3.0.0
    485485         *
    486          * @param boolean        Whether to override unloading the text domain. Default false.
    487          * @param string $domain Text domain. Unique identifier for retrieving translated strings.
     486         * @param bool   $override Whether to override unloading the text domain. Default false.
     487         * @param string $domain   Text domain. Unique identifier for retrieving translated strings.
    488488         */
    489489        $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
    490490
     
    591591 * @return bool True when textdomain is successfully loaded, false otherwise.
    592592 */
    593593function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
    594         // duplicate_hook
     594        /** This filter is documented in wp-includes/l10n.php */
    595595        $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
    596596        $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
    597597