Changeset 13993

Timestamp:

08/01/2024 10:29:23 AM (16 months ago)

Author:

imath

Message:

Improve inline comments for the BP_Members_Invitations_Component

• Add a PHP doc block to this class.
• Add another PHP doc block to the class constructor.
• Add the missing public keyword to this constructor.

Fixes #9220
Closes ​https://github.com/buddypress/buddypress/pull/354

File:

• trunk/src/bp-members/classes/class-bp-members-invitations-component.php (modified) (1 diff)

trunk/src/bp-members/classes/class-bp-members-invitations-component.php

@@ -10 +10 @@
 // Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
+
+/**
+ * BuddyPress Invitations Component Class.
+ *
+ * Invitations are actually a deactivable feature of the Members component. To make sure this feature
+ * page slugs can be customized using the BP Rewrites API, it was decided to extend the `BP_Component`
+ * class to benefit from the improvements added to it during 12.0.0 into the "rewrite" area.
+ * @see `BP_Component::register_nav()`.
+ *
+ * @since 12.0.0
+ */
 class BP_Members_Invitations_Component extends BP_Component {
 
-    function __construct() {
+    /**
+     * Start the invitations feature creation process.
+     *
+     * @since 12.0.0
+     */
+    public function __construct() {
         parent::start(
             'members_invitations',