Changeset 25934 for trunk/src/wp-includes/bookmark.php

Timestamp:

10/26/2013 04:52:48 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/bookmark.php.

Props ShinichiN, kpdesign.
Fixes #25468.

File:

• trunk/src/wp-includes/bookmark.php (modified) (5 diffs)

trunk/src/wp-includes/bookmark.php

@@ -137 +137 @@
     if ( $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) {
         if ( is_array($cache) && isset( $cache[ $key ] ) )
-            return apply_filters('get_bookmarks', $cache[ $key ], $r );
+            $bookmarks = $cache[ $key ];
+            /**
+             * Filter the returned list of bookmarks.
+             *
+             * The first time the hook is evaluated in this file, it returns the cached
+             * bookmarks list. The second evaluation returns a cached bookmarks list if the
+             * link category is passed but does not exist. The third evaluation returns
+             * the full cached results.
+             *
+             * @since 2.1.0
+             *
+             * @see get_bookmarks()
+             *
+             * @param array $bookmarks List of the cached bookmarks.
+             * @param array $r         An array of bookmark query arguments.
+             */
+            return apply_filters( 'get_bookmarks', $bookmarks, $r );
     }
 
@@ -182 +198 @@
             $cache[ $key ] = array();
             wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
+            /** This filter is documented in wp-includes/bookmark.php */
             return apply_filters( 'get_bookmarks', array(), $r );
         }
@@ -264 +281 @@
     wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
 
-    return apply_filters('get_bookmarks', $results, $r);
+    /** This filter is documented in wp-includes/bookmark.php */
+    return apply_filters( 'get_bookmarks', $results, $r );
 }
 
@@ -353 +371 @@
 
     if ( 'edit' == $context ) {
-        $value = apply_filters("edit_$field", $value, $bookmark_id);
+        /** This filter is documented in wp-includes/post.php */
+        $value = apply_filters( "edit_$field", $value, $bookmark_id );
 
         if ( 'link_notes' == $field ) {
@@ -361 +380 @@
         }
     } else if ( 'db' == $context ) {
-        $value = apply_filters("pre_$field", $value);
+        /** This filter is documented in wp-includes/post.php */
+        $value = apply_filters( "pre_$field", $value );
     } else {
-        // Use display filters by default.
-        $value = apply_filters($field, $value, $bookmark_id, $context);
+        /** This filter is documented in wp-includes/post.php */
+        $value = apply_filters( $field, $value, $bookmark_id, $context );
 
         if ( 'attribute' == $context )