8.4. Weitere Benutzerfunktionen

Blogs des Benutzers auslesen

Auch das Auslesen aller Blogs, die dem Benutzer zugewiesen wurden, ist möglich.

<?php
function get_blogs_of_user( $user_id, $all = false ) {
	...
}
?>

Dabei gilt:

  • $user_id (int)
    Die eindeutige ID des Benutzers.
  • $all (bool)
    Ob alle Blogs beachten werden sollen (true) oder ob die als gelöscht, archiviert oder spam markierten Blogs weg gelassen werden sollen (false).

Zurückgegeben wird ein Array mit Blogs als stdClass-Objekte. Falls der Benutzer nicht existiert oder keine Blogs zugewiesen wurden, wird ein leeres Array zurückgegeben.

Beispiel

You’re not allowed to see this content. Please log in first.

Herausfinden, ob ein Benutzer ein Mitglied eines Blogs ist

<?php
function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
	...
}
?>

Es gilt:

  • $user_id (int)
    Die eindeutige ID des Benutzers.
  • $blog_id (int)
    Die eindeutige ID des Blogs.

Zurückgegeben wird ein boolscher Wert (true oder false).

Beispiel

<?php
if ( is_user_member_of_blog( get_current_user_id(), 1 ) ) {
	//Ja. Benutzer ist Mitglied des Blogs mit der ID 1
}
?>

Benutzer zählen

You’re not allowed to see this content. Please log in first.

Eine Liste aller Benutzer in HTML-Format zurückgeben

<?php
function wp_dropdown_users( $args = '' ) {
	...
}
?>

Es gilt:

  • $args (array)
    Ein Array mit Argumenten (siehe unten) oder alternativ ein String mit Schlüsse-Wert-Paaren.

Zurückgegeben wird eine HTML <select>-Box.

Liste aller Argumente

Die Funktion erlaubt die selben Argumente wie get_users(). Zusätzlich aber noch folgende:

  • show_option_all (string)
    Erlaubt es, alle Benutzer auszuwählen.
  • show_option_none (string)
    Kreiert einen einzelnen Optionswert mit dem Inhalt None welches es erlaubt, alle Benutzer zu de-selektieren.
  • option_none_value (int|string)
    Der Wert, der benutzt wird, wenn show_option_none nichts zurückgibt. Standardwert ist -1.
  • $ordery (string)
    Feld, welches zur Sortierung genutzt werden soll. Standard ist display_name.
  • $order (string)
    Definiert ab- oder aufsteigende Sortierung. Akzeptiert also DESC oder ASC. Letzteres ist der Standardwert.
  • multi (bool)
    Ob das id=""-Element angezeigt werden soll (true) oder nicht (false).
  • show (string)
    Die Spalte, die als Name angezeigt werden soll. Als Standardwert wurde display_name festgelegt.
  • echo (bool)
    Ob der komplette HTML-Code sofort aus- (true) oder als String zurückgegeben (false) werden soll.
  • selected (int)
    Die ID des Benutzers der bereits markiert erscheinen soll.
  • include_selected (bool)
    Ein Array mit Benutzer-IDs, die immer in der Liste auftauchen sollen.
  • name (string)
    Das Name-Feld für die <select>-Box.
  • class (string)
    Die CSS-Klassen für das class-Feld der <select>-Box.
  • id (string)
    Das ID-Feld für die <select id="">-Box.
  • blog_id (ind)
    Die ID des Blogs, der berücksichtigt werden soll (nur Multisite).
  • hide_if_only_one_author (bool)
    Wird dieser Wert auf true gesetzt, so wird die <select>-Box nur dann angezeigt, wenn mehr als ein Benutzer existiert.
  • who (string)
    Typ des Benutzers. Standard ist ein leerer String. Akzeptiert darüber hinaus noch den Wert authors.
  • role (string)
    Die Benutzerrolle.
  • role__in (array)
    Ein Array mit Benutzerrollen. Betroffene Benutzer müssen mindestens eine dieser Rollen zugewiesen bekommen haben.
  • role__not_in (array)
    Ein Array mit Benutzerrollen, die ausgeschlossen werden sollen. Betroffene Benutzer, die mindestens eine dieser Rollen haben, werden ausgeschlossen.

Beispiel

<?php
wp_dropdown_users( array(
	'id'       => 'mm_users',
	'selected' => 2,
	'echo'     => true,
	'class'    => 'mm_users_class'
) );
?>

Gibt folgendes aus:


<select name='user' id='mm_users' class='mm_users_class'>
	<option value='1'>Max</option>
	<option value='2' selected='selected'>Daniel</option>
</select>

Anzahl der Artikel pro Benutzer zurückgeben

You’re not allowed to see this content. Please log in first.

Anzahl der Artikel von mehreren Benutzern zurückgeben

<?php
function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
	...
}
?>

Es gilt:

  • $users (array)
    Ein Array mit eindeutigen Benutzer-IDs.
  • $post_type (string)
    Der Name des Post-Typs. Als Standard ist post gesetzt.
  • $public_only (bool)
    Ob nur öffentliche Artikel (true) gezählt werden sollen.

Zurückgegeben wird ein Array mit den Zählungen pro Benutzer.

Beispiel

<?php
var_dump( count_many_users_posts(
	array( 1, 2 )
) );
?>

Gibt folgendes zurück:

array(2) {
  [1]=> string(1) "1"
  [2]=> int(0)
}

Prüfen ob eine E-Mail Adresse von einem Benutzer bereits benutzt wird

You’re not allowed to see this content. Please log in first.

Prüfen ob ein Benutzername bereits vergeben wurde

<?php
function username_exists( $username ) {
	...
}
?>

Es gilt:

  • $username (string)
    Der Benutzername der überprüft werden soll.

Zurückgegeben wird true wenn der Benutzername bereits vergeben ist. Ansonsten false.

Prüfen ob ein Benutzername gültig ist

Diese Funktion greift intern auf sanitize_user() zurück. D.h. der Benutzername wird zuerst gefiltert, wobei ungültige Zeichen entfernt werden. Gültig sind nur noch alphanumerische Zeichen, der Unterstrich, ein Leerzeichen, ein Punkt, der Bindestrich und das @-Zeichen.

<?php
function validate_username( $username ) {
	...
}
?>

Es gilt:

  • $username (string)
    Der Benutzername der überprüft werden soll.

Zurückgegeben wird true wenn der Benutzername validiert werden konnte. Ansonsten false.

Kontaktmethoden auslesen

You’re not allowed to see this content. Please log in first.

Noch mehr Benutzerfunktionen

Es gibt noch weitere Benutzerfunktionen, die ich hier nicht im Detail beschreiben werde. Beispiele sind:

You’re not allowed to see this content. Please log in first.