Changeset 47122 for trunk/src/wp-includes/plugin.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/plugin.php (modified) (8 diffs)

trunk/src/wp-includes/plugin.php

@@ -153 +153 @@
  * Example usage:
  *
- *     // The filter callback function
+ *     // The filter callback function.
  *     function example_callback( $string, $arg1, $arg2 ) {
- *         // (maybe) modify $string
+ *         // (maybe) modify $string.
  *         return $string;
  *     }
@@ -161 +161 @@
  *
  *     /*
- *      * Apply the filters by calling the 'example_callback()' function that's
- *      * hooked onto `example_filter` above.
+ *      * Apply the filters by calling the 'example_callback()' function
+ *      * that's hooked onto `example_filter` above.
  *      *
- *      * - 'example_filter' is the filter hook
- *      * - 'filter me' is the value being filtered
+ *      * - 'example_filter' is the filter hook.
+ *      * - 'filter me' is the value being filtered.
  *      * - $arg1 and $arg2 are the additional arguments passed to the callback.
  *     $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
@@ -229 +229 @@
     global $wp_filter, $wp_current_filter;
 
-    // Do 'all' actions first
+    // Do 'all' actions first.
     if ( isset( $wp_filter['all'] ) ) {
         $wp_current_filter[] = $tag;
@@ -416 +416 @@
  * Example usage:
  *
- *     // The action callback function
+ *     // The action callback function.
  *     function example_callback( $arg1, $arg2 ) {
- *         // (maybe) do something with the args
+ *         // (maybe) do something with the args.
  *     }
  *     add_action( 'example_action', 'example_callback', 10, 2 );
  *
  *     /*
- *      * Trigger the actions by calling the 'example_callback()' function that's
- *      * hooked onto `example_action` above.
+ *      * Trigger the actions by calling the 'example_callback()' function
+ *      * that's hooked onto `example_action` above.
  *      *
- *      * - 'example_action' is the action hook
+ *      * - 'example_action' is the action hook.
  *      * - $arg1 and $arg2 are the additional arguments passed to the callback.
  *     $value = do_action( 'example_action', $arg1, $arg2 );
@@ -451 +451 @@
     }
 
-    // Do 'all' actions first
+    // Do 'all' actions first.
     if ( isset( $wp_filter['all'] ) ) {
         $wp_current_filter[] = $tag;
@@ -524 +524 @@
     }
 
-    // Do 'all' actions first
+    // Do 'all' actions first.
     if ( isset( $wp_filter['all'] ) ) {
         $wp_current_filter[] = $tag;
@@ -693 +693 @@
     $mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR );
 
-    $file = preg_replace( '#^' . preg_quote( $plugin_dir, '#' ) . '/|^' . preg_quote( $mu_plugin_dir, '#' ) . '/#', '', $file ); // get relative path from plugins dir
+    // Get relative path from plugins directory.
+    $file = preg_replace( '#^' . preg_quote( $plugin_dir, '#' ) . '/|^' . preg_quote( $mu_plugin_dir, '#' ) . '/#', '', $file );
     $file = trim( $file, '/' );
     return $file;
@@ -718 +719 @@
     global $wp_plugin_paths;
 
-    // Normalize, but store as static to avoid recalculation of a constant value
+    // Normalize, but store as static to avoid recalculation of a constant value.
     static $wp_plugin_path = null, $wpmu_plugin_path = null;
     if ( ! isset( $wp_plugin_path ) ) {