Changeset 13968 for trunk/src/bp-core/bp-core-template-loader.php

Timestamp:

07/23/2024 01:13:42 AM (17 months ago)

Author:

espellcaste

Message:

WPCS: Part XII: miscellaneous fixes for some of the files of the core component.

Follow-up to [13904]

See #9174 and #9173

File:

• trunk/src/bp-core/bp-core-template-loader.php (modified) (15 diffs)

trunk/src/bp-core/bp-core-template-loader.php

@@ -8 +8 @@
  *
  * @package BuddyPress
- * @subpackage TemplateFunctions
+ * @subpackage Core
  * @since 1.7.0
  */
@@ -19 +19 @@
  *
  * @since 1.7.0
- * @since 7.0.0 Added $args parameter.
+ * @since 7.0.0 Added `$args` parameter.
  *
  * @param string      $slug Template part slug. Used to generate filenames,
@@ -55 +55 @@
      *
      * @since 1.7.0
-     * @since 7.0.0 Added $args parameter.
+     * @since 7.0.0 Added `$args` parameter.
      *
      * @param array  $templates Array of templates located.
@@ -75 +75 @@
  *
  * @since 2.6.0
- * @since 7.0.0 Added $args parameter.
+ * @since 7.0.0 Added `$args` parameter.
  *
  * @see bp_get_template_part() for full documentation.
@@ -156 +156 @@
  *
  * @since 1.7.0
- * @since 7.0.0 Added $args parameter.
+ * @since 7.0.0 Added `$args` parameter.
  *
  * @param string|array $template_names Template file(s) to search for, in order.
@@ -218 +218 @@
      * @since 2.5.0
      *
-     * @param bool $value True to load the template, false otherwise.
+     * @param bool $load_template True to load the template, false otherwise.
      */
     $load_template = (bool) apply_filters( 'bp_locate_template_and_load', true );
@@ -392 +392 @@
  *
  * @since 1.7.0
- * @since 7.0.0 Added $args parameter.
+ * @since 7.0.0 Added `$args` parameter.
  *
  * @see bp_get_template_part() for a description of $slug, $name and $args params.
@@ -541 +541 @@
      * @since 1.7.0
      *
-     * @param array $value  Array of all template locations registered so far.
+     * @param array $template_locations  Array of all template locations registered so far.
      * @param array $stacks Array of template locations.
      */
@@ -643 +643 @@
      * @since 12.0.0
      *
-     * @param WP_Query $posts_query WP_Query instance. Passed by reference.
+     * @param WP_Query $referer_query WP_Query instance. Passed by reference.
      */
     do_action_ref_array( 'bp_parse_query', array( &$referer_query ) );
@@ -654 +654 @@
  *
  * @since 12.0.0
+ *
+ * @global WP $wp WordPress main instance.
  *
  * @param string   $bp_request A specific BuddyPress request.
@@ -659 +661 @@
  * @return true
  */
-function bp_reset_query( $bp_request = '', WP_Query $query = null ) {
+function bp_reset_query( $bp_request = '', $query = null ) {
     global $wp;
 
@@ -676 +678 @@
             $matched_query = wp_parse_url( $bp_request, PHP_URL_QUERY );
         } else {
-            // Temporarly override the request uri.
+            // Temporarily override the request uri.
             $_SERVER['REQUEST_URI'] = $bp_request;
 
@@ -700 +702 @@
         $query->parse_query( $matched_query );
 
-        // Use to requery in case of root profiles.
+        // Use to request in case of root profiles.
     } elseif ( isset( $wp->request ) ) {
-        // Temporarly override the request uri.
+        // Temporarily override the request uri.
         $_SERVER['REQUEST_URI'] = str_replace( $wp->request, $bp_request, $reset_server_request_uri );
 
@@ -783 +785 @@
  * @since 1.8.0
  *
- * @return bool True if yes, false if no.
+ * @return bool
  */
 function bp_is_template_included() {
@@ -794 +796 @@
  * @since 1.7.0
  *
- * @global string $pagenow
+ * @global string $pagenow The current page being loaded.
+ * @global WP_Query $wp_query The WordPress Query object.
  */
 function bp_load_theme_functions() {