Changeset 10152

Timestamp:

09/29/2015 10:03:53 PM (9 years ago)

Author:

imath

Message:

Allow Administrators to disable/enable the Cover Image Feature from the BuddyPress settings (Administration screen)

• Create two new options for targeted components (xProfile & Groups)
• Generate two new setting fields into the components setting sections as soon as the feature is active. By default, the two new checkboxes are enabled.
• Introduce two new functions to check if the Administrator disallowed cover image uploads for Users (bp_disable_cover_image_uploads()) and Groups (bp_disable_group_cover_image_uploads()).
• Edit the bp_is_active() function to take in account the particularity of the xProfile component. See below for a detailled explanation.
• Introduce a new conditional tag to check if the current page is the profile "change-cover-image" screen.

The bp_is_active() function first checks into the "bp-active-components" database option to see if the component is active. In this option the xProfile component is keyed "xprofile". But the component global holding the extended BP_Component class is keyed "profile" and features are inside a property of this component global. So to be able to check if a feature attached to the xProfile component is active, we needed to edit this function changing the component key from "xprofile" to "profile". As a result, the xProfile filter to deactivate/activate the cover image is bp_is_profile_cover_image_active. For the Groups component, the filter is bp_is_groups_cover_image_active.

Props mercime, r-a-y

See #6570

Location:

trunk/src/bp-core

Files:

• admin/bp-core-admin-settings.php (modified) (3 diffs)
• bp-core-admin.php (modified) (2 diffs)
• bp-core-options.php (modified) (4 diffs)
• bp-core-template.php (modified) (2 diffs)

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

@@ -160 +160 @@
 }
 
+/**
+ * Allow members to upload cover images field.
+ *
+ * @since 2.4.0
+ */
+function bp_admin_setting_callback_cover_image_uploads() {
+?>
+    <input id="bp-disable-cover-image-uploads" name="bp-disable-cover-image-uploads" type="checkbox" value="1" <?php checked( ! bp_disable_cover_image_uploads() ); ?> />
+    <label for="bp-disable-cover-image-uploads"><?php _e( 'Allow registered members to upload cover images', 'buddypress' ); ?></label>
+<?php
+}
+
 /** Groups Section ************************************************************/
 
@@ -195 +207 @@
     <input id="bp-disable-group-avatar-uploads" name="bp-disable-group-avatar-uploads" type="checkbox" value="1" <?php checked( ! bp_disable_group_avatar_uploads() ); ?> />
     <label for="bp-disable-group-avatar-uploads"><?php _e( 'Allow customizable avatars for groups', 'buddypress' ); ?></label>
+<?php
+}
+
+/**
+ * 'Enable group cover images' field markup.
+ *
+ * @since 2.4.0
+ */
+function bp_admin_setting_callback_group_cover_image_uploads() {
+?>
+    <input id="bp-disable-group-cover-image-uploads" name="bp-disable-group-cover-image-uploads" type="checkbox" value="1" <?php checked( ! bp_disable_group_cover_image_uploads() ); ?> />
+    <label for="bp-disable-group-cover-image-uploads"><?php _e( 'Allow customizable cover images for groups', 'buddypress' ); ?></label>
 <?php
 }
@@ -300 +324 @@
             'bp-disable-account-deletion',
             'bp-disable-avatar-uploads',
+            'bp-disable-cover-image-uploads',
             'bp-disable-group-avatar-uploads',
+            'bp-disable-group-cover-image-uploads',
             'bp_disable_blogforum_comments',
             'bp-disable-profile-sync',

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

@@ -339 +339 @@
             add_settings_section( 'bp_xprofile', _x( 'Profile Settings', 'BuddyPress setting tab', 'buddypress' ), 'bp_admin_setting_callback_xprofile_section', 'buddypress' );
 
+            // Avatars
             add_settings_field( 'bp-disable-avatar-uploads', __( 'Profile Photo Uploads', 'buddypress' ), 'bp_admin_setting_callback_avatar_uploads', 'buddypress', 'bp_xprofile' );
             register_setting( 'buddypress', 'bp-disable-avatar-uploads', 'intval' );
+
+            // Cover images
+            if ( bp_is_active( 'xprofile', 'cover_image' ) ) {
+                add_settings_field( 'bp-disable-cover-image-uploads', __( 'Cover Image Uploads', 'buddypress' ), 'bp_admin_setting_callback_cover_image_uploads', 'buddypress', 'bp_xprofile' );
+                register_setting( 'buddypress', 'bp-disable-cover-image-uploads', 'intval' );
+            }
 
             // Profile sync setting
@@ -361 +368 @@
             add_settings_field( 'bp-disable-group-avatar-uploads', __( 'Group Photo Uploads', 'buddypress' ), 'bp_admin_setting_callback_group_avatar_uploads', 'buddypress', 'bp_groups' );
             register_setting( 'buddypress', 'bp-disable-group-avatar-uploads', 'intval' );
+
+            // Allow group cover images.
+            if ( bp_is_active( 'groups', 'cover_image' ) ) {
+                add_settings_field( 'bp-disable-group-cover-image-uploads', __( 'Group Cover Image Uploads', 'buddypress' ), 'bp_admin_setting_callback_group_cover_image_uploads', 'buddypress', 'bp_groups' );
+                register_setting( 'buddypress', 'bp-disable-group-cover-image-uploads', 'intval' );
+            }
         }
 

trunk/src/bp-core/bp-core-options.php

@@ -24 +24 @@
         /** Components ********************************************************/
 
-        'bp-deactivated-components'       => array(),
+        'bp-deactivated-components'            => array(),
 
         /** bbPress ***********************************************************/
 
         // Legacy bbPress config location
-        'bb-config-location'              => ABSPATH . 'bb-config.php',
+        'bb-config-location'                   => ABSPATH . 'bb-config.php',
 
         /** XProfile **********************************************************/
 
         // Base profile groups name
-        'bp-xprofile-base-group-name'     => 'Base',
+        'bp-xprofile-base-group-name'          => 'Base',
 
         // Base fullname field name
-        'bp-xprofile-fullname-field-name' => 'Name',
+        'bp-xprofile-fullname-field-name'      => 'Name',
 
         /** Blogs *************************************************************/
 
         // Used to decide if blogs need indexing
-        'bp-blogs-first-install'          => false,
+        'bp-blogs-first-install'               => false,
 
         /** Settings **********************************************************/
 
         // Disable the WP to BP profile sync
-        'bp-disable-profile-sync'         => false,
+        'bp-disable-profile-sync'              => false,
 
         // Hide the Toolbar for logged out users
-        'hide-loggedout-adminbar'         => false,
+        'hide-loggedout-adminbar'              => false,
 
         // Avatar uploads
-        'bp-disable-avatar-uploads'       => false,
+        'bp-disable-avatar-uploads'            => false,
+
+        // Cover image uploads
+        'bp-disable-cover-image-uploads'       => false,
 
         // Group Profile Photos
-        'bp-disable-group-avatar-uploads' => false,
+        'bp-disable-group-avatar-uploads'      => false,
+
+        // Group Cover image uploads
+        'bp-disable-group-cover-image-uploads' => false,
 
         // Allow users to delete their own accounts
-        'bp-disable-account-deletion'     => false,
+        'bp-disable-account-deletion'          => false,
 
         // Allow comments on blog and forum activity items
-        'bp-disable-blogforum-comments'   => true,
+        'bp-disable-blogforum-comments'        => true,
 
         // The ID for the current theme package.
-        '_bp_theme_package_id'            => 'legacy',
+        '_bp_theme_package_id'                 => 'legacy',
 
         /** Groups ************************************************************/
@@ -72 +78 @@
 
         // Restrict group creation to super admins
-        'bp_restrict_group_creation'      => false,
+        'bp_restrict_group_creation'           => false,
 
         /** Akismet ***********************************************************/
 
         // Users from all sites can post
-        '_bp_enable_akismet'              => true,
+        '_bp_enable_akismet'                   => true,
 
         /** Activity HeartBeat ************************************************/
 
         // HeartBeat is on to refresh activities
-        '_bp_enable_heartbeat_refresh'    => true,
+        '_bp_enable_heartbeat_refresh'         => true,
 
         /** BuddyBar **********************************************************/
 
         // Force the BuddyBar
-        '_bp_force_buddybar'              => false,
+        '_bp_force_buddybar'                   => false,
 
         /** Legacy theme *********************************************/
 
         // Whether to register the bp-default themes directory
-        '_bp_retain_bp_default'           => false,
+        '_bp_retain_bp_default'                => false,
 
         /** Widgets **************************************************/
@@ -597 +603 @@
 
 /**
+ * Are members able to upload their own cover images?
+ *
+ * @since 2.4.0
+ *
+ * @uses bp_get_option() To get the cover image uploads option.
+ *
+ * @param bool $default Optional. Fallback value if not found in the database.
+ *                      Default: false.
+ *
+ * @return bool True if cover image uploads are disabled, otherwise false.
+ */
+function bp_disable_cover_image_uploads( $default = false ) {
+
+    /**
+     * Filters whether or not members are able to upload their own cover images.
+     *
+     * @since 2.4.0
+     *
+     * @param bool $value Whether or not members are able to upload their own cover images.
+     */
+    return (bool) apply_filters( 'bp_disable_cover_image_uploads', (bool) bp_get_option( 'bp-disable-cover-image-uploads', $default ) );
+}
+
+/**
  * Are group avatars disabled?
  *
@@ -629 +659 @@
      */
     return (bool) apply_filters( 'bp_disable_group_avatar_uploads', $disabled, $default );
+}
+
+/**
+ * Are group cover images disabled?
+ *
+ * @since 2.4.0
+ *
+ * @uses bp_get_option() To get the group cover image uploads option.
+ *
+ * @param bool $default Optional. Fallback value if not found in the database.
+ *                      Default: false.
+ *
+ * @return bool True if group cover image uploads are disabled, otherwise false.
+ */
+function bp_disable_group_cover_image_uploads( $default = false ) {
+
+    /**
+     * Filters whether or not members are able to upload group cover images.
+     *
+     * @since 2.4.0
+     *
+     * @param bool $value Whether or not members are able to upload thier groups cover images.
+     */
+    return (bool) apply_filters( 'bp_disable_group_cover_image_uploads', (bool) bp_get_option( 'bp-disable-group-cover-image-uploads', $default ) );
 }
 

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

@@ -1935 +1935 @@
         // Is feature active?
         if ( ! empty( $feature ) ) {
+            // The xProfile component is specific
+            if ( 'xprofile' === $component ) {
+                $component = 'profile';
+            }
+
             if ( empty( buddypress()->$component->features ) || false === in_array( $feature, buddypress()->$component->features, true ) ) {
                 $retval = false;
@@ -2245 +2250 @@
 function bp_is_user_change_avatar() {
     return (bool) ( bp_is_profile_component() && bp_is_current_action( 'change-avatar' ) );
+}
+
+/**
+ * Is the current page the a user's change cover image profile page?
+ *
+ * Eg http://example.com/members/joe/profile/change-cover-image/ (or a subpage thereof).
+ *
+ * @since  2.4.0
+ *
+ * @return True if the current page is a user's profile edit cover image page.
+ */
+function bp_is_user_change_cover_image() {
+    return (bool) ( bp_is_profile_component() && bp_is_current_action( 'change-cover-image' ) );
 }