Changeset 28083

Timestamp:

04/12/2014 12:00:32 AM (11 years ago)

Author:

DrewAPicture

Message:

Priority fixes for various existing hook documentation.

Props kpdesign.
See #26869

Location:

trunk/src

Files:

• wp-admin/includes/plugin-install.php (modified) (1 diff)
• wp-admin/network/admin.php (modified) (1 diff)
• wp-admin/options-discussion.php (modified) (1 diff)
• wp-admin/options-writing.php (modified) (2 diffs)
• wp-admin/options.php (modified) (1 diff)
• wp-admin/user/admin.php (modified) (1 diff)
• wp-includes/class-wp-embed.php (modified) (1 diff)
• wp-includes/class-wp-xmlrpc-server.php (modified) (1 diff)
• wp-includes/comment-template.php (modified) (5 diffs)
• wp-includes/l10n.php (modified) (4 diffs)

trunk/src/wp-admin/includes/plugin-install.php

@@ -54 +54 @@
      * @since 2.7.0
      *
-     * @param bool|object         The result object. Default is false.
+     * @param bool|object $result The result object. Default false.
      * @param string      $action The type of information being requested from the Plugin Install API.
      * @param object      $args   Plugin API arguments.

trunk/src/wp-admin/network/admin.php

@@ -23 +23 @@
  * @since 3.2.0
  *
- * @param bool $redirect_user_admin_request Whether the request should be redirected.
+ * @param bool $redirect_network_admin_request Whether the request should be redirected.
  */
 $redirect_network_admin_request = apply_filters( 'redirect_network_admin_request', $redirect_network_admin_request );

trunk/src/wp-admin/options-discussion.php

@@ -81 +81 @@
  * @since 2.7.0.
  *
- * @param int $10 The maximum depth of threaded comments. Default 10.
+ * @param int $max_depth The maximum depth of threaded comments. Default 10.
  */
 $maxdeep = (int) apply_filters( 'thread_comments_depth_max', 10 );

trunk/src/wp-admin/options-writing.php

@@ -38 +38 @@
 }
 
-/**
- * Toggle site update services configuration functionality.
- *
- * @since 3.0.0
- *
- * @param bool True or false, based on whether update services configuration is enabled or not.
- */
+/** This filter is documented in wp-admin/options-writing.php */
 if ( apply_filters( 'enable_update_services_configuration', true ) ) {
     get_current_screen()->add_help_tab( array(
@@ -168 +162 @@
 
 <?php
-/** This filter is documented in wp-admin/options-writing.php */
+/**
+ * Filter whether to enable the Update Services section in the Writing settings screen.
+ *
+ * @since 3.0.0
+ *
+ * @param bool $enable Whether to enable the Update Services settings area. Default true.
+ */
 if ( apply_filters( 'enable_update_services_configuration', true ) ) {
 ?>

trunk/src/wp-admin/options.php

@@ -109 +109 @@
 
     /**
-     * Toggle post-by-email functionality.
+     * Filter whether the post-by-email functionality is enabled.
      *
      * @since 3.0.0
      *
-     * @param bool True or false, based on whether post-by-email configuration is enabled or not.
+     * @param bool $enabled Whether post-by-email configuration is enabled. Default true.
      */
     if ( apply_filters( 'enable_post_by_email_configuration', true ) )

trunk/src/wp-admin/user/admin.php

@@ -19 +19 @@
 $redirect_user_admin_request = ( ( $current_blog->domain != $current_site->domain ) || ( $current_blog->path != $current_site->path ) );
 /**
- * Filter whether a user should be redirected to the Global Dashboard in Multisite.
- *
- * Users not assigned to any sites in the network will be redirected to the Global
- * Dashboard after logging in.
+ * Filter whether to redirect the request to the User Admin in Multisite.
  *
  * @since 3.2.0

trunk/src/wp-includes/class-wp-embed.php

@@ -210 +210 @@
              * Filter whether to inspect the given URL for discoverable <link> tags.
              *
+             * @since 2.9.0
+             *
              * @see WP_oEmbed::discover()
              *

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -5776 +5776 @@
 
         $remote_ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
+
+        /** This filter is documented in wp-includes/class-http.php */
         $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $GLOBALS['wp_version'] . '; ' . get_bloginfo( 'url' ) );
 

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

@@ -519 +519 @@
     }
     $excerpt .= ($use_dotdotdot) ? '…' : '';
-    return apply_filters('get_comment_excerpt', $excerpt);
+
+    /**
+     * Filter the retrieved comment excerpt.
+     *
+     * @since 1.5.0
+     *
+     * @param string $excerpt The comment excerpt text.
+     */
+    return apply_filters( 'get_comment_excerpt', $excerpt );
 }
 
@@ -642 +650 @@
      * Filter the returned post comments permalink.
      *
-     * @since
+     * @since 3.6.0
      *
      * @param string      $comments_link Post comments permalink with '#comments' appended.
@@ -977 +985 @@
      * Filter whether the current post is open for comments.
      *
-     * @since
+     * @since 2.5.0
      *
      * @param bool        $open    Whether the current post is open for comments.
@@ -998 +1006 @@
 
     $open = ( 'open' == $_post->ping_status );
+
+    /**
+     * Filter whether the current post is open for pings.
+     *
+     * @since 2.5.0
+     *
+     * @param bool        $open    Whether the current post is open for pings.
+     * @param int|WP_Post $post_id The post ID or WP_Post object.
+     */
     return apply_filters( 'pings_open', $open, $post_id );
 }
@@ -2056 +2073 @@
         'fields'               => $fields,
         '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>',
+        /** This filter is documented in wp-includes/link-template.php */
         '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>',
+        /** This filter is documented in wp-includes/link-template.php */
         '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>',
         'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',

trunk/src/wp-includes/l10n.php

@@ -54 +54 @@
         $locale = 'en_US';
 
-    // duplicate_hook
+    /** This filter is documented in wp-includes/l10n.php */
     return apply_filters( 'locale', $locale );
 }
@@ -425 +425 @@
      * @since 2.9.0
      *
-     * @param boolean        Whether to override the text domain. Default false.
-     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
-     * @param string $mofile Path to the MO file.
+     * @param bool   $override Whether to override the text domain. Default false.
+     * @param string $domain   Text domain. Unique identifier for retrieving translated strings.
+     * @param string $mofile   Path to the MO file.
      */
     $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
@@ -480 +480 @@
 
     /**
-     * Filter text text domain for loading translation.
+     * Filter the text domain for loading translation.
      *
      * @since 3.0.0
      *
-     * @param boolean        Whether to override unloading the text domain. Default false.
-     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     * @param bool   $override Whether to override unloading the text domain. Default false.
+     * @param string $domain   Text domain. Unique identifier for retrieving translated strings.
      */
     $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
@@ -592 +592 @@
  */
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
-    // duplicate_hook
+    /** This filter is documented in wp-includes/l10n.php */
     $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
     $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );