Documentación WordPress en el núcleo

Es cierto que hay muchísima información en internet sobre WordPress, pero la mejor documentación WordPress se encuentra en la web codex.wordpress.org y en el propio código fuente de la instalación. Muchos de los archivos del núcleo vienen con comentarios tanto en la cabecera como en el interior.

Documentación interna

Si tenemos en cuenta que todas las funciones que se usan en WordPress parten del núcleo es muy interesante saber acceder a ellas y leer un poco al respecto. Si abrimos por ejemplo en la carpeta wp-includes el fichero capabilities.php vemos en la cabecera:

/**
* WordPress User Roles.
*
* The role option is simple, the structure is organized by role name that store
* the name in value of the 'name' key. The capabilities are stored as an array
* in the value of the 'capability' key.
*
* array (
* 'rolename' => array (
* 'name' => 'rolename',
* 'capabilities' => array()
* )
* )
*
* @since X.X.X
* @package WordPress
* @subpackage User
*/

Tenemos información al respecto como gestiona WordPress los permisos, nos informa de como se almacena la información y en que versión de WordPress se cambio por última vez el fichero: X.X.X.

Si vamos bajando en el documento podemos ir viendo mucha más información, sobre las variables, sobre las funciones, etc.

No es necesario, ni recomendable (por que cambia constantemente), conocer toda esta información, pero si que es útil conocer su existencia y saber como aprovecharnos de ella.

Ejemplo de uso

Supongamos que queremos saber información del usuario conectado actualmente en la plataforma, para buscar información personalizada en la base de datos, ¿Hay alguna función propia de WordPress? o ¿Que parámetros le puedo pasar y que me devuelve?. Podemos buscar en internet la información o podemos consultar directamente el núcleo.

Teniendo en cuenta que los nombres de los ficheros y las funciones tienen mucha lógica, podemos llegar fácilmente al fichero de user.php y podemos investigar un poco, existe una función que nos devuelve el ID del usuario conectado: get_current_user_id() que no admite ningún parámetro y devuelve solo el valor $user->ID,  esta función llama a otra: wp_get_current_user() que se  encuentra en un fichero de conectores: pluggable.php, y podríamos investigar que información nos devuelve para saber que devuelve un array con información del usuario: ID, user_login, etc.

Conclusión

Si queremos aprovechar las posibilidades que nos ofrece WordPress para crear nuestros propios desarrollos, conocer un poco el núcleo es muy interesante, ya que nos aporta toda la información que necesitamos.