README

Wordpress plugin to add new section for the customizer to allow the user to change the logo for website and login page.

How to install

Classical way

Download the plugin as zip archive and then upload it to your wordpress plugins folder and extract it there.
Activate the plugin from your admin panel

Composer way

run composer command : composer require hyyan/logo-controller

How to use

Plugin configutaion

The plugin comes with following configuration as default :

$default = array(
    // path for default logo 
    'default' => '/logo.png',
    //the logo url (default to home page)
    'url' => home_url('/'),
    // the logo desciption default to (get_bloginfo('name', 'display')) 
    'description' => get_bloginfo('name', 'display'),
    // enable logo display on the login page
    'enable-on-login-page' => true,
);

You can override the default configuration using add_filter function like in the following example :

// in the your theme's functions.php file

add_filter('Hyyan\LogoController.options', function(array $default) {

    $default['default'] = '/my-logo.png';
    $default['enable-on-login-page'] = false;

    return $default;
});

Display the logo in your theme

The plugin does not make any assumption about the place of your logo so you have to add it manually , probably in your header.php template.

<?php 

 // in you theme template use the following functions to get the logo
  
// print : http://example.com/path/to/logo.png 
 echo hyyan_get_the_logo(); 

// print : <img src="http://example.com/path/to/logo.png" alt="Website Title">    
 hyyan_the_logo();

Contributing

Everyone is welcome to help contribute and improve this plugin. There are several ways you can contribute:

Reporting issues (please read issue guidelines)
Suggesting new features
Writing or refactoring code
Fixing issues

hyyan / logo-controller

Maintainers

Details