Changeset 14059 for trunk/src/bp-core/classes/class-bp-component.php

Timestamp:

10/25/2024 12:38:29 AM (2 years ago)

Author:

imath

Message:

Avoid WP 6.7 notice about using translatable strings too early

Use a "raw" name instead of a "translatable" name for the BP_Component's & BP_Theme_Compat's name properties.

Props boonebgorges.

See #9247 (trunk)
Closes ​https://github.com/buddypress/buddypress/pull/391

File:

• trunk/src/bp-core/classes/class-bp-component.php (modified) (2 diffs)

trunk/src/bp-core/classes/class-bp-component.php

@@ -30 +30 @@
 
         /**
-         * Translatable name for the component.
+         * Raw name for the component.
+         *
+         * Do not use translatable strings here as this part is set before WP's `init` hook.
+         *
+         * @since 1.5.0
+         * @since 14.3.0 Changed the variable inline documentation summary and added a description.
          *
          * @internal
@@ -245 +250 @@
          * @since 2.3.0 Added $params['features'] as a configurable value.
          * @since 2.4.0 Added $params['search_query_arg'] as a configurable value.
+         * @since 14.3.0 Changed the `$name` parameter's description.
          *
          * @param string $id   Unique ID. Letters, numbers, and underscores only.
-         * @param string $name Unique name. This should be a translatable name, e.g. __( 'Groups', 'buddypress' ).
+         * @param string $name Unique raw name for the component (do not use translatable strings).
          * @param string $path The file path for the component's files. Used by {@link BP_Component::includes()}.
          * @param array  $params {