WordPress.org

Make WordPress Core

Changeset 28083


Ignore:
Timestamp:
04/12/14 00:00:32 (3 years ago)
Author:
DrewAPicture
Message:

Priority fixes for various existing hook documentation.

Props kpdesign.
See #26869

Location:
trunk/src
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/plugin-install.php

    r27677 r28083  
    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. 
  • trunk/src/wp-admin/network/admin.php

    r27725 r28083  
    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 ); 
  • trunk/src/wp-admin/options-discussion.php

    r27469 r28083  
    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 ); 
  • trunk/src/wp-admin/options-writing.php

    r27469 r28083  
    3838} 
    3939 
    40 /** 
    41  * Toggle site update services configuration functionality. 
    42  * 
    43  * @since 3.0.0 
    44  * 
    45  * @param bool True or false, based on whether update services configuration is enabled or not. 
    46  */ 
     40/** This filter is documented in wp-admin/options-writing.php */ 
    4741if ( apply_filters( 'enable_update_services_configuration', true ) ) { 
    4842    get_current_screen()->add_help_tab( array( 
     
    168162 
    169163<?php 
    170 /** This filter is documented in wp-admin/options-writing.php */ 
     164/** 
     165 * Filter whether to enable the Update Services section in the Writing settings screen. 
     166 * 
     167 * @since 3.0.0 
     168 * 
     169 * @param bool $enable Whether to enable the Update Services settings area. Default true. 
     170 */ 
    171171if ( apply_filters( 'enable_update_services_configuration', true ) ) { 
    172172?> 
  • trunk/src/wp-admin/options.php

    r26518 r28083  
    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 ) ) 
  • trunk/src/wp-admin/user/admin.php

    r26344 r28083  
    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. 
    22  * 
    23  * Users not assigned to any sites in the network will be redirected to the Global 
    24  * Dashboard after logging in. 
     21 * Filter whether to redirect the request to the User Admin in Multisite. 
    2522 * 
    2623 * @since 3.2.0 
  • trunk/src/wp-includes/class-wp-embed.php

    r26915 r28083  
    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             * 
  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r28065 r28083  
    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 
  • trunk/src/wp-includes/comment-template.php

    r27943 r28083  
    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 
     
    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. 
     
    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. 
     
    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} 
     
    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>', 
  • trunk/src/wp-includes/l10n.php

    r25991 r28083  
    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} 
     
    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 ); 
     
    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 ); 
     
    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, '/' ) ); 
Note: See TracChangeset for help on using the changeset viewer.