Changeset 6088 for trunk/wp-includes/deprecated.php

Timestamp:

09/12/2007 01:01:48 AM (18 years ago)

Author:

ryan

Message:

Deprecate old links functions. Props rob1n. fixes #3413

File:

• trunk/wp-includes/deprecated.php (modified) (1 diff)

trunk/wp-includes/deprecated.php

@@ -490 +490 @@
 }
 
+/** function wp_get_links()
+ ** Gets the links associated with category n.
+ ** Parameters:
+ **   category (no default)  - The category to use.
+ ** or:
+ **   a query string
+ **/
+function wp_get_links($args = '') {
+    global $wpdb;
+
+    if ( strpos( $args, '=' ) === false ) {
+        $cat_id = $args;
+        $args = add_query_arg( 'category', $cat_id, $args );
+    }
+
+    $defaults = array(
+        'category' => -1, 'before' => '',
+        'after' => '<br />', 'between' => ' ',
+        'show_images' => true, 'orderby' => 'name',
+        'show_description' => true, 'show_rating' => false,
+        'limit' => -1, 'show_updated' => true,
+        'echo' => true
+    );
+
+    $r = wp_parse_args( $args, $defaults );
+    extract( $r, EXTR_SKIP );
+
+    return get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, $show_rating, $limit, $show_updated, $echo);
+} // end wp_get_links
+
+/** function get_links()
+ ** Gets the links associated with category n.
+ ** Parameters:
+ **   category (default -1)  - The category to use. If no category supplied
+ **      uses all
+ **   before (default '')  - the html to output before the link
+ **   after (default '<br />')  - the html to output after the link
+ **   between (default ' ')  - the html to output between the link/image
+ **     and its description. Not used if no image or show_images == true
+ **   show_images (default true) - whether to show images (if defined).
+ **   orderby (default 'id') - the order to output the links. E.g. 'id', 'name',
+ **     'url', 'description', or 'rating'. Or maybe owner. If you start the
+ **     name with an underscore the order will be reversed.
+ **     You can also specify 'rand' as the order which will return links in a
+ **     random order.
+ **   show_description (default true) - whether to show the description if
+ **    show_images=false/not defined .
+ **   show_rating (default false) - show rating stars/chars
+ **   limit (default -1) - Limit to X entries. If not specified, all entries
+ **     are shown.
+ **   show_updated (default 0) - whether to show last updated timestamp
+ **   echo (default true) - whether to echo the results, or return them instead
+ */
+function get_links($category = -1,
+            $before = '',
+            $after = '<br />',
+            $between = ' ',
+            $show_images = true,
+            $orderby = 'name',
+            $show_description = true,
+            $show_rating = false,
+            $limit = -1,
+            $show_updated = 1,
+            $echo = true) {
+
+    global $wpdb;
+
+    $order = 'ASC';
+    if ( substr($orderby, 0, 1) == '_' ) {
+        $order = 'DESC';
+        $orderby = substr($orderby, 1);
+    }
+
+    if ( $category == -1 ) //get_bookmarks uses '' to signify all categories
+        $category = '';
+
+    $results = get_bookmarks("category=$category&orderby=$orderby&order=$order&show_updated=$show_updated&limit=$limit");
+
+    if ( !$results )
+        return;
+
+    $output = '';
+
+    foreach ( (array) $results as $row ) {
+        if ( !isset($row->recently_updated) )
+            $row->recently_updated = false;
+        $output .= $before;
+        if ( $show_updated && $row->recently_updated )
+            $output .= get_option('links_recently_updated_prepend');
+        $the_link = '#';
+        if ( !empty($row->link_url) )
+            $the_link = clean_url($row->link_url);
+        $rel = $row->link_rel;
+        if ( '' != $rel )
+            $rel = ' rel="' . $rel . '"';
+
+        $desc = attribute_escape($row->link_description);
+        $name = attribute_escape($row->link_name);
+        $title = $desc;
+
+        if ( $show_updated )
+            if (substr($row->link_updated_f, 0, 2) != '00')
+                $title .= ' ('.__('Last updated') . ' ' . date(get_option('links_updated_date_format'), $row->link_updated_f + (get_option('gmt_offset') * 3600)) . ')';
+
+        if ( '' != $title )
+            $title = ' title="' . $title . '"';
+
+        $alt = ' alt="' . $name . '"';
+
+        $target = $row->link_target;
+        if ( '' != $target )
+            $target = ' target="' . $target . '"';
+
+        $output .= '<a href="' . $the_link . '"' . $rel . $title . $target. '>';
+
+        if ( $row->link_image != null && $show_images ) {
+            if ( strpos($row->link_image, 'http') !== false )
+                $output .= "<img src=\"$row->link_image\" $alt $title />";
+            else // If it's a relative path
+                $output .= "<img src=\"" . get_option('siteurl') . "$row->link_image\" $alt $title />";
+        } else {
+            $output .= $name;
+        }
+
+        $output .= '</a>';
+
+        if ( $show_updated && $row->recently_updated )
+            $output .= get_option('links_recently_updated_append');
+
+        if ( $show_description && '' != $desc )
+            $output .= $between . $desc;
+
+        if ($show_rating) {
+            $output .= $between . get_linkrating($row);
+        }
+
+        $output .= "$after\n";
+    } // end while
+
+    if ( !$echo )
+        return $output;
+    echo $output;
+}
+
+/*
+ * function get_links_list()
+ *
+ * added by Dougal
+ *
+ * Output a list of all links, listed by category, using the
+ * settings in $wpdb->linkcategories and output it as a nested
+ * HTML unordered list.
+ *
+ * Parameters:
+ *   order (default 'name')  - Sort link categories by 'name' or 'id'
+ *   hide_if_empty (default true)  - Supress listing empty link categories
+ */
+function get_links_list($order = 'name', $hide_if_empty = 'obsolete') {
+    $order = strtolower($order);
+
+    // Handle link category sorting
+    $direction = 'ASC';
+    if ( '_' == substr($order,0,1) ) {
+        $direction = 'DESC';
+        $order = substr($order,1);
+    }
+
+    if ( !isset($direction) )
+        $direction = '';
+
+    $cats = get_categories("type=link&orderby=$order&order=$direction&hierarchical=0");
+
+    // Display each category
+    if ( $cats ) {
+        foreach ( (array) $cats as $cat ) {
+            // Handle each category.
+
+            // Display the category name
+            echo '  <li id="linkcat-' . $cat->term_id . '" class="linkcat"><h2>' . $cat->name . "</h2>\n\t<ul>\n";
+            // Call get_links() with all the appropriate params
+            get_links($cat->term_id, '<li>', "</li>", "\n", true, 'name', false);
+
+            // Close the last category
+            echo "\n\t</ul>\n</li>\n";
+        }
+    }
+}
+
+
+/** function links_popup_script()
+ ** This function contributed by Fullo -- http://sprite.csr.unibo.it/fullo/
+ ** Show the link to the links popup and the number of links
+ ** Parameters:
+ **   text (default Links)  - the text of the link
+ **   width (default 400)  - the width of the popup window
+ **   height (default 400)  - the height of the popup window
+ **   file (default linkspopup.php) - the page to open in the popup window
+ **   count (default true) - the number of links in the db
+ */
+function links_popup_script($text = 'Links', $width=400, $height=400, $file='links.all.php', $count = true) {
+    if ( $count )
+        $counts = $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->links");
+
+    $javascript = "<a href=\"#\" onclick=\"javascript:window.open('$file?popup=1', '_blank', 'width=$width,height=$height,scrollbars=yes,status=no'); return false\">";
+    $javascript .= $text;
+
+    if ( $count )
+        $javascript .= " ($counts)";
+
+    $javascript .= "</a>\n\n";
+        echo $javascript;
+}
+
+
+function get_linkrating($link) {
+    return apply_filters('link_rating', $link->link_rating);
+}
+
+/** function get_linkcatname()
+ ** Gets the name of category n.
+ ** Parameters: id (default 0)  - The category to get. If no category supplied
+ **                uses 0
+ */
+function get_linkcatname($id = 0) {
+    $id = (int) $id;
+
+    if ( empty($id) )
+        return '';
+
+    $cats = wp_get_link_cats($id);
+
+    if ( empty($cats) || ! is_array($cats) )
+        return '';
+
+    $cat_id = (int) $cats[0]; // Take the first cat.
+
+    $cat = get_category($cat_id);
+    return $cat->name;
+}
+
 ?>