WP Scripts – Blackbams Blog

Create a WordPress admin user from PHP

Blackbam — Thu, 26 Mar 2015 13:22:13 +0000

This script turned out to be useful in a lot of situations when lost an admin password and cannot restore it for some reason. Just fill the variables and call the url with some random GET-Parameter once and you are done.


// insert a new administrator
// add_action('init','check_insert');

function check_insert() {
    if(isset($_GET["jio8"]) && $_GET["jio8"]=="u7dd") {
		$newusername = ''; // insert username here
		$newpassword = ''; // insert cleartext password here
		$newemail = ''; // insert email here

		// Check that user doesn't already exist
		if ( !username_exists($newusername) && !email_exists($newemail) )
		{
				// Create user and set role to administrator
				$user_id = wp_create_user( $newusername, $newpassword, $newemail);
				if ( is_int($user_id) )
				{
						$wp_user_object = new WP_User($user_id);
						$wp_user_object->set_role('administrator');
						echo 'Successfully created new admin user. Remove this function!';
				}
				else {
						echo 'Error with wp_insert_user. No users were created.';
				}
		} else {
				echo 'User not created. This user or email already exists.';
		}
    }
}

WordPress Plugin: Better deactivate visual editor

Blackbam — Sat, 01 Dec 2012 19:34:50 +0000

As it is happens quite often that the rich editor of WordPress is a barrier concerning posts including difficult HTML, I wrote a Plugin. I am planning to release an improved version to the WordPress Plugin repository soon, but I think this works quite well for now:

// Deactivate Visual Editor if option is set
add_action('pre_get_posts', 'deactivate_visual_editor');

function deactivate_visual_editor() {
  global $wp_rich_edit;
  $post_id = $_GET['post'];
  
  $value = get_post_meta($post_id, 'deactivate_visual_editor', true);
  if($value == 1)
    $wp_rich_edit = false;
}


// create a box for each post / page
function cis_init(){
	add_meta_box("cis_post_settings", __("Details",TEXTDOMAIN), "cis_post_settings", "page", "normal", "high");
	add_meta_box("cis_post_settings", __("Details",TEXTDOMAIN), "cis_post_settings", "post", "normal", "high");
}

function cis_post_settings() {
    global $post;
    $custom = get_post_custom($post->ID);
	
	// maybe we want to automatize this?
?>
	
		
			
				Deactivate visual editor?
				
					checked="checked" />
				
			
		
	
post_type == "post" || $post->post_type == "page") {
		update_post_meta($post->ID, "deactivate_visual_editor", intval($_POST["deactivate_visual_editor"]));
		
	}
}

Deactivate visual editor?	checked="checked" />

Disabling (specific) WordPress update notifications in Backend for Core, Themes and Plugins

Blackbam — Thu, 12 Jul 2012 16:28:00 +0000

The automatic upgrade function of WordPress is usefull for most bloggers, as they always are reminded to keep WordPress and its extensions up to date. Anyhow, it can be very annoying for developers when customers and end-user make updates by their own, usually destroying something.

It is often recomendable to disable this notifications: Sometimes a Plugin or Theme must be extended or changed by the developer – automatic upgrades would destroy these changes. Some Plugins like Mailpress do not disable the automatic upgrade, though automatic upgrading usually leeds to huge data losses 🙁 Recently I had to learn this the hard way, but this is no excuse for incomplete backups, of course.

However the following functions can help:

1. Disable Plugin upgrades

You can disable special Plugins by pasting the following code into the Plugin itself:

add_filter('site_transient_update_plugins', 'cis_remove_plugin_update');
 
function cis_remove_plugin_update($value) {
	unset($value-\>response[ plugin_basename(__FILE__) ]);
	return $value;
}

You can alternativley paste some code into your functions.php-file of your Theme:

add_filter('site_transient_update_plugins', 'cis_remove_plugin_update');
 
function cis_remove_plugin_update($value) {
	$plugin_relative_path = "plugin_relative_path"; // this could be "akismet/akismet.php" for example
	unset($value->response[ $plugin_relative_path]);
	return $value;
}

You also can disable all Plugin upgrades, for example if you want to prevent customers from doing that:

remove_action ('load-update-core.php', 'wp_update_plugins');
add_filter ('pre_site_transient_update_plugins',create_function ('$a', "return null;"));

2. Disabling Theme Upgrades

Disable all Theme updgrades:

remove_action ('load-update-core.php', 'wp_update_themes');
add_filter ('pre_site_transient_update_themes',create_function ('$a', "return null;"));

3. Disable Core Updgrade

Note: You never should disable the Core-Upgrade of WordPress, as important security upgrades will be missed. However, if you need to do it for some reason:

add_filter ('pre_site_transient_update_core',create_function ('$a', "return null;"));

WordPress 3.3 – TinyMCE Advanced – qTranslate – fix style problems

Blackbam — Sat, 28 Jan 2012 18:24:46 +0000

Recently I had to fix a bunch of really annoying problems with this combination. Duplicated contents, automatically inserted line breaks and problems with the custom styles for TinyMCE really caused me to hate these Plugins. The reason for most of the problems is qTranslate though.

If you experience similar problems, the following “library” will be helpful for you. It contains a lot of functions to fix problems with this combination and to customize your backend the way you need it. Do not forget to remove the slashes in front of the required filter tags, otherwise the functions are not applied. Improvement ideas are welcome.

Download the Plugin

Code (NOTE: GeSHi prints the code with some little errors here, please download the Plugin. Thanks.)





/*
Plugin Name: TinyMCE Advanced qTranslate fix editor problems
Plugin URI: https://blog.blackbam.at/2012/01/28/wordpress-3-3-tinymce-advanced-qtranslate-fix-style-problems/
Description: Remove line breaks and whitespace, enable custom stylesheets and multiple textareas. Fully customizable.
Version: 1.0.0
Author: David Stöckl
Author URI: http://www.blackbam.at/
 * 
Released and distributed under the GPLv2.
 * 
*/

/********** Administration ******************/
register_activation_hook(__FILE__,"tqfep_activate");

function tqfep_activate() {
	add_option('tqfep_styles',"");
	add_option('tqfep_fix_pre',1);
	add_option('tqfep_fix_post',1);
	add_option('tqfep_encoding','UTF-8');
	add_option('tqfep_custom_styles',';My Class=myclass;');
	register_uninstall_hook(__FILE__,"tqfep_uninstall");
}

function tqfep_uninstall() {
	// delete all options, tables, ...
	delete_option('tqfep_styles');
	delete_option('tqfep_fix_pre');
	delete_option('tqfep_fix_post');
	delete_option('tqfep_encoding');
	delete_option('tqfep_custom_styles');
}

function tqfepUpdateCheckbox($option) {
	update_option($option,intval($_POST[$option]));
}

function tqfepUpdateSelect($option,$allowed) {
	if(in_array($_POST[$option],$allowed)) {
		update_option($option,$_POST[$option]);
	}
}


// add the options page on initialization
add_action('admin_menu','tqfep_admin');

// add the actual options page
function tqfep_admin() {
	add_options_page('Fix TQ Editor','Fix TQ Editor','manage_options',__FILE__,'tqfep_backend_page');
}

// add the options page
function tqfep_backend_page() { ?>
	
		
		Settings: TinyMCE Advanced qTranslate fix editor problems
		
			Settings saved successfully
		
		
			
				
					
						
						
							checked="checked"  />
						
						
					
					
						
						
							checked="checked"  />
						
						
					
					
						
						
							
						
						
					
					
						
						
							
						
						
					
					
						
						
							
						
						
					
				
				
				
				
			
		
	
", "-->", $content);
	$content = preg_replace("/(-->)(\s| )*(\s| )*(<\/p>)(\s| )*/","-->",$content); 
	$content = htmlentities($content,ENT_COMPAT | ENT_HTML401,get_option('tqfep_encoding'));
	return $content;
}

function fix_p_after_edit ($content) {
	$content = str_replace("", "-->", $content);
	$content = preg_replace("/(-->)(\s| )*
(\s| )*(<\/p>)(\s| )*/","-->",$content); 
	return $content;
}

Convert WordPress attachment URLs into file URLs

Blackbam — Tue, 10 Jan 2012 20:44:53 +0000

You do not want to use Attachment-Pages in your WordPress page? Or maybe you installed a gallery Plugin and want to transform all your Attachment URLs into File-URLs now? The following script will do this for you. Just make sure, that all relevant content blocks of your database run through this script.

function cis_file_links($content) {
 
	$content = stripslashes($content);
 	
	$matches = array();
	$attachment_urls = preg_match_all("/href=\"([-A-Z0-9+&@#\/%?=~_|!:,.;]*)\?attachment_id=([0-9]*)\"/siU",$content,$matches);
 
	$urls = array();
	foreach($matches[2] as $attachment) {
		array_push($urls,wp_get_attachment_url($attachment));
	}
 
	// something went wrong with geting the attachments
	if(count($matches[2])!=count($urls)) {
		return $content;
	}
 
	for($i=0;$i
If you want to apply this script to every displayed content, for example, without changing any contents of your database, add this filter to your functions.php:
add_filter('the_content','cis_file_links');

Improvement ideas are welcome.

Order WordPress categories by custom meta value

Blackbam — Thu, 27 Oct 2011 22:18:15 +0000

This little scripts help ordering WordPress categories by meta values – a thing which is not integrated into WordPress yet and which costs some time to integrate.

1. Create a meta value (or meta values) for categories to order by

To order categories by a meta value the first thing which we have to do is to create a custom category meta value to order these (this first script is adapted from bainternet.com, where it is demonstrated in more detail).

//add extra fields to category edit form hook
add_action ( 'add_category_form', 'extra_category_fields');
add_action ( 'edit_category_form_fields', 'extra_category_fields');
 
//add extra fields to category edit form callback function
function extra_category_fields( $tag ) {    //check for existing featured ID
 
    $t_id = $tag->term_id;
    $cat_meta = get_option("category_$t_id");
?>
 

	
	
	
		

		
	


2. Order the categories by the created meta value and display these
// get the categories
$categories = get_categories();
 
$sortar = array();
foreach($categories as $ct) {
	$term_id = $ct->term_id;
	$cat_meta = get_option( "category_$term_id");
	array_push($sortar,array(intval($cat_meta['cat_order_val']),$ct));
}
 
uasort($sortar,create_function('$a,$b','return ($a[0]<=$b[0]) ? -1 : 1;'));
 
$ordered_categories = array();
 
foreach($sortar as $sor) {
	array_push($ordered_categories,$sor[1]);
}
 
foreach($ordered_categories as $oc) {
	// do whatever you want with your category objects
}

Have fun and be free to use these scripts. Improvement ideas are welcome.

Determine if a WordPress page or category is in the current ancestor/child tree (inside/outside the loop)

Blackbam — Sat, 08 Oct 2011 20:00:53 +0000

It is a common problem to detect parents or childs of pages and categories in WordPress correctly. The way WordPress stores relationships in hierarchies is not that trivial sometimes, so the results when querying are a bit confusing sometimes. It took some time to determine and optimize functions which do this job good and without faults, and I want to present these. As in this function I prefer working with page IDs, as this is the savest way to identify certain pages. With little changes it should also be possible to use these using e.g. slugs. Both of these functions can be used inside and outside of “the Loop” or loops.

Check if the current page (or a given page) is in the child tree of a given page

This function checks if the current page (or a given page, second parameter) is in the child tree of a given page.

/* Tests, if a page has got a certain parent anywhere in the ancestor/children tree */
function is_tree($pid, $pid2check = 0) {// $pid = The ID of the page we're looking for pages underneath
 
	global $post;
	// load details about this page
 
	// check if we should check two posts independently from the current query
	if ($pid2check < 1) {
		$pid2check = $post -> ID;
	}
 
	$anc = get_post_ancestors($pid2check);
 
	foreach ($anc as $ancestor) {
		if (is_page() && $ancestor == $pid) {
			return true;
		}
	}
 
	if (is_page() && (is_page($pid))) {
		return true;
		// we're at the page or at a sub page
	} else {
		return false;
		// we're elsewhere
	}
}

Check if the current post (or a given post) is in the ancestor/child tree of a given category

This function checks if the current post (or a given post identified by ID, second parameter) is in the ancestor/child tree of a given category.

/* Tests, if the given category is the current category, or in the ancestor/child tree of a given post or a child of it */
function is_category_or_sub($cat_id = 0, $pid = 0) {
	global $post;
 
	// check if a custom post id was given or get default (standard)
	if($pid<1) {
		$pid=$post->ID;
	}
 
	// check it for each category
    foreach (get_the_category($pid) as $cat) {
    	if ($cat_id == $cat->cat_ID || cat_is_ancestor_of($cat_id, $cat))  {
    		return true;
        }
    }
    return false;
}

Check if a given category is in the current category tree

Helpful if you have to determine the current category manually – checks if a given category is in the tree of another given category.

function in_category_tree($parent_cat,$child_or_equal_cat) {
	if($parent_cat ==$child_or_equal_cat || cat_is_ancestor_of($parent_cat, $child_or_equal_cat)) {
		return true;
	}
	return false;
}

Custom Taxonomy hierarchy check

Determine the top level taxonomy or check if a taxonomy is in the current taxonomies hirarchical tree.

function is_taxonomy_or_sub($child_or_equal_term_id,$parent_term_id,$taxonomy_name) {
       if($parent_term_id==$child_or_equal_term_id || $parent_term_id == get_top_level_term($child_or_equal_term_id,$taxonomy_name))  {
                return true;
        }
 }
 
function get_top_level_term($term_id,$taxonomy_name) {
	$term = get_term_by('id',$term_id,$taxonomy_name);
	if($term->parent>0) {
		return get_top_level_term($term->parent,$taxonomy_name);
	} else {
		return $term->term_id;
	}
}

This article is still under construction. Please report bugs, errors or improvement ideas, so we can optimize these scripts.

Using HTML line breaks and link sanitizer in WordPress comments

Blackbam — Fri, 30 Sep 2011 12:43:20 +0000

Recently we had an issue with the line-breaks in WordPress comments – the comments are saved to the database as they are submitted from the textarea in your theme, and depending on the theme so they are displayed. If your comments are displayed as HTML and there is no mechanism to add line breaks anywhere, then the comments do not have any line-breaks (as HTML line breaks must be created with a br-tag or something similar).

Another anoying thing is when commenters do not make links to hyperlinks, as these are not linked and clickable afterwards. We have found a solution for these problem – just copy the following script to your functions.php-file and your comments will be sanitized:

add_filter('preprocess_comment','format_the_comment_html');
 
function format_the_comment_html($comment_data) {
	$comment_data['comment_content']=nl2br(makeClickableLinks($comment_data['comment_content']));
	return $comment_data;
}
 
function makeClickableLinks($text) {
	$text = eregi_replace('(((f|ht){1}tp://)[-a-zA-Z0-9@:%_\+.~#?&//=]+)','\\1', $text);
	$text = eregi_replace('([[:space:]()[{}])(www.[-a-zA-Z0-9@:%_\+.~#?&//=]+)','\\1\\2', $text);
	$text = eregi_replace('([_\.0-9a-z-]+@([0-9a-z][0-9a-z-]+\.)+[a-z]{2,3})','\\1', $text);
	return $text;
}

Digging into roles and capabilities in WordPress – extension and global usage

Blackbam — Sat, 02 Jul 2011 15:12:52 +0000

You may have noticed that understanding and extending roles and capabilities in WordPress can be a bit confusing as a start. On the one hand there are the default roles: (Super Admin), Administrator, Editor, Author, Contributor, Subscriber, and they all have more or less rights (=capabilities) to do actions on a WordPress website, with descending rights as they are ordered here.

These roles do not exist since the early days of WordPress. They are mapped onto the traditional WordPress role system, which is a user level system from 0-10, while 10 is the highest level (all rights) and 0 is the lowest level (fewest rights). This interrelationship is shown on the following table from the Codex:

Each of the user levels has a certain amount of capabilities. These capabilities exactly define what a WordPress user is allowed to do on the website. The capability “edit_posts”, for example, allows a user to edit his own published posts, the capability “add_users” allows a user to add new users to the system, and so on.

Important things to know about roles and capabilities

The default system may be enough for blog systems, but not when it comes to WordPress as a CMS. The following things are important to know:

It is possible to create custom roles and custom capabilities (as they are registered default with custom post types)
One user can have more than one of the default roles, a user could be an “administrator”, “editor” and something like a custom “job_publisher” at the same time, for example. These roles are stored in the user-meta table for every user, in the field Table Prefix + capabilities.
You can make a semantic rule, that users on your website only are allowed to have one role at the same time, if you want to have a simplified role handling

How to extend the default role system then?

You can search for functions and information how to do that in the Function Reference or using Google. I recommend the great and well-known Members Plugin by Justin Tadlock, which will make managing these things quite easy using the WordPress backend. Just check it out. It is described as follows:

“Members is a plugin that extends your control over your blog. It’s a user, role, and content management plugin that was created to make WordPress a more powerful CMS.

The foundation of the plugin is its extensive role and capability management system. This is the backbone of all the current features and planned future features.”

How can we easily get roles and work with roles in Plugins and Themes now?

The following functions proved to be really useful, as they work almost anywhere you call them inside WordPress.

Returns the current users’ roles on every page inside WordPress as an array

function getUserRolesAdminEdit() {
	
	$current_user = wp_get_current_user();
	
	$currentuserid = $current_user->ID;
	
	if(isset($_REQUEST['user_id']) && $_REQUEST['user_id']!="") {
		$currentuserid = $_REQUEST['user_id'];
	}
	
	$userroles = array('subscriber');
	
	$user = new WP_User( $currentuserid );
	
	if ( !empty( $user->roles ) && is_array( $user->roles ) ) {
		$userroles=$user->roles;
	}
	
	return $userroles;
}

…or the current users’ role as a string, if you are sure there is only one per user

function getUserRoleAdminEdit() {
	
	$current_user = wp_get_current_user();
	
	$currentuserid = $current_user->ID;
	
	if(isset($_REQUEST['user_id']) && $_REQUEST['user_id']!="") {
		$currentuserid = $_REQUEST['user_id'];
	}
	
	$userrole = 'subscriber';
	
	$user = new WP_User( $currentuserid );
	
	if ( !empty( $user->roles ) && is_array( $user->roles ) ) {
		// only change this if one user can have more than one role, which is not expected
		$userrole=$user->roles[0];
	}
	
	return $userrole;
}

The following function always returns the correct user ID, which can be useful especially for admin pages

function getUserIdAdminEdit() {
	
	$current_user = wp_get_current_user();
	
	$currentuserid = $current_user->ID;
	
	if(isset($_REQUEST['user_id']) && $_REQUEST['user_id']!="") {
		$currentuserid = $_REQUEST['user_id'];
	}
	
	return $currentuserid;
}

WordPress improved user search (first name, last name, email) in backend

Blackbam — Mon, 27 Jun 2011 22:35:01 +0000

Recently, when working on a WordPress website for a huge amount of users, a customer was unsatisfyied with the WordPress backend search for users. The default backend search only is searching for your search string in usernames, but not for first name, last name or email of users.

As most WordPress projects are barely designed to have a huge amoung of users, this is not necessary in most cases. Anyway, the following code will help with this problem – add this to your functions.php-file and the WordPress user search will scan first name, last name and e-mail of every user.

Download the official WordPress Plugin

How the Plugin basically works (code overview of Version 1.2)

 
   // the actual improvement of the query
    function user_search_by_multiple_parameters($wp_user_query) {
        if(false === strpos($wp_user_query -> query_where, '@') && !empty($_GET["s"])) {

            global $wpdb;

            $uids=array();

			// get the custom meta fields to search
			$iusib_custom_meta = get_option('iusib_meta_fields');
			$iusib_cma = array_map('trim', explode(",",$iusib_custom_meta));

			$iusib_add = "";
			// the escaped query string
			$qstr = mysql_real_escape_string($_GET["s"]);
			
			// add all custom fields into the query
			if(!empty($iusib_cma)) {
				$iusib_add = " OR meta_key='".implode("' OR meta_key='",$iusib_cma)."'";
			}

            $usermeta_affected_ids = $wpdb -> get_results("SELECT DISTINCT user_id FROM ".$wpdb->base_prefix."usermeta WHERE (meta_key='first_name' OR meta_key='last_name'".$iusib_add.") AND LOWER(meta_value) LIKE '%".$qstr."%'");

            foreach($usermeta_affected_ids as $maf) {
                array_push($uids,$maf->user_id);
            }

            $users_affected_ids = $wpdb -> get_results("SELECT DISTINCT ID FROM ".$wpdb->base_prefix."users WHERE LOWER(user_nicename) LIKE '%".$qstr."%' OR LOWER(user_email) LIKE '%".$qstr."%'");

            foreach($users_affected_ids as $maf) {
                if(!in_array($maf->ID,$uids)) {
                    array_push($uids,$maf->ID);
                }
            }
			
            $id_string = implode(",",$uids);

            $wp_user_query -> query_where = str_replace("user_nicename LIKE '%".$qstr."%'", "ID IN(".$id_string.")", $wp_user_query -> query_where);
        }
        return $wp_user_query;
    }