users.php
109 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Users, Roles and Capabilities related functions. |
| 4 | * |
| 5 | * @version $Rev: 203758 $ |
| 6 | * @author Jordi Canals |
| 7 | * @copyright Copyright (C) 2008, 2009, 2010 Jordi Canals |
| 8 | * @license GNU General Public License version 2 |
| 9 | * @link http://alkivia.org |
| 10 | * @package Alkivia |
| 11 | * @subpackage Framework |
| 12 | * |
| 13 | |
| 14 | Copyright 2008, 2009, 2010 Jordi Canals <devel@jcanals.cat> |
| 15 | |
| 16 | This program is free software; you can redistribute it and/or |
| 17 | modify it under the terms of the GNU General Public License |
| 18 | version 2 as published by the Free Software Foundation. |
| 19 | |
| 20 | This program is distributed in the hope that it will be useful, |
| 21 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 22 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 23 | GNU General Public License for more details. |
| 24 | |
| 25 | You should have received a copy of the GNU General Public License |
| 26 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * Returns all valid roles. |
| 31 | * The returned list can be translated or not. |
| 32 | * |
| 33 | * @uses apply_filters() Calls the 'alkivia_roles_translate' hook on translated roles array. |
| 34 | * @since 0.5 |
| 35 | * |
| 36 | * @param boolean $translate If the returned roles have to be translated or not. |
| 37 | * @return array All defined roles. If translated, the key is the role name and value is the translated role. |
| 38 | */ |
| 39 | function ak_get_roles( $translate = false ) { |
| 40 | global $wp_roles; |
| 41 | if ( ! isset( $wp_roles ) ) { |
| 42 | $wp_roles = new WP_Roles(); |
| 43 | } |
| 44 | |
| 45 | $roles = $wp_roles->get_names(); |
| 46 | if ( $translate ) { |
| 47 | foreach ($roles as $k => $r) { |
| 48 | $roles[$k] = _x($r, 'User role'); |
| 49 | } |
| 50 | asort($roles); |
| 51 | return apply_filters('alkivia_roles_translate', $roles); |
| 52 | } else { |
| 53 | $roles = array_keys($roles); |
| 54 | asort($roles); |
| 55 | return $roles; |
| 56 | } |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Generates the caps names from user level. |
| 61 | * |
| 62 | * @since 0.5 |
| 63 | * |
| 64 | * @param int $level Level to convert to caps |
| 65 | * @return array Generated caps |
| 66 | */ |
| 67 | function ak_level2caps( $level ) { |
| 68 | $caps = array(); |
| 69 | $level = min(10, intval($level)); |
| 70 | |
| 71 | for ( $i = $level; $i >= 0; $i--) { |
| 72 | $caps["level_{$i}"] = true; |
| 73 | } |
| 74 | |
| 75 | return $caps; |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Finds the proper level from a capabilities list. |
| 80 | * |
| 81 | * @since 0.5 |
| 82 | * |
| 83 | * @uses _ak_level_reduce() |
| 84 | * @param array $caps List of capabilities. |
| 85 | * @return int Level found, if no level found, will return 0. |
| 86 | */ |
| 87 | function ak_caps2level( $caps ) { |
| 88 | $level = array_reduce( array_keys( $caps ), '_ak_caps2level_CB', 0); |
| 89 | return $level; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Callback function to find the level from caps. |
| 94 | * Taken from WordPress 2.7.1 |
| 95 | * |
| 96 | * @since 0.5 |
| 97 | * @access private |
| 98 | * |
| 99 | * @return int level Level found. |
| 100 | */ |
| 101 | function _ak_caps2level_CB( $max, $item ) { |
| 102 | if ( preg_match( '/^level_(10|[0-9])$/i', $item, $matches ) ) { |
| 103 | $level = intval( $matches[1] ); |
| 104 | return max( $max, $level ); |
| 105 | } else { |
| 106 | return $max; |
| 107 | } |
| 108 | } |
| 109 |