WordPress.org

Make WordPress Core

Changeset 29163


Ignore:
Timestamp:
07/14/2014 01:01:22 AM (6 years ago)
Author:
DrewAPicture
Message:

Inline documentation cleanup for 4.0 audit.

Various improvements:

  • Adds @see reference for wp_list_comments() in 'wp_list_comments_args' filter docs, added in [28285]
  • Various phpDoc tweaks for the 'run_wptexturize' filter docs, added in [28715]
  • Sentence and wrapping changes for is_https_url(), added in [28894]
  • Documents the $args parameter for wp_dropdown_languages(), added in [29007]
  • Adds a period to the parameter description for _update_posts_count_on_delete(), added in [28835]
  • Documents a global in is_customize_preview(), added in [28999]
  • phpDoc tweaks, adds an access modifier for wpdb::esc_like(), added in [28711]

See #28885.

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

Legend:

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

    r29044 r29163  
    19401940     *
    19411941     * @since 4.0.0
     1942     *
     1943     * @see wp_list_comments()
    19421944     *
    19431945     * @param array $r An array of arguments for displaying comments.
  • trunk/src/wp-includes/formatting.php

    r29008 r29163  
    4141    if ( $reset || ! isset( $static_characters ) ) {
    4242        /**
    43          * Filter whether to skip running `wptexturize()`.
     43         * Filter whether to skip running wptexturize().
    4444         *
    45          * Passing false to the filter will effectively short-circuit `wptexturize()`.
     45         * Passing false to the filter will effectively short-circuit wptexturize().
    4646         * returning the original text passed to the function instead.
    4747         *
    48          * The filter runs only once, the first time `wptexturize()` is called.
     48         * The filter runs only once, the first time wptexturize() is called.
    4949         *
    5050         * @since 4.0.0
    5151         *
    52          * @param bool $run_texturize Whether to short-circuit `wptexturize()`.
     52         * @see wptexturize()
     53         *
     54         * @param bool $run_texturize Whether to short-circuit wptexturize().
    5355         */
    5456        $run_texturize = apply_filters( 'run_wptexturize', $run_texturize );
  • trunk/src/wp-includes/functions.php

    r29013 r29163  
    35073507 * @since 4.0.0
    35083508 *
    3509  * @param  string  $url The URL
    3510  * @return bool True if the given URL uses https, false if not (or if the URL is not valid).
     3509 * @param string $url The URL.
     3510 * @return bool True if the given URL uses https, false if not (or if the URL
     3511 *              is not valid).
    35113512 */
    35123513function is_https_url( $url ) {
  • trunk/src/wp-includes/l10n.php

    r29007 r29163  
    822822 *
    823823 * @since 4.0.0
     824 *
     825 * @see get_available_languages()
     826 *
     827 * @param array $args Optional arguments. Default empty array.
    824828 */
    825829function wp_dropdown_languages( $args = array() ) {
  • trunk/src/wp-includes/ms-blogs.php

    r28881 r29163  
    911911 * @since 4.0
    912912 *
    913  * @param int $post_id Post ID
     913 * @param int $post_id Post ID.
    914914 */
    915915function _update_posts_count_on_delete( $post_id ) {
  • trunk/src/wp-includes/theme.php

    r29044 r29163  
    19481948 * @since 4.0.0
    19491949 *
     1950 * @global WP_Customize_Manager $wp_customize Customizer instance.
     1951 *
    19501952 * @return bool True if the site is being previewed in the Customizer, false otherwise.
    19511953 */
  • trunk/src/wp-includes/wp-db.php

    r28978 r29163  
    11891189     *
    11901190     * @since 4.0.0
    1191      *
    1192      * @param string $text The raw text to be escaped. The input typed by the user should have no extra or deleted slashes.
    1193      * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call prepare or real_escape next.
    1194      */
    1195     function esc_like( $text ) {
     1191     * @access public
     1192     *
     1193     * @param string $text The raw text to be escaped. The input typed by the user should have no
     1194     *                     extra or deleted slashes.
     1195     * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare()
     1196     *                or real_escape next.
     1197     */
     1198    public function esc_like( $text ) {
    11961199        return addcslashes( $text, '_%\\' );
    11971200    }
Note: See TracChangeset for help on using the changeset viewer.