Changeset 10899 for trunk/src/bp-core/bp-core-filters.php

Timestamp:

06/23/2016 06:31:58 AM (9 years ago)

Author:

tw2113

Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:

• trunk/src/bp-core/bp-core-filters.php (modified) (12 diffs)

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

@@ -309 +309 @@
      * @since 1.6.0
      *
-  * @param bool    $value           Whether or not to redirect.
+     * @param bool    $value           Whether or not to redirect.
      * @param string  $redirect_to     Sanitized URL to be redirected to.
      * @param string  $redirect_to_raw Unsanitized URL to be redirected to.
@@ -350 +350 @@
  * @param string $prop      Email property to check against.
  * @param string $transform Either 'raw' or 'replace-tokens'.
+ * @return string $retval Modified email content.
  */
 function bp_email_plaintext_entity_decode( $retval, $prop, $transform ) {
@@ -546 +547 @@
  * @global object $bp BuddyPress global settings.
  *
- * @param  string $title       Original page title.
- * @param  string $sep         How to separate the various items within the page title.
- * @param  string $seplocation Direction to display title.
+ * @param string $title       Original page title.
+ * @param string $sep         How to separate the various items within the page title.
+ * @param string $seplocation Direction to display title.
  * @return string              New page title.
  */
@@ -596 +597 @@
      * Filters the older 'wp_title' page title for BuddyPress pages.
      *
-     * @since  1.5.0
-     *
-     * @param  string $new_title   The BuddyPress page title.
-     * @param  string $title       The original WordPress page title.
-     * @param  string $sep         The title parts separator.
-     * @param  string $seplocation Location of the separator (left or right).
+     * @since 1.5.0
+     *
+     * @param string $new_title   The BuddyPress page title.
+     * @param string $title       The original WordPress page title.
+     * @param string $sep         The title parts separator.
+     * @param string $seplocation Location of the separator (left or right).
      */
     return apply_filters( 'bp_modify_page_title', $new_title, $title, $sep, $seplocation );
@@ -649 +650 @@
      * Filters BuddyPress title parts that will be used into the document title.
      *
-     * @since  2.4.3
-     *
-     * @param  array $bp_title   The BuddyPress page title parts.
-     * @param  array $title      The original WordPress title parts.
+     * @since 2.4.3
+     *
+     * @param array $bp_title The BuddyPress page title parts.
+     * @param array $title    The original WordPress title parts.
      */
     return apply_filters( 'bp_modify_document_title_parts', $bp_title, $title );
@@ -750 +751 @@
  * Populate BuddyPress user nav items for the customizer.
  *
- * @since  2.3.3
- *
- * @param  array   $items  The array of menu items.
- * @param  string  $type   The requested type.
- * @param  string  $object The requested object name.
- * @param  integer $page   The page num being requested.
- * @return array           The paginated BuddyPress user nav items.
+ * @since 2.3.3
+ *
+ * @param array   $items  The array of menu items.
+ * @param string  $type   The requested type.
+ * @param string  $object The requested object name.
+ * @param integer $page   The page num being requested.
+ * @return array The paginated BuddyPress user nav items.
  */
 function bp_customizer_nav_menus_get_items( $items = array(), $type = '', $object = '', $page = 0 ) {
@@ -787 +788 @@
  * Set BuddyPress item navs for the customizer.
  *
- * @since  2.3.3
- *
- * @param  array $item_types An associative array structured for the customizer.
+ * @since 2.3.3
+ *
+ * @param array $item_types An associative array structured for the customizer.
  * @return array $item_types An associative array structured for the customizer.
  */
@@ -853 +854 @@
  * @since 2.1.0
  *
- * @param  string $edit_link The edit link.
- * @param  int    $post_id   Post ID.
+ * @param string $edit_link The edit link.
+ * @param int    $post_id   Post ID.
  * @return bool|string Will be a boolean (false) if $post_id is 0. Will be a string (the unchanged edit link)
  *                     otherwise
@@ -900 +901 @@
  *
  * @global array $wp_registered_widgets Current registered widgets.
- * @param  array $params                Current sidebar params.
+ *
+ * @param array $params Current sidebar params.
  * @return array
  */
@@ -952 +954 @@
  * @since 2.5.0
  *
- * @param string $value Property value.
- * @param string $property_name
- * @param string $transform How the return value was transformed.
+ * @param string $value         Property value.
+ * @param string $property_name Email template property name.
+ * @param string $transform     How the return value was transformed.
  * @return string Updated value.
  */
@@ -991 +993 @@
  * @since 2.5.0
  *
- * @param array $headers
- * @param string $property Name of property. Unused.
- * @param string $transform Return value transformation. Unused.
- * @param BP_Email $email Email object reference.
+ * @param array    $headers   Array of email headers.
+ * @param string   $property  Name of property. Unused.
+ * @param string   $transform Return value transformation. Unused.
+ * @param BP_Email $email     Email object reference.
  * @return array
  */
@@ -1010 +1012 @@
  * @since 2.5.0
  *
- * @param array $tokens Email tokens.
- * @param string $property_name Unused.
- * @param string $transform Unused.
- * @param BP_Email $email Email being sent.
+ * @param array    $tokens        Email tokens.
+ * @param string   $property_name Unused.
+ * @param string   $transform     Unused.
+ * @param BP_Email $email         Email being sent.
  * @return array
  */