A HitchHackers guide through WordPress

wp_register

February 12, 2011 by Thorsten 0 Comments

Definition:
function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {}

Display the Registration or Admin link.

Display a link which allows the user to navigate to the registration page if not logged in and registration is enabled or to the dashboard if logged in.

Parameters

string $before: Text to output before the link (defaults to <li>).
string $after: Text to output after the link (defaults to </li>).
boolean $echo: Default to echo and not return the link.

Defined filters

Source code

function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {



	if ( ! is_user_logged_in() ) {

		if ( get_option('users_can_register') )

			$link = $before . '<a href="' . site_url('wp-login.php?action=register', 'login') . '">' . __('Register') . '</a>' . $after;

		else

			$link = '';

	} else {

		$link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;

	}



	if ( $echo )

		echo apply_filters('register', $link);

	else

		return apply_filters('register', $link);

}

4019

/wp-includes/general-template.php, Documentation, Files, Filters, Filters by letter r, Functions, Functions by letter w

codex, idc4fca6486806d6c73d2e641bb8c22d23, register, wp_register

wp_referer_field

February 12, 2011 by Thorsten 0 Comments

Definition:
function wp_referer_field( $echo = true ) {}

Retrieve or display referer hidden field for forms.

The referer link is the current Request URI from the server super global. The input name is ‘_wp_http_referer’, in case you wanted to check manually.

Parameters

bool $echo: Whether to echo or return the referer field.

Return values

returns:Referer field.

Source code

function wp_referer_field( $echo = true ) {

	$ref = esc_attr( $_SERVER['REQUEST_URI'] );

	$referer_field = '<input type="hidden" name="_wp_http_referer" value="'. $ref . '" />';



	if ( $echo )

		echo $referer_field;

	return $referer_field;

}

4017

/wp-includes/functions.php, Documentation, Files, Functions, Functions by letter w

codex, id3184cc5387a263ec7d13c0bc8c6040a2, wp_referer_field

wp_redirect

February 12, 2011 by Thorsten 0 Comments

Definition:
function wp_redirect($location, $status = 302) {}

Redirects to another page.

Parameters

string $location: The path to redirect to
int $status: Status code to use

Return values

returns:False if $location is not set

Defined filters

wp_redirect
apply_filters('wp_redirect', $location, $status)
wp_redirect_status
apply_filters('wp_redirect_status', $status, $location)

Source code

function wp_redirect($location, $status = 302) {

	global $is_IIS;



	$location = apply_filters('wp_redirect', $location, $status);

	$status = apply_filters('wp_redirect_status', $status, $location);



	if ( !$location ) // allows the wp_redirect filter to cancel a redirect

		return false;



	$location = wp_sanitize_redirect($location);



	if ( !$is_IIS && php_sapi_name() != 'cgi-fcgi' )

		status_header($status); // This causes problems on IIS and some FastCGI setups



	header("Location: $location", true, $status);

}

4015

/wp-includes/pluggable.php, Documentation, Files, Filters, Filters by letter w, Functions, Functions by letter w

codex, id58896296f3c819c3ef53b107a7573731, wp_redirect, wp_redirect_status

wp_read_image_metadata

February 12, 2011 by Thorsten 0 Comments

Definition:
function wp_read_image_metadata( $file ) {}

Get extended image metadata, exif or iptc as available.

Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso created_timestamp, focal_length, shutter_speed, and title.

Parameters

string $file

Return values

returns:False on failure. Image metadata array on success.

Defined filters

wp_read_image_metadata_types
apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM )
wp_read_image_metadata
apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType )

Source code

function wp_read_image_metadata( $file ) {

	if ( ! file_exists( $file ) )

		return false;



	list( , , $sourceImageType ) = getimagesize( $file );



	// exif contains a bunch of data we'll probably never need formatted in ways

	// that are difficult to use. We'll normalize it and just extract the fields

	// that are likely to be useful.  Fractions and numbers are converted to

	// floats, dates to unix timestamps, and everything else to strings.

	$meta = array(

		'aperture' => 0,

		'credit' => '',

		'camera' => '',

		'caption' => '',

		'created_timestamp' => 0,

		'copyright' => '',

		'focal_length' => 0,

		'iso' => 0,

		'shutter_speed' => 0,

		'title' => '',

	);



	// read iptc first, since it might contain data not available in exif such

	// as caption, description etc

	if ( is_callable( 'iptcparse' ) ) {

		getimagesize( $file, $info );



		if ( ! empty( $info['APP13'] ) ) {

			$iptc = iptcparse( $info['APP13'] );



			// headline, "A brief synopsis of the caption."

			if ( ! empty( $iptc['2#105'][0] ) )

				$meta['title'] = utf8_encode( trim( $iptc['2#105'][0] ) );

			// title, "Many use the Title field to store the filename of the image, though the field may be used in many ways."

			elseif ( ! empty( $iptc['2#005'][0] ) )

				$meta['title'] = utf8_encode( trim( $iptc['2#005'][0] ) );



			if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption

				$caption = utf8_encode( trim( $iptc['2#120'][0] ) );

				if ( empty( $meta['title'] ) ) {

					// Assume the title is stored in 2:120 if it's short.

					if ( strlen( $caption ) < 80 )

						$meta['title'] = $caption;

					else

						$meta['caption'] = $caption;

				} elseif ( $caption != $meta['title'] ) {

					$meta['caption'] = $caption;

				}

			}



			if ( ! empty( $iptc['2#110'][0] ) ) // credit

				$meta['credit'] = utf8_encode(trim($iptc['2#110'][0]));

			elseif ( ! empty( $iptc['2#080'][0] ) ) // creator / legacy byline

				$meta['credit'] = utf8_encode(trim($iptc['2#080'][0]));



			if ( ! empty( $iptc['2#055'][0] ) and ! empty( $iptc['2#060'][0] ) ) // created date and time

				$meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );



			if ( ! empty( $iptc['2#116'][0] ) ) // copyright

				$meta['copyright'] = utf8_encode( trim( $iptc['2#116'][0] ) );

		 }

	}



	// fetch additional info from exif if available

	if ( is_callable( 'exif_read_data' ) && in_array( $sourceImageType, apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) ) ) ) {

		$exif = @exif_read_data( $file );



		if ( !empty( $exif['Title'] ) )

			$meta['title'] = utf8_encode( trim( $exif['Title'] ) );



		if ( ! empty( $exif['ImageDescription'] ) ) {

			if ( empty( $meta['title'] ) && strlen( $exif['ImageDescription'] ) < 80 ) {

				// Assume the title is stored in ImageDescription

				$meta['title'] = utf8_encode( trim( $exif['ImageDescription'] ) );

				if ( ! empty( $exif['COMPUTED']['UserComment'] ) && trim( $exif['COMPUTED']['UserComment'] ) != $meta['title'] )

					$meta['caption'] = utf8_encode( trim( $exif['COMPUTED']['UserComment'] ) );

			} elseif ( trim( $exif['ImageDescription'] ) != $meta['title'] ) {

				$meta['caption'] = utf8_encode( trim( $exif['ImageDescription'] ) );

			}

		} elseif ( ! empty( $exif['Comments'] ) && trim( $exif['Comments'] ) != $meta['title'] ) {

			$meta['caption'] = utf8_encode( trim( $exif['Comments'] ) );

		}



		if ( ! empty( $exif['Artist'] ) )

			$meta['credit'] = utf8_encode( trim( $exif['Artist'] ) );

		elseif ( ! empty($exif['Author'] ) )

			$meta['credit'] = utf8_encode( trim( $exif['Author'] ) );



		if ( ! empty( $exif['Copyright'] ) )

			$meta['copyright'] = utf8_encode( trim( $exif['Copyright'] ) );

		if ( ! empty($exif['FNumber'] ) )

			$meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );

		if ( ! empty($exif['Model'] ) )

			$meta['camera'] = utf8_encode( trim( $exif['Model'] ) );

		if ( ! empty($exif['DateTimeDigitized'] ) )

			$meta['created_timestamp'] = wp_exif_date2ts($exif['DateTimeDigitized'] );

		if ( ! empty($exif['FocalLength'] ) )

			$meta['focal_length'] = wp_exif_frac2dec( $exif['FocalLength'] );

		if ( ! empty($exif['ISOSpeedRatings'] ) )

			$meta['iso'] = utf8_encode( trim( $exif['ISOSpeedRatings'] ) );

		if ( ! empty($exif['ExposureTime'] ) )

			$meta['shutter_speed'] = wp_exif_frac2dec( $exif['ExposureTime'] );

	}



	return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );



}

4013

/wp-admin/includes/image.php, Documentation, Files, Filters, Filters by letter w, Functions, Functions by letter w

idb0e411b86044b14f118ec066ec83ddab, wp_read_image_metadata, wp_read_image_metadata_types

wp_rand

February 12, 2011 by Thorsten 0 Comments

Definition:
function wp_rand( $min = 0, $max = 0 ) {}

Generates a random number

Parameters

int $min: Lower limit for the generated number (optional, default is 0)
int $max: Upper limit for the generated number (optional, default is 4294967295)

Return values

returns:A random number between min and max

Source code

function wp_rand( $min = 0, $max = 0 ) {

	global $rnd_value;



	// Reset $rnd_value after 14 uses

	// 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value

	if ( strlen($rnd_value) < 8 ) {

		if ( defined( 'WP_SETUP_CONFIG' ) )

			static $seed = '';

		else

			$seed = get_transient('random_seed');

		$rnd_value = md5( uniqid(microtime() . mt_rand(), true ) . $seed );

		$rnd_value .= sha1($rnd_value);

		$rnd_value .= sha1($rnd_value . $seed);

		$seed = md5($seed . $rnd_value);

		if ( ! defined( 'WP_SETUP_CONFIG' ) )

			set_transient('random_seed', $seed);

	}



	// Take the first 8 digits for our value

	$value = substr($rnd_value, 0, 8);



	// Strip the first eight, leaving the remainder for the next call to wp_rand().

	$rnd_value = substr($rnd_value, 8);



	$value = abs(hexdec($value));



	// Reduce the value to be within the min - max range

	// 4294967295 = 0xffffffff = max random number

	if ( $max != 0 )

		$value = $min + (($max - $min + 1) * ($value / (4294967295 + 1)));



	return abs(intval($value));

}

4011

/wp-includes/pluggable.php, Documentation, Files, Functions, Functions by letter w

ida72d5be54e6be80ec6b9ac63e1d75a8a, wp_rand

Newer Entries

Older Entries

Ouch, we don’t have this here!

It seems that we do not have anything about this topic here, but you might want to do one of the following. If you were searching for a php function head over to the php manual and use one of their entry points

If you were searching for a WordPress related topic and did not find it here try one of the following options.

Use the search form in the navigation bar above
Use the WordPress search

If nothing like this helps try using Google or an other search engine

Google
Bing

Golden Q&A rules

Search first

Be sure that you first search in Google, the WordPress forums, Codex or this site ( using the form in the menu ). Sharing your previous results helps narrowing down the problem if you also tell us what you found and why it didn’t serve your needs.

Be specific

Give as much details about your problem as possible. Make sure to include examples, links and context related to your problem.

Be WordPress related

This site focuses on WordPress and related topics. Please make sure that your question is related to WordPress code, functionality or other related topics.

Be nice

Please keep in mind that this is a voluntary service. Answers might not always be correct or what you expect. Please be nice and let us know if any inappropriate answers come to your attention.