Changeset 6438 for trunk/src/includes/admin/tools/common.php

Timestamp:

05/27/2017 05:04:31 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Tools: Add //Filter & return note for future discovery of missing filter documentation.

Also adjust some type-casting on filtered results.

File:

• trunk/src/includes/admin/tools/common.php (modified) (4 diffs)

trunk/src/includes/admin/tools/common.php

@@ -22 +22 @@
 }
 
-/**
- * Return the URL to run a specific repair tool
- *
- * @since 2.6.0 bbPress (r5885)
- *
- * @param string $component
- */
-function bbp_get_admin_repair_tool_run_url( $component = array() ) {
-    $tools  = admin_url( 'tools.php' );
-    $page   = ( 'repair' === $component['type'] ) ? 'bbp-repair' : 'bbp-upgrade';
-    $args   = array( 'page' => $page, 'action' => 'run', 'checked' => array( $component['id'] ) );
-    $url    = add_query_arg( $args, $tools );
-    $nonced = wp_nonce_url( $url, 'bbpress-do-counts' );
-
-    return apply_filters( 'bbp_get_admin_repair_tool_run_url', $nonced, $component );
-}
+    /**
+     * Return the URL to run a specific repair tool
+     *
+     * @since 2.6.0 bbPress (r5885)
+     *
+     * @param string $component
+     */
+    function bbp_get_admin_repair_tool_run_url( $component = array() ) {
+        $tools  = admin_url( 'tools.php' );
+        $page   = ( 'repair' === $component['type'] ) ? 'bbp-repair' : 'bbp-upgrade';
+        $args   = array( 'page' => $page, 'action' => 'run', 'checked' => array( $component['id'] ) );
+        $url    = add_query_arg( $args, $tools );
+        $nonced = wp_nonce_url( $url, 'bbpress-do-counts' );
+
+        // Filter & return
+        return apply_filters( 'bbp_get_admin_repair_tool_run_url', $nonced, $component );
+    }
 
 /**
@@ -174 +175 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_get_admin_repair_tools', $tools, $type );
 }
@@ -198 +200 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_get_admin_repair_tool_registered_components', $retval );
 }
@@ -380 +383 @@
     ksort( $repair_list );
 
+    // Filter & return
     return (array) apply_filters( 'bbp_repair_list', $repair_list );
 }