Changeset 8090

Timestamp:

06/15/08 09:32:19 (3 months ago)

Author:

westi

Message:

PHPDoc updates for category.php. Fixes #5633 props jacobsantos.

Files:

• trunk/wp-includes/category.php (modified) (12 diffs)

trunk/wp-includes/category.php

@@ -1 +1 @@
-<?php
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_all_category_ids() {
-    if ( ! $cat_ids = wp_cache_get('all_category_ids', 'category') ) {
@@ -10 +23 @@
-}
-
+/**
+ * Retrieve list of category objects.
+ *
+ * If you change the type to 'link' in the arguments, then the link categories
+ * will be returned instead. Also all categories will be updated to be backwards
+ * compatible with pre-2.3 plugins and themes.
+ *
+ * @since 2.1.0
+ * @see get_terms() Type of arguments that can be changed.
+ * @link http://codex.wordpress.org/Function_Reference/get_categories
+ *
+ * @param string|array $args Optional. Change the defaults retrieving categories.
+ * @return array List of categories.
+ */
-function &get_categories($args = '') {
-    $defaults = array('type' => 'category');
@@ -25 +52 @@
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function &get_category($category, $output = OBJECT, $filter = 'raw') {
-    $category = get_term($category, 'category', $output, $filter);
@@ -37 +84 @@
-}
-
+/**
+ * Retrieve category based on URL containing the category slug.
+ *
+ * Breaks the $category_path parameter up to get the category slug.
+ *
+ * Tries to find the child path and will return it. If it doesn't find a
+ * match, then it will return the first category matching slug, if $full_match,
+ * is set to false. If it does not, then it will return null.
+ *
+ * It is also possible that it will return a WP_Error object on failure. Check
+ * for it when using this function.
+ *
+ * @since 2.1.0
+ *
+ * @param string $category_path URL containing category slugs.
+ * @param bool $full_match Optional. Whether should match full path or not.
+ * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
+ * @return null|object|array Null on failure. Type is based on $output value.
+ */
-function get_category_by_path($category_path, $full_match = true, $output = OBJECT) {
-    $category_path = rawurlencode(urldecode($category_path));
@@ -51 +117 @@
-
-    if ( empty($categories) )
-NULL
+null
-
-    foreach ($categories as $category) {
@@ -71 +137 @@
-        return get_category($categories[0]->term_id, $output);
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-function get_category_by_slug( $slug  ) {
-    $category = get_term_by('slug', $slug, 'category');
@@ -82 +156 @@
-}
-
-
+
+
+
+
+
+
+
+
+
-function get_cat_ID($cat_name='General') {
-    $cat = get_term_by('name', $cat_name, 'category');
@@ -90 +172 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-function get_catname($cat_ID) {
-    return get_cat_name($cat_ID);
-}
-
-
+
+
+
+
+
+
+
+
+
-function get_cat_name($cat_id) {
-    $cat_id = (int) $cat_id;
@@ -102 +202 @@
-}
-
+
+/**
+ * Check if a category is an ancestor of another category.
+ *
+ * You can use either an id or the category object for both parameters. If you
+ * use an integer the category will be retrieved.
+ *
+ * @since 2.1.0
+ *
+ * @param int|object $cat1 ID or object to check if this is the parent category.
+ * @param int|object $cat2 The child category.
+ * @return bool Whether $cat2 is child of $cat1
+ */
-function cat_is_ancestor_of($cat1, $cat2) {
-    if ( is_int($cat1) )
@@ -117 +230 @@
-}
-
+
+/**
+ * Sanitizes category data based on context.
+ *
+ * @since 2.3.0
+ * @uses sanitize_term() See this function for what context are supported.
+ *
+ * @param object|array $category Category data
+ * @param string $context Optional. Default is 'display'.
+ * @return object|array Same type as $category with sanitized data for safe use.
+ */
-function sanitize_category($category, $context = 'display') {
-    return sanitize_term($category, 'category', $context);
-}
-
+
+/**
+ * Sanitizes data in single category key field.
+ *
+ * @since 2.3.0
+ * @uses sanitize_term_field() See function for more details.
+ *
+ * @param string $field Category key to sanitize
+ * @param mixed $value Category value to sanitize
+ * @param int $cat_id Category ID
+ * @param string $context What filter to use, 'raw', 'display', etc.
+ * @return mixed Same type as $value after $value has been sanitized.
+ */
-function sanitize_category_field($field, $value, $cat_id, $context) {
-    return sanitize_term_field($field, $value, $cat_id, 'category', $context);
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-function &get_tags($args = '') {
-    $tags = get_terms('post_tag', $args);
@@ -137 +285 @@
-}
-
+
+/**
+ * Retrieve post tag by tag ID or tag object.
+ *
+ * If you pass the $tag parameter an object, which is assumed to be the tag row
+ * object retrieved the database. It will cache the tag data.
+ *
+ * If you pass $tag an integer of the tag ID, then that tag will
+ * be retrieved from the database, if it isn't already cached, and pass it back.
+ *
+ * If you look at get_term(), then both types will be passed through several
+ * filters and finally sanitized based on the $filter parameter value.
+ *
+ * @since 2.3.0
+ *
+ * @param int|object $tag
+ * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
+ * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
+ * @return object|array Return type based on $output value.
+ */
-function &get_tag($tag, $output = OBJECT, $filter = 'raw') {
-    return get_term($tag, 'post_tag', $output, $filter);
-}
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function update_category_cache() {
-    return true;
-}
-
+
+/**
+ * Remove the category cache data based on ID.
+ *
+ * @since 2.1.0
+ * @uses clean_term_cache() Clears the cache for the category based on ID
+ *
+ * @param int $id Category ID
+ */
-function clean_category_cache($id) {
-    clean_term_cache($id, 'category');
-}
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function _make_cat_compat( &$category) {
-    if ( is_object($category) ) {
@@ -175 +379 @@
-}
-
+
-?>