Changeset 13587

Timestamp:

09/29/2023 02:07:48 AM (18 months ago)

Author:

imath

Message:

Admin: improve code indentation of bp_get_ prefixed functions

Props plugindevs

Fixes #8998
Closes ​https://github.com/buddypress/buddypress/pull/169

Location:

trunk/src

Files:

• bp-core/admin/bp-core-admin-settings.php (modified) (1 diff)
• bp-settings/bp-settings-template.php (modified) (2 diffs)

trunk/src/bp-core/admin/bp-core-admin-settings.php

@@ -453 +453 @@
     echo bp_get_form_option( $option, $default, $slug );
 }
+
+/**
+ * Return settings API option
+ *
+ * @since 1.6.0
+ *
+ *
+ * @param string $option  Form option to return.
+ * @param string $default Form option default.
+ * @param bool   $slug    Form option slug.
+ * @return string
+ */
+function bp_get_form_option( $option, $default = '', $slug = false ) {
+
+    // Get the option and sanitize it.
+    $value = bp_get_option( $option, $default );
+
+    // Slug?
+    if ( true === $slug ) {
+
+        /**
+         * Filters the slug value in the form field.
+         *
+         * @since 1.6.0
+         *
+         * @param string $value Value being returned for the requested option.
+         */
+        $value = esc_attr( apply_filters( 'editable_slug', $value ) );
+    } else { // Not a slug.
+        $value = esc_attr( $value );
+    }
+
+    // Fallback to default.
+    if ( empty( $value ) ) {
+        $value = $default;
+    }
+
     /**
-     * Return settings API option
+     * Filters the settings API option.
      *
      * @since 1.6.0
      *
-     *
-     * @param string $option  Form option to return.
-     * @param string $default Form option default.
-     * @param bool   $slug    Form option slug.
-     * @return string
+     * @param string $value  Value being returned for the requested option.
+     * @param string $option Option whose value is being requested.
      */
-    function bp_get_form_option( $option, $default = '', $slug = false ) {
-
-        // Get the option and sanitize it.
-        $value = bp_get_option( $option, $default );
-
-        // Slug?
-        if ( true === $slug ) {
-
-            /**
-             * Filters the slug value in the form field.
-             *
-             * @since 1.6.0
-             *
-             * @param string $value Value being returned for the requested option.
-             */
-            $value = esc_attr( apply_filters( 'editable_slug', $value ) );
-        } else { // Not a slug.
-            $value = esc_attr( $value );
-        }
-
-        // Fallback to default.
-        if ( empty( $value ) )
-            $value = $default;
-
-        /**
-         * Filters the settings API option.
-         *
-         * @since 1.6.0
-         *
-         * @param string $value  Value being returned for the requested option.
-         * @param string $option Option whose value is being requested.
-         */
-        return apply_filters( 'bp_get_form_option', $value, $option );
-    }
+    return apply_filters( 'bp_get_form_option', $value, $option );
+}

trunk/src/bp-settings/bp-settings-template.php

@@ -19 +19 @@
     echo bp_get_settings_slug();
 }
+
+/**
+ * Return the settings component slug.
+ *
+ * @since 1.5.0
+ *
+ * @return string
+ */
+function bp_get_settings_slug() {
+
     /**
-     * Return the settings component slug.
+     * Filters the Settings component slug.
      *
      * @since 1.5.0
      *
-     * @return string
+     * @param string $slug Settings component slug.
      */
-    function bp_get_settings_slug() {
-
-        /**
-         * Filters the Settings component slug.
-         *
-         * @since 1.5.0
-         *
-         * @param string $slug Settings component slug.
-         */
-        return apply_filters( 'bp_get_settings_slug', buddypress()->settings->slug );
-    }
+    return apply_filters( 'bp_get_settings_slug', buddypress()->settings->slug );
+}
 
 /**
@@ -46 +47 @@
     echo bp_get_settings_root_slug();
 }
+
+/**
+ * Return the settings component root slug.
+ *
+ * @since 1.5.0
+ *
+ * @return string
+ */
+function bp_get_settings_root_slug() {
+
     /**
-     * Return the settings component root slug.
+     * Filters the Settings component root slug.
      *
      * @since 1.5.0
      *
-     * @return string
+     * @param string $root_slug Settings component root slug.
      */
-    function bp_get_settings_root_slug() {
-
-        /**
-         * Filters the Settings component root slug.
-         *
-         * @since 1.5.0
-         *
-         * @param string $root_slug Settings component root slug.
-         */
-        return apply_filters( 'bp_get_settings_root_slug', buddypress()->settings->root_slug );
-    }
+    return apply_filters( 'bp_get_settings_root_slug', buddypress()->settings->root_slug );
+}
 
 /**