3 * Misc WordPress Administration API.
6 * @subpackage Administration
10 * {@internal Missing Short Description}}
16 function got_mod_rewrite() {
17 $got_rewrite = apache_mod_loaded('mod_rewrite', true);
18 return apply_filters('got_rewrite', $got_rewrite);
22 * {@internal Missing Short Description}}
26 * @param unknown_type $filename
27 * @param unknown_type $marker
28 * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers.
30 function extract_from_markers( $filename, $marker ) {
33 if (!file_exists( $filename ) ) {
37 if ( $markerdata = explode( "\n", implode( '', file( $filename ) ) ));
40 foreach ( $markerdata as $markerline ) {
41 if (strpos($markerline, '# END ' . $marker) !== false)
44 $result[] = $markerline;
45 if (strpos($markerline, '# BEGIN ' . $marker) !== false)
54 * {@internal Missing Short Description}}
56 * Inserts an array of strings into a file (.htaccess ), placing it between
57 * BEGIN and END markers. Replaces existing marked info. Retains surrounding
58 * data. Creates file if none exists.
62 * @param unknown_type $filename
63 * @param unknown_type $marker
64 * @param unknown_type $insertion
65 * @return bool True on write success, false on failure.
67 function insert_with_markers( $filename, $marker, $insertion ) {
68 if (!file_exists( $filename ) || is_writeable( $filename ) ) {
69 if (!file_exists( $filename ) ) {
72 $markerdata = explode( "\n", implode( '', file( $filename ) ) );
75 if ( !$f = @fopen( $filename, 'w' ) )
81 foreach ( $markerdata as $n => $markerline ) {
82 if (strpos($markerline, '# BEGIN ' . $marker) !== false)
85 if ( $n + 1 < count( $markerdata ) )
86 fwrite( $f, "{$markerline}\n" );
88 fwrite( $f, "{$markerline}" );
90 if (strpos($markerline, '# END ' . $marker) !== false) {
91 fwrite( $f, "# BEGIN {$marker}\n" );
92 if ( is_array( $insertion ))
93 foreach ( $insertion as $insertline )
94 fwrite( $f, "{$insertline}\n" );
95 fwrite( $f, "# END {$marker}\n" );
102 fwrite( $f, "\n# BEGIN {$marker}\n" );
103 foreach ( $insertion as $insertline )
104 fwrite( $f, "{$insertline}\n" );
105 fwrite( $f, "# END {$marker}\n" );
115 * Updates the htaccess file with the current rules if it is writable.
117 * Always writes to the file if it exists and is writable to ensure that we
118 * blank out old rules.
122 function save_mod_rewrite_rules() {
123 if ( is_multisite() )
128 $home_path = get_home_path();
129 $htaccess_file = $home_path.'.htaccess';
131 // If the file doesn't already exist check for write access to the directory and whether we have some rules.
132 // else check for write access to the file.
133 if ((!file_exists($htaccess_file) && is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks()) || is_writable($htaccess_file)) {
134 if ( got_mod_rewrite() ) {
135 $rules = explode( "\n", $wp_rewrite->mod_rewrite_rules() );
136 return insert_with_markers( $htaccess_file, 'WordPress', $rules );
144 * Updates the IIS web.config file with the current rules if it is writable.
145 * If the permalinks do not require rewrite rules then the rules are deleted from the web.config file.
149 * @return bool True if web.config was updated successfully
151 function iis7_save_url_rewrite_rules(){
152 if ( is_multisite() )
157 $home_path = get_home_path();
158 $web_config_file = $home_path . 'web.config';
160 // Using win_is_writable() instead of is_writable() because of a bug in Windows PHP
161 if ( iis7_supports_permalinks() && ( ( ! file_exists($web_config_file) && win_is_writable($home_path) && $wp_rewrite->using_mod_rewrite_permalinks() ) || win_is_writable($web_config_file) ) ) {
162 $rule = $wp_rewrite->iis7_url_rewrite_rules(false, '', '');
163 if ( ! empty($rule) ) {
164 return iis7_add_rewrite_rule($web_config_file, $rule);
166 return iis7_delete_rewrite_rule($web_config_file);
173 * {@internal Missing Short Description}}
177 * @param unknown_type $file
179 function update_recently_edited( $file ) {
180 $oldfiles = (array ) get_option( 'recently_edited' );
182 $oldfiles = array_reverse( $oldfiles );
184 $oldfiles = array_reverse( $oldfiles );
185 $oldfiles = array_unique( $oldfiles );
186 if ( 5 < count( $oldfiles ))
187 array_pop( $oldfiles );
191 update_option( 'recently_edited', $oldfiles );
195 * If siteurl or home changed, flush rewrite rules.
199 * @param unknown_type $old_value
200 * @param unknown_type $value
202 function update_home_siteurl( $old_value, $value ) {
205 if ( defined( "WP_INSTALLING" ) )
208 // If home changed, write rewrite rules to new location.
209 $wp_rewrite->flush_rules();
212 add_action( 'update_option_home', 'update_home_siteurl', 10, 2 );
213 add_action( 'update_option_siteurl', 'update_home_siteurl', 10, 2 );
216 * Shorten an URL, to be used as link text
223 function url_shorten( $url ) {
224 $short_url = str_replace( 'http://', '', stripslashes( $url ));
225 $short_url = str_replace( 'www.', '', $short_url );
226 if ('/' == substr( $short_url, -1 ))
227 $short_url = substr( $short_url, 0, -1 );
228 if ( strlen( $short_url ) > 35 )
229 $short_url = substr( $short_url, 0, 32 ).'...';
234 * Resets global variables based on $_GET and $_POST
236 * This function resets global variables based on the names passed
237 * in the $vars array to the value of $_POST[$var] or $_GET[$var] or ''
238 * if neither is defined.
242 * @param array $vars An array of globals to reset.
244 function wp_reset_vars( $vars ) {
245 for ( $i=0; $i<count( $vars ); $i += 1 ) {
249 if ( empty( $_POST[$var] ) ) {
250 if ( empty( $_GET[$var] ) )
255 $$var = $_POST[$var];
261 * {@internal Missing Short Description}}
265 * @param unknown_type $message
267 function show_message($message) {
268 if ( is_wp_error($message) ){
269 if ( $message->get_error_data() )
270 $message = $message->get_error_message() . ': ' . $message->get_error_data();
272 $message = $message->get_error_message();
274 echo "<p>$message</p>\n";
275 wp_ob_end_flush_all();
279 function wp_doc_link_parse( $content ) {
280 if ( !is_string( $content ) || empty( $content ) )
283 if ( !function_exists('token_get_all') )
286 $tokens = token_get_all( $content );
287 $functions = array();
288 $ignore_functions = array();
289 for ( $t = 0, $count = count( $tokens ); $t < $count; $t++ ) {
290 if ( !is_array( $tokens[$t] ) ) continue;
291 if ( T_STRING == $tokens[$t][0] && ( '(' == $tokens[ $t + 1 ] || '(' == $tokens[ $t + 2 ] ) ) {
292 // If it's a function or class defined locally, there's not going to be any docs available
293 if ( ( isset( $tokens[ $t - 2 ][1] ) && in_array( $tokens[ $t - 2 ][1], array( 'function', 'class' ) ) ) || ( isset( $tokens[ $t - 2 ][0] ) && T_OBJECT_OPERATOR == $tokens[ $t - 1 ][0] ) ) {
294 $ignore_functions[] = $tokens[$t][1];
296 // Add this to our stack of unique references
297 $functions[] = $tokens[$t][1];
301 $functions = array_unique( $functions );
303 $ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );
304 $ignore_functions = array_unique( $ignore_functions );
307 foreach ( $functions as $function ) {
308 if ( in_array( $function, $ignore_functions ) )
317 * Saves option for number of rows when listing posts, pages, comments, etc.
321 function set_screen_options() {
323 if ( isset($_POST['wp_screen_options']) && is_array($_POST['wp_screen_options']) ) {
324 check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );
326 if ( !$user = wp_get_current_user() )
328 $option = $_POST['wp_screen_options']['option'];
329 $value = $_POST['wp_screen_options']['value'];
331 if ( !preg_match( '/^[a-z_-]+$/', $option ) )
334 $option = str_replace('-', '_', $option);
336 $map_option = $option;
337 $type = str_replace('edit_', '', $map_option);
338 $type = str_replace('_per_page', '', $type);
339 if ( in_array($type, get_post_types()) )
340 $map_option = 'edit_per_page';
341 if ( in_array( $type, get_taxonomies()) )
342 $map_option = 'edit_tags_per_page';
345 switch ( $map_option ) {
346 case 'edit_per_page':
347 case 'users_per_page':
348 case 'edit_comments_per_page':
349 case 'upload_per_page':
350 case 'edit_tags_per_page':
351 case 'plugins_per_page':
353 case 'sites_network_per_page':
354 case 'users_network_per_page':
355 case 'site_users_network_per_page':
356 case 'plugins_network_per_page':
357 case 'themes_network_per_page':
358 case 'site_themes_network_per_page':
359 $value = (int) $value;
360 if ( $value < 1 || $value > 999 )
364 $value = apply_filters('set-screen-option', false, $option, $value);
365 if ( false === $value )
370 update_user_meta($user->ID, $option, $value);
371 wp_redirect( remove_query_arg( array('pagenum', 'apage', 'paged'), wp_get_referer() ) );
376 function wp_menu_unfold() {
377 if ( isset($_GET['unfoldmenu']) ) {
378 delete_user_setting('mfold');
379 wp_redirect( remove_query_arg( 'unfoldmenu', stripslashes($_SERVER['REQUEST_URI']) ) );
385 * Check if rewrite rule for WordPress already exists in the IIS 7 configuration file
390 * @param string $filename The file path to the configuration file
392 function iis7_rewrite_rule_exists($filename) {
393 if ( ! file_exists($filename) )
395 if ( ! class_exists('DOMDocument') )
398 $doc = new DOMDocument();
399 if ( $doc->load($filename) === false )
401 $xpath = new DOMXPath($doc);
402 $rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
403 if ( $rules->length == 0 )
410 * Delete WordPress rewrite rule from web.config file if it exists there
414 * @param string $filename Name of the configuration file
417 function iis7_delete_rewrite_rule($filename) {
418 // If configuration file does not exist then rules also do not exist so there is nothing to delete
419 if ( ! file_exists($filename) )
422 if ( ! class_exists('DOMDocument') )
425 $doc = new DOMDocument();
426 $doc->preserveWhiteSpace = false;
428 if ( $doc -> load($filename) === false )
430 $xpath = new DOMXPath($doc);
431 $rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
432 if ( $rules->length > 0 ) {
433 $child = $rules->item(0);
434 $parent = $child->parentNode;
435 $parent->removeChild($child);
436 $doc->formatOutput = true;
437 saveDomDocument($doc, $filename);
443 * Add WordPress rewrite rule to the IIS 7 configuration file.
447 * @param string $filename The file path to the configuration file
448 * @param string $rewrite_rule The XML fragment with URL Rewrite rule
451 function iis7_add_rewrite_rule($filename, $rewrite_rule) {
452 if ( ! class_exists('DOMDocument') )
455 // If configuration file does not exist then we create one.
456 if ( ! file_exists($filename) ) {
457 $fp = fopen( $filename, 'w');
458 fwrite($fp, '<configuration/>');
462 $doc = new DOMDocument();
463 $doc->preserveWhiteSpace = false;
465 if ( $doc->load($filename) === false )
468 $xpath = new DOMXPath($doc);
470 // First check if the rule already exists as in that case there is no need to re-add it
471 $wordpress_rules = $xpath->query('/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')]');
472 if ( $wordpress_rules->length > 0 )
475 // Check the XPath to the rewrite rule and create XML nodes if they do not exist
476 $xmlnodes = $xpath->query('/configuration/system.webServer/rewrite/rules');
477 if ( $xmlnodes->length > 0 ) {
478 $rules_node = $xmlnodes->item(0);
480 $rules_node = $doc->createElement('rules');
482 $xmlnodes = $xpath->query('/configuration/system.webServer/rewrite');
483 if ( $xmlnodes->length > 0 ) {
484 $rewrite_node = $xmlnodes->item(0);
485 $rewrite_node->appendChild($rules_node);
487 $rewrite_node = $doc->createElement('rewrite');
488 $rewrite_node->appendChild($rules_node);
490 $xmlnodes = $xpath->query('/configuration/system.webServer');
491 if ( $xmlnodes->length > 0 ) {
492 $system_webServer_node = $xmlnodes->item(0);
493 $system_webServer_node->appendChild($rewrite_node);
495 $system_webServer_node = $doc->createElement('system.webServer');
496 $system_webServer_node->appendChild($rewrite_node);
498 $xmlnodes = $xpath->query('/configuration');
499 if ( $xmlnodes->length > 0 ) {
500 $config_node = $xmlnodes->item(0);
501 $config_node->appendChild($system_webServer_node);
503 $config_node = $doc->createElement('configuration');
504 $doc->appendChild($config_node);
505 $config_node->appendChild($system_webServer_node);
511 $rule_fragment = $doc->createDocumentFragment();
512 $rule_fragment->appendXML($rewrite_rule);
513 $rules_node->appendChild($rule_fragment);
515 $doc->encoding = "UTF-8";
516 $doc->formatOutput = true;
517 saveDomDocument($doc, $filename);
523 * Saves the XML document into a file
527 * @param DOMDocument $doc
528 * @param string $filename
530 function saveDomDocument($doc, $filename) {
531 $config = $doc->saveXML();
532 $config = preg_replace("/([^\r])\n/", "$1\r\n", $config);
533 $fp = fopen($filename, 'w');
534 fwrite($fp, $config);
539 * Workaround for Windows bug in is_writable() function
543 * @param string $path
546 function win_is_writable( $path ) {
547 /* will work in despite of Windows ACLs bug
548 * NOTE: use a trailing slash for folders!!!
549 * see http://bugs.php.net/bug.php?id=27609
550 * see http://bugs.php.net/bug.php?id=30931
553 if ( $path[strlen( $path ) - 1] == '/' ) // recursively return a temporary file path
554 return win_is_writable( $path . uniqid( mt_rand() ) . '.tmp');
555 else if ( is_dir( $path ) )
556 return win_is_writable( $path . '/' . uniqid( mt_rand() ) . '.tmp' );
557 // check tmp file for read/write capabilities
558 $should_delete_tmp_file = !file_exists( $path );
559 $f = @fopen( $path, 'a' );
563 if ( $should_delete_tmp_file )
569 * Display the default admin color scheme picker (Used in user-edit.php)
573 function admin_color_scheme_picker() {
574 global $_wp_admin_css_colors, $user_id; ?>
575 <fieldset><legend class="screen-reader-text"><span><?php _e('Admin Color Scheme')?></span></legend>
577 $current_color = get_user_option('admin_color', $user_id);
578 if ( empty($current_color) )
579 $current_color = 'fresh';
580 foreach ( $_wp_admin_css_colors as $color => $color_info ): ?>
581 <div class="color-option"><input name="admin_color" id="admin_color_<?php echo $color; ?>" type="radio" value="<?php echo esc_attr($color) ?>" class="tog" <?php checked($color, $current_color); ?> />
582 <table class="color-palette">
584 <?php foreach ( $color_info->colors as $html_color ): ?>
585 <td style="background-color: <?php echo $html_color ?>" title="<?php echo $color ?>"> </td>
590 <label for="admin_color_<?php echo $color; ?>"><?php echo $color_info->name ?></label>