Changeset 9602 for trunk/src/bp-core/bp-core-cssjs.php

Timestamp:

03/05/2015 06:38:55 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-cssjs.php.

See #5940.

File:

• trunk/src/bp-core/bp-core-cssjs.php (modified) (5 diffs)

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

@@ -18 +18 @@
     $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
     $url = buddypress()->plugin_url . 'bp-core/js/';
-    
+
+    /**
+     * Filters the BuddyPress Core javascript files to register.
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @param array $value Array of javascript file information to register.
+     */
     $scripts = apply_filters( 'bp_core_register_common_scripts', array(
 
@@ -50 +57 @@
     $url = buddypress()->plugin_url . 'bp-core/css/';
 
+    /**
+     * Filters the URL for the Admin Bar stylesheet.
+     *
+     * @since BuddyPress (1.1.0)
+     *
+     * @param string $value URL for the Admin Bar stylesheet.
+     */
+    $admin_bar_file = apply_filters( 'bp_core_admin_bar_css', "{$url}admin-bar{$min}.css" );
+
+    /**
+     * Filters the BuddyPress Core stylesheet files to register.
+     *
+     * @since BuddyPress (2.1.0)
+     *
+     * @param array $value Array of stylesheet file information to register.
+     */
     $styles = apply_filters( 'bp_core_register_common_styles', array(
         'bp-admin-bar' => array(
-            'file'         => apply_filters( 'bp_core_admin_bar_css', "{$url}admin-bar{$min}.css" ),
+            'file'         => $admin_bar_file,
             'dependencies' => array( 'admin-bar' )
         )
@@ -102 +125 @@
 function bp_core_add_cropper_inline_js() {
 
-    // Bail if no image was uploaded
+    /**
+     * Filters the return value of getimagesize to determine if an image was uploaded.
+     *
+     * @since BuddyPress (1.1.0)
+     *
+     * @param array $value Array of data found by getimagesize.
+     */
     $image = apply_filters( 'bp_inline_cropper_image', getimagesize( bp_core_avatar_upload_path() . buddypress()->avatar_admin->image->dir ) );
     if ( empty( $image ) ) {
@@ -242 +271 @@
  */
 function bp_core_ajax_url() {
+
+    /**
+     * Filters the proper value for BuddyPress' ajaxurl.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $value Proper ajaxurl value for BuddyPress.
+     */
     return apply_filters( 'bp_core_ajax_url', admin_url( 'admin-ajax.php', is_ssl() ? 'admin' : 'http' ) );
 }
@@ -255 +292 @@
  */
 function bp_core_get_js_dependencies() {
+
+    /**
+     * Filters the javascript dependencies for buddypress.js.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param array $value Array of javascript dependencies for buddypress.js.
+     */
     return apply_filters( 'bp_core_get_js_dependencies', array(
         'jquery',